net.sf.marineapi.nmea.util

Enum FaaMode

java.lang.Object

java.lang.Enum<FaaMode>

net.sf.marineapi.nmea.util.FaaMode

All Implemented Interfaces:

Serializable, Comparable<FaaMode>

public enum FaaMode
extends Enum<FaaMode>

FAA operating modes reported by APB, BWC, BWR, GLL, RMA, RMB, RMC, VTG, WCV and XTE sentences since NMEA 2.3. Also, the mode field in GGA was extended to contain these statuses.

Notice that FAA mode dominates the DataStatus fields. Status field will be set to DataStatus.ACTIVE for modes AUTOMATIC and DGPS, and DataStatus.VOID for all other modes.

Author:

Kimmo Tuukkanen

See Also:

GpsFixQuality, GpsFixStatus, DataStatus

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTOMATIC Operating in autonomous mode (automatic 2D/3D).
DGPS Operating in differential mode (DGPS).
ESTIMATED Operating in estimating mode (dead-reckoning).
MANUAL Operating in manual mode (forced 2D or 3D).
NONE No valid GPS data available.
SIMULATED Simulated data (running in simulator/demo mode)

Method Summary

Methods

Modifier and Type	Method and Description
char	toChar() Returns the corresponding char indicator of GPS mode.
static FaaMode	valueOf(char ch) Returns the FaaMode enum corresponding the actual char indicator used in the sentencess.
static FaaMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FaaMode[]	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

AUTOMATIC

public static final FaaMode AUTOMATIC

Operating in autonomous mode (automatic 2D/3D).

MANUAL

public static final FaaMode MANUAL

Operating in manual mode (forced 2D or 3D).

DGPS

public static final FaaMode DGPS

Operating in differential mode (DGPS).

ESTIMATED

public static final FaaMode ESTIMATED

Operating in estimating mode (dead-reckoning).

SIMULATED

public static final FaaMode SIMULATED

Simulated data (running in simulator/demo mode)

NONE

public static final FaaMode NONE

No valid GPS data available.

Method Detail

values

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

Returns:

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

valueOf

public static FaaMode 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

toChar

public char toChar()

Returns the corresponding char indicator of GPS mode.

Returns:

Mode char used in sentences.

valueOf

public static FaaMode valueOf(char ch)

Returns the FaaMode enum corresponding the actual char indicator used in the sentencess.

Parameters:

ch - Char mode indicator

Returns:

FaaMode enum