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="2019-10-18T12:12:25.568Z")
public class Temperature
extends AbstractDoubleScalarRelWithAbs<AbsoluteTemperatureUnit,​AbsoluteTemperature,​TemperatureUnit,​Temperature>
Easy access methods for the Relative Temperature DoubleScalar.

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

Author:
Alexander Verbraeck, Peter Knoppers
See Also:
Serialized Form

  • Field Details

  • 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)
      Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
      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)
      Construct a new Absolute Immutable DoubleScalar of the right type. Each extending class must implement this method.
      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 the official 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.
      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