org.djunits.value.vfloat.scalar

Class FloatAbsoluteTemperature

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<AU,A>

org.djunits.value.vfloat.scalar.AbstractFloatScalarAbs<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>

org.djunits.value.vfloat.scalar.FloatAbsoluteTemperature

All Implemented Interfaces:

Serializable, Comparable<FloatAbsoluteTemperature>, Absolute, MathFunctionsAbs<FloatAbsoluteTemperature>, Value<AbsoluteTemperatureUnit>, FloatMathFunctions<FloatAbsoluteTemperature>, FloatScalarInterface

public class FloatAbsoluteTemperature
extends AbstractFloatScalarAbs<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>

Easy access methods for the AbsoluteTemperature FloatScalar. Instead of:

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

we can now write:

 FloatAbsoluteTemperature value = new FloatAbsoluteTemperature(100.0, AbsoluteTemperatureUnit.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-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.
All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2019-02-27 23:44:43 +0100 (Wed, 27 Feb 2019) $, @version $Revision: 333 $, 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 FloatAbsoluteTemperature	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

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

Constructor Summary

Constructors

Constructor and Description
FloatAbsoluteTemperature(double value, AbsoluteTemperatureUnit unit) Construct FloatAbsoluteTemperature scalar using a double value.
FloatAbsoluteTemperature(FloatAbsoluteTemperature value) Construct FloatAbsoluteTemperature scalar.
FloatAbsoluteTemperature(float value, AbsoluteTemperatureUnit unit) Construct FloatAbsoluteTemperature scalar.

Method Summary

Modifier and Type	Method and Description
static FloatAbsoluteTemperature	createSI(float value) Construct FloatAbsoluteTemperature scalar.
FloatAbsoluteTemperature	instantiateAbs(float value, AbsoluteTemperatureUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.
FloatTemperature	instantiateRel(float value, TemperatureUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatAbsoluteTemperature	interpolate(FloatAbsoluteTemperature zero, FloatAbsoluteTemperature one, float ratio) Interpolate between two values.
static FloatAbsoluteTemperature	max(FloatAbsoluteTemperature a1, FloatAbsoluteTemperature a2) Return the maximum value of two absolute scalars.
static FloatAbsoluteTemperature	max(FloatAbsoluteTemperature a1, FloatAbsoluteTemperature a2, FloatAbsoluteTemperature... an) Return the maximum value of more than two absolute scalars.
static FloatAbsoluteTemperature	min(FloatAbsoluteTemperature a1, FloatAbsoluteTemperature a2) Return the minimum value of two absolute scalars.
static FloatAbsoluteTemperature	min(FloatAbsoluteTemperature a1, FloatAbsoluteTemperature a2, FloatAbsoluteTemperature... an) Return the minimum value of more than two absolute scalars.
static FloatAbsoluteTemperature	valueOf(String text) Returns a FloatAbsoluteTemperature representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalarAbs

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

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

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.vfloat.FloatMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final FloatAbsoluteTemperature ZERO

constant with value zero.

Constructor Detail

FloatAbsoluteTemperature

public FloatAbsoluteTemperature(float value,
                                AbsoluteTemperatureUnit unit)

Construct FloatAbsoluteTemperature scalar.

Parameters:

value - float value

unit - unit for the float value

FloatAbsoluteTemperature

public FloatAbsoluteTemperature(double value,
                                AbsoluteTemperatureUnit unit)

Construct FloatAbsoluteTemperature scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

FloatAbsoluteTemperature

public FloatAbsoluteTemperature(FloatAbsoluteTemperature value)

Construct FloatAbsoluteTemperature scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateAbs

public final FloatAbsoluteTemperature instantiateAbs(float value,
                                                     AbsoluteTemperatureUnit unit)

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

Specified by:

instantiateAbs in class AbstractFloatScalarAbs<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>

Parameters:

value - float; the float value

unit - AU; the unit

Returns:

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

instantiateRel

public final FloatTemperature instantiateRel(float value,
                                             TemperatureUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarAbs<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>

Parameters:

value - float; the float value

unit - RU; the unit

Returns:

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

createSI

public static final FloatAbsoluteTemperature createSI(float value)

Construct FloatAbsoluteTemperature scalar.

Parameters:

value - float value in BASE units

Returns:

the new scalar with the BASE value

interpolate

public static FloatAbsoluteTemperature interpolate(FloatAbsoluteTemperature zero,
                                                   FloatAbsoluteTemperature one,
                                                   float 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 FloatAbsoluteTemperature max(FloatAbsoluteTemperature a1,
                                           FloatAbsoluteTemperature 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 FloatAbsoluteTemperature max(FloatAbsoluteTemperature a1,
                                           FloatAbsoluteTemperature a2,
                                           FloatAbsoluteTemperature... 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 FloatAbsoluteTemperature min(FloatAbsoluteTemperature a1,
                                           FloatAbsoluteTemperature 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 FloatAbsoluteTemperature min(FloatAbsoluteTemperature a1,
                                           FloatAbsoluteTemperature a2,
                                           FloatAbsoluteTemperature... 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 FloatAbsoluteTemperature valueOf(String text)
                                        throws IllegalArgumentException

Returns a FloatAbsoluteTemperature 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 FloatAbsoluteTemperature

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