org.opentrafficsim.road.animation

Class AbstractSimulationScript

java.lang.Object

org.opentrafficsim.road.animation.AbstractSimulationScript

All Implemented Interfaces:

EventListener, EventListenerInterface

public abstract class AbstractSimulationScript
extends Object
implements EventListenerInterface

Template for simulation script.

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.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 9 apr. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSimulationScript(String name, String description, String[] properties) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addAnimationToggles(AbstractWrappableAnimation animation) Sets the animation toggles.
protected void	addTabs(SimpleSimulatorInterface sim) Adds taps to the animation.
protected void	animateNetwork(OTSNetwork net) Creates animations for nodes, links and lanes.
boolean	getBooleanProperty(String propertyName) Returns the boolean value of given property.
double	getDoubleProperty(String propertyName) Returns the double value of given property.
Duration	getDurationProperty(String propertyName) Returns the Duration value of given property.
GTUColorer	getGtuColorer() Returns the GTU colorer.
int	getIntegerProperty(String propertyName) Returns the int value of given property.
OTSNetwork	getNetwork() Returns the network.
String	getProperty(String propertyName) Returns the String value of given property.
DEVSSimulatorInterface.TimeDoubleUnit	getSimulator() Returns the simulator.
Time	getTimeProperty(String propertyName) Returns the Time value of given property.
void	notify(EventInterface event)
protected void	onSimulationEnd() Method that is called when the simulation has ended.
protected void	setDefaultProperties() Sets the default properties.
void	setGtuColorer(GTUColorer colorer) Set GTU colorer.
void	setProperty(String propertyName, Object propertyValue) Sets a property.
protected void	setupDemo(AbstractWrappableAnimation animation, OTSNetwork net) Method that is called when the animation has been created, to add components for a demo.
protected abstract OTSNetwork	setupSimulation(DEVSSimulatorInterface.TimeDoubleUnit sim) Sets up the simulation based on provided properties.
void	start() Starts the simulation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSimulationScript

protected AbstractSimulationScript(String name,
                                   String description,
                                   String[] properties)

Constructor.

Parameters:

name - String; name

description - String; description

properties - String[]; properties as name-value pairs

Method Detail

setProperty

public final void setProperty(String propertyName,
                              Object propertyValue)

Sets a property.

Parameters:

propertyName - String; property name

propertyValue - Object; property value

getProperty

public final String getProperty(String propertyName)

Returns the String value of given property.

Parameters:

propertyName - String; property name

Returns:

String; value of property

getDoubleProperty

public final double getDoubleProperty(String propertyName)

Returns the double value of given property.

Parameters:

propertyName - String; property name

Returns:

double; value of property

getBooleanProperty

public final boolean getBooleanProperty(String propertyName)

Returns the boolean value of given property.

Parameters:

propertyName - String; property name

Returns:

double; value of property

getIntegerProperty

public final int getIntegerProperty(String propertyName)

Returns the int value of given property.

Parameters:

propertyName - String; property name

Returns:

int; value of property

getDurationProperty

public final Duration getDurationProperty(String propertyName)

Returns the Duration value of given property.

Parameters:

propertyName - String; property name

Returns:

Duration; value of property

getTimeProperty

public final Time getTimeProperty(String propertyName)

Returns the Time value of given property.

Parameters:

propertyName - String; property name

Returns:

Time; value of property

setGtuColorer

public final void setGtuColorer(GTUColorer colorer)

Set GTU colorer.

Parameters:

colorer - GTUColorer; GTU colorer

getGtuColorer

public final GTUColorer getGtuColorer()

Returns the GTU colorer.

Returns:

returns the GTU colorer

start

public final void start()

Starts the simulation.

notify

public final void notify(EventInterface event)
                  throws RemoteException

Specified by:

notify in interface EventListenerInterface

Throws:

RemoteException

getSimulator

public final DEVSSimulatorInterface.TimeDoubleUnit getSimulator()

Returns the simulator.

Returns:

DEVSSimulatorInterface.TimeDoubleUnit; simulator

getNetwork

public final OTSNetwork getNetwork()

Returns the network.

Returns:

OTSNetwork; network

animateNetwork

protected void animateNetwork(OTSNetwork net)

Creates animations for nodes, links and lanes. This can be used if the network is not read from XML.

Parameters:

net - OTSNetwork; network

addAnimationToggles

protected void addAnimationToggles(AbstractWrappableAnimation animation)

Sets the animation toggles. May be overridden.

Parameters:

animation - AbstractWrappableAnimation; animation to set the toggle on

addTabs

protected void addTabs(SimpleSimulatorInterface sim)

Adds taps to the animation. May be overridden.

Parameters:

sim - SimpleSimulatorInterface; simulator

setDefaultProperties

protected void setDefaultProperties()

Sets the default properties. Can be overridden and use method setProperty(). Default implementation does nothing.

onSimulationEnd

protected void onSimulationEnd()

Method that is called when the simulation has ended. This can be used to store data.

setupDemo

protected void setupDemo(AbstractWrappableAnimation animation,
                         OTSNetwork net)

Method that is called when the animation has been created, to add components for a demo.

Parameters:

animation - AbstractWrappableAnimation; animation

net - OTSNetwork; network

setupSimulation

protected abstract OTSNetwork setupSimulation(DEVSSimulatorInterface.TimeDoubleUnit sim)
                                       throws Exception

Sets up the simulation based on provided properties. Properties can be obtained with getProperty(). Setting up a simulation should at least create a network and some demand. Additionally this may setup traffic control, sampling, etc.

Parameters:

sim - DEVSSimulatorInterface.TimeDoubleUnit; simulator

Returns:

OTSNetwork; network

Throws:

Exception - on any exception