Package org.djunits.value

Class AbstractScalar<U extends Unit<U>,T extends Value<U,T>>

java.lang.Object

java.lang.Number

org.djunits.value.AbstractScalar<U,T>

Type Parameters:

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

T - the value type for this unit

All Implemented Interfaces:

Serializable, Cloneable, ValueFunctions<U,T>, Value<U,T>

Direct Known Subclasses:

AbstractDoubleScalar, AbstractFloatScalar

public abstract class AbstractScalar<U extends Unit<U>,T extends Value<U,T>>
extends Number
implements Value<U,T>, Serializable

AbstractScalar is a class to help construct Scalar classes. In contrast with AbstractValue, it extends Number.

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

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScalar(U displayUnit)	Construct a new AbstractValue.

Method Summary

Modifier and Type	Method	Description
U	getDisplayUnit()	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.Number

byteValue, doubleValue, floatValue, intValue, longValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djunits.value.Value

toString, toString, toString, toString

Methods inherited from interface org.djunits.value.function.ValueFunctions

abs, ceil, floor, neg, rint

Constructor Details

AbstractScalar

protected AbstractScalar(U displayUnit)

Construct a new AbstractValue.

Parameters:

displayUnit - U; the unit of the new AbstractValue

Method Details

getDisplayUnit

public final U getDisplayUnit()

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<U extends Unit<U>,T extends Value<U,T>>

Returns:

U; the unit of this Value

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>,T extends Value<U,T>>

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>,T extends Value<U,T>>

Returns:

boolean

isRelative

public final boolean isRelative()

Indicate whether this is a Relative Value.

Specified by:

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

Returns:

boolean