Detailed Description

Class for identifying the transmitting satellite of a navigation message, as well as the "subject" satellite, in the case of almanac data where the navigation data may be for a different satellite than the one transmitting.

Definition at line 57 of file NavSatelliteID.hpp.

#include <NavSatelliteID.hpp>

Inheritance diagram for gnsstk::NavSatelliteID:

[legend]

Public Member Functions
bool	isGLOFDMA () const
	Return true if this object identifies a GLONASS FDMA signal. More...

bool	isWild () const override
	Return true if any of the fields are set to match wildcards. More...

	NavSatelliteID ()
	Sets the IDs to 0. More...

	NavSatelliteID (const NavSignalID &right)

	NavSatelliteID (const SatID &subj)

	NavSatelliteID (const SatID &subj, const SatID &xmit, CarrierBand car, TrackingCode track, NavType nmt)

	NavSatelliteID (const SatID &subj, const SatID &xmit, const ObsID &oid, const NavID &navid)

	NavSatelliteID (unsigned long subj, const SatID &xmit, const ObsID &oid, const NavID &navid)

	NavSatelliteID (unsigned long subj, SatelliteSystem sys, CarrierBand car, TrackingCode track, NavType nmt)

	NavSatelliteID (unsigned long subj, SatelliteSystem sys, CarrierBand car, TrackingCode track, XmitAnt ant, int freqOffs, bool freqOffsWild, NavType nmt=NavType::Any)

	NavSatelliteID (unsigned long subj, SatelliteSystem sys, const ObsID &oid, NavType nmt=NavType::Any)

	NavSatelliteID (unsigned long subj, unsigned long xmit, SatelliteSystem sys, CarrierBand car, TrackingCode track, NavType nmt)

bool	operator!= (const NavSatelliteID &right) const
	Implicit != not available. More...

bool	operator< (const NavSatelliteID &right) const
	Sorting so we can use this class as a map key. More...

bool	operator== (const NavSatelliteID &right) const
	Comparison, including wildcards. More...

Public Member Functions inherited from gnsstk::NavSignalID
	NavSignalID ()
	Set all data members to "Unknown". More...

	NavSignalID (SatelliteSystem sys, CarrierBand car, TrackingCode track, NavType nmt, uint32_t mcode=0, uint32_t mcodeMask=-1)

	NavSignalID (SatelliteSystem sys, const ObsID &oid, NavType nmt)

bool	operator!= (const NavSignalID &right) const
	Inequality check (all data members) More...

bool	operator< (const NavSignalID &right) const
	Sorting so we can use this class as a map key. More...

bool	operator== (const NavSignalID &right) const
	Equality check (all data members) More...

Public Attributes
SatID	sat
	ID of satellite to which the nav data applies. More...

SatID	xmitSat
	ID of the satellite transmitting the nav data. More...

Public Attributes inherited from gnsstk::NavSignalID
NavType	nav
	Navigation message structure of this signal. More...

ObsID	obs
	Carrier, tracking code, etc. More...

SatelliteSystem	system
	GNSS for this signal. More...

Additional Inherited Members
Protected Member Functions inherited from gnsstk::NavSignalID
int	order (const NavSignalID &right) const

Constructor & Destructor Documentation

◆ NavSatelliteID() [1/10]

gnsstk::NavSatelliteID::NavSatelliteID ( )

Sets the IDs to 0.

Definition at line 44 of file NavSatelliteID.cpp.

◆ NavSatelliteID() [2/10]

gnsstk::NavSatelliteID::NavSatelliteID ( const NavSignalID & right )

Initialize the parent class data while setting the sat and xmitSat to wildcard values.

Parameters

[in] right The signal to initialize from.

Definition at line 51 of file NavSatelliteID.cpp.

◆ NavSatelliteID() [3/10]

gnsstk::NavSatelliteID::NavSatelliteID	(	unsigned long	subj,
		unsigned long	xmit,
		SatelliteSystem	sys,
		CarrierBand	car,
		TrackingCode	track,
		NavType	nmt
	)

Initialize all data to specific values.

Parameters

[in]	subj	The ID of the satellite that nav data pertains to.
[in]	xmit	The ID of the satellite that transmitted the nav data.
[in]	sys	The GNSS this signal originates from.
[in]	car	The carrier band of this signal.
[in]	track	The tracking code of this signal.
[in]	nmt	The navigation message format of this signal.

Definition at line 60 of file NavSatelliteID.cpp.

◆ NavSatelliteID() [4/10]

gnsstk::NavSatelliteID::NavSatelliteID	(	unsigned long	subj,
		SatelliteSystem	sys,
		CarrierBand	car,
		TrackingCode	track,
		XmitAnt	ant,
		int	freqOffs,
		bool	freqOffsWild,
		NavType	nmt = `NavType::Any`
	)

Initialize all data to specific values.

Parameters

[in]	subj	The ID of the satellite that nav data pertains to.
[in]	xmit	The ID of the satellite that transmitted the nav data.
[in]	sys	The GNSS this signal originates from.
[in]	car	The carrier band of this signal.
[in]	track	The tracking code of this signal.
[in]	nmt	The navigation message format of this signal.

Definition at line 69 of file NavSatelliteID.cpp.

◆ NavSatelliteID() [5/10]

gnsstk::NavSatelliteID::NavSatelliteID	(	unsigned long	subj,
		SatelliteSystem	sys,
		const ObsID &	oid,
		NavType	nmt = `NavType::Any`
	)

Initialize all data to specific values.

Parameters

