Package org.djunits.value.vfloat.scalar

Class FloatSolidAngle

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<SolidAngleUnit,​FloatSolidAngle>
org.djunits.value.vfloat.scalar.FloatSolidAngle
All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatSolidAngle>, Scalar<SolidAngleUnit,​FloatSolidAngle>, Scalar.Rel<SolidAngleUnit,​FloatSolidAngle>, ValueFunctions<SolidAngleUnit,​FloatSolidAngle>, Relative<SolidAngleUnit,​FloatSolidAngle>, Value<SolidAngleUnit,​FloatSolidAngle>, FloatScalarInterface<SolidAngleUnit,​FloatSolidAngle>, FloatScalarInterface.Rel<SolidAngleUnit,​FloatSolidAngle>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2020-01-19T15:21:24.964166400Z")
public class FloatSolidAngle
extends AbstractFloatScalarRel<SolidAngleUnit,​FloatSolidAngle>
Easy access methods for the FloatSolidAngle FloatScalar, 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

    • FloatSolidAngle

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

    • FloatSolidAngle

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

    • FloatSolidAngle

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

  • Method Details

    • instantiateRel

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

    • interpolate

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

    • times

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