org.opentrafficsim.simulationengine

Interface WrappableSimulation

public interface WrappableSimulation

Requirements for demonstration that can be shown in the SuperDemo.

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

Version:

17 dec. 2014

Author:

Peter Knoppers

Method Summary

Modifier and Type	Method and Description
SimpleSimulation	buildSimulator(ArrayList<AbstractProperty<?>> 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.
ArrayList<AbstractProperty<?>>	getUserModifiedProperties() Retrieve a list of properties as the user has modified them.
SimpleSimulation	rebuildSimulator() Restart (rebuild) the simulation.
String	shortName() Return a very short description of the simulation.

Method Detail

buildSimulator

SimpleSimulation buildSimulator(ArrayList<AbstractProperty<?>> properties)
                         throws nl.tudelft.simulation.dsol.SimRuntimeException,
                                RemoteException,
                                NetworkException,
                                NamingException

Build the simulation.

Parameters:

properties - ArrayList<AbstractProperty<?>*gt;; 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:

RemoteException - on communications failure

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

NetworkException - on Network inconsistency

NamingException - when context for the animation cannot be created

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

rebuildSimulator

SimpleSimulation rebuildSimulator()
                           throws nl.tudelft.simulation.dsol.SimRuntimeException,
                                  RemoteException,
                                  NetworkException,
                                  NamingException

Restart (rebuild) the simulation.

Returns:

SimpleSimulation; the new simulation

Throws:

RemoteException - on communications failure

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

NetworkException - on Network inconsistency

NamingException - when context for the animation cannot be created

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

getUserModifiedProperties

ArrayList<AbstractProperty<?>> getUserModifiedProperties()

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

Returns:

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