Package org.opentrafficsim.road.network.lane

Record Class LanePosition

java.lang.Object
java.lang.Record
org.opentrafficsim.road.network.lane.LanePosition
Record Components:
lane - Lane; the lane for the position
position - Length; the position on the lane, relative to the cross section link (design line) line, or against it
All Implemented Interfaces:
Serializable
public record LanePosition(Lane lane, org.djunits.value.vdouble.scalar.Length position) extends Record implements Serializable
Store one position and lane of a GTU.

Copyright (c) 2013-2024 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, Wouter Schakel
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    LanePosition(Lane lane, org.djunits.value.vdouble.scalar.Length position)
    Creates an instance of a LanePosition record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final org.djutils.draw.point.OrientedPoint2d
    getLocation()
    Retrieve the location and direction of the GTU on the lane.
    final int
    hashCode()
    Returns a hash code value for this object.
    Lane
    lane()
    Returns the value of the lane record component.
    org.djunits.value.vdouble.scalar.Length
    position()
    Returns the value of the position record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • LanePosition

      public LanePosition(Lane lane, org.djunits.value.vdouble.scalar.Length position)
      Creates an instance of a LanePosition record class.
      Parameters:
      lane - the value for the lane record component
      position - the value for the position record component

  • Method Details

    • getLocation

      public final org.djutils.draw.point.OrientedPoint2d getLocation()
      Retrieve the location and direction of the GTU on the lane.
      Returns:
      OrientedPoint2d; the location and direction of the GTU on the lane

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • lane

      public Lane lane()
      Returns the value of the lane record component.
      Returns:
      the value of the lane record component

    • position

      public org.djunits.value.vdouble.scalar.Length position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component