Package org.opentrafficsim.core.dsol

Interface OtsModelInterface

All Superinterfaces:

DsolModel<Duration,OtsSimulatorInterface>

All Known Implementing Classes:

AbstractOtsModel

public interface OtsModelInterface
extends DsolModel<Duration,OtsSimulatorInterface>

OtsModelInterface described the generic properties of an OtsModel such as the network and the model name.

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

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return a description of the simulation (HTML formatted).
Network	getNetwork()	Return the traffic network for the simulation.
String	getShortName()	Return a very short description of the simulation.

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

Method Details

getNetwork

Network getNetwork()

Return the traffic network for the simulation.

Returns:

the network.

getShortName

String getShortName()

Return a very short description of the simulation.

Returns:

short description of the simulation

getDescription

String getDescription()

Return a description of the simulation (HTML formatted).

Returns:

HTML text describing the simulation