GPGGA Class Reference

#include <NMEA.h>

Inheritance diagram for GPGGA:

NMEA

List of all members.


Detailed Description

NMEA GPGGA message.

GPGGA Message Format


Public Types

enum  FIELDS {
  GGAMSG = NMEA::FIELD_0, GGATIME, GGALATD, GGALATM,
  GGALATH, GGALOND, GGALONM, GGALONH,
  GGAQUAL, GGASIU, GGAHDOP, GGAALT,
  GGAALTU, GGAGEOH, GGAGEOHU, GGADUPT,
  GGADRID, GGACHK
}
 GPGGA Field mnemonics. More...

Public Member Functions

 GPGGA ()
 Default no argument constructor.
int setTIME (time_t time)
 Set time field.
int setLATD (int latd)
 Set lat degrees field.
int setLATM (double latm)
 Set lat minutes field.
int setLATH (char lath)
 Set lat hemisphere field.
int setLOND (int lond)
 Set lon degrees field.
int setLONM (double lonm)
 Set lon min field.
int setLONH (char lonh)
 Set lon hemisphere field.
int setQUAL (int qual)
 Set signal quality field.
int setHDOP (double hdop)
 Set horizontal dilution of precision field.
int setALT (double alt)
 Set altitude field.
int setALTU (char altu)
 Set altitude units field.
int setSIU (int siu)
 Set satellites in use field.
int setGEOH (double alt)
 Set geoid separation field.
int setGEOHU (char geohu)
 Set geoid separation units field.
int setDUPT (int dupt)
 Set age of differential correlation field.
int setDRID (int drid)
 Set differential reference station ID field.
virtual const char * toString ()
 Format NMEA string using current field values.

Friends

ostream & operator<< (ostream &output, const GPGGA &n)
 output stream operator

Member Enumeration Documentation

enum GPGGA::FIELDS

GPGGA Field mnemonics.

These are mapped onto the field enumerations in the base class.

Reimplemented from NMEA.


Member Function Documentation

int GPGGA::setTIME ( time_t  time  ) 

Set time field.

Parameters:
time new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setLATD ( int  latd  ) 

Set lat degrees field.

Parameters:
latd new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setLATM ( double  latm  ) 

Set lat minutes field.

Parameters:
latm new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setLATH ( char  lath  ) 

Set lat hemisphere field.

Parameters:
lath new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setLOND ( int  lond  ) 

Set lon degrees field.

Parameters:
lond new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setLONM ( double  lonm  ) 

Set lon min field.

Parameters:
lonm new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setLONH ( char  lonh  ) 

Set lon hemisphere field.

Parameters:
lonh new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setQUAL ( int  qual  ) 

Set signal quality field.

Parameters:
qual new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setHDOP ( double  hdop  ) 

Set horizontal dilution of precision field.

Parameters:
hdop new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setALT ( double  alt  ) 

Set altitude field.

Parameters:
alt new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setALTU ( char  altu  ) 

Set altitude units field.

Parameters:
altu new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setSIU ( int  siu  ) 

Set satellites in use field.

Parameters:
siu new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setGEOH ( double  geoh  ) 

Set geoid separation field.

Parameters:
geoh new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setGEOHU ( char  geohu  ) 

Set geoid separation units field.

Parameters:
geohu new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setDUPT ( int  dupt  ) 

Set age of differential correlation field.

Parameters:
dupt new value
Returns:
OK on success, ERROR otherwise

int GPGGA::setDRID ( int  drid  ) 

Set differential reference station ID field.

Parameters:
drid new value
Returns:
OK on success, ERROR otherwise

const char * GPGGA::toString (  )  [virtual]

Format NMEA string using current field values.

See also:
NMEA.h


Friends And Related Function Documentation

ostream& operator<< ( ostream &  output,
const GPGGA n 
) [friend]

output stream operator

Formats object for output stream insertion

Parameters:
output output stream handle
n GPGGA object pointer


The documentation for this class was generated from the following files:
Generated on Tue Jul 15 13:10:24 2008 for Benthic Imaging AUV by  doxygen 1.5.4