Detailed Description

Definition at line 82 of file ObsID.hpp.

#include <ObsID.hpp>

Inheritance diagram for gnsstk::ObsID:

Public Member Functions
void	clearMcodeMask (uint32_t clearmask)
	Clear bits in mcodeMask that are set in clearmask. More...

virtual std::ostream &	dump (std::ostream &s) const
	Convenience output method. More...

uint32_t	getMcodeBits () const
	Return the value of mcode. More...

uint32_t	getMcodeMask () const
	Return the value of mcodeMask. More...

bool	isWild () const
	Return true if any of the data are wildcard values. More...

void	makeWild ()
	Set all data to wildcard values. More...

void	maskMcodeBits (uint32_t newval, uint32_t newmask)

	ObsID ()

	ObsID (ObservationType ot, CarrierBand cb, TrackingCode tc, int fo, uint32_t mc, XmitAnt transmitter=XmitAnt::Standard, bool fw=false)

	ObsID (ObservationType ot, CarrierBand cb, TrackingCode tc, int fo, XmitAnt transmitter=XmitAnt::Any, bool fw=false)

	ObsID (ObservationType ot, CarrierBand cb, TrackingCode tc, XmitAnt transmitter=XmitAnt::Any)

bool	operator!= (const ObsID &right) const

virtual bool	operator< (const ObsID &right) const

bool	operator<= (const ObsID &right) const

virtual bool	operator== (const ObsID &right) const
	Equality requires all fields to be the same. More...

bool	operator> (const ObsID &right) const

bool	operator>= (const ObsID &right) const

void	setMcodeBits (uint32_t newval, uint32_t newmask=-1)
	Set the value of mcode while simultaneously setting the mask. More...

void	setMcodeMask (uint32_t newmask=-1)
	Set the value of mcodeMask on its own. More...

virtual	~ObsID ()
	Destructor. More...

Static Public Member Functions
static std::string	getDescCB (CarrierBand e)
	SWIG accessor. Not overloaded, because SWIG. More...

static std::string	getDescOT (ObservationType e)
	SWIG accessor. Not overloaded, because SWIG. More...

static std::string	getDescTC (TrackingCode e)
	SWIG accessor. Not overloaded, because SWIG. More...

Public Attributes
CarrierBand	band

TrackingCode	code

int	freqOffs
	GLONASS frequency offset. More...

bool	freqOffsWild
	True=Treat freqOffs as a wildcard when matching. More...

ObservationType	type

XmitAnt	xmitAnt
	Identify the transmitting antenna. More...

Static Public Attributes
static GNSSTK_EXPORT std::map< CarrierBand, std::string >	cbDesc

static GNSSTK_EXPORT std::map< ObservationType, std::string >	otDesc

static GNSSTK_EXPORT std::map< TrackingCode, std::string >	tcDesc
	These strings are for forming a somewhat verbose description. More...

static GNSSTK_EXPORT bool	verbose = false

Private Attributes
uint32_t	mcode
	Data to uniquely identify M-code signal. More...

uint32_t	mcodeMask
	Bitmask for matching mcode. More...

Friends
class	::ObsID_T

Constructor & Destructor Documentation

◆ ObsID() [1/4]

gnsstk::ObsID::ObsID ( )

inline

empty constructor, creates a wildcard object. mcode and freqOffs are kept wild by default intentionally.

Definition at line 87 of file ObsID.hpp.

◆ ObsID() [2/4]

gnsstk::ObsID::ObsID	(	ObservationType	ot,
		CarrierBand	cb,
		TrackingCode	tc,
		XmitAnt	transmitter = `XmitAnt::Any`
	)

inline

Explicit constructor mcode and freqOffs are kept wild by default intentionally.

Definition at line 95 of file ObsID.hpp.

◆ ObsID() [3/4]

gnsstk::ObsID::ObsID	(	ObservationType	ot,
		CarrierBand	cb,
		TrackingCode	tc,
		int	fo,
		XmitAnt	transmitter = `XmitAnt::Any`,
		bool	fw = `false`
	)

inlineexplicit

Explicit constructor for GLONASS.

Parameters

[in]	ot	The observation type (range, phase,, etc.).
[in]	cb	The carrier band (L1, L2, etc.).
[in]	tc	The tracking code (CA, L2CM, etc.).
[in]	fo	The frequency offset of the GLONASS signal.
[in]	fw	If true, fo is ignored and freqOffs will match any value.

Definition at line 108 of file ObsID.hpp.

◆ ObsID() [4/4]

gnsstk::ObsID::ObsID	(	ObservationType	ot,
		CarrierBand	cb,
		TrackingCode	tc,
		int	fo,
		uint32_t	mc,
		XmitAnt	transmitter = `XmitAnt::Standard`,
		bool	fw = `false`
	)

