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

NMEA-Gx-VTG message payload. More...

#include <nmea.hpp>

Inheritance diagram for fpsdk::common::parser::nmea::NmeaVtgPayload:
[legend]
Collaboration diagram for fpsdk::common::parser::nmea::NmeaVtgPayload:
[legend]

Public Member Functions

bool SetFromMsg (const uint8_t *msg, const std::size_t msg_size) final
 Set data from message.
Public Member Functions inherited from fpsdk::common::parser::nmea::NmeaPayload
virtual ~NmeaPayload ()=default
 Virtual dtor for polymorphism.
bool SetFromBuf (const std::vector< uint8_t > &buf)
 Set data from message.

Public Attributes

NmeaFloat cogt
 Course over ground (true) [deg].
NmeaFloat cogm
 Course over ground (magnetic) [deg], not typically available.
NmeaFloat sogn
 Speed over ground [knots].
NmeaFloat sogk
 Speed over ground [km/h].
NmeaModeGllVtg mode = NmeaModeGllVtg::UNSPECIFIED
 Positioning system mode.
Public Attributes inherited from fpsdk::common::parser::nmea::NmeaPayload
NmeaTalkerId talker_ = NmeaTalkerId::UNSPECIFIED
 Talker.
NmeaFormatter formatter_ = NmeaFormatter::UNSPECIFIED
 Formatter.
bool valid_ = false
 Payload successfully decoded (true), or not (yet) decoded (false)

Static Public Attributes

static constexpr const char * FORMATTER = "VTG"
 Talker.

Detailed Description

NMEA-Gx-VTG message payload.

Definition at line 601 of file nmea.hpp.

Member Function Documentation

◆ SetFromMsg()

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

Set data from message.

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)

Implements fpsdk::common::parser::nmea::NmeaPayload.

Member Data Documentation

◆ cogt

NmeaFloat fpsdk::common::parser::nmea::NmeaVtgPayload::cogt

Course over ground (true) [deg].

Definition at line 603 of file nmea.hpp.

◆ cogm

NmeaFloat fpsdk::common::parser::nmea::NmeaVtgPayload::cogm

Course over ground (magnetic) [deg], not typically available.

Definition at line 604 of file nmea.hpp.

◆ sogn

NmeaFloat fpsdk::common::parser::nmea::NmeaVtgPayload::sogn

Speed over ground [knots].

Definition at line 605 of file nmea.hpp.

◆ sogk

NmeaFloat fpsdk::common::parser::nmea::NmeaVtgPayload::sogk

Speed over ground [km/h].

Definition at line 606 of file nmea.hpp.

◆ mode

NmeaModeGllVtg fpsdk::common::parser::nmea::NmeaVtgPayload::mode = NmeaModeGllVtg::UNSPECIFIED

Positioning system mode.

Definition at line 607 of file nmea.hpp.

◆ FORMATTER

const char* fpsdk::common::parser::nmea::NmeaVtgPayload::FORMATTER = "VTG"
staticconstexpr

Talker.

Definition at line 611 of file nmea.hpp.


The documentation for this struct was generated from the following file:
  • fpsdk_common/include/fpsdk_common/parser/nmea.hpp