net.sf.marineapi.nmea.util
Enum GpsMode

java.lang.Object
  java.lang.Enum<GpsMode>
      net.sf.marineapi.nmea.util.GpsMode

All Implemented Interfaces:

Serializable, Comparable<GpsMode>

public enum GpsMode
extends Enum<GpsMode>

GpsMode defines the supported GPS operating modes.

Version:

$Revision: 31 $

Author:

Kimmo Tuukkanen

Enum Constant Summary

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

char	toChar() Returns the corresponding char indicator of GPS mode.
static GpsMode	valueOf(char ch) Returns the GpsMode enum corresponding the actual char indicator used in the sentencess.
static GpsMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static GpsMode[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTOMATIC

public static final GpsMode AUTOMATIC

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

MANUAL

public static final GpsMode MANUAL

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

DGPS

public static final GpsMode DGPS

Operating in differential mode (DGPS).

ESTIMATED

public static final GpsMode ESTIMATED

Operating in estimating mode (dead-reckoning).

SIMULATED

public static final GpsMode SIMULATED

Simulated data (running in simulator/demo mode)

NONE

public static final GpsMode NONE

No valid GPS data available.

Method Detail

values

public static final GpsMode[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(GpsMode c : GpsMode.values())
        System.out.println(c);

Returns:

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

valueOf

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

toChar

public char toChar()

Returns the corresponding char indicator of GPS mode.

Returns:

Mode char used in sentences.

valueOf

public static GpsMode valueOf(char ch)

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

Parameters:

ch - Char mode indicator

Returns:

GpsMode enum