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

Record Class NavigatingIterable.Entry<T>

java.lang.Object

java.lang.Record

org.opentrafficsim.road.gtu.lane.perception.structure.NavigatingIterable.Entry<T>

Type Parameters:

T - type of object

Record Components:

distance - distance to object

merge - ego-distance until the road of the object and the road of the perceiving GTU merge

object - the perceived object

All Implemented Interfaces:

Comparable<NavigatingIterable.Entry<?>>

Enclosing class:

NavigatingIterable<T,L extends LaneRecordInterface<L>>

public static record NavigatingIterable.Entry<T>(Length distance, Length merge, T object)
extends Record
implements Comparable<NavigatingIterable.Entry<?>>

Container for a perceived object with the distance towards it and the distance until the road of the object and the road of the perceiving GTU merge.

Copyright (c) 2024-2024 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
Entry(Length distance, Length merge, T object)	Creates an instance of a Entry record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(NavigatingIterable.Entry<?> o)
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.
Length	merge()	Returns the value of the merge record component.
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

Entry

public Entry(Length distance,
 Length merge,
 T object)

Creates an instance of a Entry record class.

Parameters:

distance - the value for the distance record component

merge - the value for the merge record component

object - the value for the object record component

Method Details

compareTo

public int compareTo(NavigatingIterable.Entry<?> 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.

distance

public Length distance()

Returns the value of the distance record component.

Returns:

the value of the distance record component

merge

public Length merge()

Returns the value of the merge record component.

Returns:

the value of the merge record component

object

public T object()

Returns the value of the object record component.

Returns:

the value of the object record component