org.djunits.value.vdouble.scalar

Class AbsoluteTemperature

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.AbstractDoubleScalar<AU,A>

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

org.djunits.value.vdouble.scalar.AbsoluteTemperature

All Implemented Interfaces:

Serializable, Comparable<AbsoluteTemperature>, Absolute, MathFunctionsAbs<AbsoluteTemperature>, Value<AbsoluteTemperatureUnit>, DoubleMathFunctions<AbsoluteTemperature>, DoubleScalarInterface

public class AbsoluteTemperature
extends AbstractDoubleScalarAbs<AbsoluteTemperatureUnit,AbsoluteTemperature,TemperatureUnit,Temperature>

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

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

we can now write:

 AbsoluteTemperature value = new AbsoluteTemperature(100.0, AbsoluteTemperatureUnit.BASE);
 

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

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.AbstractDoubleScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static AbsoluteTemperature	createSI(double value) Construct %TypeAbsl% scalar.
AbsoluteTemperature	instantiateAbs(double value, AbsoluteTemperatureUnit unit) Construct a new Absolute Immutable DoubleScalar of the right type.
Temperature	instantiateRel(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.
static AbsoluteTemperature	valueOf(String text) Returns a AbsoluteTemperature representation of a textual representation of a value with a unit.

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

ceil, divideBy, floor, minus, minus, multiplyBy, plus, rint, round

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

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

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,
                           AbsoluteTemperatureUnit 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

instantiateAbs

public final AbsoluteTemperature instantiateAbs(double value,
                                                AbsoluteTemperatureUnit unit)

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

Specified by:

instantiateAbs in class AbstractDoubleScalarAbs<AbsoluteTemperatureUnit,AbsoluteTemperature,TemperatureUnit,Temperature>

Parameters:

value - double; the double value

unit - AU; the unit

Returns:

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

instantiateRel

public final Temperature instantiateRel(double value,
                                        TemperatureUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarAbs<AbsoluteTemperatureUnit,AbsoluteTemperature,TemperatureUnit,Temperature>

Parameters:

value - double; the double value

unit - RU; the unit

Returns:

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

createSI

public static final AbsoluteTemperature createSI(double value)

Construct %TypeAbsl% scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

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

valueOf

public static AbsoluteTemperature valueOf(String text)
                                   throws IllegalArgumentException

Returns a AbsoluteTemperature representation of a textual representation of a value with a unit. The String representation that can be parsed is the double value in the unit, followed by the official abbreviation of the unit. Spaces are allowed, but not necessary, between the value and the unit.

Parameters:

text - String; the textual representation to parse into a AbsoluteTemperature

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

Throws:

IllegalArgumentException - when the text cannot be parsed