1 package org.opentrafficsim.core.dsol;
2
3 import org.opentrafficsim.core.network.OTSNetwork;
4
5 import nl.tudelft.simulation.dsol.model.DSOLModel;
6
7 /**
8 * OTSModelInterface described the gneric properties of an OTSModel such as the network and the model name.
9 * <p>
10 * Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
11 * BSD-style license. See <a href="http://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
12 * <p>
13 * @version $Revision: 4831 $, $LastChangedDate: 2019-01-06 01:35:05 +0100 (Sun, 06 Jan 2019) $, by $Author: averbraeck $,
14 * initial version Aug 15, 2014 <br>
15 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
16 */
17 public interface OTSModelInterface extends DSOLModel.TimeDoubleUnit<OTSSimulatorInterface>
18 {
19 /**
20 * Return the traffic network for the simulation.
21 * @return the network.
22 */
23 OTSNetwork getNetwork();
24
25 /**
26 * Return a very short description of the simulation.
27 * @return String; short description of the simulation
28 */
29 String getShortName();
30
31 /**
32 * Return a description of the simulation (HTML formatted).
33 * @return String; HTML text describing the simulation
34 */
35 String getDescription();
36 }