NDEVR
API Documentation
NMEASentenceReaderabstract

Abstract base class for parsing specific NMEA sentence types (e.g. More...

Inheritance diagram for NMEASentenceReader:
[legend]
Collaboration diagram for NMEASentenceReader:
[legend]

Public Member Functions

virtual StringView name () const =0
 Returns the display name of this sentence reader.
virtual NMEAUpdateInfo processRxCommand (const StringView &command, const StringView &data, NMEAInfo &info)=0
 Processes a received NMEA command and its data payload.
virtual Buffer< StringViewsupportedTypes () const =0
 Returns the NMEA sentence types this reader can handle.

Public Attributes

TimeSpan average_rx_rate = Constant<TimeSpan>::Invalid
 Average time between received messages.
uint04 count = 0
 Total number of messages processed.
Time last_rx_time = Constant<Time>::Invalid
 Time of the last received message.

Protected Member Functions

void onMessageReceived ()
 Updates receive timing statistics after processing a message.

Protected Attributes

Buffer< StringViewm_sentence_parts
 Temporary storage for parsed sentence fields.

Detailed Description

Abstract base class for parsing specific NMEA sentence types (e.g.

GGA, GSV, RMC). Subclasses implement processRxCommand to handle their specific sentence format.

Definition at line 11 of file NMEAParserPacket.h.

Member Function Documentation

◆ name()

virtual StringView NMEASentenceReader::name ( ) const
pure virtual

Returns the display name of this sentence reader.

Returns
The reader name.

Implemented in CNMEASentenceGGA, CNMEASentenceGSA, CNMEASentenceGST, CNMEASentenceGSV, CNMEASentencePCSW, and CNMEASentenceRMC.

◆ processRxCommand()

virtual NMEAUpdateInfo NMEASentenceReader::processRxCommand ( const StringView & command,
const StringView & data,
NMEAInfo & info )
pure virtual

Processes a received NMEA command and its data payload.

Parameters
[in]commandThe NMEA command type (e.g. "GGA").
[in]dataThe comma-separated data payload.
[in]infoThe NMEA info structure to update.
Returns
Update information describing what changed.

Implemented in CNMEASentenceGGA, CNMEASentenceGSA, CNMEASentenceGST, CNMEASentenceGSV, CNMEASentencePCSW, and CNMEASentenceRMC.

◆ supportedTypes()

virtual Buffer< StringView > NMEASentenceReader::supportedTypes ( ) const
pure virtual

Returns the NMEA sentence types this reader can handle.

Returns
A buffer of supported type identifiers.

Implemented in CNMEASentenceGGA, CNMEASentenceGSA, CNMEASentenceGST, CNMEASentenceGSV, CNMEASentencePCSW, and CNMEASentenceRMC.


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