LaneKeepingPolicy (OpenTrafficSim road classes 1.6.0 API)

java.lang.Object
- java.lang.Enum<LaneKeepingPolicy>
- - org.opentrafficsim.road.network.lane.changing.LaneKeepingPolicy

All Implemented Interfaces:

Serializable, Comparable<LaneKeepingPolicy>
```
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-2022 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Sep 13, 2015

Author:

Alexander Verbraeck

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

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

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - 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 Detail
  - values
```
public static LaneKeepingPolicy[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (LaneKeepingPolicy c : LaneKeepingPolicy.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LaneKeepingPolicy valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
    
    NullPointerException - if the argument is null