org.opentrafficsim.core.dsol

Interface OTSDEVSSimulatorInterface

All Superinterfaces:

DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.TimeUnit>,OTSSimTimeDouble>, EventProducerInterface, OTSSimulatorInterface, Remote, Serializable, SimulatorInterface<org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.TimeUnit>,OTSSimTimeDouble>

All Known Subinterfaces:

SimpleAnimatorInterface, SimpleSimulatorInterface

All Known Implementing Classes:

OTSDEVSAnimator, OTSDEVSRealTimeClock, OTSDEVSSimulator, SimpleAnimator, SimpleSimulator

public interface OTSDEVSSimulatorInterface
extends DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.TimeUnit>,OTSSimTimeDouble>, OTSSimulatorInterface

Typed extension of the DEVSSimulatorInterface without remote exceptions and using the Time and Duration arguments.

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.

Version:

$Revision: 2051 $, $LastChangedDate: 2016-05-28 11:33:31 +0200 (Sat, 28 May 2016) $, by $Author: averbraeck $, initial version Aug 15, 2014

Author:

Alexander Verbraeck

Nested Class Summary

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, DEVSSimulatorInterface.TimeLongUnit

Field Summary

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

Method Summary

Modifier and Type	Method and Description
boolean	cancelEvent(SimEventInterface<OTSSimTimeDouble> event)
EventListInterface<OTSSimTimeDouble>	getEventList()
void	runUpTo(org.djunits.value.vdouble.scalar.Time when) Runs the simulator up to a certain time; events at that time will not yet be executed.
void	scheduleEvent(SimEventInterface<OTSSimTimeDouble> event)
void	scheduleEventAbs(OTSSimTimeDouble absoluteTime, Object source, Object target, String method, Object[] args)
void	scheduleEventAbs(OTSSimTimeDouble absoluteTime, short priority, Object source, Object target, String method, Object[] args)
void	scheduleEventAbs(org.djunits.value.vdouble.scalar.Time absoluteTime, Object source, Object target, String method, Object[] args) schedules a methodCall at an absolute time.
void	scheduleEventAbs(org.djunits.value.vdouble.scalar.Time absoluteTime, short priority, Object source, Object target, String method, Object[] args) schedules a methodCall at an absolute time.
void	scheduleEventNow(Object source, Object target, String method, Object[] args)
void	scheduleEventNow(short priority, Object source, Object target, String method, Object[] args)
void	scheduleEventRel(org.djunits.value.vdouble.scalar.Duration relativeDelay, Object source, Object target, String method, Object[] args) schedules a methodCall at a relative duration.
void	scheduleEventRel(org.djunits.value.vdouble.scalar.Duration relativeDelay, short priority, Object source, Object target, String method, Object[] args) schedules a methodCall at a relative duration.
void	setEventList(EventListInterface<OTSSimTimeDouble> eventList)

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

isPauseOnError, runUpTo, runUpToAndIncluding, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventAbs, scheduleEventNow, scheduleEventNow, scheduleEventRel, scheduleEventRel, 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

Method Detail

cancelEvent

boolean cancelEvent(SimEventInterface<OTSSimTimeDouble> event)

Specified by:

cancelEvent in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.TimeUnit>,OTSSimTimeDouble>

getEventList

EventListInterface<OTSSimTimeDouble> getEventList()

Specified by:

getEventList in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.TimeUnit>,OTSSimTimeDouble>

scheduleEvent

void scheduleEvent(SimEventInterface<OTSSimTimeDouble> event)
            throws SimRuntimeException

Specified by:

scheduleEvent in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.TimeUnit>,OTSSimTimeDouble>

Throws:

SimRuntimeException

scheduleEventRel

void scheduleEventRel(org.djunits.value.vdouble.scalar.Duration relativeDelay,
                      short priority,
                      Object source,
                      Object target,
                      String method,
                      Object[] args)
               throws SimRuntimeException

