agi.foundation.routedesign

Enum StationaryHoldProcedure.ConfigurationData

java.lang.Object

java.lang.Enum<StationaryHoldProcedure.ConfigurationData>

agi.foundation.routedesign.StationaryHoldProcedure.ConfigurationData

All Implemented Interfaces:

Enumeration, Serializable, Comparable<StationaryHoldProcedure.ConfigurationData>

Enclosing class:

StationaryHoldProcedure

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

An enumeration indicating the status of configuring the surface procedure.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SUCCESSFUL The configuration was successful.
UNKNOWN There was an unknown error during configuration.

Method Summary

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

The configuration was successful.

UNKNOWN

public static final StationaryHoldProcedure.ConfigurationData UNKNOWN

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

Method Detail

values

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

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

Returns:

The default enum constant.