Package org.djunits.value.vfloat.scalar

Class FloatAngle

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

Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.
All rights reserved.
BSD-style license. See OpenTrafficSim License.

Author:
Alexander Verbraeck, Peter Knoppers
See Also:
Serialized Form

  • Field Details

  • Constructor Details

    • FloatAngle

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

    • FloatAngle

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

    • FloatAngle

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

  • Method Details

    • instantiateRel

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

    • instantiateAbs

      public final FloatDirection instantiateAbs​(float value, DirectionUnit unit)
      Construct a new Absolute Immutable FloatScalar of the right type. Each extending class must implement this method.
      Parameters:
      value - float; the float value
      unit - AU; the absolute unit
      Returns:
      A a new absolute instance of the FloatScalar of the right type

    • interpolate

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

    • max

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

    • max

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

    • min

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

    • min

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

    • valueOf

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