org.opentrafficsim.kpi.sampling.data

Class ExtendedDataTypeFloat<T extends org.djunits.value.vfloat.scalar.AbstractFloatScalar<?,T>,O extends org.djunits.value.vfloat.vector.AbstractFloatVector<?,O>>

java.lang.Object

org.opentrafficsim.kpi.sampling.data.ExtendedDataType<T,O,float[]>

org.opentrafficsim.kpi.sampling.data.ExtendedDataTypeFloat<T,O>

Type Parameters:

T - type in vector

O - vector type

Direct Known Subclasses:

ExtendedDataTypeDuration, ExtendedDataTypeLength, ExtendedDataTypeSpeed

public abstract class ExtendedDataTypeFloat<T extends org.djunits.value.vfloat.scalar.AbstractFloatScalar<?,T>,O extends org.djunits.value.vfloat.vector.AbstractFloatVector<?,O>>
extends ExtendedDataType<T,O,float[]>

Copyright (c) 2013-2016 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 21 mrt. 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract O	convert(float[] storage) Convert float array to typed array.
O	convert(float[] storage, int size) Convert storage type to output type.
protected abstract T	convertValue(float value) Convert float to typed value.
String	formatValue(String format, T value) Formats the value into a string.
T	getOutputValue(O output, int i) Returns a specific output value.
T	getStorageValue(float[] storage, int i) Returns a specific storage value.
float[]	initializeStorage() Returns an initial storage object.
float[]	setValue(float[] storage, int i, T value) Returns an updated list/array/vector of the storage type, including a new value at given index.

Methods inherited from class org.opentrafficsim.kpi.sampling.data.ExtendedDataType

equals, getId, getValue, hashCode, interpolate

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedDataTypeFloat

public ExtendedDataTypeFloat(String id)

Constructor setting the id.

Parameters:

id - id

Method Detail

setValue

public final float[] setValue(float[] storage,
                              int i,
                              T value)

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

Specified by:

setValue in class ExtendedDataType<T extends org.djunits.value.vfloat.scalar.AbstractFloatScalar<?,T>,O extends org.djunits.value.vfloat.vector.AbstractFloatVector<?,O>,float[]>

Parameters:

storage - storage

i - 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

initializeStorage

public final float[] initializeStorage()

Returns an initial storage object.

Specified by:

initializeStorage in class ExtendedDataType<T extends org.djunits.value.vfloat.scalar.AbstractFloatScalar<?,T>,O extends org.djunits.value.vfloat.vector.AbstractFloatVector<?,O>,float[]>

Returns:

initial storage object.

formatValue

public final 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);
 

Specified by:

formatValue in class ExtendedDataType<T extends org.djunits.value.vfloat.scalar.AbstractFloatScalar<?,T>,O extends org.djunits.value.vfloat.vector.AbstractFloatVector<?,O>,float[]>

Parameters:

format - format

value - value

Returns:

formatted value

getOutputValue

public final T getOutputValue(O output,
                              int i)
                       throws SamplingException

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

Specified by:

getOutputValue in class ExtendedDataType<T extends org.djunits.value.vfloat.scalar.AbstractFloatScalar<?,T>,O extends org.djunits.value.vfloat.vector.AbstractFloatVector<?,O>,float[]>

Parameters:

output - output

i - index of value to return

Returns:

the i'th output value

Throws:

SamplingException - when i is out of bounds.

getStorageValue

public T getStorageValue(float[] storage,
                         int i)
                  throws SamplingException

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

Specified by:

getStorageValue in class ExtendedDataType<T extends org.djunits.value.vfloat.scalar.AbstractFloatScalar<?,T>,O extends org.djunits.value.vfloat.vector.AbstractFloatVector<?,O>,float[]>

Parameters:

storage - storage

i - index of value to return

Returns:

the i'th output value

Throws:

SamplingException - when i is out of bounds.

convertValue

protected abstract T convertValue(float value)

Convert float to typed value.

Parameters:

value - float value

Returns:

typed value

convert

public O convert(float[] storage,
                 int size)

Convert storage type to output type.

Specified by:

convert in class ExtendedDataType<T extends org.djunits.value.vfloat.scalar.AbstractFloatScalar<?,T>,O extends org.djunits.value.vfloat.vector.AbstractFloatVector<?,O>,float[]>

Parameters:

storage - stored data

size - size of trajectory

Returns:

converted output

convert

protected abstract O convert(float[] storage)
                      throws org.djunits.value.ValueException

Convert float array to typed array.

Parameters:

storage - float array storage

Returns:

typed array

Throws:

org.djunits.value.ValueException - when float array cannot be converted