org.opentrafficsim.kpi.sampling.data

Class ExtendedDataType<T,O,S,G extends GtuDataInterface>

java.lang.Object

org.opentrafficsim.kpi.sampling.data.ExtendedDataType<T,O,S,G>

Type Parameters:

T - type of value

O - output type

S - storage type

G - gtu data type

All Implemented Interfaces:

org.opentrafficsim.base.Identifiable

Direct Known Subclasses:

ExtendedDataTypeFloat, ExtendedDataTypeList, ExtendedDataTypeNumber

public abstract class ExtendedDataType<T,O,S,G extends GtuDataInterface>
extends Object
implements org.opentrafficsim.base.Identifiable

Type class to define different types of data by which trajectories can be extended beyond the basic t, x, v, a. Extend this class to define a new data type. Extended data types are defined with 3 generic types. <T> is the type of a single scalar value, <O> is the output type of the whole trajectory, e.g. List<Double> or FloatLengthVector, and <S> is the storage type by which the data is gathered, e.g. List<Double> or float[].

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 11 okt. 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor and Description
ExtendedDataType(String id) Constructor setting the id.

Method Summary

Modifier and Type	Method and Description
abstract O	convert(S storage, int size) Convert storage type to output type.
boolean	equals(Object obj)
abstract String	formatValue(String format, T value) Formats the value into a string.
String	getId()
abstract T	getOutputValue(O output, int index) Returns a specific output value.
abstract T	getStorageValue(S storage, int index) Returns a specific storage value.
abstract T	getValue(G gtu) Returns the current value of the gtu.
int	hashCode()
abstract S	initializeStorage() Returns an initial storage object.
<AU extends org.djunits.unit.AbsoluteLinearUnit<AU,RU>,RU extends org.djunits.unit.Unit<RU>> T	interpolate(T value0, T value1, double f) Interpolate value between two measured values.
abstract S	setValue(S storage, int index, T value) Returns an updated list/array/vector of the storage type, including a new value at given index.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedDataType

public ExtendedDataType(String id)

Constructor setting the id.

Parameters:

id - id

Method Detail

getId

public final String getId()

Specified by:

getId in interface org.opentrafficsim.base.Identifiable

Returns:

id

getValue

public abstract T getValue(G gtu)

Returns the current value of the gtu.

Parameters:

gtu - gtu

Returns:

current value of the gtu

setValue

public abstract S setValue(S storage,
                           int index,
                           T value)

Returns an updated list/array/vector of the storage type, including a new value at given index.

Parameters:

storage - storage

index - index to store next value

value - value to add

Returns:

updated list/array/vector of the storage type, including a new value at given index

getOutputValue

public abstract T getOutputValue(O output,
                                 int index)
                          throws SamplingException

Returns a specific output value. This is used to store extended data types as generic file, i.e. text file.

Parameters:

output - output

index - index of value to return

Returns:

the i'th output value

Throws:

SamplingException - when i is out of bounds.

getStorageValue

public abstract T getStorageValue(S storage,
                                  int index)
                           throws SamplingException

Returns a specific storage value. This is used to bypass conversion to the output type when trajectories are cut.

Parameters:

storage - storage

index - index of value to return

Returns:

the i'th output value

Throws:

SamplingException - when i is out of bounds.

initializeStorage

public abstract S initializeStorage()

Returns an initial storage object.

Returns:

initial storage object.

convert

public abstract O convert(S storage,
                          int size)

Convert storage type to output type.

Parameters:

storage - stored data

size - size of trajectory

Returns:

converted output

formatValue

public abstract String formatValue(String format,
                                   T value)

Formats the value into a string. If the value is numeric, the default implementation is:

 String.format(format, value.si);
 

Parameters:

format - format

value - value

Returns:

formatted value

interpolate

public <AU extends org.djunits.unit.AbsoluteLinearUnit<AU,RU>,RU extends org.djunits.unit.Unit<RU>> T interpolate(T value0,
                                                                                                                  T value1,
                                                                                                                  double f)

Interpolate value between two measured values. The default implementation takes a linear interpolation over time for DoubleScalar, FloatScalar, Double and Float, or the closest value in time otherwise.

Type Parameters:

AU - unit of value, if values are DoubleScalar

RU - the corresponding relative unit

Parameters:

value0 - first value

value1 - second value

f - interpolation fraction

Returns:

interpolated value

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object