Package org.djunits.value.vdouble.scalar

Class Temperature

java.lang.Object

java.lang.Number

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

org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>

org.djunits.value.vdouble.scalar.base.DoubleScalarRel<RU,R>

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

org.djunits.value.vdouble.scalar.Temperature

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Temperature>, Relative<TemperatureUnit,Temperature>, RelWithAbs<AbsoluteTemperatureUnit,AbsoluteTemperature,TemperatureUnit,Temperature>, Value<TemperatureUnit,Temperature>

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

Easy access methods for the Relative Temperature 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 Temperature	NaN	Constant with value NaN.
static final Temperature	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final Temperature	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final Temperature	ONE	Constant with value one.
static final Temperature	POS_MAXVALUE	Constant with value MAX_VALUE.
static final Temperature	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final Temperature	ZERO	Constant with value zero.

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

si

Constructor Summary

Constructors

Constructor	Description
Temperature(double value, TemperatureUnit unit)	Construct Temperature scalar.
Temperature(Temperature value)	Construct Temperature scalar.

Method Summary

Modifier and Type	Method	Description
final Dimensionless	divide(Temperature v)	Calculate the division of Temperature and Temperature, which results in a Dimensionless scalar.
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 Temperature	instantiateSI(double value)	Construct Temperature scalar.
static Temperature	interpolate(Temperature zero, Temperature one, double ratio)	Interpolate between two values.
static Temperature	max(Temperature r1, Temperature r2)	Return the maximum value of two relative scalars.
static Temperature	max(Temperature r1, Temperature r2, Temperature... rn)	Return the maximum value of more than two relative scalars.
static Temperature	min(Temperature r1, Temperature r2)	Return the minimum value of two relative scalars.
static Temperature	min(Temperature r1, Temperature r2, Temperature... rn)	Return the minimum value of more than two relative scalars.
static Temperature	of(double value, String unitString)	Returns a Temperature based on a value and the textual representation of the unit, which can be localized.
SIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
static Temperature	valueOf(String text)	Returns a Temperature representation of a textual representation of a value with a unit.

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

plus

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

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

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

divide, divide, minus, plus, times, times

Methods inherited from interface org.djunits.value.Value

isAbsolute, isRelative

Field Details

ZERO

public static final Temperature ZERO

Constant with value zero.

ONE

public static final Temperature ONE

Constant with value one.

NaN

public static final Temperature NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final Temperature POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Temperature NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Temperature POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Temperature NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

Temperature

public Temperature(double value,
 TemperatureUnit unit)

Construct Temperature scalar.

Parameters:

value - double; double value

unit - TemperatureUnit; unit for the double value

Temperature

public Temperature(Temperature value)

Construct Temperature scalar.

Parameters:

value - Temperature; Scalar from which to construct this instance

Method Details

instantiateRel

public final Temperature instantiateRel(double value,
 TemperatureUnit unit)

Description copied from class: DoubleScalarRel

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

Specified by:

instantiateRel in class DoubleScalarRel<TemperatureUnit,Temperature>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

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

instantiateAbs

public final AbsoluteTemperature instantiateAbs(double value,
 AbsoluteTemperatureUnit unit)

Description copied from class: DoubleScalarRelWithAbs

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

Specified by:

instantiateAbs in class DoubleScalarRelWithAbs<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

instantiateSI

public static final Temperature instantiateSI(double value)

Construct Temperature scalar.

Parameters:

value - double; the double value in SI units

Returns:

Temperature; the new scalar with the SI value

interpolate

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

Interpolate between two values.

Parameters:

zero - Temperature; the low value

one - Temperature; the high value

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

Returns:

Temperature; a Scalar at the ratio between

max

public static Temperature max(Temperature r1,
 Temperature r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - Temperature; the first scalar

r2 - Temperature; the second scalar

Returns:

Temperature; the maximum value of two relative scalars

max

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

Return the maximum value of more than two relative scalars.

Parameters:

r1 - Temperature; the first scalar

r2 - Temperature; the second scalar

rn - Temperature...; the other scalars

Returns:

Temperature; the maximum value of more than two relative scalars

min

public static Temperature min(Temperature r1,
 Temperature r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - Temperature; the first scalar

r2 - Temperature; the second scalar

Returns:

Temperature; the minimum value of two relative scalars

min

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

Return the minimum value of more than two relative scalars.

Parameters:

r1 - Temperature; the first scalar

r2 - Temperature; the second scalar

rn - Temperature...; the other scalars

Returns:

Temperature; the minimum value of more than two relative scalars

valueOf

public static Temperature valueOf(String text)

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

Returns:

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

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

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

divide

public final Dimensionless divide(Temperature v)

Calculate the division of Temperature and Temperature, which results in a Dimensionless scalar.

Parameters:

v - Temperature; scalar

Returns:

Dimensionless; scalar as a division of Temperature and Temperature

reciprocal

public SIScalar reciprocal()

Description copied from class: DoubleScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class DoubleScalarRel<TemperatureUnit,Temperature>

Returns:

DoubleScalar<?>; a new scalar instance with correct SI dimensions