Package org.djunits.value.vfloat.scalar

Class FloatEquivalentDose

    • Constructor Detail

      • FloatEquivalentDose

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

      • FloatEquivalentDose

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

      • FloatEquivalentDose

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

    • Method Detail

      • instantiateRel

        public final FloatEquivalentDose instantiateRel​(float value,
                                                EquivalentDoseUnit 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 FloatEquivalentDose instantiateSI​(float value)
        Construct FloatEquivalentDose scalar.
        Parameters:
        value - float; the float value in SI units
        Returns:
        the new scalar with the SI value

      • interpolate

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

      • valueOf

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