agi.foundation.routedesign

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

Enum SpeedReference

java.lang.Object

java.lang.Enum<SpeedReference>

agi.foundation.routedesign.SpeedReference

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SpeedReference>

public enum SpeedReference
extends Enum<SpeedReference>
implements Enumeration

An enumeration indicating whether the speed represents the total combined speed accounting for the surface speed and the vertical rate or whether the speed represents the speed along the surface path.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SURFACE The speed along the surface path (without accounting for vertical motion).
TOTAL The total combined speed accounting for the surface speed and the vertical rate.

Method Summary

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

TOTAL

public static final SpeedReference TOTAL

The total combined speed accounting for the surface speed and the vertical rate.

SURFACE

public static final SpeedReference SURFACE

The speed along the surface path (without accounting for vertical motion).

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.