agi.foundation.routedesign

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

Enum RouteHeightReference

java.lang.Object

java.lang.Enum<RouteHeightReference>

agi.foundation.routedesign.RouteHeightReference

All Implemented Interfaces:

Enumeration, Serializable, Comparable<RouteHeightReference>

public enum RouteHeightReference
extends Enum<RouteHeightReference>
implements Enumeration

An enumeration indicating the reference surface to use when representing a height.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MEAN_SEA_LEVEL Height referenced to MeanSeaLevel (get / set), which must be configured prior to propagating the route.
SURFACE_SHAPE Height referenced to the Ellipsoid reference surface of the CentralBody.

Method Summary

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

SURFACE_SHAPE

public static final RouteHeightReference SURFACE_SHAPE

Height referenced to the Ellipsoid reference surface of the CentralBody.

MEAN_SEA_LEVEL

public static final RouteHeightReference MEAN_SEA_LEVEL

Height referenced to MeanSeaLevel (get / set), which must be configured prior to propagating the route.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.