fpsdk::common::parser::nmea::NmeaCollectGsaGsv Struct Reference

Collector for NMEA-Gx-GSA and NMEA-Gx-GPA. More...

#include <nmea.hpp>

Collaboration diagram for fpsdk::common::parser::nmea::NmeaCollectGsaGsv:

Classes
struct	Sat
	Satellite info. More...
struct	Sig

Public Member Functions
bool	AddGsa (const NmeaGsaPayload &gsa)
	Add NMEA-GN-GSA message to collection.
bool	AddGsv (const NmeaGsvPayload &gsv)
	Add NMEA-Gx-GSV message to collection.
void	Complete ()
	Complete collection after feeding all GSA and GSV messages.
bool	AddGsaAndGsv (const std::vector< NmeaGsaPayload > &gsas, const std::vector< NmeaGsvPayload > &gsvs)
	Add NMEA-GN-GSA and NMEA-Gx-GSV messages to collection.

Public Attributes
std::vector< Sat >	sats_
	Collected satellite info.
std::vector< Sig >	sigs_
	Collected signal info.

Detailed Description

Collector for NMEA-Gx-GSA and NMEA-Gx-GPA.

Note that the user is responsible to call Complete() on every end of epoch. This collector by itself has no means to determine start or end of epoch. If Complete() is not called, the Add...() methods refuse to collect more data after a certain threshold (see MAX_COLLECT below) and fail. This is to prevent memory growing forever if Complete() is not called appropriately.

Definition at line 868 of file nmea.hpp.

Member Function Documentation

AddGsa()

bool fpsdk::common::parser::nmea::NmeaCollectGsaGsv::AddGsa

(

const NmeaGsaPayload &

gsa

)

Add NMEA-GN-GSA message to collection.

These must be provided in order and completely, and before the GSV messages.

Parameters

[in]

gsa

Decoded message payload

Returns

true if the message was accepted, false otherwise

AddGsv()

bool fpsdk::common::parser::nmea::NmeaCollectGsaGsv::AddGsv

(

const NmeaGsvPayload &

gsv

)

Add NMEA-Gx-GSV message to collection.

These must be provided in order and completely, and after the GSA messages.

Parameters

[in]

gsv

Decoded message payload

Returns

true if the message was accepted, false otherwise

AddGsaAndGsv()

bool fpsdk::common::parser::nmea::NmeaCollectGsaGsv::AddGsaAndGsv	(	const std::vector< NmeaGsaPayload > &	gsas,
		const std::vector< NmeaGsvPayload > &	gsvs )

Add NMEA-GN-GSA and NMEA-Gx-GSV messages to collection.

Does all of AddGsa(), AddGsv() and Complete() in one call.

Parameters

[in]	gsas	All decoded message payloads, complete and in order
[in]	gsvs	All decoded message payloads, complete and in order

Returns

true if all messages were collected successfully

Member Data Documentation

sats_

std::vector<Sat> fpsdk::common::parser::nmea::NmeaCollectGsaGsv::sats_

Collected satellite info.

Definition at line 893 of file nmea.hpp.

sigs_

std::vector<Sig> fpsdk::common::parser::nmea::NmeaCollectGsaGsv::sigs_

Collected signal info.

Definition at line 894 of file nmea.hpp.

---

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

• fpsdk_common/include/fpsdk_common/parser/nmea.hpp