Package org.ka2ddo.gps

Enum Class GpsFixQuality

java.lang.Object

java.lang.Enum<GpsFixQuality>

org.ka2ddo.gps.GpsFixQuality

All Implemented Interfaces:

Serializable, Comparable<GpsFixQuality>, Constable

public enum GpsFixQuality
extends Enum<GpsFixQuality>

This enum defines the fix quality (as used in the NMEA 0183 V3.01 $GPGGA sentence).

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DGPS	Differential GPS fix.
DR	Estimated dead-reckoned fix.
FLOAT_RTK	float Real-Time Kinematic fix.
GPS_SPS	Standard GPS fix.
INVALID	No fix.
MANUAL	Manual input.
PPS	Providing only time reference.
RTK	Real-time kinematic fix.
SIM	Simulation.

Method Summary

Modifier and Type	Method	Description
static GpsFixQuality	getByModeChar(char ch)	Look up the GpsFixQuality enum by is $xxGNS sentence mode indicator.
int	getRank()	Get the preferred rank of this quality to compare qualities if multiple constellations were used to provide an answer.
static void	initMap()	Initialize the mode map if it isn't already initialized.
final boolean	isValid()	Indicate whether this quality code indicates valid position data.
static GpsFixQuality	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GpsFixQuality[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INVALID

public static final GpsFixQuality INVALID

No fix.

GPS_SPS

public static final GpsFixQuality GPS_SPS

Standard GPS fix.

DGPS

public static final GpsFixQuality DGPS

Differential GPS fix.

PPS

public static final GpsFixQuality PPS

Providing only time reference.

RTK

public static final GpsFixQuality RTK

Real-time kinematic fix.

FLOAT_RTK

public static final GpsFixQuality FLOAT_RTK

float Real-Time Kinematic fix.

DR

public static final GpsFixQuality DR

Estimated dead-reckoned fix.

MANUAL

public static final GpsFixQuality MANUAL

Manual input.

SIM

public static final GpsFixQuality SIM

Simulation.

Method Details

values

public static GpsFixQuality[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static GpsFixQuality valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isValid

public final boolean isValid()

Indicate whether this quality code indicates valid position data.

Returns:

boolean true if this quality code has valid position data associated with it

initMap

public static void initMap()

Initialize the mode map if it isn't already initialized.

getByModeChar

public static GpsFixQuality getByModeChar(char ch)

Look up the GpsFixQuality enum by is $xxGNS sentence mode indicator.

Parameters:

ch - mode indicator character from a $GNGNS sentence

Returns:

coresponding GpsFixQuality value

getRank

public int getRank()

Get the preferred rank of this quality to compare qualities if multiple constellations were used to provide an answer.

Returns:

int relative quality rank for this GpsFixQuality