org.opentrafficsim.core.dsol

Interface OTSDEVSSimulatorInterface

All Superinterfaces:

DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>, nl.tudelft.simulation.event.EventProducerInterface, OTSSimulatorInterface, Remote, Serializable, SimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,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.Time,org.djunits.value.vdouble.scalar.Duration,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: 2947 $, $LastChangedDate: 2016-12-22 05:43:50 +0100 (Thu, 22 Dec 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()
Replication<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>	getReplication()
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.
SimEventInterface<OTSSimTimeDouble>	scheduleEvent(SimEventInterface<OTSSimTimeDouble> event)
SimEventInterface<OTSSimTimeDouble>	scheduleEventAbs(OTSSimTimeDouble absoluteTime, Object source, Object target, String method, Object[] args)
SimEventInterface<OTSSimTimeDouble>	scheduleEventAbs(OTSSimTimeDouble absoluteTime, short priority, Object source, Object target, String method, Object[] args)
SimEventInterface<OTSSimTimeDouble>	scheduleEventAbs(org.djunits.value.vdouble.scalar.Time absoluteTime, Object source, Object target, String method, Object[] args) schedules a methodCall at an absolute time.
SimEventInterface<OTSSimTimeDouble>	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.
SimEventInterface<OTSSimTimeDouble>	scheduleEventNow(Object source, Object target, String method, Object[] args)
SimEventInterface<OTSSimTimeDouble>	scheduleEventNow(short priority, Object source, Object target, String method, Object[] args)
SimEventInterface<OTSSimTimeDouble>	scheduleEventRel(org.djunits.value.vdouble.scalar.Duration relativeDelay, Object source, Object target, String method, Object[] args) schedules a methodCall at a relative duration.
SimEventInterface<OTSSimTimeDouble>	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, 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

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

getEventList

EventListInterface<OTSSimTimeDouble> getEventList()

Specified by:

getEventList in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

scheduleEvent

SimEventInterface<OTSSimTimeDouble> scheduleEvent(SimEventInterface<OTSSimTimeDouble> event)
                                           throws SimRuntimeException

Specified by:

scheduleEvent in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

Throws:

SimRuntimeException

scheduleEventRel

SimEventInterface<OTSSimTimeDouble> 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.

Specified by:

scheduleEventRel in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

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.

Returns:

the simulation event so it can be cancelled later

Throws:

SimRuntimeException - whenever the event is scheduled in the past.

scheduleEventRel

SimEventInterface<OTSSimTimeDouble> 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.

Specified by:

scheduleEventRel in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

Parameters:

relativeDelay - the relativeDelay in timeUnits of the simulator.

source - the source of the event

target - the target

method - the method

args - the arguments.

Returns:

the simulation event so it can be cancelled later

Throws:

SimRuntimeException - whenever the event is scheduled in the past.

scheduleEventAbs

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

Throws:

SimRuntimeException

scheduleEventAbs

SimEventInterface<OTSSimTimeDouble> 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.

Specified by:

scheduleEventAbs in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

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.

Returns:

the simulation event so it can be cancelled later

Throws:

SimRuntimeException - whenever the event is scheduled in the past.

scheduleEventAbs

SimEventInterface<OTSSimTimeDouble> 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.

Specified by:

scheduleEventAbs in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

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.

Returns:

the simulation event so it can be cancelled later

Throws:

SimRuntimeException - whenever the event is scheduled in the past.

scheduleEventAbs

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

Specified by:

scheduleEventAbs in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

Throws:

SimRuntimeException

scheduleEventNow

SimEventInterface<OTSSimTimeDouble> scheduleEventNow(short priority,
                                                     Object source,
                                                     Object target,
                                                     String method,
                                                     Object[] args)
                                              throws SimRuntimeException

Specified by:

scheduleEventNow in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

Throws:

SimRuntimeException

scheduleEventNow

SimEventInterface<OTSSimTimeDouble> scheduleEventNow(Object source,
                                                     Object target,
                                                     String method,
                                                     Object[] args)
                                              throws SimRuntimeException

Specified by:

scheduleEventNow in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

Throws:

SimRuntimeException

setEventList

void setEventList(EventListInterface<OTSSimTimeDouble> eventList)
           throws SimRuntimeException

Specified by:

setEventList in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

Throws:

SimRuntimeException

getReplication

Replication<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble> getReplication()

Specified by:

getReplication in interface SimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

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.

Specified by:

runUpTo in interface DEVSSimulatorInterface<org.djunits.value.vdouble.scalar.Time,org.djunits.value.vdouble.scalar.Duration,OTSSimTimeDouble>

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