Package org.opentrafficsim.core.dsol

Class OTSLoggingAnimator

java.lang.Object

org.djutils.event.EventProducer

nl.tudelft.simulation.dsol.simulators.Simulator<A,R,T>

nl.tudelft.simulation.dsol.simulators.DEVSSimulator<A,R,T>

nl.tudelft.simulation.dsol.simulators.DEVSAnimator<A,R,T>

nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock<Time,Duration,SimTimeDoubleUnit>

nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock.TimeDoubleUnit

org.opentrafficsim.core.dsol.OTSAnimator

org.opentrafficsim.core.dsol.OTSLoggingAnimator

All Implemented Interfaces:

Serializable, Runnable, Remote, AnimatorInterface, DEVSSimulatorInterface<Time,Duration,SimTimeDoubleUnit>, DEVSSimulatorInterface.TimeDoubleUnit, SimulatorInterface<Time,Duration,SimTimeDoubleUnit>, SimulatorInterface.TimeDoubleUnit, EventProducerInterface, OTSAnimatorInterface, OTSSimulatorInterface

public class OTSLoggingAnimator
extends OTSAnimator

Construct a DSOL DEVSRealTimeClock the easy way.

Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2018-10-30 14:03:57 +0100 (Tue, 30 Oct 2018) $, @version $Revision: 4727 $, by $Author: pknoppers $, initial version 11 mei 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock

DEVSRealTimeClock.CalendarDouble, DEVSRealTimeClock.CalendarFloat, DEVSRealTimeClock.CalendarLong, DEVSRealTimeClock.TimeDouble, DEVSRealTimeClock.TimeDoubleUnit, DEVSRealTimeClock.TimeFloat, DEVSRealTimeClock.TimeFloatUnit, DEVSRealTimeClock.TimeLong

Nested classes/interfaces inherited from interface nl.tudelft.simulation.dsol.simulators.AnimatorInterface

AnimatorInterface.AnimationThread

Nested classes/interfaces inherited from interface nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface

DEVSSimulatorInterface.CalendarDouble, DEVSSimulatorInterface.CalendarFloat, DEVSSimulatorInterface.CalendarLong, DEVSSimulatorInterface.TimeDouble, DEVSSimulatorInterface.TimeDoubleUnit, DEVSSimulatorInterface.TimeFloat, DEVSSimulatorInterface.TimeFloatUnit, DEVSSimulatorInterface.TimeLong

Nested classes/interfaces inherited from interface nl.tudelft.simulation.dsol.simulators.SimulatorInterface

SimulatorInterface.CalendarDouble, SimulatorInterface.CalendarFloat, SimulatorInterface.CalendarLong, SimulatorInterface.TimeDouble, SimulatorInterface.TimeDoubleUnit, SimulatorInterface.TimeFloat, SimulatorInterface.TimeFloatUnit, SimulatorInterface.TimeLong

Field Summary

Fields inherited from class nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock

BACKLOG_EVENT, CHANGE_SPEED_FACTOR_EVENT

Fields inherited from class nl.tudelft.simulation.dsol.simulators.DEVSSimulator

eventList

Fields inherited from class nl.tudelft.simulation.dsol.simulators.Simulator

replication, running, semaphore, simulatorTime, worker

Fields inherited from class org.djutils.event.EventProducer

listeners

Fields inherited from interface nl.tudelft.simulation.dsol.simulators.AnimatorInterface

ANIMATION_DELAY_CHANGED_EVENT, DEFAULT_ANIMATION_DELAY, UPDATE_ANIMATION_EVENT

Fields inherited from interface nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface

EVENTLIST_CHANGED_EVENT

Fields inherited from interface org.djutils.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Fields inherited from interface nl.tudelft.simulation.dsol.simulators.SimulatorInterface

END_REPLICATION_EVENT, START_EVENT, START_REPLICATION_EVENT, STEP_EVENT, STOP_EVENT, TIME_CHANGED_EVENT, WARMUP_EVENT

Constructor Summary

Constructors

Constructor	Description
OTSLoggingAnimator(String path, Serializable simulatorId)	Construct an OTSAnimator.

Method Summary

Modifier and Type	Method	Description
void	initialize(Time startTime, Duration warmupPeriod, Duration runLength, OTSModelInterface model)	Initialize a simulation engine without animation; the easy way.
void	initialize(Time startTime, Duration warmupPeriod, Duration runLength, OTSModelInterface model, int replicationnr)	Initialize a simulation engine without animation and prescribed replication number; the easy way.
void	initialize(Time startTime, Duration warmupPeriod, Duration runLength, OTSModelInterface model, Map<String,StreamInterface> streams)	Initialize a simulation engine without animation; the easy way.
void	run()
String	toString()

Methods inherited from class org.opentrafficsim.core.dsol.OTSAnimator

getReplication, scheduleEvent

