SentenceId (Java Marine API 0.10.0 API)

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.

Author:

Kimmo Tuukkanen

See Also:

TalkerId

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APB` Autopilot sentence "B"; xte, bearings and heading toward destination
`BOD` Bearing Origin to Destination
`CUR` Current
`DBT` Depth of water below transducer; in meters, feet and fathoms
`DPT` Depth of water below transducer; in meters.
`DTM` Datum reference.
`GGA` Global Positioning System fix data
`GLL` Geographic position (latitude/longitude)
`GNS` GNSS fix data (GPS, GLONASS and future constellations).
`GSA` Dilution of precision (DOP) of GPS fix and active satellites
`GSV` Detailed satellite data
`HDG` Vessel heading in degrees with magnetic variation and deviation.
`HDM` Vessel heading in degrees with respect to true north.
`HDT` Vessel heading in degrees true
`MDA` Meteorological Composite
`MHU` Relative and absolute humidity with dew point
`MMB` Barometric pressure in inches of mercury and bars.
`MTA` Air temperature in degrees centigrade (Celsius).
`MTW` Water temperature in degrees centigrade (Celsius).
`MWD` Wind speed and direction
`MWV` Wind speed and angle
`RMB` Recommended minimum navigation information
`RMC` Recommended minimum specific GPS/TRANSIT data
`ROT` Rate of Turn
`RPM` Revolutions measured from engine or shaft.
`RSA` Rudder angle, measured in degrees
`RTE` Route data and waypoint list
`TTM` Tracked target
`VBW` Dual ground/water speed and stern ground/water speed.
`VDM` AIS - Received data from other vessels
`VDO` AIS - Own vessel data
`VDR` Set and drift, direction and speed of current.
`VHW` Water speed and heading
`VLW` Distance traveled through water, cumulative and since reset.
`VTG` Track made good and ground speed
`VWR` Relative Wind Speed and Angle
`VWT` True Wind Speed and Angle
`WPL` Waypoint location (latitude/longitude)
`XDR` Transducer measurements (sensor data)
`XTE` Cross-track error, measured
`ZDA` UTC time and date with local time zone offset

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`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 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
  - APB
```
public static final SentenceId APB
```
    Autopilot sentence "B"; xte, bearings and heading toward destination
  - BOD
```
public static final SentenceId BOD
```
    Bearing Origin to Destination
  - CUR
```
public static final SentenceId CUR
```
    Current
  - 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.
  - DTM
```
public static final SentenceId DTM
```
    Datum reference.
  - GGA
```
public static final SentenceId GGA
```
    Global Positioning System fix data
  - GLL
```
public static final SentenceId GLL
```
    Geographic position (latitude/longitude)
  - GNS
```
public static final SentenceId GNS
```
    GNSS fix data (GPS, GLONASS and future constellations).
  - 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
  - HDG
```
public static final SentenceId HDG
```
    Vessel heading in degrees with magnetic variation and deviation.
  - HDM
```
public static final SentenceId HDM
```
    Vessel heading in degrees with respect to true north.
  - HDT
```
public static final SentenceId HDT
```
    Vessel heading in degrees true
  - MHU
```
public static final SentenceId MHU
```
    Relative and absolute humidity with dew point
  - MMB
```
public static final SentenceId MMB
```
    Barometric pressure in inches of mercury and bars.
  - MTA
```
public static final SentenceId MTA
```
    Air temperature in degrees centigrade (Celsius).
  - MTW
```
public static final SentenceId MTW
```
    Water temperature in degrees centigrade (Celsius).
  - MWV
```
public static final SentenceId MWV
```
    Wind speed and angle
  - RMB
```
public static final SentenceId RMB
```
    Recommended minimum navigation information
  - RMC
```
public static final SentenceId RMC
```
    Recommended minimum specific GPS/TRANSIT data
  - ROT
```
public static final SentenceId ROT
```
    Rate of Turn
  - RPM
```
public static final SentenceId RPM
```
    Revolutions measured from engine or shaft.
  - RSA
```
public static final SentenceId RSA
```
    Rudder angle, measured in degrees
  - RTE
```
public static final SentenceId RTE
```
    Route data and waypoint list
  - TTM
```
public static final SentenceId TTM
```
    Tracked target
  - VBW
```
public static final SentenceId VBW
```
    Dual ground/water speed and stern ground/water speed.
  - VDM
```
public static final SentenceId VDM
```
    AIS - Received data from other vessels
  - VDO
```
public static final SentenceId VDO
```
    AIS - Own vessel data
  - VDR
```
public static final SentenceId VDR
```
    Set and drift, direction and speed of current.
  - VLW
```
public static final SentenceId VLW
```
    Distance traveled through water, cumulative and since reset.
  - VTG
```
public static final SentenceId VTG
```
    Track made good and ground speed
  - VHW
```
public static final SentenceId VHW
```
    Water speed and heading
  - WPL
```
public static final SentenceId WPL
```
    Waypoint location (latitude/longitude)
  - VWR
```
public static final SentenceId VWR
```
    Relative Wind Speed and Angle
  - VWT
```
public static final SentenceId VWT
```
    True Wind Speed and Angle
  - XDR
```
public static final SentenceId XDR
```
    Transducer measurements (sensor data)
  - XTE
```
public static final SentenceId XTE
```
    Cross-track error, measured
  - MDA
```
public static final SentenceId MDA
```
    Meteorological Composite
  - MWD
```
public static final SentenceId MWD
```
    Wind speed and direction
  - ZDA
```
public static final SentenceId ZDA
```
    UTC time and date with local time zone offset
- Method Detail
  - values
```
public static SentenceId[] 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 (SentenceId c : SentenceId.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are 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
    
    NullPointerException - if the argument is null
  - 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 recognized as NMEA sentence

Enum SentenceId

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

APB

BOD

CUR

DBT

DPT

DTM

GGA

GLL

GNS

GSA

GSV

HDG

HDM

HDT

MHU

MMB

MTA

MTW

MWV

RMB

RMC

ROT

RPM

RSA

RTE

TTM

VBW

VDM

VDO

VDR

VLW

VTG

VHW

WPL

VWR

VWT

XDR

XTE

MDA

MWD

ZDA

Method Detail

values

valueOf

parse

parseStr