Package org.opentrafficsim.core.dsol

Class AbstractOtsModel

java.lang.Object

org.djutils.event.LocalEventProducer

nl.tudelft.simulation.dsol.model.AbstractDsolModel<Duration,OtsSimulatorInterface>

org.opentrafficsim.core.dsol.AbstractOtsModel

All Implemented Interfaces:

DsolModel<Duration,OtsSimulatorInterface>, EventProducer, OtsModelInterface

public abstract class AbstractOtsModel
extends AbstractDsolModel<Duration,OtsSimulatorInterface>
implements OtsModelInterface

AbstractOtsModel is the base class for a model that runs on an OtsSimulatorInterface.

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

Author:

Alexander Verbraeck

Field Summary

Fields inherited from class nl.tudelft.simulation.dsol.model.AbstractDsolModel

inputParameterMap, outputStatistics, simulator, streamInformation

Fields inherited from interface org.djutils.event.EventProducer

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Constructor	Description
AbstractOtsModel(OtsSimulatorInterface simulator)	Instantiate an abstract OtsModel.
AbstractOtsModel(OtsSimulatorInterface simulator, String shortName, String description, StreamInformation streamInformation)	Instantiate an abstract OtsModel with an initial set of streams (e.g., with seed management).

Method Summary

Modifier and Type	Method	Description
static StreamInformation	defaultInitialStreams()	Create the default initial streams.
final String	getDescription()	Return a description of the simulation (HTML formatted).
final String	getShortName()	Return a very short description of the simulation.
final void	setDescription(String description)	Set description.
final void	setShortName(String shortName)	Set short name.

Methods inherited from class nl.tudelft.simulation.dsol.model.AbstractDsolModel

addInputParameter, getInputParameter, getInputParameterMap, getOutputStatistics, getResetApplicationExecutable, getSimulator, getStreamInformation, resetApplication, setInputParameterMap, setResetApplicationExecutable, setStreamInformation

Methods inherited from class org.djutils.event.LocalEventProducer

getEventListenerMap

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.model.DsolModel

constructModel, getDefaultStream, getInputParameterBoolean, getInputParameterDouble, getInputParameterDoubleScalar, getInputParameterFloat, getInputParameterFloatScalar, getInputParameterInteger, getInputParameterLocalDateTime, getInputParameterLong, getInputParameterMap, getInputParameterString, getInputParameterUnit, getOutputStatistics, getResetApplicationExecutable, getSimulator, getStream, getStreamInformation, getStreams, resetApplication, resetStreams, setInputParameterMap, setResetApplicationExecutable, setStreamInformation

Methods inherited from interface org.djutils.event.EventProducer

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

Methods inherited from interface org.opentrafficsim.core.dsol.OtsModelInterface

getNetwork

Constructor Details

AbstractOtsModel

public AbstractOtsModel(OtsSimulatorInterface simulator)

Instantiate an abstract OtsModel. The name and description will be set as the class name. Streams will be default.

Parameters:

simulator - the simulator to use

AbstractOtsModel

public AbstractOtsModel(OtsSimulatorInterface simulator,
 String shortName,
 String description,
 StreamInformation streamInformation)

Instantiate an abstract OtsModel with an initial set of streams (e.g., with seed management).

Parameters:

simulator - the simulator to use

shortName - a very short description of the simulation

description - a description of the simulation (HTML formatted)

streamInformation - the initial set of streams (e.g., with seed management)

Method Details

defaultInitialStreams

public static StreamInformation defaultInitialStreams()

Create the default initial streams.

Returns:

the default initial streams

getShortName

public final String getShortName()

Description copied from interface: OtsModelInterface

Return a very short description of the simulation.

Specified by:

getShortName in interface OtsModelInterface

Returns:

short description of the simulation

setShortName

public final void setShortName(String shortName)

Set short name.

Parameters:

shortName - set shortName

getDescription

public final String getDescription()

Description copied from interface: OtsModelInterface

Return a description of the simulation (HTML formatted).

Specified by:

getDescription in interface OtsModelInterface

Returns:

HTML text describing the simulation

setDescription

public final void setDescription(String description)

Set description.

Parameters:

description - set description