org.opentrafficsim.simulationengine

Interface WrappableAnimation

All Known Implementing Classes:

AbstractWrappableAnimation

public interface WrappableAnimation

Requirements for demonstration that can be shown in the SuperDemo.

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

$LastChangedDate: 2015-08-23 12:51:29 +0200 (Sun, 23 Aug 2015) $, @version $Revision: 1293 $, by $Author: averbraeck $, initial version 17 dec. 2014

Author:

Peter Knoppers

Method Summary

Modifier and Type	Method and Description
SimpleSimulatorInterface	buildAnimator(org.djunits.value.vdouble.scalar.Time startTime, org.djunits.value.vdouble.scalar.Duration warmupPeriod, org.djunits.value.vdouble.scalar.Duration runLength, List<org.opentrafficsim.base.modelproperties.Property<?>> properties, Rectangle rect, boolean exitOnClose) Build the animation.
String	description() Return a description of the simulation (HTML formatted).
List<org.opentrafficsim.base.modelproperties.Property<?>>	getProperties() Retrieve a list of visible properties of the simulation.
List<org.opentrafficsim.base.modelproperties.Property<?>>	getUserModifiedProperties() Retrieve a list of properties as the user has modified them.
SimpleSimulatorInterface	rebuildSimulator(Rectangle rect) Restart (rebuild) the simulation.
String	shortName() Return a very short description of the simulation.
void	stopTimersThreads() Stop the timers and threads that are connected when disposing of this wrappable simulation.

Method Detail

buildAnimator

SimpleSimulatorInterface buildAnimator(org.djunits.value.vdouble.scalar.Time startTime,
                                       org.djunits.value.vdouble.scalar.Duration warmupPeriod,
                                       org.djunits.value.vdouble.scalar.Duration runLength,
                                       List<org.opentrafficsim.base.modelproperties.Property<?>> properties,
                                       Rectangle rect,
                                       boolean exitOnClose)
                                throws nl.tudelft.simulation.dsol.SimRuntimeException,
                                       NetworkException,
                                       NamingException,
                                       OTSSimulationException,
                                       org.opentrafficsim.base.modelproperties.PropertyException

Build the animation.

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 - List<Property<?>>; the (possibly user-modified) properties. This list must contain all the properties returned by getProperties(); any additional properties may be ignored

rect - the x, y, width and height for the window to rebuild. Use null for maximized screen.

exitOnClose - Use EXIT_ON_CLOSE when true, DISPOSE_ON_CLOSE when false on closing of the window.

Returns:

SimpleSimulation; the new simulation

Throws:

nl.tudelft.simulation.dsol.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

org.opentrafficsim.base.modelproperties.PropertyException - when one of the user modified properties has the empty string as key

rebuildSimulator

SimpleSimulatorInterface rebuildSimulator(Rectangle rect)
                                   throws nl.tudelft.simulation.dsol.SimRuntimeException,
                                          NetworkException,
                                          NamingException,
                                          OTSSimulationException,
                                          org.opentrafficsim.base.modelproperties.PropertyException

Restart (rebuild) the simulation.

Parameters:

rect - the x, y, width and height for the window to rebuild. Use null for maximized screen.

Returns:

SimpleSimulation; the new simulation

Throws:

nl.tudelft.simulation.dsol.SimRuntimeException - on ???

NetworkException - on Network inconsistency

NamingException - when context for the animation cannot be created

OTSSimulationException - when the (re)construction of the simulation model fails

org.opentrafficsim.base.modelproperties.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

List<org.opentrafficsim.base.modelproperties.Property<?>> 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:

List<Property<?>>; the list of visible properties

getUserModifiedProperties

List<org.opentrafficsim.base.modelproperties.Property<?>> getUserModifiedProperties()

Retrieve a list of properties as the user has modified them.

Returns:

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

stopTimersThreads

void stopTimersThreads()

Stop the timers and threads that are connected when disposing of this wrappable simulation.