OvertakingDirection (Open Traffic Sim road classes 1.04.04 API)

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

All Implemented Interfaces:

Serializable, Comparable<OvertakingDirection>
```
public enum OvertakingDirection
extends Enum<OvertakingDirection>
```
The direction in which a GTU is allowed to overtake another GTU, used as a return type for evaluating overtaking conditions.
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

Enum Constant Summary

Enum Constants
Enum Constant Description

BOTH
Left and right are both allowed.

LEFT
Left only.

NONE
Neither left nor right are allowed.

RIGHT
Right only.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static OvertakingDirection`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static OvertakingDirection[]`	`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
  - LEFT
```
public static final OvertakingDirection LEFT
```
    Left only.
  - RIGHT
```
public static final OvertakingDirection RIGHT
```
    Right only.
  - BOTH
```
public static final OvertakingDirection BOTH
```
    Left and right are both allowed.
  - NONE
```
public static final OvertakingDirection NONE
```
    Neither left nor right are allowed.
- Method Detail
  - values
```
public static OvertakingDirection[] 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 (OvertakingDirection c : OvertakingDirection.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OvertakingDirection 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