Temperature (DJUNITS 3.00.07 API)

java.lang.Object
- java.lang.Number
- - org.djunits.value.Scalar<U>
  - - org.djunits.value.vdouble.scalar.AbstractDoubleScalar<U,R>
    - - org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<TemperatureUnit,Temperature>
      - org.djunits.value.vdouble.scalar.Temperature

All Implemented Interfaces:

Serializable, Comparable<Temperature>, MathFunctionsAbs<Temperature>, MathFunctionsRel<Temperature>, Relative, Value<TemperatureUnit>, DoubleMathFunctions<Temperature>, DoubleScalarInterface
```
public class Temperature
extends AbstractDoubleScalarRel<TemperatureUnit,Temperature>
```
Easy access methods for the Relative Temperature DoubleScalar. Instead of:
```
 DoubleScalar<TemperatureUnit> value = new DoubleScalar<TemperatureUnit>(100.0, TemperatureUnit.SI);
 
```
we can now write:
```
 Temperature value = new Temperature(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-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.
All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2018-01-28 03:17:44 +0100 (Sun, 28 Jan 2018) $, @version $Revision: 256 $, by $Author: averbraeck $, initial version Sep 1, 2015
Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and 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`	`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.AbstractDoubleScalar
si

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions
ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors
Constructor and 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 and Description
`static Temperature`	`createSI(double value)` Construct Temperature scalar.
`Dimensionless`	`divideBy(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`	`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.
`AbsoluteTemperature`	`plus(AbsoluteTemperature v)` Relative scalar plus Absolute scalar = Absolute scalar.

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel
abs, ceil, divideBy, floor, minus, multiplyBy, neg, plus, rint, round

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar
compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar
expressAsSIUnit, expressAsSpecifiedUnit, getUnit, 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 org.djunits.value.vdouble.DoubleMathFunctions
DIV, MULT, POW

- Field Detail
  - ZERO
```
public static final Temperature ZERO
```
    constant with value zero.
  - 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 value
    
    unit - unit for the double value
  - Temperature
```
public Temperature(Temperature value)
```
    Construct Temperature scalar.
    
    Parameters:
    
    value - 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.
    
    Specified by:
    
    instantiateRel in class AbstractDoubleScalarRel<TemperatureUnit,Temperature>
    
    Parameters:
    
    value - the double value
    
    unit - 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 - the double value
    
    unit - the unit
    
    Returns:
    
    A a new absolute instance of the DoubleScalar of the right type
  - createSI
```
public static final Temperature createSI(double value)
```
    Construct Temperature scalar.
    
    Parameters:
    
    value - double value in SI units
    
    Returns:
    
    the new scalar with the SI value
  - interpolate
```
public static Temperature interpolate(Temperature zero,
                                      Temperature one,
                                      double 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 AbsoluteTemperature plus(AbsoluteTemperature 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
  - max
```
public static Temperature max(Temperature r1,
                              Temperature 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 Temperature max(Temperature r1,
                              Temperature r2,
                              Temperature... 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 Temperature min(Temperature r1,
                              Temperature 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 Temperature min(Temperature r1,
                              Temperature r2,
                              Temperature... 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 Dimensionless divideBy(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

Class Temperature

Field Summary

Fields inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

Constructor Summary

Method Summary

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

Methods inherited from class org.djunits.value.Scalar

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Methods inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

Field Detail

ZERO

NaN

POSITIVE_INFINITY

NEGATIVE_INFINITY

POS_MAXVALUE

NEG_MAXVALUE

Constructor Detail

Temperature

Temperature

Method Detail

instantiateRel

instantiateAbs

createSI

interpolate

plus

max

max

min

min

divideBy