Package org.opentrafficsim.road.network.lane.changing

Enum Class LaneKeepingPolicy

java.lang.Object

java.lang.Enum<LaneKeepingPolicy>

org.opentrafficsim.road.network.lane.changing.LaneKeepingPolicy

All Implemented Interfaces:

Serializable, Comparable<LaneKeepingPolicy>, Constable

public enum LaneKeepingPolicy
extends Enum<LaneKeepingPolicy>

Enum to indicate the general lane keeping rules: keep left, keep right, or keep lane. When KEEP_RIGHT or KEEP_LEFT is used, the gap acceptance policy of the GTU indicates when the vehicle will move back to the left or right after overtaking. The GTU could decide to stay in a lane and not go back as well; it is a general policy that asks the collaboration of the GTU driver.

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

Author:

Alexander Verbraeck

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
KEEPLANE	Constant to indicate that the general policy is to keep lane.
KEEPLEFT	Constant to indicate that the general policy is to keep left.
KEEPRIGHT	Constant to indicate that the general policy is to keep right.

Method Summary

Modifier and Type	Method	Description
static LaneKeepingPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LaneKeepingPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

KEEPRIGHT

public static final LaneKeepingPolicy KEEPRIGHT

Constant to indicate that the general policy is to keep right.

KEEPLEFT

public static final LaneKeepingPolicy KEEPLEFT

Constant to indicate that the general policy is to keep left.

KEEPLANE

public static final LaneKeepingPolicy KEEPLANE

Constant to indicate that the general policy is to keep lane.

Method Details

values

public static LaneKeepingPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static LaneKeepingPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null