Package org.djunits.value.vdouble.scalar

Class Illuminance

java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>
org.djunits.value.vdouble.scalar.base.DoubleScalarRel<IlluminanceUnit,Illuminance>
org.djunits.value.vdouble.scalar.Illuminance
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Illuminance>, Relative<IlluminanceUnit,Illuminance>, Value<IlluminanceUnit,Illuminance>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2025-09-06T15:16:28.380798Z") public class Illuminance extends DoubleScalarRel<IlluminanceUnit,Illuminance>
Easy access methods for the Illuminance DoubleScalar, which is relative by definition.

Copyright (c) 2013-2025 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:
Alexander Verbraeck, Peter Knoppers
See Also:

  • Field Details

    • 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 Details

    • Illuminance

      public Illuminance(double value, IlluminanceUnit unit)
      Construct Illuminance scalar with a unit.
      Parameters:
      value - the double value, expressed in the given unit
      unit - unit for the double value

    • Illuminance

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

  • Method Details

    • instantiateRel

      public final Illuminance instantiateRel(double value, IlluminanceUnit unit)
      Description copied from class: DoubleScalarRel
      Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
      Specified by:
      instantiateRel in class DoubleScalarRel<IlluminanceUnit,Illuminance>
      Parameters:
      value - the double value
      unit - the unit
      Returns:
      R a new relative instance of the DoubleScalar of the right type

    • ofSI

      public static final Illuminance ofSI(double value)
      Construct Illuminance scalar based on an SI value.
      Parameters:
      value - the double value in SI units
      Returns:
      the new scalar with the SI value

    • interpolate

      public static Illuminance interpolate(Illuminance zero, Illuminance one, double ratio)
      Interpolate between two values. Note that the first value does not have to be smaller than the second.
      Parameters:
      zero - the value at a ratio of zero
      one - the value at a ratio of one
      ratio - the ratio between 0 and 1, inclusive
      Returns:
      a Illuminance at the given ratio between 0 and 1

    • max

      public static Illuminance max(Illuminance r1, Illuminance r2)
      Return the maximum value of two relative scalars.
      Parameters:
      r1 - the first scalar
      r2 - the second scalar
      Returns:
      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 - the first scalar
      r2 - the second scalar
      rn - the other scalars
      Returns:
      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 - the first scalar
      r2 - the second scalar
      Returns:
      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 - the first scalar
      r2 - the second scalar
      rn - the other scalars
      Returns:
      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 a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.
      Parameters:
      text - the textual representation to parse into a Illuminance
      Returns:
      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, which can be localized.
      Parameters:
      value - the value to use
      unitString - the textual representation of the unit
      Returns:
      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 - scalar
      Returns:
      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 - scalar
      Returns:
      scalar as a multiplication of Illuminance and Area

    • reciprocal

      public SIScalar reciprocal()
      Description copied from class: DoubleScalarRel
      Create the reciprocal of this scalar with the correct dimensions.
      Overrides:
      reciprocal in class DoubleScalarRel<IlluminanceUnit,Illuminance>
      Returns:
      a new scalar instance with correct SI dimensions

    • multiply

      public static Illuminance multiply(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)
      Multiply two scalars that result in a scalar of type Illuminance.
      Parameters:
      scalar1 - the first scalar
      scalar2 - the second scalar
      Returns:
      the multiplication of both scalars as an instance of Illuminance

    • divide

      public static Illuminance divide(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)
      Divide two scalars that result in a scalar of type Illuminance.
      Parameters:
      scalar1 - the first scalar
      scalar2 - the second scalar
      Returns:
      the division of scalar1 by scalar2 as an instance of Illuminance