agi.foundation.navigation

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

Enum AccuracyCalculationPersona

java.lang.Object

java.lang.Enum<AccuracyCalculationPersona>

agi.foundation.navigation.AccuracyCalculationPersona

All Implemented Interfaces:

Enumeration, Serializable, Comparable<AccuracyCalculationPersona>

public enum AccuracyCalculationPersona
extends Enum<AccuracyCalculationPersona>
implements Enumeration

Type definitions for the accuracy calculation persona. The persona defines how the evaluator will react when it encounters no data for a given satellite or too few satellites are available during a navigation accuracy calculation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DILIGENT Diligent persona means the navigation accuracy calculation will try to provide an accuracy answer even if data for some of the requested satellites is missing.
LAZY Lazy persona means the navigation accuracy calculation will not try to provide an accuracy answer if it encounters missing data for a satellite.

Method Summary

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

DILIGENT

public static final AccuracyCalculationPersona DILIGENT

Diligent persona means the navigation accuracy calculation will try to provide an accuracy answer even if data for some of the requested satellites is missing. The accuracy calculation will not use those satellites, reducing the total list of satellites to use in the calculation. If there are too few satellites to calculate a solution, the processing will continue with no solution given for that set. This is the default behavior.

LAZY

public static final AccuracyCalculationPersona LAZY

Lazy persona means the navigation accuracy calculation will not try to provide an accuracy answer if it encounters missing data for a satellite. Upon encountering missing data, the evaluator will throw a DataUnavailableException. If there are too few satellites to determine a solution, an IllegalStateException will be thrown.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.