agi.foundation.routedesign

(agi.foundation.routedesign-2024r1.jar)

Enum DefaultProfileBehavior

java.lang.Object

java.lang.Enum<DefaultProfileBehavior>

agi.foundation.routedesign.DefaultProfileBehavior

All Implemented Interfaces:

Enumeration, Serializable, Comparable<DefaultProfileBehavior>

public enum DefaultProfileBehavior
extends Enum<DefaultProfileBehavior>
implements Enumeration

An enumeration indicating which type of connection to use for a given RoutePropagator. Options include the ability to follow the terrain at a constant height offset, fly above the terrain at a minimum height, or ignore terrain and simply connect the heights between RouteProcedures with either a flat or inclined line segment.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVOID_TERRAIN Indicates the connection will attempt to avoid terrain by a specified minimum height.
FOLLOW_TERRAIN Indicates the connection has a constant height above the terrain.
STANDARD_CONNECTION Indicates the connection will ignore any terrain definition and instead connect the heights between RouteProcedures by either a flat or an inclined segment.

Method Summary

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

FOLLOW_TERRAIN

public static final DefaultProfileBehavior FOLLOW_TERRAIN

Indicates the connection has a constant height above the terrain. This requires the user to specify a TerrainProvider and is useful when modeling ground vehicles or other objects moving along the ground.

AVOID_TERRAIN

public static final DefaultProfileBehavior AVOID_TERRAIN

Indicates the connection will attempt to avoid terrain by a specified minimum height. This requires the user to specify a TerrainProvider and is useful for modeling aircraft that are operating over mountainous terrain.

STANDARD_CONNECTION

public static final DefaultProfileBehavior STANDARD_CONNECTION

Indicates the connection will ignore any terrain definition and instead connect the heights between RouteProcedures by either a flat or an inclined segment.

Method Detail

values

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

Returns:

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

valueOf

public static DefaultProfileBehavior 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 DefaultProfileBehavior 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 DefaultProfileBehavior getDefault()

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

Returns:

The default enum constant.