org.djunits.value.vdouble.scalar

Class AbsoluteTemperature

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.DoubleScalar<U>

org.djunits.value.vdouble.scalar.DoubleScalar.Abs<U>

org.djunits.value.vdouble.scalar.TypedDoubleScalarAbs<TemperatureUnit,AbsoluteTemperature,Temperature>

org.djunits.value.vdouble.scalar.AbsoluteTemperature

All Implemented Interfaces:

Serializable, Comparable<DoubleScalar.Abs<TemperatureUnit>>, Absolute, MathFunctionsAbs<DoubleScalar.Abs<TemperatureUnit>>, Value<TemperatureUnit>, DoubleMathFunctions<DoubleScalar<TemperatureUnit>>

public class AbsoluteTemperature
extends TypedDoubleScalarAbs<TemperatureUnit,AbsoluteTemperature,Temperature>

Easy access methods for the Absolute AbsoluteTemperature DoubleScalar. Instead of:

 DoubleScalar.Abs<TemperatureUnit> value = new DoubleScalar.Abs<TemperatureUnit>(100.0, TemperatureUnit.SI);
 

we can now write:

 AbsoluteTemperature value = new AbsoluteTemperature(100.0, TemperatureUnit.SI);
 

The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

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.

$LastChangedDate: 2015-12-22 04:32:39 +0100 (Tue, 22 Dec 2015) $, @version $Revision: 180 $, by $Author: averbraeck $, initial version Sep 1, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.scalar.DoubleScalar

DoubleScalar.Abs<U extends Unit<U>>, DoubleScalar.Rel<U extends Unit<U>>

Field Summary

Fields

Modifier and Type	Field and Description
static AbsoluteTemperature	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.DoubleScalar.Abs

si

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor and Description
AbsoluteTemperature(AbsoluteTemperature value) Construct AbsoluteTemperature scalar.
AbsoluteTemperature(double value, TemperatureUnit unit) Construct AbsoluteTemperature scalar.

Method Summary

Modifier and Type	Method and Description
protected AbsoluteTemperature	instantiateTypeAbs(double value, TemperatureUnit unit) Construct a new Absolute Immutable DoubleScalar of the right type.
protected Temperature	instantiateTypeRel(double value, TemperatureUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static AbsoluteTemperature	interpolate(AbsoluteTemperature zero, AbsoluteTemperature one, double ratio) Interpolate between two values.
static AbsoluteTemperature	max(AbsoluteTemperature a1, AbsoluteTemperature a2) Return the maximum value of two absolute scalars.
static AbsoluteTemperature	max(AbsoluteTemperature a1, AbsoluteTemperature a2, AbsoluteTemperature... an) Return the maximum value of more than two absolute scalars.
static AbsoluteTemperature	min(AbsoluteTemperature a1, AbsoluteTemperature a2) Return the minimum value of two absolute scalars.
static AbsoluteTemperature	min(AbsoluteTemperature a1, AbsoluteTemperature a2, AbsoluteTemperature... an) Return the minimum value of more than two absolute scalars.

Methods inherited from class org.djunits.value.vdouble.scalar.TypedDoubleScalarAbs

ceil, floor, minus, minus, plus, rint, round, toRel

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar.Abs

compareTo, divideBy, eq, ge, getSI, gt, le, lt, minus, minus, multiplyBy, ne, plus

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar

divide, divide, doubleValue, equals, floatValue, getInUnit, getInUnit, hashCode, interpolate, interpolate, intValue, longValue, minus, minus, minus, multiply, multiply, plus, plus, plus, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final AbsoluteTemperature ZERO

constant with value zero.

Constructor Detail

AbsoluteTemperature

public AbsoluteTemperature(double value,
                           TemperatureUnit unit)

Construct AbsoluteTemperature scalar.

Parameters:

value - double value

unit - unit for the double value

AbsoluteTemperature

public AbsoluteTemperature(AbsoluteTemperature value)

Construct AbsoluteTemperature scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateTypeAbs

protected final AbsoluteTemperature instantiateTypeAbs(double value,
                                                       TemperatureUnit unit)

Construct a new Absolute Immutable DoubleScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateTypeAbs in class TypedDoubleScalarAbs<TemperatureUnit,AbsoluteTemperature,Temperature>

Parameters:

value - the double value

unit - the unit

Returns:

A a new absolute instance of the DoubleScalar of the right type

instantiateTypeRel

protected final Temperature instantiateTypeRel(double value,
                                               TemperatureUnit unit)

Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateTypeRel in class TypedDoubleScalarAbs<TemperatureUnit,AbsoluteTemperature,Temperature>

Parameters:

value - the double value

unit - the unit

Returns:

R a new relative instance of the DoubleScalar of the right type

interpolate

public static AbsoluteTemperature interpolate(AbsoluteTemperature zero,
                                              AbsoluteTemperature one,
                                              double ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

public static AbsoluteTemperature max(AbsoluteTemperature a1,
                                      AbsoluteTemperature a2)

Return the maximum value of two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

Returns:

the maximum value of two absolute scalars

max

public static AbsoluteTemperature max(AbsoluteTemperature a1,
                                      AbsoluteTemperature a2,
                                      AbsoluteTemperature... an)

Return the maximum value of more than two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

an - the other scalars

Returns:

the maximum value of more than two absolute scalars

min

public static AbsoluteTemperature min(AbsoluteTemperature a1,
                                      AbsoluteTemperature a2)

Return the minimum value of two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

Returns:

the minimum value of two absolute scalars

min

public static AbsoluteTemperature min(AbsoluteTemperature a1,
                                      AbsoluteTemperature a2,
                                      AbsoluteTemperature... an)

Return the minimum value of more than two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

an - the other scalars

Returns:

the minimum value of more than two absolute scalars