agi.foundation.routedesign

Enum InscribedTurnProcedure.ConfigurationData

java.lang.Object

java.lang.Enum<InscribedTurnProcedure.ConfigurationData>

agi.foundation.routedesign.InscribedTurnProcedure.ConfigurationData

All Implemented Interfaces:

Enumeration, Serializable, Comparable<InscribedTurnProcedure.ConfigurationData>

Enclosing class:

InscribedTurnProcedure

public static enum InscribedTurnProcedure.ConfigurationData
extends Enum<InscribedTurnProcedure.ConfigurationData>
implements Enumeration

An enumeration indicating the status of configuring the surface procedure.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSUFFICIENT_SPACE_FOR_TURN The InscribedTurnProcedure has too tight of a turn to perform the maneuver.
SUCCESSFUL The configuration was successful.
UNKNOWN There was an unknown error during configuration.
WARNING_NEGLIGIBLE_TURN The inscribed turn at the waypoint was negligible.

Method Summary

Modifier and Type	Method and Description
static InscribedTurnProcedure.ConfigurationData	getDefault() Get the enum constant that is considered to be the default.
static InscribedTurnProcedure.ConfigurationData	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 InscribedTurnProcedure.ConfigurationData	valueOf(String name) Returns the enum constant of this type with the specified name.
static InscribedTurnProcedure.ConfigurationData[]	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

SUCCESSFUL

public static final InscribedTurnProcedure.ConfigurationData SUCCESSFUL

The configuration was successful.

UNKNOWN

public static final InscribedTurnProcedure.ConfigurationData UNKNOWN

There was an unknown error during configuration. This may indicate that there was some bad input.

WARNING_NEGLIGIBLE_TURN

public static final InscribedTurnProcedure.ConfigurationData WARNING_NEGLIGIBLE_TURN

The inscribed turn at the waypoint was negligible.

INSUFFICIENT_SPACE_FOR_TURN

public static final InscribedTurnProcedure.ConfigurationData INSUFFICIENT_SPACE_FOR_TURN

The InscribedTurnProcedure has too tight of a turn to perform the maneuver. Instead, the route will be discontinuous at this procedure.

Check that the previous and next procedures are not too close, the turning radius is not too large, and that the angles to and from this waypoint are not too close together.

Method Detail

values

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

Returns:

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

valueOf

public static InscribedTurnProcedure.ConfigurationData 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 InscribedTurnProcedure.ConfigurationData 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 InscribedTurnProcedure.ConfigurationData getDefault()

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

Returns:

The default enum constant.