Fixposition SDK 0.0.0-heads/main-0-g90a51ff
Collection of c++ libraries and apps for use with Fixposition products
Loading...
Searching...
No Matches
fpsdk::common::parser::nmea::NmeaGgaPayload Struct Reference

NMEA-Gx-GGA message payload. More...

#include <nmea.hpp>

Inheritance diagram for fpsdk::common::parser::nmea::NmeaGgaPayload:
Collaboration diagram for fpsdk::common::parser::nmea::NmeaGgaPayload:

Public Member Functions

bool SetFromMsg (const uint8_t *msg, const std::size_t msg_size)
 Set data from sentence.
 
- Public Member Functions inherited from fpsdk::common::parser::nmea::NmeaPayload
virtual ~NmeaPayload ()=default
 Virtual dtor for polymorphism.
 

Public Attributes

NmeaTime time
 Time.
 
NmeaLlh llh
 Position (with height)
 
NmeaQualityGga quality = NmeaQualityGga::UNSPECIFIED
 Fix quality.
 
NmeaInt num_sv
 Number of satellites used (may be limited to 12)
 
NmeaFloat hdop
 Horizontal dilution of precision (only with valid fix)
 
NmeaFloat diff_age
 Differential data age (optional, NMEA 4.11 only)
 
NmeaInt diff_sta
 Differential station ID (optional, NMEA 4.11 only)
 
- Public Attributes inherited from fpsdk::common::parser::nmea::NmeaPayload
NmeaTalkerId talker = NmeaTalkerId::UNSPECIFIED
 Talker.
 
bool valid_ = false
 Payload successfully decoded (true), or not (yet) decoded (false)
 

Static Public Attributes

static constexpr const char * FORMATTER = "GGA"
 Formatter.
 

Detailed Description

NMEA-Gx-GGA message payload.

Definition at line 471 of file nmea.hpp.

Member Function Documentation

◆ SetFromMsg()

bool fpsdk::common::parser::nmea::NmeaGgaPayload::SetFromMsg ( const uint8_t * msg,
const std::size_t msg_size )

Set data from sentence.

Parameters
[in]msgPointer to the NMEA message
[in]msg_sizeSize of the NMEA message (>= 11)
Returns
true if sentence payload was correct and all data could be extracted (fields are now valid), or false otherwise (fields are now invalid)

Member Data Documentation

◆ time

NmeaTime fpsdk::common::parser::nmea::NmeaGgaPayload::time

Time.

Definition at line 473 of file nmea.hpp.

◆ llh

NmeaLlh fpsdk::common::parser::nmea::NmeaGgaPayload::llh

Position (with height)

Definition at line 474 of file nmea.hpp.

◆ quality

NmeaQualityGga fpsdk::common::parser::nmea::NmeaGgaPayload::quality = NmeaQualityGga::UNSPECIFIED

Fix quality.

Definition at line 475 of file nmea.hpp.

◆ num_sv

NmeaInt fpsdk::common::parser::nmea::NmeaGgaPayload::num_sv

Number of satellites used (may be limited to 12)

Definition at line 476 of file nmea.hpp.

◆ hdop

NmeaFloat fpsdk::common::parser::nmea::NmeaGgaPayload::hdop

Horizontal dilution of precision (only with valid fix)

Definition at line 477 of file nmea.hpp.

◆ diff_age

NmeaFloat fpsdk::common::parser::nmea::NmeaGgaPayload::diff_age

Differential data age (optional, NMEA 4.11 only)

Definition at line 478 of file nmea.hpp.

◆ diff_sta

NmeaInt fpsdk::common::parser::nmea::NmeaGgaPayload::diff_sta

Differential station ID (optional, NMEA 4.11 only)

Definition at line 479 of file nmea.hpp.

◆ FORMATTER

const char* fpsdk::common::parser::nmea::NmeaGgaPayload::FORMATTER = "GGA"
staticconstexpr

Formatter.

Definition at line 492 of file nmea.hpp.


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