Package org.djunits.value.vdouble.scalar

Class Illuminance

java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,​S>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar<U,​R>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarRel<IlluminanceUnit,​Illuminance>
org.djunits.value.vdouble.scalar.Illuminance
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Illuminance>, Scalar<IlluminanceUnit,​Illuminance>, Scalar.Rel<IlluminanceUnit,​Illuminance>, ValueFunctions<IlluminanceUnit,​Illuminance>, Relative<IlluminanceUnit,​Illuminance>, Value<IlluminanceUnit,​Illuminance>, DoubleScalarInterface<IlluminanceUnit,​Illuminance>, DoubleScalarInterface.Rel<IlluminanceUnit,​Illuminance>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2020-01-19T15:21:24.964166400Z")
public class Illuminance
extends AbstractDoubleScalarRel<IlluminanceUnit,​Illuminance>
Easy access methods for the Illuminance DoubleScalar, which is relative by definition.

Copyright (c) 2013-2020 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:
Serialized Form

  • Field Details

  • Constructor Details

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

    • 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