org.opentrafficsim.simulationengine

Interface SimpleSimulatorInterface

All Superinterfaces:

DEVSSimulatorInterface<Time,Duration,SimTimeDoubleUnit>, DEVSSimulatorInterface.TimeDoubleUnit, EventProducerInterface, Remote, Serializable, SimulatorInterface<Time,Duration,SimTimeDoubleUnit>, SimulatorInterface.TimeDoubleUnit

All Known Subinterfaces:

SimpleAnimatorInterface

All Known Implementing Classes:

SimpleAnimator, SimpleSimulator

public interface SimpleSimulatorInterface
extends DEVSSimulatorInterface.TimeDoubleUnit

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 11 mei 2015

Author:

Alexander Verbraeck, Peter Knoppers

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

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
SimEvent<SimTimeDoubleUnit>	scheduleEvent(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 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

Method Detail

scheduleEvent

SimEvent<SimTimeDoubleUnit> scheduleEvent(Time executionTime,
                                          short priority,
                                          Object source,
                                          Object target,
                                          String method,
                                          Object[] args)
                                   throws SimRuntimeException

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

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:

SimRuntimeException - when the executionTime is in the past