org.opentrafficsim.simulationengine

Interface WrappableSimulation

All Known Implementing Classes:

AbstractWrappableSimulation

public interface WrappableSimulation

Requirements for demonstration that can be shown in the SuperDemo.

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

$LastChangedDate: 2018-09-19 13:55:45 +0200 (Wed, 19 Sep 2018) $, @version $Revision: 4006 $, by $Author: averbraeck $, initial version 17 dec. 2014

Author:

Peter Knoppers

Method Summary

Modifier and Type	Method and Description
SimpleSimulatorInterface	buildSimulator(Time startTime, Duration warmupPeriod, Duration runLength, ArrayList<Property<?>> properties) Build the simulation.
String	description() Return a description of the simulation (HTML formatted).
ArrayList<AbstractProperty<?>>	getProperties() Retrieve a list of visible properties of the simulation.
void	setNextReplication(Integer nextReplication) Set the number of the next spawned replication.
String	shortName() Return a very short description of the simulation.

Method Detail

buildSimulator

SimpleSimulatorInterface buildSimulator(Time startTime,
                                        Duration warmupPeriod,
                                        Duration runLength,
                                        ArrayList<Property<?>> properties)
                                 throws SimRuntimeException,
                                        NetworkException,
                                        NamingException,
                                        OTSSimulationException,
                                        PropertyException

Build the simulation.

Parameters:

startTime - Time; the start time of the simulation

warmupPeriod - Duration; the warm up period of the simulation (use new Duration(0, SECOND) if you don't know what this is)

runLength - Duration; the duration of the simulation

properties - ArrayList<AbstractProperty<?>>; the (possibly user-modified) properties. This list must contain all the properties returned by getProperties(); any additional properties may be ignored

Returns:

SimpleSimulation; the new simulation

Throws:

SimRuntimeException - on ???

NetworkException - on Network inconsistency

NamingException - when context for the animation cannot be created

OTSSimulationException - when the construction of the simulation, the control panel, the animation, or the charts fails

PropertyException - when one of the user modified properties has the empty string as key

shortName

String shortName()

Return a very short description of the simulation.

Returns:

String; short description of the simulation

description

String description()

Return a description of the simulation (HTML formatted).

Returns:

String; HTML text describing the simulation

getProperties

ArrayList<AbstractProperty<?>> getProperties()

Retrieve a list of visible properties of the simulation.
The caller can modify the returned result. If the internal format is also an ArrayList it is highly recommended to make a protective copy and return that.

Returns:

ArrayList<AbstractProperty<?>>; the list of visible properties

setNextReplication

void setNextReplication(Integer nextReplication)

Set the number of the next spawned replication.

Parameters:

nextReplication - Integer; the next replication number, or null to use the built-in auto-incrementing replication counter