org.opentrafficsim.core.value

Interface Value<U extends Unit<U>>

Type Parameters:

U - the unit type

All Known Implementing Classes:

AbstractValue, DoubleMatrix, DoubleMatrix.Abs, DoubleMatrix.Abs.Dense, DoubleMatrix.Abs.Sparse, DoubleMatrix.Rel, DoubleMatrix.Rel.Dense, DoubleMatrix.Rel.Sparse, DoubleScalar, DoubleScalar.Abs, DoubleScalar.Rel, DoubleVector, DoubleVector.Abs, DoubleVector.Abs.Dense, DoubleVector.Abs.Sparse, DoubleVector.Rel, DoubleVector.Rel.Dense, DoubleVector.Rel.Sparse, FloatMatrix, FloatMatrix.Abs, FloatMatrix.Abs.Dense, FloatMatrix.Abs.Sparse, FloatMatrix.Rel, FloatMatrix.Rel.Dense, FloatMatrix.Rel.Sparse, FloatScalar, FloatScalar.Abs, FloatScalar.Rel, FloatVector, FloatVector.Abs, FloatVector.Abs.Dense, FloatVector.Abs.Sparse, FloatVector.Rel, FloatVector.Rel.Dense, FloatVector.Rel.Sparse, MutableDoubleMatrix, MutableDoubleMatrix.Abs, MutableDoubleMatrix.Abs.Dense, MutableDoubleMatrix.Abs.Sparse, MutableDoubleMatrix.Rel, MutableDoubleMatrix.Rel.Dense, MutableDoubleMatrix.Rel.Sparse, MutableDoubleScalar, MutableDoubleScalar.Abs, MutableDoubleScalar.Rel, MutableDoubleVector, MutableDoubleVector.Abs, MutableDoubleVector.Abs.Dense, MutableDoubleVector.Abs.Sparse, MutableDoubleVector.Rel, MutableDoubleVector.Rel.Dense, MutableDoubleVector.Rel.Sparse, MutableFloatMatrix, MutableFloatMatrix.Abs, MutableFloatMatrix.Abs.Dense, MutableFloatMatrix.Abs.Sparse, MutableFloatMatrix.Rel, MutableFloatMatrix.Rel.Dense, MutableFloatMatrix.Rel.Sparse, MutableFloatScalar, MutableFloatScalar.Abs, MutableFloatScalar.Rel, MutableFloatVector, MutableFloatVector.Abs, MutableFloatVector.Abs.Dense, MutableFloatVector.Abs.Sparse, MutableFloatVector.Rel, MutableFloatVector.Rel.Dense, MutableFloatVector.Rel.Sparse, Scalar

public interface Value<U extends Unit<U>>

Value is a static interface that forces implementation of a few unit- and value-related methods.

This file was generated by the OpenTrafficSim value classes generator, 26 jun, 2015

Copyright (c) 2014 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

26 jun, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
Value<U>	copy() Create a deep copy of this Value.
double	expressAsSIUnit(double value) Convert a value to the standard SI unit.
U	getUnit() Retrieve the unit of this Value.
boolean	isAbsolute() Indicate whether this is an Absolute Value.
boolean	isRelative() Indicate whether this is a Relative Value.

Method Detail

getUnit

U getUnit()

Retrieve the unit of this Value.

Returns:

U; the unit of this Value

expressAsSIUnit

double expressAsSIUnit(double value)

Convert a value to the standard SI unit.

Parameters:

value - double; the value to convert to the standard SI unit

Returns:

double; the value in the standard SI unit

isAbsolute

boolean isAbsolute()

Indicate whether this is an Absolute Value.

Returns:

boolean

isRelative

boolean isRelative()

Indicate whether this is a Relative Value.

Returns:

boolean

copy

Value<U> copy()

Create a deep copy of this Value.

Returns:

Value<U>