Package org.djunits.value.vfloat.scalar

Class FloatAbsoluteTemperature

    • Constructor Detail

      • FloatAbsoluteTemperature

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

      • FloatAbsoluteTemperature

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

      • FloatAbsoluteTemperature

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

    • Method Detail

      • 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

      • 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 - RU; the unit
        Returns:
        R a new relative instance of the FloatScalar of the right type

      • instantiateSI

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

      • interpolate

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

      • valueOf

        public static FloatAbsoluteTemperature valueOf​(String text)
        Returns a FloatAbsoluteTemperature 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 FloatAbsoluteTemperature
        Returns:
        FloatAbsoluteTemperature; 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 FloatAbsoluteTemperature of​(float value,
                                          String unitString)
        Returns a FloatAbsoluteTemperature 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:
        FloatAbsoluteTemperature; 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