net.sf.marineapi.nmea.util

Enum GpsFixStatus

java.lang.Object

java.lang.Enum<GpsFixStatus>

net.sf.marineapi.nmea.util.GpsFixStatus

All Implemented Interfaces:

Serializable, Comparable<GpsFixStatus>

public enum GpsFixStatus
extends Enum<GpsFixStatus>

GpsFixStatus defines the status of current GPS fix.

Author:

Kimmo Tuukkanen

See Also:

FaaMode, GpsFixQuality, DataStatus

Enum Constant Summary

Enum Constants

Enum Constant and Description
GPS_2D 2D GPS fix (lat/lon)
GPS_3D 3D GPS fix (lat/lon/alt)
GPS_NA No GPS fix available

Method Summary

Modifier and Type	Method and Description
int	toInt() Returns the corresponding int value for fix status enum.
static GpsFixStatus	valueOf(int val) Returns the GpsFixStatus enum corresponding to actual int identifier used in the sentences.
static GpsFixStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static GpsFixStatus[]	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

GPS_NA

public static final GpsFixStatus GPS_NA

No GPS fix available

GPS_2D

public static final GpsFixStatus GPS_2D

2D GPS fix (lat/lon)

GPS_3D

public static final GpsFixStatus GPS_3D

3D GPS fix (lat/lon/alt)

Method Detail

values

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

Returns:

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

valueOf

public static GpsFixStatus 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 value for fix status enum.

Returns:

Fix status integer values as in sentences

valueOf

public static GpsFixStatus valueOf(int val)

Returns the GpsFixStatus enum corresponding to actual int identifier used in the sentences.

Parameters:

val - Fix status indentifier int

Returns:

GpsFixStatus enum