org.opentrafficsim.simulationengine

Class SimpleAnimator

java.lang.Object

nl.tudelft.simulation.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<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

org.opentrafficsim.core.dsol.OTSDEVSRealTimeClock

org.opentrafficsim.simulationengine.SimpleAnimator

All Implemented Interfaces:

Serializable, Runnable, Remote, nl.tudelft.simulation.dsol.simulators.AnimatorInterface, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>, nl.tudelft.simulation.dsol.simulators.SimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>, nl.tudelft.simulation.event.EventProducerInterface, OTSAnimatorInterface, OTSDEVSSimulatorInterface, OTSSimulatorInterface, SimpleSimulatorInterface

public class SimpleAnimator
extends OTSDEVSRealTimeClock
implements SimpleSimulatorInterface, Serializable

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

$LastChangedDate: 2016-10-26 11:50:35 +0200 (Wed, 26 Oct 2016) $, @version $Revision: 2422 $, by $Author: averbraeck $, 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

nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock.CalendarDouble, nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock.CalendarFloat, nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock.CalendarLong, nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock.TimeDouble, nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock.TimeDoubleUnit, nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock.TimeFloat, nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock.TimeFloatUnit, nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock.TimeLong, nl.tudelft.simulation.dsol.simulators.DEVSRealTimeClock.TimeLongUnit

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

nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.CalendarDouble, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.CalendarFloat, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.CalendarLong, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDouble, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeFloat, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeFloatUnit, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeLong, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeLongUnit

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

nl.tudelft.simulation.dsol.simulators.AnimatorInterface.AnimationThread

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 nl.tudelft.simulation.event.EventProducer

listeners

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

EVENTLIST_CHANGED_EVENT

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

END_OF_REPLICATION_EVENT, START_EVENT, START_REPLICATION_EVENT, STEP_EVENT, STOP_EVENT, TIME_CHANGED_EVENT, WARMUP_EVENT

Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

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

ANIMATION_DELAY_CHANGED_EVENT, DEFAULT_ANIMATION_DELAY, UPDATE_ANIMATION_EVENT

Constructor Summary

Constructors

Constructor and Description
SimpleAnimator(org.djunits.value.vdouble.scalar.Time startTime, org.djunits.value.vdouble.scalar.Duration warmupPeriod, org.djunits.value.vdouble.scalar.Duration runLength, OTSModelInterface model) Create a simulation engine with animation; the easy way.

Method Summary

Modifier and Type	Method and Description
nl.tudelft.simulation.dsol.formalisms.eventscheduling.SimEvent<OTSSimTimeDouble>	scheduleEvent(org.djunits.value.vdouble.scalar.Time executionTime, short priority, Object source, Object target, String method, Object[] args) Construct and schedule a SimEvent using a Time to specify the execution time.

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

initialize, relativeMillis, runUpTo, toString

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

getSpeedFactor, getUpdateMsec, isCatchup, run, 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, getEventList, isPauseOnError, runUpToAndIncluding, scheduleEvent, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventNow, scheduleEventNow, scheduleEventNow, scheduleEventNow, scheduleEventRel, scheduleEventRel, scheduleEventRel, scheduleEventRel, setEventList, setPauseOnError, step, stop

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

cleanUp, getReplication, getSimulatorTime, isRunning, start, start, step, stop

Methods inherited from class nl.tudelft.simulation.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, removeAllListeners, removeAllListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opentrafficsim.core.dsol.OTSDEVSSimulatorInterface

cancelEvent, getEventList, runUpTo, scheduleEvent, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventNow, scheduleEventNow, scheduleEventRel, scheduleEventRel, setEventList

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

isPauseOnError, runUpToAndIncluding, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventNow, scheduleEventNow, scheduleEventRel, scheduleEventRel, setPauseOnError

Methods inherited from interface org.opentrafficsim.core.dsol.OTSSimulatorInterface

getSimulatorTime, initialize, isRunning, start, step, stop

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

getReplication, start, step, stop

Methods inherited from interface nl.tudelft.simulation.event.EventProducerInterface

addListener, addListener, addListener, addListener, removeListener

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

getAnimationDelay, setAnimationDelay, updateAnimation

Constructor Detail

SimpleAnimator

public SimpleAnimator(org.djunits.value.vdouble.scalar.Time startTime,
                      org.djunits.value.vdouble.scalar.Duration warmupPeriod,
                      org.djunits.value.vdouble.scalar.Duration runLength,
                      OTSModelInterface model)
               throws nl.tudelft.simulation.dsol.SimRuntimeException,
                      NamingException,
                      org.opentrafficsim.base.modelproperties.PropertyException

Create a simulation engine with animation; the easy way. PauseOnError is set to true;

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:

nl.tudelft.simulation.dsol.SimRuntimeException - on ???

NamingException - when context for the animation cannot be created

org.opentrafficsim.base.modelproperties.PropertyException - when one of the user modified properties has the empty string as key

Method Detail

scheduleEvent

public final nl.tudelft.simulation.dsol.formalisms.eventscheduling.SimEvent<OTSSimTimeDouble> scheduleEvent(org.djunits.value.vdouble.scalar.Time executionTime,
                                                                                                            short priority,
                                                                                                            Object source,
                                                                                                            Object target,
                                                                                                            String method,
                                                                                                            Object[] args)
                                                                                                     throws nl.tudelft.simulation.dsol.SimRuntimeException

Construct and schedule a SimEvent using a Time to specify the execution time.

Specified by:

scheduleEvent in interface SimpleSimulatorInterface

Parameters:

executionTime - Time; the time at which the event must happen

priority - short; should be between SimEventInterface.MAX_PRIORITY and SimEventInterface.MIN_PRIORITY; most normal events should use SimEventInterface.NORMAL_PRIORITY

source - Object; the object that creates/schedules the event

target - Object; the object that must execute the event

method - String; the name of the method of target that must execute the event

args - Object[]; the arguments of the method that must execute the event

Returns:

SimEvent<OTSSimTimeDouble>; the event that was scheduled (the caller should save this if a need to cancel the event may arise later)

Throws:

nl.tudelft.simulation.dsol.SimRuntimeException - when the executionTime is in the past