NMEA payload base class. More...

#include <nmea.hpp>

Inheritance diagram for fpsdk::common::parser::nmea::NmeaPayload:

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

Public Attributes
NmeaTalkerId	talker_ = NmeaTalkerId::UNSPECIFIED
	Talker.
NmeaFormatter	formatter_ = NmeaFormatter::UNSPECIFIED
	Formatter.
bool	valid_ = false
	Payload successfully decoded (true), or not (yet) decoded (false)

Detailed Description

NMEA payload base class.

Definition at line 513 of file nmea.hpp.

Member Function Documentation

◆ SetFromMsg()

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

pure virtual

Set data from message.

Parameters

[in]	msg	Pointer to the NMEA message
[in]	msg_size	Size 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)

Implemented in fpsdk::common::parser::nmea::NmeaGgaPayload, fpsdk::common::parser::nmea::NmeaGllPayload, fpsdk::common::parser::nmea::NmeaGsaPayload, fpsdk::common::parser::nmea::NmeaGstPayload, fpsdk::common::parser::nmea::NmeaGsvPayload, fpsdk::common::parser::nmea::NmeaHdtPayload, fpsdk::common::parser::nmea::NmeaRmcPayload, fpsdk::common::parser::nmea::NmeaVtgPayload, and fpsdk::common::parser::nmea::NmeaZdaPayload.

Referenced by SetFromBuf().

◆ SetFromBuf()

bool fpsdk::common::parser::nmea::NmeaPayload::SetFromBuf ( const std::vector< uint8_t > & buf )

inline

Set data from message.

Parameters

[in] buf The NMEA message data

Returns: true if message payload was correct and all data could be extracted (fields are now valid), or false otherwise (fields are now invalid)

Definition at line 539 of file nmea.hpp.

References SetFromMsg().

Member Data Documentation

◆ talker_

NmeaTalkerId fpsdk::common::parser::nmea::NmeaPayload::talker_ = NmeaTalkerId::UNSPECIFIED

Talker.

Definition at line 515 of file nmea.hpp.

◆ formatter_

NmeaFormatter fpsdk::common::parser::nmea::NmeaPayload::formatter_ = NmeaFormatter::UNSPECIFIED

Formatter.

Definition at line 516 of file nmea.hpp.

◆ valid_

bool fpsdk::common::parser::nmea::NmeaPayload::valid_ = false

Payload successfully decoded (true), or not (yet) decoded (false)

Definition at line 517 of file nmea.hpp.

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

fpsdk_common/include/fpsdk_common/parser/nmea.hpp

Public Member Functions

Public Attributes