Package org.opentrafficsim.base

Record Class DistancedObject<T>

java.lang.Object
java.lang.Record
org.opentrafficsim.base.DistancedObject<T>
Type Parameters:
T - underlying object type
Record Components:
object - underlying object
distance - distance to object
All Implemented Interfaces:
Comparable<DistancedObject<T>>
public record DistancedObject<T>(T object, org.djunits.value.vdouble.scalar.Length distance) extends Record implements Comparable<DistancedObject<T>>
Wrapper for object and its distance.

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

Author:
Wouter Schakel

  • Constructor Summary

    Constructors
    Constructor
    Description
    DistancedObject(T object, org.djunits.value.vdouble.scalar.Length distance)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(DistancedObject<T> o)
     
    org.djunits.value.vdouble.scalar.Length
    distance()
    Returns the value of the distance record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    T
    object()
    Returns the value of the object 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

    • DistancedObject

      public DistancedObject(T object, org.djunits.value.vdouble.scalar.Length distance)
      Constructor.
      Parameters:
      object - underlying object
      distance - distance to object@param object underlying object

  • Method Details

    • compareTo

      public int compareTo(DistancedObject<T> o)
      Specified by:
      compareTo in interface Comparable<T>

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