org.opentrafficsim.simulationengine

Class AbstractWrappableSimulation

java.lang.Object

org.opentrafficsim.simulationengine.AbstractWrappableSimulation

All Implemented Interfaces:

WrappableSimulation

Direct Known Subclasses:

TestOpenDriveParser, TestXMLParser

public abstract class AbstractWrappableSimulation
extends Object
implements WrappableSimulation

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

$LastChangedDate: 2015-08-30 00:16:51 +0200 (Sun, 30 Aug 2015) $, @version $Revision: 1329 $, by $Author: averbraeck $, initial version Jun 18, 2015

Author:

Alexander Verbraeck, Peter Knoppers

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 ArrayList<AbstractProperty<?>>	properties The properties exhibited by this simulation.
protected ArrayList<AbstractProperty<?>>	savedUserModifiedProperties The properties after (possible) editing by the user.

Constructor Summary

Constructors

Constructor and Description
AbstractWrappableSimulation()

Method Summary

Modifier and Type	Method and Description
SimpleAnimator	buildSimulator(ArrayList<AbstractProperty<?>> userModifiedProperties, Rectangle rect, boolean eoc) Build the simulation.
ArrayList<AbstractProperty<?>>	getProperties() Retrieve a list of visible properties of the simulation.
ArrayList<AbstractProperty<?>>	getUserModifiedProperties() Retrieve a list of properties as the user has modified them.
protected abstract Rectangle2D.Double	makeAnimationRectangle()
protected abstract JPanel	makeCharts()
protected abstract OTSModelInterface	makeModel(GTUColorer colorer)
SimpleSimulation	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.WrappableSimulation

description, shortName

Field Detail

properties

protected ArrayList<AbstractProperty<?>> properties

The properties exhibited by this simulation.

savedUserModifiedProperties

protected ArrayList<AbstractProperty<?>> 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

AbstractWrappableSimulation

public AbstractWrappableSimulation()

Method Detail

buildSimulator

public final SimpleAnimator buildSimulator(ArrayList<AbstractProperty<?>> userModifiedProperties,
                                           Rectangle rect,
                                           boolean eoc)
                                    throws RemoteException,
                                           nl.tudelft.simulation.dsol.SimRuntimeException,
                                           NamingException

Build the simulation.

Specified by:

buildSimulator in interface WrappableSimulation

Parameters:

userModifiedProperties - ArrayList<AbstractProperty<?>>; 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:

RemoteException - on communications failure

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

NamingException - when context for the animation cannot be created

makeCharts

protected abstract JPanel makeCharts()

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.

makeModel

protected abstract OTSModelInterface makeModel(GTUColorer colorer)

Parameters:

colorer - the GTU colorer to use.

Returns:

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

makeAnimationRectangle

protected abstract Rectangle2D.Double makeAnimationRectangle()

Returns:

the initial rectangle for the animation.

getProperties

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

Specified by:

getProperties in interface WrappableSimulation

Returns:

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

rebuildSimulator

public final SimpleSimulation rebuildSimulator(Rectangle rect)
                                        throws nl.tudelft.simulation.dsol.SimRuntimeException,
                                               RemoteException,
                                               NetworkException,
                                               NamingException

Restart (rebuild) the simulation.

Specified by:

rebuildSimulator in interface WrappableSimulation

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

RemoteException - on communications failure

NetworkException - on Network inconsistency

NamingException - when context for the animation cannot be created

getUserModifiedProperties

public final ArrayList<AbstractProperty<?>> getUserModifiedProperties()

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

Specified by:

getUserModifiedProperties in interface WrappableSimulation

Returns:

ArrayList<AbstractProperty<?>>; 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 WrappableSimulation