schedules a methodCall at a relative duration. The executionTime is thus simulator.getSimulatorTime()+relativeDuration.

Parameters:

relativeDelay - the relativeDelay in timeUnits of the simulator.

priority - the priority compared to other events scheduled at the same time.

source - the source of the event

target - the target

method - the method

args - the arguments.

Throws:

SimRuntimeException - whenever the event is scheduled in the past.

scheduleEventRel

void scheduleEventRel(org.djunits.value.vdouble.scalar.Duration relativeDelay,
                      Object source,
                      Object target,
                      String method,
                      Object[] args)
               throws SimRuntimeException

schedules a methodCall at a relative duration. The executionTime is thus simulator.getSimulatorTime()+relativeDuration.

Parameters:

relativeDelay - the relativeDelay in timeUnits of the simulator.

source - the source of the event

target - the target

method - the method

args - the arguments.

Throws:

SimRuntimeException - whenever the event is scheduled in the past.

scheduleEventAbs

void scheduleEventAbs(OTSSimTimeDouble absoluteTime,
                      short priority,
                      Object source,
                      Object target,
                      String method,
                      Object[] args)
               throws SimRuntimeException

Specified by:

scheduleEventAbs in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.TimeUnit>,OTSSimTimeDouble>

Throws:

SimRuntimeException

scheduleEventAbs

void scheduleEventAbs(org.djunits.value.vdouble.scalar.Time absoluteTime,
                      Object source,
                      Object target,
                      String method,
                      Object[] args)
               throws SimRuntimeException

schedules a methodCall at an absolute time.

Parameters:

absoluteTime - the exact time to schedule the method on the simulator.

source - the source of the event

target - the target

method - the method

args - the arguments.

Throws:

SimRuntimeException - whenever the event is scheduled in the past.

scheduleEventAbs

void scheduleEventAbs(org.djunits.value.vdouble.scalar.Time absoluteTime,
                      short priority,
                      Object source,
                      Object target,
                      String method,
                      Object[] args)
               throws SimRuntimeException

schedules a methodCall at an absolute time.

Parameters:

absoluteTime - the exact time to schedule the method on the simulator.

priority - the priority compared to other events scheduled at the same time.

source - the source of the event

target - the target

method - the method

args - the arguments.

Throws:

SimRuntimeException - whenever the event is scheduled in the past.

scheduleEventAbs

void scheduleEventAbs(OTSSimTimeDouble absoluteTime,
                      Object source,
                      Object target,
                      String method,
                      Object[] args)
               throws SimRuntimeException

Specified by:

scheduleEventAbs in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.TimeUnit>,OTSSimTimeDouble>

Throws:

SimRuntimeException

scheduleEventNow

void scheduleEventNow(short priority,
                      Object source,
                      Object target,
                      String method,
                      Object[] args)
               throws SimRuntimeException

Specified by:

scheduleEventNow in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.TimeUnit>,OTSSimTimeDouble>

Throws:

SimRuntimeException

scheduleEventNow

void scheduleEventNow(Object source,
                      Object target,
                      String method,
                      Object[] args)
               throws SimRuntimeException

Specified by:

scheduleEventNow in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.TimeUnit>,OTSSimTimeDouble>

Throws:

SimRuntimeException

setEventList

void setEventList(EventListInterface<OTSSimTimeDouble> eventList)
           throws SimRuntimeException

Specified by:

setEventList in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.DoubleScalar.Abs<org.djunits.unit.TimeUnit>,org.djunits.value.vdouble.scalar.DoubleScalar.Rel<org.djunits.unit.TimeUnit>,OTSSimTimeDouble>

Throws:

SimRuntimeException

runUpTo

void runUpTo(org.djunits.value.vdouble.scalar.Time when)
      throws SimRuntimeException

Runs the simulator up to a certain time; events at that time will not yet be executed.

Parameters:

when - the absolute time till when we want to run the simulation

Throws:

SimRuntimeException - whenever starting fails. Possible occasions include starting a started simulator