agi.foundation.routedesign

Enum CircularHoldProcedure.ConfigurationData

java.lang.Object

java.lang.Enum<CircularHoldProcedure.ConfigurationData>

agi.foundation.routedesign.CircularHoldProcedure.ConfigurationData

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CircularHoldProcedure.ConfigurationData>

Enclosing class:

CircularHoldProcedure

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

An enumeration indicating whether the configuration of the hold was successful or whether there was an error.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEXT_POINT_INSIDE_HOLD The configuration was unsuccessful because the next procedure ended inside the circular hold and no exit tangent exists.
PREVIOUS_POINT_INSIDE_HOLD The configuration was unsuccessful because the previous procedure ended inside the circular hold and no entry tangent exists.
SUCCESSFUL Configuration successful.
UNKNOWN There was an unknown problem with the configuration.

Method Summary

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

Configuration successful.

UNKNOWN

public static final CircularHoldProcedure.ConfigurationData UNKNOWN

There was an unknown problem with the configuration.

PREVIOUS_POINT_INSIDE_HOLD

public static final CircularHoldProcedure.ConfigurationData PREVIOUS_POINT_INSIDE_HOLD

The configuration was unsuccessful because the previous procedure ended inside the circular hold and no entry tangent exists.

NEXT_POINT_INSIDE_HOLD

public static final CircularHoldProcedure.ConfigurationData NEXT_POINT_INSIDE_HOLD

The configuration was unsuccessful because the next procedure ended inside the circular hold and no exit tangent exists.

Method Detail

values

public static CircularHoldProcedure.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 (CircularHoldProcedure.ConfigurationData c : CircularHoldProcedure.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 CircularHoldProcedure.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 CircularHoldProcedure.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 CircularHoldProcedure.ConfigurationData getDefault()

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

Returns:

The default enum constant.