Package org.djunits.value.vdouble.scalar

Class Illuminance

    • Field Detail

      • ZERO

        public static final Illuminance ZERO
        Constant with value zero.

      • ONE

        public static final Illuminance ONE
        Constant with value one.

      • NaN

        public static final Illuminance NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final Illuminance POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final Illuminance NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final Illuminance POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final Illuminance NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • Illuminance

        public Illuminance​(double value,
                   IlluminanceUnit unit)
        Construct Illuminance scalar.
        Parameters:
        value - double; the double value
        unit - IlluminanceUnit; unit for the double value

      • Illuminance

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

    • Method Detail

      • instantiateRel

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

      • instantiateSI

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • times

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