Detailed Description

Defines a class that is used by NavFilter and child classes to both identify the source of a navigation message as well as the message itself. The navigation messages are defined as child classes of NavFilterKey such that the message-format specific data is defined.

To put it another way, this is the base class and the child classes define the data storage for the nav message.

Note: The data members in this class are not always required to be set. The use of the data field members is filter-dependent. Consult the preconditions of the validate method of the filters in use to determine which data members MUST be set.

Definition at line 66 of file NavFilterKey.hpp.

#include <NavFilterKey.hpp>

Inheritance diagram for gnsstk::NavFilterKey:

[legend]

Public Member Functions
virtual void	dump (std::ostream &s) const

	NavFilterKey ()
	Initialize key members to empty defaults. More...

Public Attributes
CarrierBand	carrier
	carrier band of navigation message More...

gnsstk::TrackingCode	code
	ranging code of navigation message More...

uint32_t	prn
	identifier of broadcasting satellite More...

std::string	rxID
	receiver identifier for data source More...

std::string	stationID
	site/station identifier for data source More...

gnsstk::CommonTime	timeStamp

Protected Member Functions
virtual void	dummy ()

Constructor & Destructor Documentation

◆ NavFilterKey()

gnsstk::NavFilterKey::NavFilterKey ( )

Initialize key members to empty defaults.

Definition at line 45 of file NavFilterKey.cpp.

Member Function Documentation

◆ dummy()

virtual void gnsstk::NavFilterKey::dummy ( )

inlineprotectedvirtual

Definition at line 90 of file NavFilterKey.hpp.

◆ dump()

void gnsstk::NavFilterKey::dump ( std::ostream & s ) const

virtual

Reimplemented in gnsstk::GenericNavFilterData, gnsstk::LNavFilterData, and gnsstk::CNavFilterData.

Definition at line 53 of file NavFilterKey.cpp.

Member Data Documentation

◆ carrier

CarrierBand gnsstk::NavFilterKey::carrier

carrier band of navigation message

Definition at line 79 of file NavFilterKey.hpp.

◆ code

gnsstk::TrackingCode gnsstk::NavFilterKey::code

ranging code of navigation message

Definition at line 80 of file NavFilterKey.hpp.

◆ prn

uint32_t gnsstk::NavFilterKey::prn

identifier of broadcasting satellite

Definition at line 78 of file NavFilterKey.hpp.

◆ rxID

std::string gnsstk::NavFilterKey::rxID

receiver identifier for data source

Definition at line 77 of file NavFilterKey.hpp.

◆ stationID

std::string gnsstk::NavFilterKey::stationID

site/station identifier for data source

Definition at line 76 of file NavFilterKey.hpp.

◆ timeStamp

gnsstk::CommonTime gnsstk::NavFilterKey::timeStamp

Time stamp for the nav subframe. This may vary depending on GNSS and implementation. Refer to the documentation for the validate methods of individual filters for any requirements on the contents of this field.

Definition at line 75 of file NavFilterKey.hpp.

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