agi.foundation.navigation.advanced

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

Enum NavigationSignalTrackingType

java.lang.Object

java.lang.Enum<NavigationSignalTrackingType>

agi.foundation.navigation.advanced.NavigationSignalTrackingType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<NavigationSignalTrackingType>

public enum NavigationSignalTrackingType
extends Enum<NavigationSignalTrackingType>
implements Enumeration

Defines signal tracking types within a NavigationReceiverChannel.

For GpsReceivers that use NavigationSignals that require a handover, identify the initial tracking signal(s) with NavigationSignalTrackingType.STARTING and the other signal(s) with NavigationSignalTrackingType.MAINTAINING. This will ensure tracking occurs correctly. For example, a NavigationReceiverChannel tracking L1 CA code initially and transferring to L1 PY and L2 PY will have these three signals in its NavigationSignalCollection. The L1 CA NavigationSignal will have Tracking (get / set) set to NavigationSignalTrackingType.STARTING, while the two PY signals will have Tracking (get / set) set to NavigationSignalTrackingType.MAINTAINING.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAINTAINING Identifies a signal used to maintain tracking in a NavigationReceiverChannel.
STARTING Identifies a signal used to start tracking in a NavigationReceiverChannel.

Method Summary

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

STARTING

public static final NavigationSignalTrackingType STARTING

Identifies a signal used to start tracking in a NavigationReceiverChannel.

MAINTAINING

public static final NavigationSignalTrackingType MAINTAINING

Identifies a signal used to maintain tracking in a NavigationReceiverChannel.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.