org.djunits.value.vfloat.scalar

Class FloatTemperature

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<U,R>

org.djunits.value.vfloat.scalar.AbstractFloatScalarRel<TemperatureUnit,FloatTemperature>

org.djunits.value.vfloat.scalar.FloatTemperature

All Implemented Interfaces:

Serializable, Comparable<FloatTemperature>, MathFunctionsAbs<FloatTemperature>, MathFunctionsRel<FloatTemperature>, Relative, Value<TemperatureUnit>, FloatMathFunctions<FloatTemperature>, FloatScalarInterface

public class FloatTemperature
extends AbstractFloatScalarRel<TemperatureUnit,FloatTemperature>

Easy access methods for the %Type% FloatScalar. Instead of:

 FloatScalar.Rel<TemperatureUnit> value = new FloatScalar.Rel<TemperatureUnit>(100.0, TemperatureUnit.SI);
 

we can now write:

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

$LastChangedDate: 2019-03-03 00:53:50 +0100 (Sun, 03 Mar 2019) $, @version $Revision: 349 $, 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 FloatTemperature	NaN constant with value NaN.
static FloatTemperature	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatTemperature	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatTemperature	POS_MAXVALUE constant with value MAX_VALUE.
static FloatTemperature	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatTemperature	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
FloatTemperature(double value, TemperatureUnit unit) Construct FloatTemperature scalar using a double value.
FloatTemperature(FloatTemperature value) Construct FloatTemperature scalar.
FloatTemperature(float value, TemperatureUnit unit) Construct FloatTemperature scalar.

Method Summary

Modifier and Type	Method and Description
static FloatTemperature	createSI(float value) Construct FloatTemperature scalar.
FloatDimensionless	divideBy(FloatTemperature v) Calculate the division of FloatTemperature and FloatTemperature, which results in a FloatDimensionless 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 FloatTemperature	interpolate(FloatTemperature zero, FloatTemperature one, float ratio) Interpolate between two values.
static FloatTemperature	max(FloatTemperature r1, FloatTemperature r2) Return the maximum value of two relative scalars.
static FloatTemperature	max(FloatTemperature r1, FloatTemperature r2, FloatTemperature... rn) Return the maximum value of more than two relative scalars.
static FloatTemperature	min(FloatTemperature r1, FloatTemperature r2) Return the minimum value of two relative scalars.
static FloatTemperature	min(FloatTemperature r1, FloatTemperature r2, FloatTemperature... rn) Return the minimum value of more than two relative scalars.
FloatAbsoluteTemperature	plus(FloatAbsoluteTemperature v) Relative scalar plus Absolute scalar = Absolute scalar.
static FloatTemperature	valueOf(String text) Returns a FloatTemperature representation of a textual representation of a value with a unit.

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

abs, ceil, divideBy, floor, minus, multiplyBy, neg, 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 FloatTemperature ZERO

constant with value zero.

NaN

public static final FloatTemperature NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatTemperature POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatTemperature NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatTemperature POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatTemperature NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatTemperature

public FloatTemperature(float value,
                        TemperatureUnit unit)

Construct FloatTemperature scalar.

Parameters:

value - float value

unit - unit for the float value

FloatTemperature

public FloatTemperature(FloatTemperature value)

Construct FloatTemperature scalar.

Parameters:

value - Scalar from which to construct this instance

FloatTemperature

public FloatTemperature(double value,
                        TemperatureUnit unit)

Construct FloatTemperature scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

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 AbstractFloatScalarRel<TemperatureUnit,FloatTemperature>

Parameters:

value - float; the float value

unit - U; the unit

Returns:

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

createSI

public static final FloatTemperature createSI(float value)

Construct FloatTemperature scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

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.

Parameters:

value - the float value

unit - the unit

Returns:

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

interpolate

public static FloatTemperature interpolate(FloatTemperature zero,
                                           FloatTemperature 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

plus

public final FloatAbsoluteTemperature plus(FloatAbsoluteTemperature v)

Relative scalar plus Absolute scalar = Absolute scalar.

Parameters:

v - the value to add

Returns:

sum of this value and v as a new object

max

public static FloatTemperature max(FloatTemperature r1,
                                   FloatTemperature r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the maximum value of two relative scalars

max

public static FloatTemperature max(FloatTemperature r1,
                                   FloatTemperature r2,
                                   FloatTemperature... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the maximum value of more than two relative scalars

min

public static FloatTemperature min(FloatTemperature r1,
                                   FloatTemperature r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the minimum value of two relative scalars

min

public static FloatTemperature min(FloatTemperature r1,
                                   FloatTemperature r2,
                                   FloatTemperature... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two relative scalars

valueOf

public static FloatTemperature valueOf(String text)
                                throws IllegalArgumentException

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

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

divideBy

public final FloatDimensionless divideBy(FloatTemperature v)

Calculate the division of FloatTemperature and FloatTemperature, which results in a FloatDimensionless scalar.

Parameters:

v - FloatTemperature scalar

Returns:

FloatDimensionless scalar as a division of FloatTemperature and FloatTemperature