Package org.djunits.value.vfloat.scalar

Class FloatLuminousIntensity

    • Constructor Detail

      • FloatLuminousIntensity

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

      • FloatLuminousIntensity

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

      • FloatLuminousIntensity

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

    • Method Detail

      • instantiateRel

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

      • valueOf

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

      • times

        public final FloatLuminousFlux times​(FloatSolidAngle v)
        Calculate the multiplication of FloatLuminousIntensity and FloatSolidAngle, which results in a FloatLuminousFlux scalar.
        Parameters:
        v - FloatLuminousIntensity scalar
        Returns:
        FloatLuminousFlux scalar as a multiplication of FloatLuminousIntensity and FloatSolidAngle