Package org.djunits.value.vfloat.scalar

Class FloatLuminousFlux

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<LuminousFluxUnit,​FloatLuminousFlux>
org.djunits.value.vfloat.scalar.FloatLuminousFlux
All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatLuminousFlux>, Scalar<LuminousFluxUnit,​FloatLuminousFlux>, Scalar.Rel<LuminousFluxUnit,​FloatLuminousFlux>, ValueFunctions<LuminousFluxUnit,​FloatLuminousFlux>, Relative<LuminousFluxUnit,​FloatLuminousFlux>, Value<LuminousFluxUnit,​FloatLuminousFlux>, FloatScalarInterface<LuminousFluxUnit,​FloatLuminousFlux>, FloatScalarInterface.Rel<LuminousFluxUnit,​FloatLuminousFlux>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class FloatLuminousFlux
extends AbstractFloatScalarRel<LuminousFluxUnit,​FloatLuminousFlux>
Easy access methods for the FloatLuminousFlux 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

    • FloatLuminousFlux

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

    • FloatLuminousFlux

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

    • FloatLuminousFlux

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

  • Method Details

    • instantiateRel

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

    • interpolate

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

    • divide

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

    • divide

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

    • divide

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

    • divide

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