net.sf.marineapi.nmea.sentence

Enum TalkerId

java.lang.Object

java.lang.Enum<TalkerId>

net.sf.marineapi.nmea.sentence.TalkerId

All Implemented Interfaces:

Serializable, Comparable<TalkerId>

public enum TalkerId
extends Enum<TalkerId>

The enumeration of Talker IDs, i.e. the first two characters in sentence's address field. For example, GP in $GPGGA. Notice that proprietary sentences are identified by single character P.

This enum contains also non-NMEA IDs to enable parsing AIS messages; AI, AB and BS. However, the correct meaning of these are still unconfirmed.

Author:

Kimmo Tuukkanen

See Also:

SentenceId

Enum Constant Summary

Enum Constants

Enum Constant and Description
AB AIS "Broadcast" message (to support ABVDM)
AG Autopilot - General
AI AIS (to support AIVDM and AIVDO)
AP Autopilot - Magnetic
BD Beidou satellite navigation system (Chinese)
BS AIS "Base Station" message (to support BSVDM)
CC Deprecated.
CD Communications - Digital Selective Calling (DSC)
CM Deprecated.
CP Channel Pilot (Navicom Dynamics proprietary)
CS Communications - Satellite
CT Communications - Radio-Telephone (MF/HF)
CV Communications - Radio-Telephone (VHF)
CX Communications - Scanning Receiver
DE Deprecated.
DF Direction Finder
DM Velocity Sensor, Speed Log, Water, Magnetic
EC Electronic Chart Display < Information System (ECDIS)
EP Emergency Position Indicating Beacon (EPIRB)
ER Engine Room Monitoring Systems
GA Galileo satellite navigation system (European)
GB Beidou satellite navigation system (Chinese)
GI Indian Regional Navigation Satellite System (IRNSS)
GL GLONASS (according to IEIC 61162-1)
GN Mixed GLONASS and GPS data (according to IEIC 61162-1)
GP Global Positioning System (GPS)
GQ Quasi Zenith Satellite System (QXSS, Japanese)
HC Heading - Magnetic Compass
HE Heading - North Seeking Gyro
HN Heading - Non North Seeking Gyro
II Integrated Instrumentation
IN Integrated Navigation
IR Indian Regional Navigation Satellite System (IRNSS)
LA Deprecated.
LC Deprecated.
MP Deprecated.
OM Deprecated.
OS Deprecated.
P Proprietary sentence format (does not define the talker device).
QZ QZSS regional GPS augmentation system (Japan)
RA RADAR and/or ARPA
RC Propulsion Remote Control System
SD Sounder, Depth
SN Electronic Positioning System, other/general
SS Sounder, Scanning
TI Turn Rate Indicator
TR TRANSIT Navigation System
VD Velocity Sensor, Doppler, other/general
VM Velocity Sensor, Speed Log, Water, Magnetic
VW Velocity Sensor, Speed Log, Water, Mechanical
WI Weather Instruments
YC Deprecated.
YD Deprecated.
YF Deprecated.
YL Deprecated.
YP Deprecated.
YR Deprecated.
YT Deprecated.
YV Deprecated.
YX Transducer
ZA Timekeeper - Atomic Clock
ZC Timekeeper - Chronometer
ZQ Timekeeper - Quartz
ZV Timekeeper - Radio Update, WWV or WWVH

Method Summary

Methods

Modifier and Type	Method and Description
static TalkerId	parse(String nmea) Parses the talker id from specified sentence String and returns the corresponding TalkerId enum using the valueOf(String) method.
static TalkerId	valueOf(String name) Returns the enum constant of this type with the specified name.
static TalkerId[]	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

AI

public static final TalkerId AI

AIS (to support AIVDM and AIVDO)

AB

public static final TalkerId AB

AIS "Broadcast" message (to support ABVDM)

BS

public static final TalkerId BS

AIS "Base Station" message (to support BSVDM)

AG

public static final TalkerId AG

Autopilot - General

AP

public static final TalkerId AP

Autopilot - Magnetic

BD

public static final TalkerId BD

Beidou satellite navigation system (Chinese)

CC

@Deprecated
public static final TalkerId CC

Deprecated.

Computer - Programmed Calculator (obsolete)

CD

public static final TalkerId CD

Communications - Digital Selective Calling (DSC)

CM

@Deprecated
public static final TalkerId CM

Deprecated.

Computer - Memory Data (obsolete)

CP

public static final TalkerId CP

Channel Pilot (Navicom Dynamics proprietary)

CS

public static final TalkerId CS

Communications - Satellite

CT

public static final TalkerId CT

Communications - Radio-Telephone (MF/HF)

CV

public static final TalkerId CV

Communications - Radio-Telephone (VHF)

