org.djunits.value.vfloat.scalar

Class FloatTemperature

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.FloatScalar<U>

org.djunits.value.vfloat.scalar.FloatScalar.Rel<U>

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

org.djunits.value.vfloat.scalar.FloatTemperature

All Implemented Interfaces:

Serializable, Comparable<FloatScalar.Rel<TemperatureUnit>>, MathFunctionsAbs<FloatScalar.Rel<TemperatureUnit>>, MathFunctionsRel<FloatScalar.Rel<TemperatureUnit>>, Relative, Value<TemperatureUnit>, FloatMathFunctions<FloatScalar<TemperatureUnit>>

public class FloatTemperature
extends TypedFloatScalarRel<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-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.
All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2016-05-28 14:25:52 +0200 (Sat, 28 May 2016) $, @version $Revision: 202 $, 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.vfloat.scalar.FloatScalar

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

Field Summary

Fields

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

Fields inherited from class org.djunits.value.vfloat.scalar.FloatScalar.Rel

si

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

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, 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
FloatDimensionless	divideBy(FloatTemperature v) Calculate the division of FloatTemperature and FloatTemperature, which results in a FloatDimensionless scalar.
protected FloatAbsoluteTemperature	instantiateTypeAbs(float value, TemperatureUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.
protected FloatTemperature	instantiateTypeRel(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.
FloatAbsoluteTemperature	toAbs() Translate the relative scalar into an absolute scalar (e.g., before or after a multiplication or division).

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

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

Methods inherited from class org.djunits.value.vfloat.scalar.FloatScalar.Rel

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

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

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

DIV, MULT, POW

Field Detail

ZERO

public static final FloatTemperature ZERO

constant with value zero.

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

instantiateTypeRel

protected final FloatTemperature instantiateTypeRel(float value,
                                                    TemperatureUnit unit)

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

Specified by:

instantiateTypeRel in class TypedFloatScalarRel<TemperatureUnit,FloatTemperature>

Parameters:

value - the float value

unit - the unit

Returns:

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

instantiateTypeAbs

protected final FloatAbsoluteTemperature instantiateTypeAbs(float value,
                                                            TemperatureUnit 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

toAbs

public final FloatAbsoluteTemperature toAbs()

Translate the relative scalar into an absolute scalar (e.g., before or after a multiplication or division).

Returns:

an absolute version of this temperature scalar.

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

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