[in]	subj	The ID of the satellite that nav data pertains to.
[in]	xmit	The ID of the satellite that transmitted the nav data.
[in]	sys	The GNSS this signal originates from.
[in]	car	The carrier band of this signal.
[in]	track	The tracking code of this signal.
[in]	nmt	The navigation message format of this signal.

Definition at line 81 of file NavSatelliteID.cpp.

◆ NavSatelliteID() [6/10]

gnsstk::NavSatelliteID::NavSatelliteID	(	unsigned long	subj,
		SatelliteSystem	sys,
		CarrierBand	car,
		TrackingCode	track,
		NavType	nmt
	)

Initialize transmit satellite to a wildcard and all other data to specific values. Intended to be used for searching.

Parameters

[in]	subj	The ID of the satellite that nav data pertains to.
[in]	sys	The GNSS this signal originates from.
[in]	car	The carrier band of this signal.
[in]	track	The tracking code of this signal.
[in]	nmt	The navigation message format of this signal.

Definition at line 91 of file NavSatelliteID.cpp.

◆ NavSatelliteID() [7/10]

gnsstk::NavSatelliteID::NavSatelliteID	(	unsigned long	subj,
		const SatID &	xmit,
		const ObsID &	oid,
		const NavID &	navid
	)

Initialize all data to specific values. This is intended to be used when decoding GPS LNAV subframe 5 page 25, but it may have other uses.

Parameters

[in]	subj	The ID of the satellite that nav data pertains to.
[in]	xmit	The ID of the satellite that transmitted the nav data.
[in]	oid	The carrier band/tracking code this signal originates from.
[in]	navid	The navigation message format of this signal.

Definition at line 101 of file NavSatelliteID.cpp.

◆ NavSatelliteID() [8/10]

gnsstk::NavSatelliteID::NavSatelliteID	(	const SatID &	subj,
		const SatID &	xmit,
		const ObsID &	oid,
		const NavID &	navid
	)

Initialize all data to specific values. This is intended to be used when decoding CNAV almanacs on QZSS (which can have GPS satellites as the subject ID), but it may have other uses.

Parameters

[in]	subj	The ID of the satellite that nav data pertains to.
[in]	xmit	The ID of the satellite that transmitted the nav data.
[in]	oid	The carrier band/tracking code this signal originates from.
[in]	navid	The navigation message format of this signal.

Definition at line 111 of file NavSatelliteID.cpp.

◆ NavSatelliteID() [9/10]

gnsstk::NavSatelliteID::NavSatelliteID	(	const SatID &	subj,
		const SatID &	xmit,
		CarrierBand	car,
		TrackingCode	track,
		NavType	nmt
	)

Initialize all data to specific values.

Parameters

[in]	subj	The ID of the satellite that nav data pertains to.
[in]	xmit	The ID of the satellite that transmitted the nav data.
[in]	car	The carrier band of this signal.
[in]	track	The tracking code of this signal.
[in]	nmt	The navigation message format of this signal.

Definition at line 121 of file NavSatelliteID.cpp.

◆ NavSatelliteID() [10/10]

gnsstk::NavSatelliteID::NavSatelliteID ( const SatID & subj )

Initialize system, sat to the given value, and the remaining data members to wildcards.

Parameters

[in] subj The satellite that nav data pertains to.

Definition at line 130 of file NavSatelliteID.cpp.

Member Function Documentation

◆ isGLOFDMA()

bool gnsstk::NavSatelliteID::isGLOFDMA ( ) const

Return true if this object identifies a GLONASS FDMA signal.

Definition at line 173 of file NavSatelliteID.cpp.

◆ isWild()

bool gnsstk::NavSatelliteID::isWild ( ) const

overridevirtual

Return true if any of the fields are set to match wildcards.

Reimplemented from gnsstk::NavSignalID.

Definition at line 166 of file NavSatelliteID.cpp.

◆ operator!=()

bool gnsstk::NavSatelliteID::operator!= ( const NavSatelliteID & right ) const

inline

Implicit != not available.

Definition at line 160 of file NavSatelliteID.hpp.

◆ operator<()

bool gnsstk::NavSatelliteID::operator< ( const NavSatelliteID & right ) const

Sorting so we can use this class as a map key.

Definition at line 140 of file NavSatelliteID.cpp.

◆ operator==()

bool gnsstk::NavSatelliteID::operator== ( const NavSatelliteID & right ) const

Comparison, including wildcards.

Definition at line 155 of file NavSatelliteID.cpp.

Member Data Documentation

◆ sat

SatID gnsstk::NavSatelliteID::sat

ID of satellite to which the nav data applies.

Definition at line 169 of file NavSatelliteID.hpp.

◆ xmitSat

SatID gnsstk::NavSatelliteID::xmitSat

ID of the satellite transmitting the nav data.

Definition at line 170 of file NavSatelliteID.hpp.

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

Detailed Description

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ NavSatelliteID() [1/10]

◆ NavSatelliteID() [2/10]

◆ NavSatelliteID() [3/10]

◆ NavSatelliteID() [4/10]

◆ NavSatelliteID() [5/10]

◆ NavSatelliteID() [6/10]

◆ NavSatelliteID() [7/10]

◆ NavSatelliteID() [8/10]

◆ NavSatelliteID() [9/10]

◆ NavSatelliteID() [10/10]

Member Function Documentation

◆ isGLOFDMA()

◆ isWild()

◆ operator!=()

◆ operator<()

◆ operator==()

Member Data Documentation

◆ sat

◆ xmitSat