net.sf.marineapi.nmea.sentence
Enum SentenceId

java.lang.Object
  java.lang.Enum<SentenceId>
      net.sf.marineapi.nmea.sentence.SentenceId

All Implemented Interfaces:

Serializable, Comparable<SentenceId>

public enum SentenceId
extends Enum<SentenceId>

Defines the supported NMEA 0831 sentence types. Sentence address field is a combination of talker and sentence IDs, for example GPBOD, GPGGA or GPGGL.

Version:

$Revision: 87 $

Author:

Kimmo Tuukkanen

See Also:

TalkerId

Enum Constant Summary

BOD
Bearing Origin to Destination

DBT
Depth of water below transducer; in meters, feet and fathoms

DPT
Depth of water below transducer; in meters.

GGA
Global Positioning System fix data

GLL
Geographic position (latitude/longitude)

GSA
Dilution of precision (DOP) of GPS fix and active satellites

GSV
Detailed satellite data

RMB
Recommended minimum navigation information

RMC
Recommended minimum specific GPS/TRANSIT data

RTE
Route data and waypoint list

WPL
Waypoint location (latitude/longitude)

VTG
Track made good and ground speed

ZDA
UTC time and date with local time zone offset

Method Summary

static SentenceId	parse(String nmea) Parses the sentence id from specified sentence String and returns a corresponding SentenceId enum (assuming it exists).
static String	parseStr(String nmea) Parses the sentence id from specified sentence String and returns it as String.
static SentenceId	valueOf(String name) Returns the enum constant of this type with the specified name.
static SentenceId[]	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

BOD

public static final SentenceId BOD

Bearing Origin to Destination

DBT

public static final SentenceId DBT

Depth of water below transducer; in meters, feet and fathoms

DPT

public static final SentenceId DPT

Depth of water below transducer; in meters.

GGA

public static final SentenceId GGA

Global Positioning System fix data

GLL

public static final SentenceId GLL

Geographic position (latitude/longitude)

GSA

public static final SentenceId GSA

Dilution of precision (DOP) of GPS fix and active satellites

GSV

public static final SentenceId GSV

Detailed satellite data

RMB

public static final SentenceId RMB

Recommended minimum navigation information

RMC

public static final SentenceId RMC

Recommended minimum specific GPS/TRANSIT data

RTE

public static final SentenceId RTE

Route data and waypoint list

VTG

public static final SentenceId VTG

Track made good and ground speed

WPL

public static final SentenceId WPL

Waypoint location (latitude/longitude)

ZDA

public static final SentenceId ZDA

UTC time and date with local time zone offset

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static SentenceId parse(String nmea)

Parses the sentence id from specified sentence String and returns a corresponding SentenceId enum (assuming it exists).

Parameters:

nmea - Sentence String

Returns:

SentenceId enum

Throws:

IllegalArgumentException - If specified String is not valid sentence

parseStr

public static String parseStr(String nmea)

Parses the sentence id from specified sentence String and returns it as String.

Parameters:

nmea - Sentence String

Returns:

Sentence Id, e.g. "GGA" or "GLL"

Throws:

IllegalArgumentException - If specified String is not valid