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

Enum Class OvertakingDirection

java.lang.Object

java.lang.Enum<OvertakingDirection>

org.opentrafficsim.road.network.lane.changing.OvertakingDirection

All Implemented Interfaces:

Serializable, Comparable<OvertakingDirection>, Constable

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-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
BOTH	Left and right are both allowed.
LEFT	Left only.
NONE	Neither left nor right are allowed.
RIGHT	Right only.

Method Summary

Modifier and Type	Method	Description
static OvertakingDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OvertakingDirection[]	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

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 Details

values

public static OvertakingDirection[] 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 OvertakingDirection 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