CmdGeneration (DESMO-J 2.5.1c API)

java.lang.Object
- desmoj.extensions.visualization2d.engine.command.WriteCmds
- - desmoj.extensions.visualization2d.animation.CmdGeneration

```
public class CmdGeneration
extends WriteCmds
```
CmdGeneration manages cmd- and log-file generation writing simTimeBound command and converts Simtime to animationTime

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

christian.mueller@th-wildau.de For information about subproject: desmoj.extensions.visualization2d please have a look at: http://www.th-wildau.de/cmueller/Desmo-J/Visualization2d/ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors
Constructor and Description
`CmdGeneration(java.lang.String cmdFileName, java.lang.String logFileName, java.net.URL iconPathURL)` Supportmethods of cmds-file-generation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkAndLog(Command c)` The Method checkAndLog makes a syntax and semantic check of the generated animation commands.
`void`	`close()` close cmds- and log-file
`java.lang.String`	`createInternId(java.lang.String name)` create an internal Id based on name.
`void`	`experimentStart(Experiment exp, double initSpeed)` sets begin and end time of experiment, create cmds command "createSimTimeBounds" and starts experiment
`long`	`getAnimationRunTime(TimeInstant t)` distance between actual simTime and initTime as UnixTimeStamp
`long`	`getAnimationTime(TimeInstant t)` get Unix TimeStamp of Time t, shown in viewer
`long`	`getAnimationTimeInit()` get Unix TimeStamp of animation begin
`java.lang.String`	`getCmdFileName()`
`java.net.URL`	`getCmdFileURL()` get CmdFileName as File-URL
`java.net.URL`	`getIconPathURL()`
`TimeInstant`	`getInitTime()`
`java.lang.String`	`getLogFileName()`
`java.util.TimeZone`	`getTimeZone()`
`boolean`	`isInitPhase()` say true when simulation isn't started
`void`	`setCheckAndLog()` Only when checkAndLog is set the Method CheckAndLog is active.
`void`	`setFlushSeq(int flushSeq)` sets the number of comands, when CommandFrame.writeCmdBuffer is flushed in cmdFile.
`void`	`setStartStopTime(TimeInstant begin, TimeInstant end, java.util.TimeZone timezone)` Defines simulation start- and stop-time.
`void`	`setTimeZone(java.util.TimeZone timezone)`
`void`	`write(Command c)` write a command in CommandFrame.writeCmdBuffer.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CmdGeneration
```
public CmdGeneration(java.lang.String cmdFileName,
                     java.lang.String logFileName,
                     java.net.URL iconPathURL)
```
    Supportmethods of cmds-file-generation. Opens cmds- and log-file and
    
    Parameters:
    
    cmdFileName -
    
    logFileName -
    
    iconPathURL -
    
    Throws:
    
    java.io.UnsupportedEncodingException
- Method Detail
  - setStartStopTime
```
public void setStartStopTime(TimeInstant begin,
                             TimeInstant end,
                             java.util.TimeZone timezone)
```
    Defines simulation start- and stop-time. Must be between experiment constructor and model-experiment connect.
    Attention: It makes no sence to define a TimeInstant before experiment constructor.
    
    Parameters:
    
    begin - Begin of simulation
    
    end - End of simulation
    
    timezone - Timezone of simulation, UTC when null
  - close
```
public void close()
```
    close cmds- and log-file
  - getCmdFileName
```
public java.lang.String getCmdFileName()
```
  - getLogFileName
```
public java.lang.String getLogFileName()
```
  - setCheckAndLog
```
public void setCheckAndLog()
```
    Only when checkAndLog is set the Method CheckAndLog is active. Default is false. The Method checkAndLog makes a syntax and semantic check of the generated animation commands. The commands are also logged in logFileName from constructor. For semantic check the whole animation environment is build in heap. This consumes a lot of time and heap space. Normally the CheckAndLog Method is switched off.
  - setFlushSeq
```
public void setFlushSeq(int flushSeq)
```
    sets the number of comands, when CommandFrame.writeCmdBuffer is flushed in cmdFile. Default is 1000 A small value reduces the uses buffer space and may be increases the running time.
    
    Parameters:
    
    flushSeq -
  - getCmdFileURL
```
public java.net.URL getCmdFileURL()
```
    get CmdFileName as File-URL
    
    Returns:
  - getIconPathURL
```
public java.net.URL getIconPathURL()
```
  - write
```
public void write(Command c)
```
    write a command in CommandFrame.writeCmdBuffer. When the buffer has more than this.flushSeq comands, the buffer is flushed in cmdFile
    
    Overrides:
    
    write in class WriteCmds
    
    Parameters:
    
    c - Command to write
  - checkAndLog
```
public void checkAndLog(Command c)
```
    The Method checkAndLog makes a syntax and semantic check of the generated animation commands. The commands are also logged in logFileName from constructor. For semantic check the whole animation environment is build in heap. This consumes a lot of time and heap space. This Method works only when its switched on with setCheckAndLog() Method. Normally the CheckAndLog Method is switched off.
    
    Parameters:
    
    c - Command to write
  - isInitPhase
```
public boolean isInitPhase()
```
    say true when simulation isn't started
    
    Returns:
  - getInitTime
```
public TimeInstant getInitTime()
```
  - experimentStart
```
public void experimentStart(Experiment exp,
                            double initSpeed)
```
    sets begin and end time of experiment, create cmds command "createSimTimeBounds" and starts experiment
    
    Parameters:
    
    exp -
    
    begin -
    
    end -
    
    timezone -
    
    initSpeed -
  - getAnimationTimeInit
```
public long getAnimationTimeInit()
```
    get Unix TimeStamp of animation begin
    
    Returns:
  - getAnimationTime
```
public long getAnimationTime(TimeInstant t)
```
    get Unix TimeStamp of Time t, shown in viewer
    
    Parameters:
    
    t - TimeInstant, used in desmoj
    
    Returns:
    
    computed Time-stamp
  - getAnimationRunTime
```
public long getAnimationRunTime(TimeInstant t)
```
    distance between actual simTime and initTime as UnixTimeStamp
    
    Parameters:
    
    t - SimTime distance
    
    Returns:
    
    computed AnimationTime distance
  - setTimeZone
```
public void setTimeZone(java.util.TimeZone timezone)
```
  - getTimeZone
```
public java.util.TimeZone getTimeZone()
```
  - createInternId
```
public java.lang.String createInternId(java.lang.String name)
```
    create an internal Id based on name. This id is used as an internal id by building animation objects.
    
    Parameters:
    
    name -
    
    Returns:

Class CmdGeneration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CmdGeneration

Method Detail

setStartStopTime

close

getCmdFileName

getLogFileName

setCheckAndLog

setFlushSeq

getCmdFileURL

getIconPathURL

write

checkAndLog

isInitPhase

getInitTime

experimentStart

getAnimationTimeInit

getAnimationTime

getAnimationRunTime

setTimeZone

getTimeZone

createInternId