org.djunits.value

Class AbstractValue<U extends Unit<U>>

java.lang.Object

org.djunits.value.AbstractValue<U>

Type Parameters:

U - the Unit of the value(s) in this AbstractValue. Used for setting, getting and displaying the value(s)

All Implemented Interfaces:

Serializable, Value<U>

Direct Known Subclasses:

AbstractDoubleMatrix, AbstractDoubleVector, AbstractFloatMatrix, AbstractFloatVector

public abstract class AbstractValue<U extends Unit<U>>
extends Object
implements Value<U>, Serializable

AbstractValue is a class to help construct Matrix, Complex, and Vector but it does not extend java.lang.Number. The Scalar class does extend Number, and implements the same interfaces from Value.

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

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

$LastChangedDate: 2018-08-11 03:31:46 +0200 (Sat, 11 Aug 2018) $, @version $Revision: 306 $, by $Author: averbraeck $, initial version 26 jun, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractValue(U unit) Construct a new AbstractValue.

Method Summary

Modifier and Type	Method and Description
double	expressAsSIUnit(double value) Convert a value to the standard SI unit.
protected double	expressAsSpecifiedUnit(double value) Convert a value in SI standard unit into the unit of this AbstractValue.
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.
void	setDisplayUnit(U newUnit) Set a new display unit for the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractValue

protected AbstractValue(U unit)

Construct a new AbstractValue.

Parameters:

unit - U; the unit of the new AbstractValue

Method Detail

getUnit

public final U getUnit()

Retrieve the unit of this Value.

Specified by:

getUnit in interface Value<U extends Unit<U>>

Returns:

U; the unit of this Value

expressAsSIUnit

public final double expressAsSIUnit(double value)

Convert a value to the standard SI unit.

Specified by:

expressAsSIUnit in interface Value<U extends Unit<U>>

Parameters:

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

Returns:

double; the value in the standard SI unit

expressAsSpecifiedUnit

protected final double expressAsSpecifiedUnit(double value)

Convert a value in SI standard unit into the unit of this AbstractValue.

Parameters:

value - double; the value in the standard SI unit

Returns:

double; the value in the unit as specified for this AbstractValue

setDisplayUnit

public void setDisplayUnit(U newUnit)

Set a new display unit for the value. Internally, the value will stay stored in the default or SI unit.

Specified by:

setDisplayUnit in interface Value<U extends Unit<U>>

Parameters:

newUnit - U; the new display unit of this Value

isAbsolute

public final boolean isAbsolute()

Indicate whether this is an Absolute Value.

Specified by:

isAbsolute in interface Value<U extends Unit<U>>

Returns:

boolean

isRelative

public final boolean isRelative()

Indicate whether this is a Relative Value.

Specified by:

isRelative in interface Value<U extends Unit<U>>

Returns:

boolean