Package org.djunits.value.vfloat.scalar

Class FloatAmountOfSubstance

    • Constructor Detail

      • FloatAmountOfSubstance

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

      • FloatAmountOfSubstance

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

      • FloatAmountOfSubstance

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

    • Method Detail

      • instantiateRel

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

      • valueOf

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

      • divide

        public final FloatDuration divide​(FloatCatalyticActivity v)
        Calculate the division of FloatAmountOfSubstance and FloatCatalyticActivity, which results in a FloatDuration scalar.
        Parameters:
        v - FloatAmountOfSubstance; scalar
        Returns:
        FloatDuration; scalar as a division of FloatAmountOfSubstance and FloatCatalyticActivity

      • divide

        public final FloatCatalyticActivity divide​(FloatDuration v)
        Calculate the division of FloatAmountOfSubstance and FloatDuration, which results in a FloatCatalyticActivity scalar.
        Parameters:
        v - FloatAmountOfSubstance; scalar
        Returns:
        FloatCatalyticActivity; scalar as a division of FloatAmountOfSubstance and FloatDuration