GPRMC Class Reference

#include <NMEA.h>

Inheritance diagram for GPRMC:

NMEA

List of all members.

Detailed Description

NMEA GPRMC message.

GPRMC Message Format


Public Types

enum  FIELDS {
  RMCMSG = NMEA::FIELD_0, RMCTIME, RMCSTAT, RMCLATD,
  RMCLATM, RMCLATH, RMCLOND, RMCLONM,
  RMCLONH, RMCSOG, RMCCOG, RMCDATE,
  RMCMVM, RMCMVD, RMCCHK
}
 GPRMC Field mnemonics. More...

Public Member Functions

 GPRMC ()
 Default no argument constructor.
int setTIME (time_t time)
 Set time field.
int setSTAT (char stat)
 Set status 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 setSOG (double sog)
 Set speed over ground field.
int setCOG (double cog)
 Set course over ground field.
int setDATE (time_t date)
 Set date field.
int setMVM (double nvn)
 Set Magnetic Variation Magnitude.
int setMVD (char mvd)
 Set Magnetic Variation Direction.
virtual const char * toString ()
 Generate NMEA string from current field values.

Friends

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

Member Enumeration Documentation

enum GPRMC::FIELDS

GPRMC Field mnemonics.

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

See also:
NMEA::FIELDS

Reimplemented from NMEA.

Member Function Documentation

int GPRMC::setTIME ( time_t  time  ) 

Set time field.

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

int GPRMC::setSTAT ( char  stat  ) 

Set status field.

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

int GPRMC::setLATD ( int  latd  ) 

Set lat degrees field.

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

int GPRMC::setLATM ( double  latm  ) 

Set lat minutes field.

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

int GPRMC::setLATH ( char  lath  ) 

Set lat hemisphere field.

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

int GPRMC::setLOND ( int  lond  ) 

Set lon degrees field.

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

int GPRMC::setLONM ( double  lonm  ) 

Set lon min field.

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

int GPRMC::setLONH ( char  lonh  ) 

Set lon hemisphere field.

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

int GPRMC::setSOG ( double  sog  ) 

Set speed over ground field.

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

int GPRMC::setCOG ( double  cog  ) 

Set course over ground field.

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

int GPRMC::setDATE ( time_t  date  ) 

Set date field.

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

int GPRMC::setMVM ( double  mvm  ) 

Set Magnetic Variation Magnitude.

Parameters:
mvm (0.0-180.0 degrees)
Returns:
OK on success, ERROR otherwise (may indicate input range error)

int GPRMC::setMVD ( char  mvd  ) 

Set Magnetic Variation Direction.

Parameters:
mvd ('E':East|'W':West)
Returns:
OK on success, ERROR otherwise (may indicate input range error)

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

Generate NMEA string from current field values.

Returns:
string representation of NMEA message.

Friends And Related Function Documentation

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

output stream operator

Formats object for output stream insertion

Parameters:
output output stream handle
n Field object pointer

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