Package org.djunits.value.vfloat.scalar

Class FloatTemperature

java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,​S>
org.djunits.value.vfloat.scalar.base.AbstractFloatScalar<U,​R>
org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel<RU,​R>
org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRelWithAbs<AbsoluteTemperatureUnit,​FloatAbsoluteTemperature,​TemperatureUnit,​FloatTemperature>
org.djunits.value.vfloat.scalar.FloatTemperature
All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatTemperature>, Scalar<TemperatureUnit,​FloatTemperature>, Scalar.Rel<TemperatureUnit,​FloatTemperature>, Scalar.RelWithAbs<AbsoluteTemperatureUnit,​FloatAbsoluteTemperature,​TemperatureUnit,​FloatTemperature>, ValueFunctions<TemperatureUnit,​FloatTemperature>, Relative<TemperatureUnit,​FloatTemperature>, Value<TemperatureUnit,​FloatTemperature>, FloatScalarInterface<TemperatureUnit,​FloatTemperature>, FloatScalarInterface.Rel<TemperatureUnit,​FloatTemperature>, FloatScalarInterface.RelWithAbs<AbsoluteTemperatureUnit,​FloatAbsoluteTemperature,​TemperatureUnit,​FloatTemperature>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class FloatTemperature
extends AbstractFloatScalarRelWithAbs<AbsoluteTemperatureUnit,​FloatAbsoluteTemperature,​TemperatureUnit,​FloatTemperature>
Easy access methods for the FloatTemperature FloatScalar.

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

    • FloatTemperature

      public FloatTemperature​(float value, TemperatureUnit unit)
      Construct FloatTemperature scalar.
      Parameters:
      value - float; the float value
      unit - TemperatureUnit; unit for the float value

    • FloatTemperature

      public FloatTemperature​(FloatTemperature value)
      Construct FloatTemperature scalar.
      Parameters:
      value - FloatTemperature; Scalar from which to construct this instance

    • FloatTemperature

      public FloatTemperature​(double value, TemperatureUnit unit)
      Construct FloatTemperature scalar using a double value.
      Parameters:
      value - double; the double value
      unit - TemperatureUnit; unit for the resulting float value

  • Method Details

    • instantiateRel

      public final FloatTemperature instantiateRel​(float value, TemperatureUnit unit)
      Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.
      Parameters:
      value - float; the float value
      unit - U; the unit
      Returns:
      R a new relative instance of the FloatScalar of the right type

    • instantiateSI

      public static final FloatTemperature instantiateSI​(float value)
      Construct FloatTemperature scalar.
      Parameters:
      value - float; the float value in SI units
      Returns:
      FloatTemperature; the new scalar with the SI value

    • instantiateAbs

      public final FloatAbsoluteTemperature instantiateAbs​(float value, AbsoluteTemperatureUnit unit)
      Construct a new Absolute Immutable FloatScalar of the right type. Each extending class must implement this method.
      Parameters:
      value - float; the float value
      unit - AU; the absolute unit
      Returns:
      A a new absolute instance of the FloatScalar of the right type

    • interpolate

      public static FloatTemperature interpolate​(FloatTemperature zero, FloatTemperature one, float ratio)
      Interpolate between two values.
      Parameters:
      zero - FloatTemperature; the low value
      one - FloatTemperature; the high value
      ratio - double; the ratio between 0 and 1, inclusive
      Returns:
      FloatTemperature; a Scalar at the ratio between

    • max

      public static FloatTemperature max​(FloatTemperature r1, FloatTemperature r2)
      Return the maximum value of two relative scalars.
      Parameters:
      r1 - FloatTemperature; the first scalar
      r2 - FloatTemperature; the second scalar
      Returns:
      FloatTemperature; the maximum value of two relative scalars

    • max

      public static FloatTemperature max​(FloatTemperature r1, FloatTemperature r2, FloatTemperature... rn)
      Return the maximum value of more than two relative scalars.
      Parameters:
      r1 - FloatTemperature; the first scalar
      r2 - FloatTemperature; the second scalar
      rn - FloatTemperature...; the other scalars
      Returns:
      FloatTemperature; the maximum value of more than two relative scalars

    • min

      public static FloatTemperature min​(FloatTemperature r1, FloatTemperature r2)
      Return the minimum value of two relative scalars.
      Parameters:
      r1 - FloatTemperature; the first scalar
      r2 - FloatTemperature; the second scalar
      Returns:
      FloatTemperature; the minimum value of two relative scalars

    • min

      public static FloatTemperature min​(FloatTemperature r1, FloatTemperature r2, FloatTemperature... rn)
      Return the minimum value of more than two relative scalars.
      Parameters:
      r1 - FloatTemperature; the first scalar
      r2 - FloatTemperature; the second scalar
      rn - FloatTemperature...; the other scalars
      Returns:
      FloatTemperature; the minimum value of more than two relative scalars

    • valueOf

      public static FloatTemperature valueOf​(String text)
      Returns a FloatTemperature 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 FloatTemperature
      Returns:
      FloatTemperature; 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 FloatTemperature of​(float value, String unitString)
      Returns a FloatTemperature 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:
      FloatTemperature; 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 FloatDimensionless divide​(FloatTemperature v)
      Calculate the division of FloatTemperature and FloatTemperature, which results in a FloatDimensionless scalar.
      Parameters:
      v - FloatTemperature scalar
      Returns:
      FloatDimensionless scalar as a division of FloatTemperature and FloatTemperature