CX

public static final TalkerId CX

Communications - Scanning Receiver

DE

@Deprecated
public static final TalkerId DE

Deprecated.

DECCA Navigation (obsolete)

DF

public static final TalkerId DF

Direction Finder

DM

public static final TalkerId DM

Velocity Sensor, Speed Log, Water, Magnetic

EC

public static final TalkerId EC

Electronic Chart Display < Information System (ECDIS)

EP

public static final TalkerId EP

Emergency Position Indicating Beacon (EPIRB)

ER

public static final TalkerId ER

Engine Room Monitoring Systems

GA

public static final TalkerId GA

Galileo satellite navigation system (European)

GB

public static final TalkerId GB

Beidou satellite navigation system (Chinese)

GI

public static final TalkerId GI

Indian Regional Navigation Satellite System (IRNSS)

GL

public static final TalkerId GL

GLONASS (according to IEIC 61162-1)

GN

public static final TalkerId GN

Mixed GLONASS and GPS data (according to IEIC 61162-1)

GP

public static final TalkerId GP

Global Positioning System (GPS)

GQ

public static final TalkerId GQ

Quasi Zenith Satellite System (QXSS, Japanese)

HC

public static final TalkerId HC

Heading - Magnetic Compass

HE

public static final TalkerId HE

Heading - North Seeking Gyro

HN

public static final TalkerId HN

Heading - Non North Seeking Gyro

II

public static final TalkerId II

Integrated Instrumentation

IN

public static final TalkerId IN

Integrated Navigation

LA

@Deprecated
public static final TalkerId LA

Deprecated.

Loran A (obsolete)

LC

@Deprecated
public static final TalkerId LC

Deprecated.

Loran C (obsolete)

MP

@Deprecated
public static final TalkerId MP

Deprecated.

Microwave Positioning System (obsolete)

OM

@Deprecated
public static final TalkerId OM

Deprecated.

OMEGA Navigation System (obsolete)

OS

@Deprecated
public static final TalkerId OS

Deprecated.

Distress Alarm System (obsolete)

P

public static final TalkerId P

Proprietary sentence format (does not define the talker device).

QZ

public static final TalkerId QZ

QZSS regional GPS augmentation system (Japan)

RA

public static final TalkerId RA

RADAR and/or ARPA

RC

public static final TalkerId RC

Propulsion Remote Control System

IR

public static final TalkerId IR

Indian Regional Navigation Satellite System (IRNSS)

SD

public static final TalkerId SD

Sounder, Depth

SN

public static final TalkerId SN

Electronic Positioning System, other/general

SS

public static final TalkerId SS

Sounder, Scanning

TI

public static final TalkerId TI

Turn Rate Indicator

TR

public static final TalkerId TR

TRANSIT Navigation System

VD

public static final TalkerId VD

Velocity Sensor, Doppler, other/general

VM

public static final TalkerId VM

Velocity Sensor, Speed Log, Water, Magnetic

VW

public static final TalkerId VW

Velocity Sensor, Speed Log, Water, Mechanical

WI

public static final TalkerId WI

Weather Instruments

YC

@Deprecated
public static final TalkerId YC

Deprecated.

Transducer - Temperature (obsolete)

YD

@Deprecated
public static final TalkerId YD

Deprecated.

Transducer - Displacement, Angular or Linear (obsolete)

YF

@Deprecated
public static final TalkerId YF

Deprecated.

Transducer - Frequency (obsolete)

YL

@Deprecated
public static final TalkerId YL

Deprecated.

Transducer - Level (obsolete)

YP

@Deprecated
public static final TalkerId YP

Deprecated.

Transducer - Pressure (obsolete)

YR

@Deprecated
public static final TalkerId YR

Deprecated.

Transducer - Flow Rate (obsolete)

YT

@Deprecated
public static final TalkerId YT

Deprecated.

Transducer - Tachometer (obsolete)

YV

@Deprecated
public static final TalkerId YV

Deprecated.

Transducer - Volume (obsolete)

YX

public static final TalkerId YX

Transducer

ZA

public static final TalkerId ZA

Timekeeper - Atomic Clock

ZC

public static final TalkerId ZC

Timekeeper - Chronometer

ZQ

public static final TalkerId ZQ

Timekeeper - Quartz

ZV

public static final TalkerId ZV

Timekeeper - Radio Update, WWV or WWVH

Method Detail

values

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

Returns:

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

valueOf

public static TalkerId 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 TalkerId parse(String nmea)

Parses the talker id from specified sentence String and returns the corresponding TalkerId enum using the valueOf(String) method.

Parameters:

nmea - Sentence String

Returns:

TalkerId enum

Throws:

IllegalArgumentException - If specified String is not recognized as NMEA sentence