org.opentrafficsim.core.network

Enum LateralDirectionality

java.lang.Object

java.lang.Enum<LateralDirectionality>

org.opentrafficsim.core.network.LateralDirectionality

All Implemented Interfaces:

Serializable, Comparable<LateralDirectionality>

public enum LateralDirectionality
extends Enum<LateralDirectionality>

Directionality in lateral direction. LEFT corresponds to a positive offset, RIGHT to a negative offset.

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

$LastChangedDate: 2015-08-27 01:29:47 +0200 (Thu, 27 Aug 2015) $, @version $Revision: 1303 $, by $Author: averbraeck $, initial version Oct 15, 2014

Author:

Alexander Verbraeck, Peter Knoppers, Guus Tamminga

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEFT Direction to the left of our current driving direction.
RIGHT Direction to the right of our current driving direction.

Method Summary

Modifier and Type	Method and Description
static LateralDirectionality	offsetDirection(double offset)
static LateralDirectionality	valueOf(String name) Returns the enum constant of this type with the specified name.
static LateralDirectionality[]	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 LateralDirectionality LEFT

Direction to the left of our current driving direction.

RIGHT

public static final LateralDirectionality RIGHT

Direction to the right of our current driving direction.

Method Detail

values

public static LateralDirectionality[] 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 (LateralDirectionality c : LateralDirectionality.values())
    System.out.println(c);

Returns:

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

valueOf

public static LateralDirectionality 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

offsetDirection

public static LateralDirectionality offsetDirection(double offset)
                                             throws NetworkException

Parameters:

offset - the offset to calculate the lateral directionality for

Returns:

LEFT for a positive offset, RIGHT for negative offset

Throws:

NetworkException - when offset == 0.0 or offset == NaN