Package org.opentrafficsim.core.perception

Class HistoricalValue<T>

java.lang.Object

org.opentrafficsim.core.perception.AbstractHistorical<T,AbstractHistorical.EventValue<T>>

org.opentrafficsim.core.perception.HistoricalValue<T>

Type Parameters:

T - value type

All Implemented Interfaces:

Historical<T>, HistoryManager.HistoricalElement

public class HistoricalValue<T>
extends AbstractHistorical<T,AbstractHistorical.EventValue<T>>
implements Historical<T>

Single-valued historical state.

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

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

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

AbstractHistorical.EventValue<T>

Constructor Summary

Constructors

Constructor	Description
HistoricalValue(HistoryManager historyManager)	Constructor.
HistoricalValue(HistoryManager historyManager, T initialValue)	Construct a new HistoricalValue.

Method Summary

Modifier and Type	Method	Description
T	get()	Get value at current simulation time.
T	get(Time time)	Get value at a specific time.
void	set(T value)	Set value at the current simulation time.
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

HistoricalValue

public HistoricalValue(HistoryManager historyManager)

Constructor.

Parameters:

historyManager - HistoryManager; history manager

HistoricalValue

public HistoricalValue(HistoryManager historyManager,
                       T initialValue)

Construct a new HistoricalValue.

Parameters:

historyManager - HistoryManager; history manager

initialValue - T; initial value

Method Detail

set

public final void set(T value)

Set value at the current simulation time. If a value is already stored for this time, it is replaced.

Specified by:

set in interface Historical<T>

Parameters:

value - T; value

get

public final T get()

Get value at current simulation time. TODO specify what happens when no value was set for the current simulation time

Specified by:

get in interface Historical<T>

Returns:

T; value at current simulation time

get

public final T get(Time time)

Get value at a specific time. TODO specify what happens when no value has ever been set, or the value for the specified time can not be determined.

Specified by:

get in interface Historical<T>

Parameters:

time - Time; time to get the value

Returns:

T; value at current time

toString

public String toString()

Overrides:

toString in class Object