Package org.djunits.value.vdouble.scalar

Class Direction

java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vdouble.scalar.base.DoubleScalar<AU,A>
org.djunits.value.vdouble.scalar.base.DoubleScalarAbs<DirectionUnit,Direction,AngleUnit,Angle>
org.djunits.value.vdouble.scalar.Direction
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Direction>, Absolute<DirectionUnit,Direction,AngleUnit,Angle>, Value<DirectionUnit,Direction>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2025-09-06T15:16:28.380798Z") public class Direction extends DoubleScalarAbs<DirectionUnit,Direction,AngleUnit,Angle>
Easy access methods for the Absolute Direction DoubleScalar.

Copyright (c) 2013-2025 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 Direction ZERO
      Constant with value zero.

  • Constructor Details

    • Direction

      public Direction(double value, DirectionUnit unit)
      Construct Direction scalar with a unit.
      Parameters:
      value - the double value, expressed in the given unit
      unit - unit for the double value

    • Direction

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

  • Method Details

    • instantiateAbs

      public final Direction instantiateAbs(double value, DirectionUnit unit)
      Description copied from class: DoubleScalarAbs
      Construct a new Absolute Immutable DoubleScalar of the right type. Each extending class must implement this method.
      Specified by:
      instantiateAbs in class DoubleScalarAbs<DirectionUnit,Direction,AngleUnit,Angle>
      Parameters:
      value - the double value
      unit - the absolute unit
      Returns:
      A a new absolute instance of the DoubleScalar of the right type

    • instantiateRel

      public final Angle instantiateRel(double value, AngleUnit unit)
      Description copied from class: DoubleScalarAbs
      Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
      Specified by:
      instantiateRel in class DoubleScalarAbs<DirectionUnit,Direction,AngleUnit,Angle>
      Parameters:
      value - the double value
      unit - the unit
      Returns:
      R a new relative instance of the DoubleScalar of the right type

    • ofSI

      public static final Direction ofSI(double value)
      Construct Direction scalar based on a BASE unit value.
      Parameters:
      value - value in BASE units
      Returns:
      the new scalar with the BASE unit value

    • interpolate

      public static Direction interpolate(Direction zero, Direction one, double ratio)
      Interpolate between two values. Note that the first value does not have to be smaller than the second.
      Parameters:
      zero - the value at a ratio of zero
      one - the value at a ratio of one
      ratio - the ratio between 0 and 1, inclusive
      Returns:
      a Direction at the given ratio between 0 and 1

    • max

      public static Direction max(Direction a1, Direction a2)
      Return the maximum value of two absolute scalars.
      Parameters:
      a1 - the first scalar
      a2 - the second scalar
      Returns:
      the maximum value of two absolute scalars

    • max

      public static Direction max(Direction a1, Direction a2, Direction... an)
      Return the maximum value of more than two absolute scalars.
      Parameters:
      a1 - the first scalar
      a2 - the second scalar
      an - the other scalars
      Returns:
      the maximum value of more than two absolute scalars

    • min

      public static Direction min(Direction a1, Direction a2)
      Return the minimum value of two absolute scalars.
      Parameters:
      a1 - the first scalar
      a2 - the second scalar
      Returns:
      the minimum value of two absolute scalars

    • min

      public static Direction min(Direction a1, Direction a2, Direction... an)
      Return the minimum value of more than two absolute scalars.
      Parameters:
      a1 - the first scalar
      a2 - the second scalar
      an - the other scalars
      Returns:
      the minimum value of more than two absolute scalars

    • valueOf

      public static Direction valueOf(String text)
      Returns a Direction 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 - the textual representation to parse into a Direction
      Returns:
      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 Direction of(double value, String unitString)
      Returns a Direction based on a value and the textual representation of the unit, which can be localized.
      Parameters:
      value - the value to use
      unitString - the textual representation of the unit
      Returns:
      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