Package org.opentrafficsim.core.dsol

Class AbstractOTSModel

java.lang.Object

org.djutils.event.EventProducer

nl.tudelft.simulation.dsol.model.AbstractDSOLModel<Time,Duration,SimTimeDoubleUnit,S>

nl.tudelft.simulation.dsol.model.AbstractDSOLModel.TimeDoubleUnit<OTSSimulatorInterface>

org.opentrafficsim.core.dsol.AbstractOTSModel

All Implemented Interfaces:

java.io.Serializable, DSOLModel<Time,Duration,SimTimeDoubleUnit,OTSSimulatorInterface>, DSOLModel.TimeDoubleUnit<OTSSimulatorInterface>, EventProducerInterface, OTSModelInterface

public abstract class AbstractOTSModel
extends AbstractDSOLModel.TimeDoubleUnit<OTSSimulatorInterface>
implements OTSModelInterface

AbstractOTSModel is the base class for a model that runs on an OTSSimulator.

Copyright (c) 2003-2020 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information www.simulation.tudelft.nl. The source code and binary code of this software is proprietary information of Delft University of Technology.

Author:

Alexander Verbraeck

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class nl.tudelft.simulation.dsol.model.AbstractDSOLModel

AbstractDSOLModel.CalendarDouble<S extends SimulatorInterface.CalendarDouble>, AbstractDSOLModel.CalendarFloat<S extends SimulatorInterface.CalendarFloat>, AbstractDSOLModel.CalendarLong<S extends SimulatorInterface.CalendarLong>, AbstractDSOLModel.TimeDouble<S extends SimulatorInterface.TimeDouble>, AbstractDSOLModel.TimeDoubleUnit<S extends SimulatorInterface.TimeDoubleUnit>, AbstractDSOLModel.TimeFloat<S extends SimulatorInterface.TimeFloat>, AbstractDSOLModel.TimeFloatUnit<S extends SimulatorInterface.TimeFloatUnit>, AbstractDSOLModel.TimeLong<S extends SimulatorInterface.TimeLong>

Nested classes/interfaces inherited from interface nl.tudelft.simulation.dsol.model.DSOLModel

DSOLModel.CalendarDouble<S extends SimulatorInterface.CalendarDouble>, DSOLModel.CalendarFloat<S extends SimulatorInterface.CalendarFloat>, DSOLModel.CalendarLong<S extends SimulatorInterface.CalendarLong>, DSOLModel.TimeDouble<S extends SimulatorInterface.TimeDouble>, DSOLModel.TimeDoubleUnit<S extends SimulatorInterface.TimeDoubleUnit>, DSOLModel.TimeFloat<S extends SimulatorInterface.TimeFloat>, DSOLModel.TimeFloatUnit<S extends SimulatorInterface.TimeFloatUnit>, DSOLModel.TimeLong<S extends SimulatorInterface.TimeLong>

Field Summary

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

inputParameterMap, outputStatistics, simulator

Fields inherited from class org.djutils.event.EventProducer

eventProducerImpl

Fields inherited from interface org.djutils.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Constructor	Description
AbstractOTSModel(OTSSimulatorInterface simulator)	Instantiate an abstract OTSModel.
AbstractOTSModel(OTSSimulatorInterface simulator, java.lang.String shortName, java.lang.String description)	Instantiate an abstract OTSModel.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Return a description of the simulation (HTML formatted).
java.lang.String	getShortName()	Return a very short description of the simulation.
void	setDescription(java.lang.String description)
void	setShortName(java.lang.String shortName)

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

addInputParameter, getInputParameter, getInputParameterMap, getOutputStatistics, getSimulator

Methods inherited from class org.djutils.event.EventProducer

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

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, getInputParameterMap, getOutputStatistics, getSimulator

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

getNetwork

Constructor Detail

AbstractOTSModel

public AbstractOTSModel(OTSSimulatorInterface simulator,
                        java.lang.String shortName,
                        java.lang.String description)

Instantiate an abstract OTSModel.

Parameters:

simulator - OTSSimulatorInterface; the simulator to use

shortName - String; a very short description of the simulation

description - String; a description of the simulation (HTML formatted)

AbstractOTSModel

public AbstractOTSModel(OTSSimulatorInterface simulator)

Instantiate an abstract OTSModel. The name and description will be set as the class name.

Parameters:

simulator - OTSSimulatorInterface; the simulator to use

Method Detail

getShortName

public final java.lang.String getShortName()

Return a very short description of the simulation.

Specified by:

getShortName in interface OTSModelInterface

Returns:

String; short description of the simulation

setShortName

public final void setShortName(java.lang.String shortName)

Parameters:

shortName - String; set shortName

getDescription

public final java.lang.String getDescription()

Return a description of the simulation (HTML formatted).

Specified by:

getDescription in interface OTSModelInterface

Returns:

String; HTML text describing the simulation

setDescription

public final void setDescription(java.lang.String description)

Parameters:

description - String; set description