org.opentrafficsim.core.gtu.animation

Class LaneChangeUrgeGTUColorer.LaneChangeDistanceAndDirection

java.lang.Object

org.opentrafficsim.core.gtu.animation.LaneChangeUrgeGTUColorer.LaneChangeDistanceAndDirection

Enclosing class:

LaneChangeUrgeGTUColorer

public static class LaneChangeUrgeGTUColorer.LaneChangeDistanceAndDirection
extends Object

Pack a distance available for performing a lane change and a direction in one object.

Field Summary

Fields

Modifier and Type	Field and Description
DoubleScalar.Rel<LengthUnit>	distance The distance available to complete the next required lane change.
Boolean	left The lateral direction of the next required lane change is left (if this field is true); right (if this field is false); none (if this field is null)

Constructor Summary

Constructors

Constructor and Description
LaneChangeDistanceAndDirection(DoubleScalar.Rel<LengthUnit> distance, Boolean left) Construct a new LaneChangeDistanceAndDirection object.

Method Summary

Modifier and Type	Method and Description
DoubleScalar.Rel<LengthUnit>	getDistance() Retrieve the distance available to complete the next required lane change.
Boolean	getLeft() Retrieve the lateral direction of the next required lane change.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

distance

public final DoubleScalar.Rel<LengthUnit> distance

The distance available to complete the next required lane change.

left

public final Boolean left

The lateral direction of the next required lane change is left (if this field is true); right (if this field is false); none (if this field is null)

Constructor Detail

LaneChangeDistanceAndDirection

public LaneChangeDistanceAndDirection(DoubleScalar.Rel<LengthUnit> distance,
                                      Boolean left)

Construct a new LaneChangeDistanceAndDirection object.

Parameters:

distance - DoubleScalar.Abs<LengthUnit>; the distance available for performing a lane change

left - Boolean; if true the lane change to perform is to the left; if false, the lane change to perform is to the right; if null, no lane change is needed, or possible

Method Detail

getDistance

public final DoubleScalar.Rel<LengthUnit> getDistance()

Retrieve the distance available to complete the next required lane change.

Returns:

DoubleScalar.Rel<LengthUnit>; the distance available to complete the next required lane change

getLeft

public final Boolean getLeft()

Retrieve the lateral direction of the next required lane change.

Returns:

Boolean; true if the next required lane change is to the left, false if the next required lane change is to the right, null if no lane change is required (or possible)

toString

public final String toString()

Overrides:

toString in class Object