Package org.djunits.value.vdouble.scalar

Class Position

java.lang.Object
java.lang.Number
org.djunits.value.AbstractScalar<U,​S>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalar<AU,​A>
org.djunits.value.vdouble.scalar.base.AbstractDoubleScalarAbs<PositionUnit,​Position,​LengthUnit,​Length>
org.djunits.value.vdouble.scalar.Position
All Implemented Interfaces:
Serializable, Cloneable, Comparable<Position>, Absolute, Scalar<PositionUnit,​Position>, Scalar.Abs<PositionUnit,​Position,​LengthUnit,​Length>, ValueFunctions<PositionUnit,​Position>, Value<PositionUnit,​Position>, DoubleScalarInterface<PositionUnit,​Position>, DoubleScalarInterface.Abs<PositionUnit,​Position,​LengthUnit,​Length>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2019-10-18T12:12:25.568Z")
public class Position
extends AbstractDoubleScalarAbs<PositionUnit,​Position,​LengthUnit,​Length>
Easy access methods for the Absolute Position DoubleScalar.

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

    • ZERO

      public static final Position ZERO
      Constant with value zero.

  • Constructor Details

    • Position

      public Position​(double value, PositionUnit unit)
      Construct Position scalar.
      Parameters:
      value - double; value
      unit - PositionUnit; unit for the double value

    • Position

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

  • Method Details

    • instantiateAbs

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

    • instantiateRel

      public final Length instantiateRel​(double value, LengthUnit unit)
      Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
      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 Position instantiateSI​(double value)
      Construct Position scalar.
      Parameters:
      value - double; value in SI units
      Returns:
      Position; the new scalar with the SI value

    • interpolate

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

    • max

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

    • max

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

    • min

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

    • min

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

    • valueOf

      public static Position valueOf​(String text)
      Returns a Position 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 Position
      Returns:
      Position; 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 Position of​(double value, String unitString)
      Returns a Position 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:
      Position; 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