Package org.opentrafficsim.road.gtu.lane.perception

Record Class PerceptionCollectable.UnderlyingDistance<U>

java.lang.Object
java.lang.Record
org.opentrafficsim.road.gtu.lane.perception.PerceptionCollectable.UnderlyingDistance<U>
Type Parameters:
U - underlying object type
Record Components:
object - underlying object
distance - distance to object
All Implemented Interfaces:
Comparable<PerceptionCollectable.UnderlyingDistance<U>>
Enclosing interface:
PerceptionCollectable<H extends Headway,U>
public static record PerceptionCollectable.UnderlyingDistance<U>(U object, org.djunits.value.vdouble.scalar.Length distance) extends Record implements Comparable<PerceptionCollectable.UnderlyingDistance<U>>
Wrapper for object and its distance.

  • Constructor Details

    • UnderlyingDistance

      public UnderlyingDistance(U object, org.djunits.value.vdouble.scalar.Length distance)
      Creates an instance of a UnderlyingDistance record class.
      Parameters:
      object - the value for the object record component
      distance - the value for the distance record component

  • Method Details

    • compareTo

      public int compareTo(PerceptionCollectable.UnderlyingDistance<U> o)
      Specified by:
      compareTo in interface Comparable<U>

    • 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.

    • object

      public U object()
      Returns the value of the object record component.
      Returns:
      the value of the object record component

    • distance

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