agi.foundation.routedesign

Enum RacetrackHoldProcedure.ConfigurationData

java.lang.Object

java.lang.Enum<RacetrackHoldProcedure.ConfigurationData>

agi.foundation.routedesign.RacetrackHoldProcedure.ConfigurationData

All Implemented Interfaces:

Enumeration, Serializable, Comparable<RacetrackHoldProcedure.ConfigurationData>

Enclosing class:

RacetrackHoldProcedure

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

An enumeration indicating the status of configuring the surface procedure.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEXT_POINT_UNREACHABLE The next target point was unreachable.
PREVIOUS_POINT_UNREACHABLE The previous target point was unreachable.
SUCCESSFUL The configuration was successful.
UNKNOWN There was an unknown error with the configuration.

Method Summary

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

The configuration was successful.

UNKNOWN

public static final RacetrackHoldProcedure.ConfigurationData UNKNOWN

There was an unknown error with the configuration.

PREVIOUS_POINT_UNREACHABLE

public static final RacetrackHoldProcedure.ConfigurationData PREVIOUS_POINT_UNREACHABLE

The previous target point was unreachable. This is usually caused by constraining the hold so that the target point lies within all the available entry arcs to the hold.

NEXT_POINT_UNREACHABLE

public static final RacetrackHoldProcedure.ConfigurationData NEXT_POINT_UNREACHABLE

The next target point was unreachable. This is usually caused by constraining the hold so that the target point lies within all the available exit arcs to the hold.

Method Detail

values

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

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

Returns:

The default enum constant.