Class SolidAngle

All Implemented Interfaces:
Serializable, Cloneable, Comparable<SolidAngle>, Relative<SolidAngleUnit,SolidAngle>, Value<SolidAngleUnit,SolidAngle>

@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2023-07-23T14:06:38.224104100Z") public class SolidAngle extends DoubleScalarRel<SolidAngleUnit,SolidAngle>
Easy access methods for the SolidAngle DoubleScalar, which is relative by definition.

Copyright (c) 2013-2024 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 SolidAngle ZERO
      Constant with value zero.
    • ONE

      public static final SolidAngle ONE
      Constant with value one.
    • NaN

      public static final SolidAngle NaN
      Constant with value NaN.
    • POSITIVE_INFINITY

      public static final SolidAngle POSITIVE_INFINITY
      Constant with value POSITIVE_INFINITY.
    • NEGATIVE_INFINITY

      public static final SolidAngle NEGATIVE_INFINITY
      Constant with value NEGATIVE_INFINITY.
    • POS_MAXVALUE

      public static final SolidAngle POS_MAXVALUE
      Constant with value MAX_VALUE.
    • NEG_MAXVALUE

      public static final SolidAngle NEG_MAXVALUE
      Constant with value -MAX_VALUE.
  • Constructor Details

    • SolidAngle

      public SolidAngle(double value, SolidAngleUnit unit)
      Construct SolidAngle scalar.
      Parameters:
      value - double; the double value
      unit - SolidAngleUnit; unit for the double value
    • SolidAngle

      public SolidAngle(SolidAngle value)
      Construct SolidAngle scalar.
      Parameters:
      value - SolidAngle; Scalar from which to construct this instance
  • Method Details

    • instantiateRel

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

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

      public static SolidAngle max(SolidAngle r1, SolidAngle r2)
      Return the maximum value of two relative scalars.
      Parameters:
      r1 - SolidAngle; the first scalar
      r2 - SolidAngle; the second scalar
      Returns:
      SolidAngle; the maximum value of two relative scalars
    • max

      public static SolidAngle max(SolidAngle r1, SolidAngle r2, SolidAngle... rn)
      Return the maximum value of more than two relative scalars.
      Parameters:
      r1 - SolidAngle; the first scalar
      r2 - SolidAngle; the second scalar
      rn - SolidAngle...; the other scalars
      Returns:
      SolidAngle; the maximum value of more than two relative scalars
    • min

      public static SolidAngle min(SolidAngle r1, SolidAngle r2)
      Return the minimum value of two relative scalars.
      Parameters:
      r1 - SolidAngle; the first scalar
      r2 - SolidAngle; the second scalar
      Returns:
      SolidAngle; the minimum value of two relative scalars
    • min

      public static SolidAngle min(SolidAngle r1, SolidAngle r2, SolidAngle... rn)
      Return the minimum value of more than two relative scalars.
      Parameters:
      r1 - SolidAngle; the first scalar
      r2 - SolidAngle; the second scalar
      rn - SolidAngle...; the other scalars
      Returns:
      SolidAngle; the minimum value of more than two relative scalars
    • valueOf

      public static SolidAngle valueOf(String text)
      Returns a SolidAngle 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 - String; the textual representation to parse into a SolidAngle
      Returns:
      SolidAngle; 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 SolidAngle of(double value, String unitString)
      Returns a SolidAngle based on a value and the textual representation of the unit, which can be localized.
      Parameters:
      value - double; the value to use
      unitString - String; the textual representation of the unit
      Returns:
      SolidAngle; 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(SolidAngle v)
      Calculate the division of SolidAngle and SolidAngle, which results in a Dimensionless scalar.
      Parameters:
      v - SolidAngle; scalar
      Returns:
      Dimensionless; scalar as a division of SolidAngle and SolidAngle
    • times

      public final LuminousFlux times(LuminousIntensity v)
      Calculate the multiplication of SolidAngle and LuminousIntensity, which results in a LuminousFlux scalar.
      Parameters:
      v - SolidAngle; scalar
      Returns:
      LuminousFlux; scalar as a multiplication of SolidAngle and LuminousIntensity
    • reciprocal

      public SIScalar reciprocal()
      Description copied from class: DoubleScalarRel
      Create the reciprocal of this scalar with the correct dimensions.
      Specified by:
      reciprocal in class DoubleScalarRel<SolidAngleUnit,SolidAngle>
      Returns:
      DoubleScalar<?>; a new scalar instance with correct SI dimensions