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<DoubleScalar.Abs<TimeUnit>,DoubleScalar.Rel<TimeUnit>,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<DoubleScalar.Abs<TimeUnit>,DoubleScalar.Rel<TimeUnit>,OTSSimTimeDouble>, nl.tudelft.simulation.dsol.simulators.SimulatorInterface<DoubleScalar.Abs<TimeUnit>,DoubleScalar.Rel<TimeUnit>,OTSSimTimeDouble>, nl.tudelft.simulation.event.EventProducerInterface, OTSAnimatorInterface, OTSDEVSSimulatorInterface, OTSSimulatorInterface, SimpleSimulation

public class SimpleAnimator
extends OTSDEVSRealTimeClock
implements SimpleSimulation

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

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

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(DoubleScalar.Abs<TimeUnit> startTime, DoubleScalar.Rel<TimeUnit> warmupPeriod, DoubleScalar.Rel<TimeUnit> runLength, OTSModelInterface model, Rectangle2D extent) Create a simulation engine with animation; the easy way.

Method Summary

Modifier and Type	Method and Description
nl.tudelft.simulation.dsol.animation.D2.AnimationPanel	getAnimationPanel() Easy access to the AnimationPanel.
nl.tudelft.simulation.dsol.gui.swing.DSOLPanel<DoubleScalar.Abs<TimeUnit>,DoubleScalar.Rel<TimeUnit>,OTSSimTimeDouble>	getPanel() To use in a Swing application add the DSOLPanel to a JFrame.
nl.tudelft.simulation.dsol.formalisms.eventscheduling.SimEvent<OTSSimTimeDouble>	scheduleEvent(DoubleScalar.Abs<TimeUnit> executionTime, short priority, Object source, Object target, String method, Object[] args) Construct and schedule a SimEvent using a DoubleScalar.Abs<TimeUnit> to specify the execution time.
void	setPanel(nl.tudelft.simulation.dsol.gui.swing.DSOLPanel<DoubleScalar.Abs<TimeUnit>,DoubleScalar.Rel<TimeUnit>,OTSSimTimeDouble> panel)

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

relativeMillis

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

getSpeedFactor, isCatchup, run, setCatchup, setSpeedFactor

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

getAnimationDelay, setAnimationDelay, updateAnimation

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

cancelEvent, getEventList, initialize, isPauseOnError, scheduleEvent, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventNow, scheduleEventNow, scheduleEventRel, scheduleEventRel, setEventList, setPauseOnError, step, stop

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

getContext, getReplication, getSimulatorTime, isRunning, start

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, toString, wait, wait, wait

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

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

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

getContext, getReplication, getSimulatorTime, initialize, isRunning, 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, getContext, setAnimationDelay, updateAnimation

Constructor Detail

SimpleAnimator

public SimpleAnimator(DoubleScalar.Abs<TimeUnit> startTime,
                      DoubleScalar.Rel<TimeUnit> warmupPeriod,
                      DoubleScalar.Rel<TimeUnit> runLength,
                      OTSModelInterface model,
                      Rectangle2D extent)
               throws RemoteException,
                      nl.tudelft.simulation.dsol.SimRuntimeException,
                      NamingException

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

Parameters:

startTime - DoubleScalar.Abs<TimeUnit>; the start time of the simulation

warmupPeriod - DoubleScalar.Rel<TimeUnit>; the warm up period of the simulation (use new DoubleScalar.Rel<TimeUnit>(0, TimeUnit.SECOND) if you don't know what this is)

runLength - DoubleScalar.Rel<TimeUnit>; the duration of the simulation

model - OTSModelInterface; the simulation to execute

extent - Rectangle2D; bottom left corner, length and width of the area (world) to animate.

Throws:

RemoteException - on communications failure

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

NamingException - when context for the animation cannot be created

Method Detail

getPanel

public final nl.tudelft.simulation.dsol.gui.swing.DSOLPanel<DoubleScalar.Abs<TimeUnit>,DoubleScalar.Rel<TimeUnit>,OTSSimTimeDouble> getPanel()

To use in a Swing application add the DSOLPanel to a JFrame.

Specified by:

getPanel in interface SimpleSimulation

Returns:

the simulation panel (extends JPanel).

getAnimationPanel

public final nl.tudelft.simulation.dsol.animation.D2.AnimationPanel getAnimationPanel()

Easy access to the AnimationPanel.

Returns:

AnimationPanel

scheduleEvent

public final nl.tudelft.simulation.dsol.formalisms.eventscheduling.SimEvent<OTSSimTimeDouble> scheduleEvent(DoubleScalar.Abs<TimeUnit> executionTime,
                                                                                                            short priority,
                                                                                                            Object source,
                                                                                                            Object target,
                                                                                                            String method,
                                                                                                            Object[] args)
                                                                                                     throws nl.tudelft.simulation.dsol.SimRuntimeException

Construct and schedule a SimEvent using a DoubleScalar.Abs<TimeUnit> to specify the execution time.

Specified by:

scheduleEvent in interface SimpleSimulation

Parameters:

executionTime - DoubleScalar.Abs<TimeUnit>; 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

setPanel

public final void setPanel(nl.tudelft.simulation.dsol.gui.swing.DSOLPanel<DoubleScalar.Abs<TimeUnit>,DoubleScalar.Rel<TimeUnit>,OTSSimTimeDouble> panel)

Parameters:

panel - set panel.