inlineexplicit

Explicit constructor for avoiding wildcard values.

Parameters

[in]	ot	The observation type (range, phase,, etc.).
[in]	cb	The carrier band (L1, L2, etc.).
[in]	tc	The tracking code (CA, L2CM, etc.).
[in]	fo	The frequency offset of the GLONASS signal.
[in]	mc	The mcode bits to match.
[in]	fw	If true, fo is ignored and freqOffs will match any value.

Definition at line 123 of file ObsID.hpp.

◆ ~ObsID()

virtual gnsstk::ObsID::~ObsID ( )

inlinevirtual

Destructor.

Definition at line 160 of file ObsID.hpp.

Member Function Documentation

◆ clearMcodeMask()

void gnsstk::ObsID::clearMcodeMask ( uint32_t clearmask )

inline

Clear bits in mcodeMask that are set in clearmask.

Definition at line 192 of file ObsID.hpp.

◆ dump()

std::ostream & gnsstk::ObsID::dump ( std::ostream & s ) const

virtual

Convenience output method.

Definition at line 51 of file ObsID.cpp.

◆ getDescCB()

static std::string gnsstk::ObsID::getDescCB ( CarrierBand e )

inlinestatic

SWIG accessor. Not overloaded, because SWIG.

Definition at line 210 of file ObsID.hpp.

◆ getDescOT()

static std::string gnsstk::ObsID::getDescOT ( ObservationType e )

inlinestatic

SWIG accessor. Not overloaded, because SWIG.

Definition at line 213 of file ObsID.hpp.

◆ getDescTC()

static std::string gnsstk::ObsID::getDescTC ( TrackingCode e )

inlinestatic

SWIG accessor. Not overloaded, because SWIG.

Definition at line 207 of file ObsID.hpp.

◆ getMcodeBits()

uint32_t gnsstk::ObsID::getMcodeBits ( ) const

inline

Return the value of mcode.

Definition at line 186 of file ObsID.hpp.

◆ getMcodeMask()

uint32_t gnsstk::ObsID::getMcodeMask ( ) const

inline

Return the value of mcodeMask.

Definition at line 195 of file ObsID.hpp.

◆ isWild()

bool gnsstk::ObsID::isWild ( ) const

Return true if any of the data are wildcard values.

Definition at line 159 of file ObsID.cpp.

◆ makeWild()

void gnsstk::ObsID::makeWild ( )

Set all data to wildcard values.

Definition at line 147 of file ObsID.cpp.

◆ maskMcodeBits()

void gnsstk::ObsID::maskMcodeBits	(	uint32_t	newval,
		uint32_t	newmask
	)

inline

Alter the value of mcode by replacing only the masked bits in newmask with the value in newval.

Parameters

[in]	newval	The data to be inserted into the mcode bitflag.
[in]	newmask	Only bits set in newmask will be set in mcode, and mcodeMask will be updated to include set bits in newmask.

Postcondition: mcode = (mcode & ~newmask) | (newval & newmask); mcodeMask |= newmask

Definition at line 180 of file ObsID.hpp.

◆ operator!=()

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

inline

Definition at line 144 of file ObsID.hpp.

◆ operator<()

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

virtual

This ordering is somewhat arbitrary but is required to be able to use an ObsID as an index to a std::map. If an application needs some other ordering, inherit and override this function. One 'feature' that has been added is that an Any code/carrier/type will match any other code/carrier/type in the equality operator. The intent is to support performing an operation like "tell me if this is a pseudorange that was collected on L1 from any code".

Definition at line 105 of file ObsID.cpp.

◆ operator<=()

bool gnsstk::ObsID::operator<= ( const ObsID & right ) const

inline

Definition at line 150 of file ObsID.hpp.

◆ operator==()

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

virtual

Equality requires all fields to be the same.

Definition at line 71 of file ObsID.cpp.

◆ operator>()

bool gnsstk::ObsID::operator> ( const ObsID & right ) const

inline

Definition at line 147 of file ObsID.hpp.

◆ operator>=()

bool gnsstk::ObsID::operator>= ( const ObsID & right ) const

inline

Definition at line 153 of file ObsID.hpp.

◆ setMcodeBits()

void gnsstk::ObsID::setMcodeBits	(	uint32_t	newval,
		uint32_t	newmask = `-1`
	)

inline

Set the value of mcode while simultaneously setting the mask.

Definition at line 170 of file ObsID.hpp.

◆ setMcodeMask()

void gnsstk::ObsID::setMcodeMask ( uint32_t newmask = -1 )

inline

Set the value of mcodeMask on its own.

Definition at line 189 of file ObsID.hpp.

Friends And Related Function Documentation

◆ ::ObsID_T

friend class ::ObsID_T

friend

Definition at line 228 of file ObsID.hpp.

Member Data Documentation

