Package nl.tudelft.simulation.dsol.simulators

Interface DessSimulatorInterface<T extends Number & Comparable<T>>

Type Parameters:

T - the time type

All Superinterfaces:

org.djutils.event.EventProducer, Remote, Serializable, SimulatorInterface<T>

All Known Implementing Classes:

DessSimulator, DevDessAnimator, DevDessSimulator

public interface DessSimulatorInterface<T extends Number & Comparable<T>>
extends SimulatorInterface<T>

The DessSimulatorInterface defines the methods for a DESS simulator. DESS stands for the Differential Equation System Specification. More information on Modeling and Simulation can be found in "Theory of Modeling and Simulation" by Bernard Zeigler et.al.

Copyright (c) 2002-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://https://simulation.tudelft.nl/dsol/docs/latest/license.html.

Since:

1.5

Author:

Peter Jacobs , Alexander Verbraeck

Field Summary

Fields

Modifier and Type	Field	Description
static final org.djutils.event.EventType	TIME_STEP_CHANGED_EVENT	TIME_STEP_CHANGED_EVENT is fired when the time step is set.

Fields inherited from interface org.djutils.event.EventProducer

FIRST_POSITION, LAST_POSITION

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

START_EVENT, STARTING_EVENT, STOP_EVENT, STOPPING_EVENT, TIME_CHANGED_EVENT

Method Summary

Modifier and Type	Method	Description
T	getTimeStep()	returns the time step of the DESS simulator.
void	setTimeStep(T timeStep)	Method setTimeStep sets the time step of the simulator.

Methods inherited from interface org.djutils.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, getEventListenerMap, getEventTypesWithListeners, getListenerReferences, hasListeners, numberOfListeners, removeAllListeners, removeAllListeners, removeListener

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

addScheduledMethodOnInitialize, addScheduledMethodOnInitialize, cleanUp, endReplication, getErrorLogLevel, getErrorStrategy, getLogger, getModel, getReplication, getReplicationState, getRunState, getSimulatorTime, initialize, isInitialized, isStartingOrRunning, isStoppingOrStopped, runUpTo, runUpToAndIncluding, setErrorLogLevel, setErrorStrategy, setErrorStrategy, start, step, stop

Field Details

TIME_STEP_CHANGED_EVENT

static final org.djutils.event.EventType TIME_STEP_CHANGED_EVENT

TIME_STEP_CHANGED_EVENT is fired when the time step is set.

Method Details

getTimeStep

T getTimeStep()

returns the time step of the DESS simulator.

Returns:

the timeStep

setTimeStep

void setTimeStep(T timeStep)
          throws SimRuntimeException

Method setTimeStep sets the time step of the simulator.

Parameters:

timeStep - T; the new timeStep. Its value should be > 0.0

Throws:

SimRuntimeException - when timestep <= 0, NaN, or Infinity