Package org.opentrafficsim.core.dsol

Interface OTSModelInterface

All Superinterfaces:

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

All Known Implementing Classes:

AbstractOTSModel

public interface OTSModelInterface
extends DSOLModel.TimeDoubleUnit<OTSSimulatorInterface>

OTSModelInterface described the generic properties of an OTSModel such as the network and the model name.

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

Version:

$Revision: 5019 $, $LastChangedDate: 2019-02-28 11:23:33 +0100 (Thu, 28 Feb 2019) $, by $Author: pknoppers $, initial version Aug 15, 2014

Author:

Alexander Verbraeck

Nested Class Summary

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>

Method Summary

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

Methods inherited from interface nl.tudelft.simulation.dsol.model.DSOLModel

constructModel, getInputParameterMap, getOutputStatistics, getSimulator

Method Details

getNetwork

OTSNetwork getNetwork()

Return the traffic network for the simulation.

Returns:

the network.

getShortName

java.lang.String getShortName()

Return a very short description of the simulation.

Returns:

String; short description of the simulation

getDescription

java.lang.String getDescription()

Return a description of the simulation (HTML formatted).

Returns:

String; HTML text describing the simulation