agi.foundation.navigation

(agi.foundation.navigation-2023r1.jar)

Enum DilutionOfPrecisionType

java.lang.Object

java.lang.Enum<DilutionOfPrecisionType>

agi.foundation.navigation.DilutionOfPrecisionType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<DilutionOfPrecisionType>

public enum DilutionOfPrecisionType
extends Enum<DilutionOfPrecisionType>
implements Enumeration

An enumeration defining the type of Dilution of Precision (DOP).

Enum Constant Summary

Enum Constants

Enum Constant and Description
GEOMETRIC The geometric dilution of precision (GDOP).
POSITION The position dilution of precision (PDOP).
TIME The time dilution of precision (TDOP).
X The dilution of precision along the X axis.
XY The dilution of precision in the X-Y plane.
Y The dilution of precision along the Y axis.
Z The dilution of precision along the Z axis.

Method Summary

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

X

public static final DilutionOfPrecisionType X

The dilution of precision along the X axis. When using conventional ENU (East-North-Up) axes, this is the dilution of precision in the East direction, or EDOP.

Y

public static final DilutionOfPrecisionType Y

The dilution of precision along the Y axis. When using conventional ENU (East-North-Up) axes, this is the dilution of precision in the North direction, or NDOP.

Z

public static final DilutionOfPrecisionType Z

The dilution of precision along the Z axis. When using conventional ENU (East-North-Up) axes, this is the dilution of precision in the Up/Vertical direction, or VDOP.

XY

public static final DilutionOfPrecisionType XY

The dilution of precision in the X-Y plane. When using conventional ENU (East-North-Up) axes, this is the dilution of precision in the horizontal plane, or HDOP.

POSITION

public static final DilutionOfPrecisionType POSITION

The position dilution of precision (PDOP).

TIME

public static final DilutionOfPrecisionType TIME

The time dilution of precision (TDOP).

GEOMETRIC

public static final DilutionOfPrecisionType GEOMETRIC

The geometric dilution of precision (GDOP).

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.