Package org.djunits.value.vfloat.scalar

Class FloatAbsoluteTemperature

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vfloat.scalar.base.FloatScalar<AU,A>

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

org.djunits.value.vfloat.scalar.FloatAbsoluteTemperature

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatAbsoluteTemperature>, Absolute<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>, Value<AbsoluteTemperatureUnit,FloatAbsoluteTemperature>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatAbsoluteTemperature
extends FloatScalarAbs<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>

Easy access methods for the FloatAbsoluteTemperature FloatScalar.

Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.
All rights reserved.
BSD-style license. See DJUNITS License.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final FloatAbsoluteTemperature	ZERO	Constant with value zero.

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

si

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final FloatAbsoluteTemperature	instantiateAbs(float value, AbsoluteTemperatureUnit unit)	Construct a new Absolute Immutable FloatScalar of the right type.
final FloatTemperature	instantiateRel(float value, TemperatureUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static final FloatAbsoluteTemperature	instantiateSI(float value)	Construct FloatAbsoluteTemperature scalar.
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	of(float value, String unitString)	Returns a FloatAbsoluteTemperature based on a value and the textual representation of the unit, which can be localized.
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.base.FloatScalarAbs

abs, ceil, floor, minus, minus, neg, plus, rint

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

compareTo, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

Methods inherited from class org.djunits.value.base.Scalar

format, format, getDisplayUnit, setDisplayUnit

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

isAbsolute, isRelative

Field Details

ZERO

public static final FloatAbsoluteTemperature ZERO

Constant with value zero.

Constructor Details

FloatAbsoluteTemperature

public FloatAbsoluteTemperature(float value,
 AbsoluteTemperatureUnit unit)

Construct FloatAbsoluteTemperature scalar.

Parameters:

value - float; the float value

unit - AbsoluteTemperatureUnit; unit for the float value

FloatAbsoluteTemperature

public FloatAbsoluteTemperature(double value,
 AbsoluteTemperatureUnit unit)

Construct FloatAbsoluteTemperature scalar using a double value.

Parameters:

value - double; the double value

unit - AbsoluteTemperatureUnit; unit for the resulting float value

FloatAbsoluteTemperature

public FloatAbsoluteTemperature(FloatAbsoluteTemperature value)

Construct FloatAbsoluteTemperature scalar.

Parameters:

value - FloatAbsoluteTemperature; Scalar from which to construct this instance

Method Details

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 FloatScalarAbs<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>

Parameters:

value - float; the float value

unit - AU; the absolute 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 FloatScalarAbs<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

instantiateSI

public static final FloatAbsoluteTemperature instantiateSI(float value)

Construct FloatAbsoluteTemperature scalar.

Parameters:

value - float; the float value in BASE units

Returns:

FloatAbsoluteTemperature; the new scalar with the BASE value

interpolate

public static FloatAbsoluteTemperature interpolate(FloatAbsoluteTemperature zero,
 FloatAbsoluteTemperature one,
 float ratio)

Interpolate between two values.

Parameters:

zero - FloatAbsoluteTemperature; the low value

one - FloatAbsoluteTemperature; the high value

ratio - float; the ratio between 0 and 1, inclusive

Returns:

FloatAbsoluteTemperature; 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 - FloatAbsoluteTemperature; the first scalar

a2 - FloatAbsoluteTemperature; the second scalar

Returns:

FloatAbsoluteTemperature; 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 - FloatAbsoluteTemperature; the first scalar

a2 - FloatAbsoluteTemperature; the second scalar

an - FloatAbsoluteTemperature...; the other scalars

Returns:

FloatAbsoluteTemperature; 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 - FloatAbsoluteTemperature; the first scalar

a2 - FloatAbsoluteTemperature; the second scalar

Returns:

FloatAbsoluteTemperature; 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 - FloatAbsoluteTemperature; the first scalar

a2 - FloatAbsoluteTemperature; the second scalar

an - FloatAbsoluteTemperature...; the other scalars

Returns:

FloatAbsoluteTemperature; the minimum value of more than two absolute scalars

valueOf

public static FloatAbsoluteTemperature valueOf(String text)

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 a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.

Parameters:

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

Returns:

FloatAbsoluteTemperature; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static FloatAbsoluteTemperature of(float value,
 String unitString)

Returns a FloatAbsoluteTemperature based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

FloatAbsoluteTemperature; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the unit cannot be parsed or is incorrect

NullPointerException - when the unitString argument is null