org.opentrafficsim.simulationengine

Class SimpleSimulator

java.lang.Object

nl.tudelft.simulation.event.EventProducer

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

nl.tudelft.simulation.dsol.simulators.DEVSSimulator<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,nl.tudelft.simulation.dsol.simtime.SimTimeDoubleUnit>

nl.tudelft.simulation.dsol.simulators.DEVSSimulator.TimeDoubleUnit

org.opentrafficsim.simulationengine.SimpleSimulator

All Implemented Interfaces:

Serializable, Runnable, Remote, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,nl.tudelft.simulation.dsol.simtime.SimTimeDoubleUnit>, nl.tudelft.simulation.dsol.simulators.DEVSSimulatorInterface.TimeDoubleUnit, nl.tudelft.simulation.dsol.simulators.SimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,nl.tudelft.simulation.dsol.simtime.SimTimeDoubleUnit>, nl.tudelft.simulation.dsol.simulators.SimulatorInterface.TimeDoubleUnit, nl.tudelft.simulation.event.EventProducerInterface, SimpleSimulatorInterface

public class SimpleSimulator
extends nl.tudelft.simulation.dsol.simulators.DEVSSimulator.TimeDoubleUnit
implements SimpleSimulatorInterface, Serializable

Construct a DSOL DEVSSimulator or DEVSAnimator the easy way.

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

$LastChangedDate: 2018-09-19 13:55:45 +0200 (Wed, 19 Sep 2018) $, @version $Revision: 4006 $, by $Author: averbraeck $, initial version 12 nov. 2014

Author:

Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
SimpleSimulator(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 without animation; the easy way.
SimpleSimulator(org.djunits.value.vdouble.scalar.Time startTime, org.djunits.value.vdouble.scalar.Duration warmupPeriod, org.djunits.value.vdouble.scalar.Duration runLength, OTSModelInterface model, int replication) Create a simulation engine with animation and prescribed replication number; the easy way.

Method Summary

Modifier and Type	Method and Description
nl.tudelft.simulation.dsol.formalisms.eventscheduling.SimEvent<nl.tudelft.simulation.dsol.simtime.SimTimeDoubleUnit>	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 nl.tudelft.simulation.dsol.simulators.DEVSSimulator

autoPauseSimulator, cancelEvent, getEventList, initialize, isPauseOnError, run, runUpTo, 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, getSimTime, 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, toString, wait, wait, wait

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 nl.tudelft.simulation.dsol.simulators.SimulatorInterface

getReplication, getSimTime, getSimulatorTime, initialize, isRunning, start, start, step, step, stop, stop

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

addListener, addListener, addListener, addListener, removeListener

Constructor Detail

SimpleSimulator

public SimpleSimulator(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

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

Parameters:

startTime - SimTimeDoubleUnit; 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 the context for the replication cannot be created

SimpleSimulator

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

Create a simulation engine with animation and prescribed replication number; 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

replication - int; the replication number

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<nl.tudelft.simulation.dsol.simtime.SimTimeDoubleUnit> 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<SimTimeDoubleUnit>; 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