1 package org.opentrafficsim.core.dsol;
2
3 import org.djunits.value.vdouble.scalar.Duration;
4 import org.opentrafficsim.core.network.Network;
5
6 import nl.tudelft.simulation.dsol.model.DsolModel;
7
8 /**
9 * OtsModelInterface described the generic properties of an OtsModel such as the network and the model name.
10 * <p>
11 * Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
12 * BSD-style license. See <a href="https://opentrafficsim.org/docs/license.html">OpenTrafficSim License</a>.
13 * </p>
14 * @author <a href="https://github.com/averbraeck">Alexander Verbraeck</a>
15 */
16 public interface OtsModelInterface extends DsolModel<Duration, OtsSimulatorInterface>
17 {
18 /**
19 * Return the traffic network for the simulation.
20 * @return the network.
21 */
22 Network getNetwork();
23
24 /**
25 * Return a very short description of the simulation.
26 * @return String; short description of the simulation
27 */
28 String getShortName();
29
30 /**
31 * Return a description of the simulation (HTML formatted).
32 * @return String; HTML text describing the simulation
33 */
34 String getDescription();
35 }