OTSModelInterface (Open Traffic Sim core classes 1.04.02 API)

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-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision: 6010 $, $LastChangedDate: 2020-01-23 11:14:19 +0100 (Thu, 23 Jan 2020) $, 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.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

All Methods Instance Methods Abstract Methods
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 Detail
  - 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