◆ band

CarrierBand gnsstk::ObsID::band

Definition at line 200 of file ObsID.hpp.

◆ cbDesc

std::map< CarrierBand, std::string > gnsstk::ObsID::cbDesc

static

Initial value:

{
      { CarrierBand::Unknown,    "UnknownBand" },
      { CarrierBand::Any,        "AnyBand" },
      { CarrierBand::L1L2,       "comboL1L2" },
      { CarrierBand::L1,         "L1" },
      { CarrierBand::L2,         "L2" },
      { CarrierBand::L5,         "L5" },
      { CarrierBand::G1,         "G1" },
      { CarrierBand::G1a,        "G1a" },
      { CarrierBand::G2a,        "G2a" },
      { CarrierBand::G2,         "G2" },
      { CarrierBand::G3,         "G3" },
      { CarrierBand::E5b,        "E5b" },
      { CarrierBand::E5ab,       "E5a+b" },
      { CarrierBand::E6,         "E6" },
      { CarrierBand::B1,         "B1" },
      { CarrierBand::B2,         "B2" },
      { CarrierBand::B3,         "B3" },
      { CarrierBand::I9,         "I9" },
      { CarrierBand::Undefined,  "undefined" },
   }

Definition at line 217 of file ObsID.hpp.

◆ code

TrackingCode gnsstk::ObsID::code

Definition at line 201 of file ObsID.hpp.

◆ freqOffs

int gnsstk::ObsID::freqOffs

GLONASS frequency offset.

Definition at line 203 of file ObsID.hpp.

◆ freqOffsWild

bool gnsstk::ObsID::freqOffsWild

True=Treat freqOffs as a wildcard when matching.

Definition at line 204 of file ObsID.hpp.

◆ mcode

uint32_t gnsstk::ObsID::mcode

private

Data to uniquely identify M-code signal.

Definition at line 226 of file ObsID.hpp.

◆ mcodeMask

uint32_t gnsstk::ObsID::mcodeMask

private

Bitmask for matching mcode.

Definition at line 227 of file ObsID.hpp.

◆ otDesc

std::map< ObservationType, std::string > gnsstk::ObsID::otDesc

static

Initial value:

{
      { ObservationType::Unknown,    "UnknownType" },
      { ObservationType::Any,        "AnyType" },
      { ObservationType::Range,      "pseudorange" },
      { ObservationType::Phase,      "phase" },
      { ObservationType::Doppler,    "doppler" },
      { ObservationType::SNR,        "snr" },
      { ObservationType::Channel,    "channel" },
      { ObservationType::DemodStat,  "demodStatus" },
      { ObservationType::Iono,       "iono" },
      { ObservationType::SSI,        "ssi" },
      { ObservationType::LLI,        "lli" },
      { ObservationType::TrackLen,   "tlen" },
      { ObservationType::NavMsg,     "navmsg" },
      { ObservationType::RngStdDev,  "rngSigma" },
      { ObservationType::PhsStdDev,  "phsSigma" },
      { ObservationType::FreqIndx,   "freqIndx" },
      { ObservationType::Undefined,  "undefined" },
   }

Definition at line 218 of file ObsID.hpp.

◆ tcDesc

std::map< TrackingCode, std::string > gnsstk::ObsID::tcDesc

static

These strings are for forming a somewhat verbose description.

Definition at line 216 of file ObsID.hpp.

◆ type

ObservationType gnsstk::ObsID::type

Definition at line 199 of file ObsID.hpp.

◆ verbose

bool gnsstk::ObsID::verbose = false

static

If true, dump and operator<< will include the values of freqOffs, freqOffsWild, mcode, and mcodeMask. These are flags that were added more recently, so this also preserves traditional output.

Definition at line 223 of file ObsID.hpp.

◆ xmitAnt

XmitAnt gnsstk::ObsID::xmitAnt

Identify the transmitting antenna.

Definition at line 202 of file ObsID.hpp.

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

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Friends

Constructor & Destructor Documentation

◆ ObsID() [1/4]

◆ ObsID() [2/4]

◆ ObsID() [3/4]

◆ ObsID() [4/4]

◆ ~ObsID()

Member Function Documentation

◆ clearMcodeMask()

◆ dump()

◆ getDescCB()

◆ getDescOT()

◆ getDescTC()

◆ getMcodeBits()

◆ getMcodeMask()

◆ isWild()

◆ makeWild()

◆ maskMcodeBits()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ setMcodeBits()

◆ setMcodeMask()

Friends And Related Function Documentation

◆ ::ObsID_T

Member Data Documentation

◆ band

◆ cbDesc

◆ code

◆ freqOffs

◆ freqOffsWild

◆ mcode

◆ mcodeMask

◆ otDesc

◆ tcDesc

◆ type

◆ verbose

◆ xmitAnt