Package org.djunits.value.vdouble.scalar
Class Temperature
- java.lang.Object
-
- java.lang.Number
-
- org.djunits.value.AbstractScalar<U,S>
-
- org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar<U,R>
-
- org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel<RU,R>
-
- org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRelWithAbs<AbsoluteTemperatureUnit,AbsoluteTemperature,TemperatureUnit,Temperature>
-
- org.djunits.value.vdouble.scalar.Temperature
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Temperature>
,Scalar<TemperatureUnit,Temperature>
,Scalar.Rel<TemperatureUnit,Temperature>
,Scalar.RelWithAbs<AbsoluteTemperatureUnit,AbsoluteTemperature,TemperatureUnit,Temperature>
,ValueFunctions<TemperatureUnit,Temperature>
,Relative<TemperatureUnit,Temperature>
,Value<TemperatureUnit,Temperature>
,DoubleScalarInterface<TemperatureUnit,Temperature>
,DoubleScalarInterface.Rel<TemperatureUnit,Temperature>
,DoubleScalarInterface.RelWithAbs<AbsoluteTemperatureUnit,AbsoluteTemperature,TemperatureUnit,Temperature>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2023-04-30T13:59:27.633664900Z") public class Temperature extends AbstractDoubleScalarRelWithAbs<AbsoluteTemperatureUnit,AbsoluteTemperature,TemperatureUnit,Temperature>
Easy access methods for the Relative Temperature DoubleScalar.Copyright (c) 2013-2023 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
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.djunits.value.vdouble.scalar.base.DoubleScalarInterface
DoubleScalarInterface.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends DoubleScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends DoubleScalarInterface.RelWithAbs<AU,A,RU,R>>, DoubleScalarInterface.Rel<U extends Unit<U>,R extends DoubleScalarInterface.Rel<U,R>>, DoubleScalarInterface.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends DoubleScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends DoubleScalarInterface.RelWithAbs<AU,A,RU,R>>
-
Nested classes/interfaces inherited from interface org.djunits.value.base.Scalar
Scalar.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>, Scalar.Rel<U extends Unit<U>,R extends Scalar.Rel<U,R>>, Scalar.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>
-
-
Field Summary
Fields Modifier and Type Field Description static Temperature
NaN
Constant with value NaN.static Temperature
NEG_MAXVALUE
Constant with value -MAX_VALUE.static Temperature
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY.static Temperature
ONE
Constant with value one.static Temperature
POS_MAXVALUE
Constant with value MAX_VALUE.static Temperature
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY.static Temperature
ZERO
Constant with value zero.-
Fields inherited from class org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar
si
-
-
Constructor Summary
Constructors Constructor Description Temperature(double value, TemperatureUnit unit)
Construct Temperature scalar.Temperature(Temperature value)
Construct Temperature scalar.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Dimensionless
divide(Temperature v)
Calculate the division of Temperature and Temperature, which results in a Dimensionless scalar.AbsoluteTemperature
instantiateAbs(double value, AbsoluteTemperatureUnit unit)
Construct a new Absolute Immutable DoubleScalar of the right type.Temperature
instantiateRel(double value, TemperatureUnit unit)
Construct a new Relative Immutable DoubleScalar of the right type.static 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.AbstractDoubleScalarRelWithAbs
plus
-
Methods inherited from class org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel
abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times
-
Methods inherited from class org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar
compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString
-
Methods inherited from class org.djunits.value.AbstractScalar
getDisplayUnit, isAbsolute, isRelative, 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 java.lang.Comparable
compareTo
-
Methods inherited from interface org.djunits.value.vdouble.scalar.base.DoubleScalarInterface
getInUnit, getInUnit, getSI
-
Methods inherited from interface org.djunits.value.base.Scalar
eq, eq0, format, format, ge, ge0, gt, gt0, le, le0, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toTextualString, toTextualString
-
Methods inherited from interface org.djunits.value.base.Scalar.Rel
minus, plus
-
Methods inherited from interface org.djunits.value.Value
getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString
-
-
-
-
Field Detail
-
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 Detail
-
Temperature
public Temperature(double value, TemperatureUnit unit)
Construct Temperature scalar.- Parameters:
value
- double; double valueunit
- 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 Detail
-
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.- Parameters:
value
- double; the double valueunit
- RU; the unit- Returns:
- R a new relative instance of the DoubleScalar of the right type
-
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.- Parameters:
value
- double; the double valueunit
- 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 valueone
- Temperature; the high valueratio
- 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 scalarr2
- 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 scalarr2
- Temperature; the second scalarrn
- 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 scalarr2
- 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 scalarr2
- Temperature; the second scalarrn
- 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 parsedNullPointerException
- 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 useunitString
- 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 incorrectNullPointerException
- 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()
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocal
in classAbstractDoubleScalarRel<TemperatureUnit,Temperature>
- Returns:
- DoubleScalar<?>; a new scalar instance with correct SI dimensions
-
-