Methods inherited from class nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock.TimeDoubleUnit

simulatorTimeForWallClockMillis

Methods inherited from class nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock

getSpeedFactor, getUpdateMsec, isAnimation, isCatchup, setAnimation, setCatchup, setSpeedFactor, setSpeedFactor, setUpdateMsec

Methods inherited from class nl.tudelft.simulation.dsol.simulators.DEVSAnimator

getAnimationDelay, setAnimationDelay, updateAnimation

Methods inherited from class nl.tudelft.simulation.dsol.simulators.DEVSSimulator

autoPauseSimulator, cancelEvent, endReplication, getEventList, initialize, isPauseOnError, runUpTo, runUpToAndIncluding, scheduleEvent, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventNow, scheduleEventNow, scheduleEventNow, scheduleEventNow, scheduleEventRel, scheduleEventRel, scheduleEventRel, scheduleEventRel, setEventList, setPauseOnError, step

Methods inherited from class nl.tudelft.simulation.dsol.simulators.Simulator

cleanUp, getLogger, getSimTime, getSimulatorTime, getSourceId, isRunning, start, start, step, stop, stop

Methods inherited from class org.djutils.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, getEventTypesWithListeners, hasListeners, numberOfListeners, removeAllListeners, removeAllListeners, removeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface nl.tudelft.simulation.dsol.simulators.AnimatorInterface

getAnimationDelay, setAnimationDelay, updateAnimation

Methods inherited from interface nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface

cancelEvent, getEventList, isPauseOnError, runUpTo, runUpToAndIncluding, scheduleEvent, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventNow, scheduleEventNow, scheduleEventNow, scheduleEventNow, scheduleEventRel, scheduleEventRel, scheduleEventRel, scheduleEventRel, setEventList, setPauseOnError

Methods inherited from interface org.djutils.event.EventProducerInterface

addListener, addListener, addListener, addListener, getEventTypesWithListeners, hasListeners, numberOfListeners, removeListener

Methods inherited from interface nl.tudelft.simulation.dsol.simulators.SimulatorInterface

endReplication, getLogger, getSimTime, getSimulatorTime, getSourceId, initialize, isRunning, start, start, step, step, stop, stop

Constructor Details

OTSLoggingAnimator

public OTSLoggingAnimator(String path, Serializable simulatorId)

Construct an OTSAnimator.

Parameters:

path - path for logging

simulatorId - the id of the simulator to use in remote communication

Method Details

initialize

public void initialize(Time startTime, Duration warmupPeriod, Duration runLength, OTSModelInterface model) throws SimRuntimeException, NamingException

Initialize a simulation engine without animation; the easy way. PauseOnError is set to true;

Specified by:

initialize in interface OTSSimulatorInterface

Overrides:

initialize in class OTSAnimator

Parameters:

startTime - Time; the start time of the simulation

warmupPeriod - Duration; the warm up period of the simulation (use new Duration(0, SECOND) if you don't know what this is)

runLength - Duration; the duration of the simulation

model - OTSModelInterface; the simulation to execute

Throws:

SimRuntimeException - when e.g., warmupPeriod is larger than runLength

NamingException - when the context for the replication cannot be created

initialize

public void initialize(Time startTime, Duration warmupPeriod, Duration runLength, OTSModelInterface model, Map<String,StreamInterface> streams) throws SimRuntimeException, NamingException

Initialize a simulation engine without animation; the easy way. PauseOnError is set to true;

Overrides:

initialize in class OTSAnimator

Parameters:

startTime - Time; the start time of the simulation

warmupPeriod - Duration; the warm up period of the simulation (use new Duration(0, SECOND) if you don't know what this is)

runLength - Duration; the duration of the simulation

model - OTSModelInterface; the simulation to execute

streams - Map<String, StreamInterface>; streams

Throws:

SimRuntimeException - when e.g., warmupPeriod is larger than runLength

NamingException - when the context for the replication cannot be created

initialize

public void initialize(Time startTime, Duration warmupPeriod, Duration runLength, OTSModelInterface model, int replicationnr) throws SimRuntimeException, NamingException

Initialize a simulation engine without animation and prescribed replication number; the easy way. PauseOnError is set to true;

Specified by:

initialize in interface OTSSimulatorInterface

Overrides:

initialize in class OTSAnimator

Parameters:

startTime - Time; the start time of the simulation

warmupPeriod - Duration; the warm up period of the simulation (use new Duration(0, SECOND) if you don't know what this is)

runLength - Duration; the duration of the simulation

model - OTSModelInterface; the simulation to execute

replicationnr - int; the replication number

Throws:

SimRuntimeException - when e.g., warmupPeriod is larger than runLength

NamingException - when context for the animation cannot be created

toString

public String toString()

Overrides:

toString in class OTSAnimator

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class DEVSRealTimeClock<Time,Duration,SimTimeDoubleUnit>