agi.foundation.routedesign

(agi.foundation.routedesign-2024r1.jar)

Enum WaypointTurnDirection

java.lang.Object

java.lang.Enum<WaypointTurnDirection>

agi.foundation.routedesign.WaypointTurnDirection

All Implemented Interfaces:

Enumeration, Serializable, Comparable<WaypointTurnDirection>

public enum WaypointTurnDirection
extends Enum<WaypointTurnDirection>
implements Enumeration

An enumeration indicating the turn direction at a waypoint or whether to let the propagator specify the best direction based on the connection geometry.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEFT Indicates that the position will turn left at the waypoint.
RIGHT Indicates that the position will turn right at the waypoint.
UNSPECIFIED Indicates that the turn at the given waypoint should move in the direction that makes the most sense given the heading information from the previous and to the next procedure.

Method Summary

Modifier and Type	Method and Description
static WaypointTurnDirection	getDefault() Get the enum constant that is considered to be the default.
static WaypointTurnDirection	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static WaypointTurnDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static WaypointTurnDirection[]	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

UNSPECIFIED

public static final WaypointTurnDirection UNSPECIFIED

Indicates that the turn at the given waypoint should move in the direction that makes the most sense given the heading information from the previous and to the next procedure.

RIGHT

public static final WaypointTurnDirection RIGHT

Indicates that the position will turn right at the waypoint. This may result in a turn of greater than 180 degrees, depending on the location of the surrounding procedures.

LEFT

public static final WaypointTurnDirection LEFT

Indicates that the position will turn left at the waypoint. This may result in a turn of greater than 180 degrees, depending on the location of the surrounding procedures.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static WaypointTurnDirection getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static WaypointTurnDirection getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.