Package org.opentrafficsim.road.gtu.perception.object

Record Class PerceivedGtu.Maneuver.Record

java.lang.Object

java.lang.Record

org.opentrafficsim.road.gtu.perception.object.PerceivedGtu.Maneuver.Record

Record Components:

isChangingLeft - whether the GTU is changing lanes to the left

isChangingRight - whether the GTU is changing lanes to the right

getDeviation - lateral deviation from the lane center line

All Implemented Interfaces:

PerceivedGtu.Maneuver

Enclosing interface:

PerceivedGtu.Maneuver

public static record PerceivedGtu.Maneuver.Record(boolean isChangingLeft, boolean isChangingRight, org.djunits.value.vdouble.scalar.Length getDeviation)
extends Record
implements PerceivedGtu.Maneuver

Record storing signals information.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opentrafficsim.road.gtu.perception.object.PerceivedGtu.Maneuver

PerceivedGtu.Maneuver.Record

Field Summary

Fields inherited from interface org.opentrafficsim.road.gtu.perception.object.PerceivedGtu.Maneuver

NONE

Constructor Summary

Constructors

Constructor	Description
Record(boolean isChangingLeft, boolean isChangingRight, org.djunits.value.vdouble.scalar.Length getDeviation)	Constructor.

Method Summary

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

Methods inherited from interface org.opentrafficsim.road.gtu.perception.object.PerceivedGtu.Maneuver

getLaneChangeDirection, isChangingLane

Constructor Details

Record

public Record(boolean isChangingLeft,
 boolean isChangingRight,
 org.djunits.value.vdouble.scalar.Length getDeviation)

Constructor.

Parameters:

isChangingLeft - whether the GTU is changing lanes to the left

isChangingRight - whether the GTU is changing lanes to the right

getDeviation - lateral deviation from the lane center line

Throws:

IllegalArgumentException - when both isChangingLeft and isChangingRight are true

NullPointerException - when getDeviation is null

Method Details

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

isChangingLeft

public boolean isChangingLeft()

Returns the value of the isChangingLeft record component.

Specified by:

isChangingLeft in interface PerceivedGtu.Maneuver

Returns:

the value of the isChangingLeft record component

isChangingRight

public boolean isChangingRight()

Returns the value of the isChangingRight record component.

Specified by:

isChangingRight in interface PerceivedGtu.Maneuver

Returns:

the value of the isChangingRight record component

getDeviation

public org.djunits.value.vdouble.scalar.Length getDeviation()

Returns the value of the getDeviation record component.

Specified by:

getDeviation in interface PerceivedGtu.Maneuver

Returns:

the value of the getDeviation record component