Package org.opentrafficsim.core.perception

Class HistoricalParameters

java.lang.Object

org.opentrafficsim.core.perception.AbstractHistorical<HistoricalParameters.ParameterValueSet,HistoricalParameters.ParameterEvent>

org.opentrafficsim.core.perception.HistoricalParameters

All Implemented Interfaces:

Parameters, HistoryManager.HistoricalElement

public class HistoricalParameters
extends AbstractHistorical<HistoricalParameters.ParameterValueSet,HistoricalParameters.ParameterEvent>
implements Parameters

Historical representation of Parameters.

Copyright (c) 2013-2022 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 19 jan. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HistoricalParameters.ParameterEvent	Parameter event, which will restore the previous value.
static class	HistoricalParameters.ParameterValueSet	Value for a parameter event, which contains a parameter type and (the previous) value.

Nested classes/interfaces inherited from class org.opentrafficsim.core.perception.AbstractHistorical

AbstractHistorical.EventValue<T>

Constructor Summary

Constructors

Constructor	Description
HistoricalParameters(HistoryManager manager, Parameters parameters)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	contains(ParameterType<?> parameterType)
<T> T	getParameter(ParameterType<T> parameterType)
<T> T	getParameterOrNull(ParameterType<T> parameterType)
Parameters	getParameters()	Get the parameters at the current simulation time.
Parameters	getParameters(Time time)	Get the parameters at the given simulation time.
void	resetParameter(ParameterType<?> parameterType)
void	setAllIn(Parameters parameters)
<T> void	setParameter(ParameterType<T> parameterType, T value)
<T> void	setParameterResettable(ParameterType<T> parameterType, T value)
String	toString()

Methods inherited from class org.opentrafficsim.core.perception.AbstractHistorical

addEvent, cleanUpHistory, getEvent, getEvents, getLastEvent, isLastState, now, removeEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoricalParameters

public HistoricalParameters(HistoryManager manager,
                            Parameters parameters)

Constructor.

Parameters:

manager - HistoryManager; history manager

parameters - Parameters; initial parameter set

Method Detail

getParameters

public Parameters getParameters()

Get the parameters at the current simulation time.

Returns:

Parameters; parameters at the current simulation time

getParameters

public Parameters getParameters(Time time)

Get the parameters at the given simulation time.

Parameters:

time - Time; simulation time

Returns:

Parameters; parameters at the given simulation time

setParameter

public <T> void setParameter(ParameterType<T> parameterType,
                             T value)
                      throws ParameterException

Specified by:

setParameter in interface Parameters

Throws:

ParameterException

setParameterResettable

public <T> void setParameterResettable(ParameterType<T> parameterType,
                                       T value)
                                throws ParameterException

Specified by:

setParameterResettable in interface Parameters

Throws:

ParameterException

resetParameter

public void resetParameter(ParameterType<?> parameterType)
                    throws ParameterException

Specified by:

resetParameter in interface Parameters

Throws:

ParameterException

getParameter

public <T> T getParameter(ParameterType<T> parameterType)
                   throws ParameterException

Specified by:

getParameter in interface Parameters

Throws:

ParameterException

getParameterOrNull

public <T> T getParameterOrNull(ParameterType<T> parameterType)

Specified by:

getParameterOrNull in interface Parameters

contains

public boolean contains(ParameterType<?> parameterType)

Specified by:

contains in interface Parameters

setAllIn

public void setAllIn(Parameters parameters)

Specified by:

setAllIn in interface Parameters

toString

public String toString()

Overrides:

toString in class Object