Package org.djunits.value.vfloat.scalar

Class FloatIlluminance

java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,​S>
org.djunits.value.vfloat.scalar.base.AbstractFloatScalar<U,​R>
org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel<IlluminanceUnit,​FloatIlluminance>
org.djunits.value.vfloat.scalar.FloatIlluminance
All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatIlluminance>, Scalar<IlluminanceUnit,​FloatIlluminance>, Scalar.Rel<IlluminanceUnit,​FloatIlluminance>, ValueFunctions<IlluminanceUnit,​FloatIlluminance>, Relative<IlluminanceUnit,​FloatIlluminance>, Value<IlluminanceUnit,​FloatIlluminance>, FloatScalarInterface<IlluminanceUnit,​FloatIlluminance>, FloatScalarInterface.Rel<IlluminanceUnit,​FloatIlluminance>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class FloatIlluminance
extends AbstractFloatScalarRel<IlluminanceUnit,​FloatIlluminance>
Easy access methods for the FloatIlluminance FloatScalar, which is relative by definition.

Copyright (c) 2013-2019 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

    • FloatIlluminance

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

    • FloatIlluminance

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

    • FloatIlluminance

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

  • Method Details

    • instantiateRel

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

    • interpolate

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

    • max

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

    • times

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