GpsFixQuality

java.lang.Object
- java.lang.Enum<GpsFixQuality>
- - org.ka2ddo.gps.GpsFixQuality

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GpsFixQuality>
```
public enum GpsFixQuality
extends java.lang.Enum<GpsFixQuality>
```
This enum defines the fix quality (as used in the NMEA 0183 V3.01 $GPGGA sentence).

Author:

Andrew Pavlin, KA2DDO

Enum Constant Summary

Enum Constants
Enum Constant and 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`boolean`	`isValid()` Indicate whether this quality code indicates valid position data.
`static GpsFixQuality`	`valueOf(java.lang.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 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 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(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.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

Enum GpsFixQuality

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INVALID

GPS_SPS

DGPS

PPS

RTK

FLOAT_RTK

DR

MANUAL

SIM

Method Detail

values

valueOf

isValid

initMap

getByModeChar

getRank