Package org.djunits.value.vdouble.scalar

Class AbsoluteTemperature

java.lang.Object

java.lang.Number

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

org.djunits.value.vdouble.scalar.base.DoubleScalar<AU,A>

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

org.djunits.value.vdouble.scalar.AbsoluteTemperature

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AbsoluteTemperature>, Absolute<AbsoluteTemperatureUnit,AbsoluteTemperature,TemperatureUnit,Temperature>, Value<AbsoluteTemperatureUnit,AbsoluteTemperature>

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

Easy access methods for the Absolute AbsoluteTemperature DoubleScalar.

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 AbsoluteTemperature	ZERO	Constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

si

Constructor Summary

Constructors

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

Method Summary

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

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

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

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 AbsoluteTemperature ZERO

Constant with value zero.

Constructor Details

AbsoluteTemperature

public AbsoluteTemperature(double value,
 AbsoluteTemperatureUnit unit)

Construct AbsoluteTemperature scalar.

Parameters:

value - double; value

unit - AbsoluteTemperatureUnit; unit for the double value

AbsoluteTemperature

public AbsoluteTemperature(AbsoluteTemperature value)

Construct AbsoluteTemperature scalar.

Parameters:

value - AbsoluteTemperature; Scalar from which to construct this instance

Method Details

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 DoubleScalarAbs<AbsoluteTemperatureUnit,AbsoluteTemperature,TemperatureUnit,Temperature>

Parameters:

value - double; the double value

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

instantiateSI

public static final AbsoluteTemperature instantiateSI(double value)

Construct AbsoluteTemperature scalar.

Parameters:

value - double; value in SI units

Returns:

AbsoluteTemperature; the new scalar with the SI value

interpolate

public static AbsoluteTemperature interpolate(AbsoluteTemperature zero,
 AbsoluteTemperature one,
 double ratio)

Interpolate between two values.

Parameters:

zero - AbsoluteTemperature; the low value

one - AbsoluteTemperature; the high value

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

Returns:

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

a2 - AbsoluteTemperature; the second scalar

Returns:

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

a2 - AbsoluteTemperature; the second scalar

an - AbsoluteTemperature...; 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 - AbsoluteTemperature; the first scalar

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

a2 - AbsoluteTemperature; the second scalar

an - AbsoluteTemperature...; the other scalars

Returns:

the minimum value of more than two absolute scalars

valueOf

public static AbsoluteTemperature valueOf(String text)

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

Returns:

AbsoluteTemperature; 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 AbsoluteTemperature of(double value,
 String unitString)

Returns a AbsoluteTemperature 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:

AbsoluteTemperature; 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