org.opentrafficsim.simulationengine

Class AbstractWrappableAnimation

java.lang.Object

org.opentrafficsim.simulationengine.AbstractWrappableAnimation

All Implemented Interfaces:

Serializable, WrappableAnimation

public abstract class AbstractWrappableAnimation
extends Object
implements WrappableAnimation, Serializable

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: 2016-10-28 16:34:11 +0200 (Fri, 28 Oct 2016) $, @version $Revision: 2429 $, by $Author: pknoppers $, initial version Jun 18, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	exitOnClose Use EXIT_ON_CLOSE when true, DISPOSE_ON_CLOSE when false on closing of the window.
protected OTSAnimationPanel	panel The tabbed panel so other tabs can be added by the classes that extend this class.
protected List<org.opentrafficsim.base.modelproperties.Property<?>>	properties The properties exhibited by this simulation.
protected List<org.opentrafficsim.base.modelproperties.Property<?>>	savedUserModifiedProperties The properties after (possible) editing by the user.

Constructor Summary

Constructors

Constructor and Description
AbstractWrappableAnimation()

Method Summary

Modifier and Type	Method and Description
SimpleAnimator	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<?>> userModifiedProperties, Rectangle rect, boolean eoc) Build the animation.
protected SimpleAnimator	buildSimpleAnimator(org.djunits.value.vdouble.scalar.Time startTime, org.djunits.value.vdouble.scalar.Duration warmupPeriod, org.djunits.value.vdouble.scalar.Duration runLength, OTSModelInterface model) Build the animator.
OTSAnimationPanel	getPanel()
ArrayList<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.
protected abstract Rectangle2D.Double	makeAnimationRectangle()
protected abstract JPanel	makeCharts(SimpleSimulatorInterface simulator) Make the chart panel.
protected abstract OTSModelInterface	makeModel(GTUColorer colorer)
SimpleSimulatorInterface	rebuildSimulator(Rectangle rect) Restart (rebuild) the simulation.
void	stopTimersThreads() Stop the timers and threads that are connected when disposing of this wrappable simulation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opentrafficsim.simulationengine.WrappableAnimation

description, shortName

Field Detail

properties

protected List<org.opentrafficsim.base.modelproperties.Property<?>> properties

The properties exhibited by this simulation.

savedUserModifiedProperties

protected List<org.opentrafficsim.base.modelproperties.Property<?>> savedUserModifiedProperties

The properties after (possible) editing by the user.

exitOnClose

protected boolean exitOnClose

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

panel

protected OTSAnimationPanel panel

The tabbed panel so other tabs can be added by the classes that extend this class.

Constructor Detail

AbstractWrappableAnimation

public AbstractWrappableAnimation()

Method Detail

buildSimpleAnimator

protected SimpleAnimator buildSimpleAnimator(org.djunits.value.vdouble.scalar.Time startTime,
                                             org.djunits.value.vdouble.scalar.Duration warmupPeriod,
                                             org.djunits.value.vdouble.scalar.Duration runLength,
                                             OTSModelInterface model)
                                      throws nl.tudelft.simulation.dsol.SimRuntimeException,
                                             NamingException,
                                             org.opentrafficsim.base.modelproperties.PropertyException

Build the animator.

Parameters:

startTime - Time; the start time

warmupPeriod - Duration; the warm up period

runLength - Duration; the duration of the simulation / animation

model - OTSModelInterface; the simulation model

Returns:

SimpleAnimator; a newly constructed animator

Throws:

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

NamingException - when context for the animation cannot be created

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

buildAnimator

public SimpleAnimator 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<?>> userModifiedProperties,
                                    Rectangle rect,
                                    boolean eoc)
                             throws nl.tudelft.simulation.dsol.SimRuntimeException,
                                    NamingException,
                                    OTSSimulationException,
                                    org.opentrafficsim.base.modelproperties.PropertyException

Build the animation.

Specified by:

buildAnimator in interface WrappableAnimation

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

userModifiedProperties - 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.

eoc - 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 ???

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

makeCharts

protected abstract JPanel makeCharts(SimpleSimulatorInterface simulator)
                              throws OTSSimulationException,
                                     org.opentrafficsim.base.modelproperties.PropertyException

Make the chart panel.

Parameters:

simulator - SimpleSimulatorInterface; the simulator

Returns:

the JPanel with the charts; the result will be put in the statistics tab. May return null; this causes no statistics tab to be created.

Throws:

OTSSimulationException - in case the chart, axes or legend cannot be generated

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

makeModel

protected abstract OTSModelInterface makeModel(GTUColorer colorer)
                                        throws OTSSimulationException

Parameters:

colorer - the GTU colorer to use.

Returns:

the demo model. Don't forget to keep a local copy.

Throws:

OTSSimulationException - in case the construction of the model fails

makeAnimationRectangle

protected abstract Rectangle2D.Double makeAnimationRectangle()

Returns:

the initial rectangle for the animation.

getProperties

public final ArrayList<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.

Specified by:

getProperties in interface WrappableAnimation

Returns:

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

rebuildSimulator

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

Restart (rebuild) the simulation.

Specified by:

rebuildSimulator in interface WrappableAnimation

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

getUserModifiedProperties

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

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

Specified by:

getUserModifiedProperties in interface WrappableAnimation

Returns:

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

stopTimersThreads

public void stopTimersThreads()

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

Specified by:

stopTimersThreads in interface WrappableAnimation

getPanel

public final OTSAnimationPanel getPanel()

Returns:

panel