OTSModelInterface (Open Traffic Sim core classes 1.05.00 API)

All Superinterfaces:

DSOLModel<Time,Duration,SimTimeDoubleUnit,OTSSimulatorInterface>, DSOLModel.TimeDoubleUnit<OTSSimulatorInterface>, 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-2022 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision: 7012 $, $LastChangedDate: 2022-02-09 18:05:59 +0100 (Wed, 09 Feb 2022) $, by $Author: averbraeck $, initial version Aug 15, 2014

Author:

Alexander Verbraeck

Nested Class Summary
- Nested classes/interfaces inherited from interface nl.tudelft.simulation.dsol.model.DSOLModel
  DSOLModel.TimeDouble<S extends SimulatorInterface<Double,Double,SimTimeDouble>>, DSOLModel.TimeDoubleUnit<S extends SimulatorInterface<Time,Duration,SimTimeDoubleUnit>>, DSOLModel.TimeFloat<S extends SimulatorInterface<Float,Float,SimTimeFloat>>, DSOLModel.TimeFloatUnit<S extends SimulatorInterface<FloatTime,FloatDuration,SimTimeFloatUnit>>, DSOLModel.TimeLong<S extends SimulatorInterface<Long,Long,SimTimeLong>>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getDescription()`	Return a description of the simulation (HTML formatted).
`OTSNetwork`	`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, getInputParameterMap, getOutputStatistics, getSimulator, getStream, getStreamInformation, getStreams, resetStreams, setStreamInformation

- Method Detail
  - getNetwork
```
OTSNetwork getNetwork()
```
    Return the traffic network for the simulation.
    
    Returns:
    
    the network.
  - getShortName
```
String getShortName()
```
    Return a very short description of the simulation.
    
    Returns:
    
    String; short description of the simulation
  - getDescription
```
String getDescription()
```
    Return a description of the simulation (HTML formatted).
    
    Returns:
    
    String; HTML text describing the simulation