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

Enum LaneKeepingPolicy

java.lang.Object
java.lang.Enum<LaneKeepingPolicy>
org.opentrafficsim.road.network.lane.changing.LaneKeepingPolicy
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<LaneKeepingPolicy>, java.lang.constant.Constable
public enum LaneKeepingPolicy
extends java.lang.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-2020 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

  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.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​(java.lang.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, 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

  • Method Details

    • values

      public static LaneKeepingPolicy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static LaneKeepingPolicy valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null