net.sf.marineapi.nmea.util

Enum GpsFixQuality

java.lang.Object

java.lang.Enum<GpsFixQuality>

net.sf.marineapi.nmea.util.GpsFixQuality

All Implemented Interfaces:

Serializable, Comparable<GpsFixQuality>

public enum GpsFixQuality
extends Enum<GpsFixQuality>

GpsFixQuality defines the supported fix quality types.

Author:

Kimmo Tuukkanen

See Also:

FaaMode, GpsFixStatus, DataStatus

Enum Constant Summary

Enum Constants

Enum Constant and Description
DGPS Differential GPS fix.
ESTIMATED Estimated, dead reckoning (2.3 feature)
FRTK Float RTK
INVALID No GPS fix acquired.
MANUAL Manual input mode
NORMAL Normal GPS fix, Standard Position Service (SPS).
PPS Precise Positioning Service fix.
RTK Real Time Kinematic
SIMULATED Simulation mode

Method Summary

Modifier and Type	Method and Description
int	toInt() Returns the corresponding int indicator for fix quality.
static GpsFixQuality	valueOf(int val) Get GpsFixQuality enum that corresponds the actual integer identifier used in the sentences.
static GpsFixQuality	valueOf(String name) Returns the enum constant of this type with the specified name.
static GpsFixQuality[]	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

INVALID

public static final GpsFixQuality INVALID

No GPS fix acquired.

NORMAL

public static final GpsFixQuality NORMAL

Normal GPS fix, Standard Position Service (SPS).

DGPS

public static final GpsFixQuality DGPS

Differential GPS fix.

PPS

public static final GpsFixQuality PPS

Precise Positioning Service fix.

RTK

public static final GpsFixQuality RTK

Real Time Kinematic

FRTK

public static final GpsFixQuality FRTK

Float RTK

ESTIMATED

public static final GpsFixQuality ESTIMATED

Estimated, dead reckoning (2.3 feature)

MANUAL

public static final GpsFixQuality MANUAL

Manual input mode

SIMULATED

public static final GpsFixQuality SIMULATED

Simulation mode

Method Detail

values

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

Returns:

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

valueOf

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

toInt

public int toInt()

Returns the corresponding int indicator for fix quality.

Returns:

Fix quality indicator value as indicated in sentences.

valueOf

public static GpsFixQuality valueOf(int val)

Get GpsFixQuality enum that corresponds the actual integer identifier used in the sentences.

Parameters:

val - Status identifier value

Returns:

GpsFixQuality enum