org.opentrafficsim.simulationengine

Class AbstractWrappableSimulation

java.lang.Object

org.opentrafficsim.simulationengine.AbstractWrappableSimulation

All Implemented Interfaces:

Serializable, WrappableSimulation

public abstract class AbstractWrappableSimulation
extends Object
implements WrappableSimulation, Serializable

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.

$LastChangedDate: 2018-09-19 13:55:45 +0200 (Wed, 19 Sep 2018) $, @version $Revision: 4006 $, by $Author: averbraeck $, initial version Jun 18, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<AbstractProperty<?>>	properties The properties exhibited by this simulation.

Constructor Summary

Constructors

Constructor and Description
AbstractWrappableSimulation()

Method Summary

Modifier and Type	Method and Description
protected SimpleSimulator	buildSimpleSimulator(Time startTime, Duration warmupPeriod, Duration runLength, OTSModelInterface model) Build the simulator.
protected SimpleSimulator	buildSimpleSimulator(Time startTime, Duration warmupPeriod, Duration runLength, OTSModelInterface otsModel, int replicationNumber) Build the simulator with the specified replication number.
SimpleSimulator	buildSimulator(Time startTime, Duration warmupPeriod, Duration runLength, ArrayList<Property<?>> userModifiedProperties) Build the simulation.
ArrayList<AbstractProperty<?>>	getProperties() Retrieve a list of visible properties of the simulation.
protected abstract OTSModelInterface	makeModel()
void	setNextReplication(Integer nextReplication) Set the number of the next spawned replication.

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.

Constructor Detail

AbstractWrappableSimulation

public AbstractWrappableSimulation()

Method Detail

buildSimpleSimulator

protected SimpleSimulator buildSimpleSimulator(Time startTime,
                                               Duration warmupPeriod,
                                               Duration runLength,
                                               OTSModelInterface model)
                                        throws SimRuntimeException,
                                               NamingException,
                                               PropertyException

Build the simulator.

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:

SimpleSimulator; the newly constructed simulator

Throws:

SimRuntimeException - on ???

NamingException - when context for the animation cannot be created

PropertyException - when one of the user modified properties has the empty string as key

buildSimpleSimulator

protected SimpleSimulator buildSimpleSimulator(Time startTime,
                                               Duration warmupPeriod,
                                               Duration runLength,
                                               OTSModelInterface otsModel,
                                               int replicationNumber)
                                        throws SimRuntimeException,
                                               NamingException,
                                               PropertyException

Build the simulator with the specified replication number.

Parameters:

startTime - Time; the start time

warmupPeriod - Duration; the warm up period

runLength - Duration; the duration of the simulation / animation

otsModel - OTSModelInterface; the simulation model

replicationNumber - int; the replication number

Returns:

SimpleAnimator; a newly constructed animator

Throws:

SimRuntimeException - on ???

NamingException - when context for the animation cannot be created

PropertyException - when one of the user modified properties has the empty string as key

buildSimulator

public SimpleSimulator buildSimulator(Time startTime,
                                      Duration warmupPeriod,
                                      Duration runLength,
                                      ArrayList<Property<?>> userModifiedProperties)
                               throws SimRuntimeException,
                                      NamingException,
                                      OTSSimulationException,
                                      PropertyException

Build the simulation.

Specified by:

buildSimulator in interface WrappableSimulation

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

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

PropertyException - when one of the user modified properties has the empty string as key

makeModel

protected abstract OTSModelInterface makeModel()
                                        throws OTSSimulationException

Returns:

the model.

Throws:

OTSSimulationException - when the construction of the model fails

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

setNextReplication

public final void setNextReplication(Integer nextReplication)

Set the number of the next spawned replication.

Specified by:

setNextReplication in interface WrappableSimulation

Parameters:

nextReplication - Integer; the next replication number, or null to use the built-in auto-incrementing replication counter