Goby3  3.1.5a
2024.05.23
goby::util::gps::RMC Struct Reference

#include <goby/util/linebasedcomms/gps_sentence.h>

Public Types

enum  Fields {
  UTC_TIME = 1, VALIDITY = 2, LATITUDE = 3, LATITUDE_NS = 4,
  LONGITUDE = 5, LONGITUDE_EW = 6, SPEED_OVER_GROUND = 7, COURSE_OVER_GROUND = 8,
  DATE = 9, MAGNETIC_VARIATION = 10, MAG_VARIATION_EW = 11, MODE = 12,
  NAV_STATUS = 13
}
 
enum  Status { DataValid, NavigationReceiverWarning }
 

Public Member Functions

 RMC ()=default
 
 RMC (const NMEASentence &sentence)
 
void parse (const NMEASentence &sentence)
 
NMEASentence serialize (std::string talker_id="GP", int num_fields=min_size) const
 

Public Attributes

boost::optional< goby::time::SystemClock::time_pointtime
 
boost::optional< boost::units::quantity< boost::units::degree::plane_angle > > latitude
 
boost::optional< boost::units::quantity< boost::units::degree::plane_angle > > longitude
 
boost::optional< boost::units::quantity< boost::units::si::velocity > > speed_over_ground
 
boost::optional< boost::units::quantity< boost::units::degree::plane_angle > > course_over_ground
 
boost::optional< boost::units::quantity< boost::units::degree::plane_angle > > magnetic_variation
 
boost::optional< Statusstatus
 

Static Public Attributes

constexpr static int min_size = MAG_VARIATION_EW + 1
 

Detailed Description

Definition at line 56 of file gps_sentence.h.

Member Enumeration Documentation

◆ Fields

Enumerator
UTC_TIME 
VALIDITY 
LATITUDE 
LATITUDE_NS 
LONGITUDE 
LONGITUDE_EW 
SPEED_OVER_GROUND 
COURSE_OVER_GROUND 
DATE 
MAGNETIC_VARIATION 
MAG_VARIATION_EW 
MODE 
NAV_STATUS 

Definition at line 75 of file gps_sentence.h.

◆ Status

Enumerator
DataValid 
NavigationReceiverWarning 

Definition at line 92 of file gps_sentence.h.

Constructor & Destructor Documentation

◆ RMC() [1/2]

goby::util::gps::RMC::RMC ( )
default

◆ RMC() [2/2]

goby::util::gps::RMC::RMC ( const NMEASentence sentence)
inline

Definition at line 61 of file gps_sentence.h.

Member Function Documentation

◆ parse()

void goby::util::gps::RMC::parse ( const NMEASentence sentence)

◆ serialize()

NMEASentence goby::util::gps::RMC::serialize ( std::string  talker_id = "GP",
int  num_fields = min_size 
) const

Member Data Documentation

◆ course_over_ground

boost::optional<boost::units::quantity<boost::units::degree::plane_angle> > goby::util::gps::RMC::course_over_ground

Definition at line 71 of file gps_sentence.h.

◆ latitude

boost::optional<boost::units::quantity<boost::units::degree::plane_angle> > goby::util::gps::RMC::latitude

Definition at line 68 of file gps_sentence.h.

◆ longitude

boost::optional<boost::units::quantity<boost::units::degree::plane_angle> > goby::util::gps::RMC::longitude

Definition at line 69 of file gps_sentence.h.

◆ magnetic_variation

boost::optional<boost::units::quantity<boost::units::degree::plane_angle> > goby::util::gps::RMC::magnetic_variation

Definition at line 73 of file gps_sentence.h.

◆ min_size

constexpr static int goby::util::gps::RMC::min_size = MAG_VARIATION_EW + 1
staticconstexpr

Definition at line 100 of file gps_sentence.h.

◆ speed_over_ground

boost::optional<boost::units::quantity<boost::units::si::velocity> > goby::util::gps::RMC::speed_over_ground

Definition at line 70 of file gps_sentence.h.

◆ status

boost::optional<Status> goby::util::gps::RMC::status

Definition at line 98 of file gps_sentence.h.

◆ time

boost::optional<goby::time::SystemClock::time_point> goby::util::gps::RMC::time

Definition at line 66 of file gps_sentence.h.


The documentation for this struct was generated from the following file: