desmoj.extensions.visualization2d.engine.viewer

Class SimulationTime

java.lang.Object

desmoj.extensions.visualization2d.engine.viewer.SimulationTime

public class SimulationTime
extends java.lang.Object

The simulationtime is allways computed from real system-time. The simulation-time-value is given by a long an can be interpreted in a java-typical way as a time-value. Normally the time runs with a specified speed. It's can started, halted (pause), continued and stopped. In a trace-mode the time can step from one value to the next.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHOW_DATE
static int	SHOW_DATE_TIME
static int	SHOW_DATE_TIME_MILLIS
static int	SHOW_DAY
static int	SHOW_DAY_DATE_TIME_MILLIS_DST
static int	SHOW_DST
static int	SHOW_MILLIS
static int	SHOW_TIME
static int	SHOW_TIME_MILLIS
static int	SHOW_TIMEZONE

Constructor Summary

Constructors

Constructor and Description
SimulationTime(long start, long end, double speed, java.util.TimeZone timezone, java.util.Locale locale) Constructor for SimulationTime

Method Summary

Modifier and Type	Method and Description
void	cont() when SimulationTime is on pause, then lets it go running.
long	getSimulationEnd()
long	getSimulationStart()
long	getSimulationTime()
double	getSpeed() get simulation-speed
static java.lang.String	getTimeString(long time, int format) convert the time value to human-readable format.
static java.lang.String	getTimeZoneString()
boolean	isPause()
boolean	isRunning() means SimulationTime is started, not stopped and simulationEnd inn't reached.
void	pause() lets pause SimulationTime
void	setSimulationTime(long time) set simulation-time
void	setSpeed(double speed) updates simulation-speed
void	start() starts SimulationTime running by start-time
void	stop() stops SimulationTime

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SHOW_DATE

public static final int SHOW_DATE

See Also:

Constant Field Values

SHOW_TIME

public static final int SHOW_TIME

See Also:

Constant Field Values

SHOW_MILLIS

public static final int SHOW_MILLIS

See Also:

Constant Field Values

SHOW_DATE_TIME

public static final int SHOW_DATE_TIME

See Also:

Constant Field Values

SHOW_DATE_TIME_MILLIS

public static final int SHOW_DATE_TIME_MILLIS

See Also:

Constant Field Values

SHOW_TIME_MILLIS

public static final int SHOW_TIME_MILLIS

See Also:

Constant Field Values

SHOW_DAY

public static final int SHOW_DAY

See Also:

Constant Field Values

SHOW_DST

public static final int SHOW_DST

See Also:

Constant Field Values

SHOW_TIMEZONE

public static final int SHOW_TIMEZONE

See Also:

Constant Field Values

SHOW_DAY_DATE_TIME_MILLIS_DST

public static final int SHOW_DAY_DATE_TIME_MILLIS_DST

See Also:

Constant Field Values

Constructor Detail

SimulationTime

public SimulationTime(long start,
                      long end,
                      double speed,
                      java.util.TimeZone timezone,
                      java.util.Locale locale)

Constructor for SimulationTime

Parameters:

start - start-time

end - end-time

speed - SimulationTime runs speed times fast as natural time

timezone - default is UTC

locale - default is Locale.ENGLISH

Method Detail

getTimeString

public static java.lang.String getTimeString(long time,
                                             int format)

convert the time value to human-readable format. time == Long.MIN_VALUE is written as "".

Parameters:

time - internal time as long

format - timeformat for output

Returns:

time value to human-readable format

getTimeZoneString

public static java.lang.String getTimeZoneString()

start

public void start()

starts SimulationTime running by start-time

stop

public void stop()

stops SimulationTime

pause

public void pause()

lets pause SimulationTime

cont

public void cont()

when SimulationTime is on pause, then lets it go running. In trace-mode it jumps to next step, set by setNextStep().

setSpeed

public void setSpeed(double speed)

updates simulation-speed

Parameters:

speed -

getSpeed

public double getSpeed()

get simulation-speed

Returns:

speed, stored in SimulationTime

setSimulationTime

public void setSimulationTime(long time)

set simulation-time

Parameters:

time -

getSimulationTime

public long getSimulationTime()

isRunning

public boolean isRunning()

means SimulationTime is started, not stopped and simulationEnd inn't reached.

Returns:

true, when running

isPause

public boolean isPause()

getSimulationStart

public long getSimulationStart()

getSimulationEnd

public long getSimulationEnd()