agi.foundation.routedesign

Enum TerrainAvoidanceProfile.ConfigurationData

java.lang.Object

java.lang.Enum<TerrainAvoidanceProfile.ConfigurationData>

agi.foundation.routedesign.TerrainAvoidanceProfile.ConfigurationData

All Implemented Interfaces:

Enumeration, Serializable, Comparable<TerrainAvoidanceProfile.ConfigurationData>

Enclosing class:

TerrainAvoidanceProfile

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

An enumeration indicating the result of configuring the TerrainAvoidanceProfile.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEIGHT_BELOW_MINIMUM The height of the profile was above terrain at the boundaries, but the interior had problems avoiding the terrain.
HEIGHT_BELOW_MINIMUM_ON_BOUNDARY The boundary conditions of the profile were such that maintaining the minimum height above the terrain was impossible.
INSUFFICIENT_SPACE_TO_SATISFY_PROFILE_CONDITIONS There was insufficient space to satisfy the specified conditions of the profile.
SUCCESSFUL Configuration was successful.
UNKNOWN There was an unknown error during configuration.

Method Summary

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

Configuration was successful.

UNKNOWN

public static final TerrainAvoidanceProfile.ConfigurationData UNKNOWN

There was an unknown error during configuration.

INSUFFICIENT_SPACE_TO_SATISFY_PROFILE_CONDITIONS

public static final TerrainAvoidanceProfile.ConfigurationData INSUFFICIENT_SPACE_TO_SATISFY_PROFILE_CONDITIONS

There was insufficient space to satisfy the specified conditions of the profile. This usually indicates that there is a problem making it impossible to avoid the terrain.

HEIGHT_BELOW_MINIMUM_ON_BOUNDARY

public static final TerrainAvoidanceProfile.ConfigurationData HEIGHT_BELOW_MINIMUM_ON_BOUNDARY

The boundary conditions of the profile were such that maintaining the minimum height above the terrain was impossible. Check to ensure that the initial and final heights are above terrain and that surrounding profiles were not fixed with heights below the terrain.

HEIGHT_BELOW_MINIMUM

public static final TerrainAvoidanceProfile.ConfigurationData HEIGHT_BELOW_MINIMUM

The height of the profile was above terrain at the boundaries, but the interior had problems avoiding the terrain. This can occur when there are extremely sharp peaks or if the pitch rates are sufficiently large as to make avoiding terrain surfaces impossible.

Method Detail

values

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

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

Returns:

The default enum constant.