Public Member Functions | Public Attributes | Protected Member Functions | List of all members
gnsstk::NavSignalID Class Reference

Detailed Description

Class used to identify navigation data signal types.

Definition at line 54 of file NavSignalID.hpp.

#include <NavSignalID.hpp>

Inheritance diagram for gnsstk::NavSignalID:
Inheritance graph
[legend]

Public Member Functions

virtual bool isWild () const
 return true if any of the fields are set to match wildcards. More...
 
 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

NavType nav
 Navigation message structure of this signal. More...
 
ObsID obs
 Carrier, tracking code, etc. More...
 
SatelliteSystem system
 GNSS for this signal. More...
 

Protected Member Functions

int order (const NavSignalID &right) const
 

Constructor & Destructor Documentation

◆ NavSignalID() [1/3]

gnsstk::NavSignalID::NavSignalID ( )

Set all data members to "Unknown".

Definition at line 44 of file NavSignalID.cpp.

◆ NavSignalID() [2/3]

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

Initialize all data to specified values.

Parameters
[in]sysThe GNSS this signal originates from.
[in]carThe carrier band of this signal.
[in]trackThe tracking code of this signal.
[in]nmtThe navigation message format of this signal.
[in]mcodeData to uniquely identify M-code signal.
[in]mcodeMaskBitmask for matching mcode.

Definition at line 52 of file NavSignalID.cpp.

◆ NavSignalID() [3/3]

gnsstk::NavSignalID::NavSignalID ( SatelliteSystem  sys,
const ObsID oid,
NavType  nmt 
)

Initialize all data to specified values.

Parameters
[in]sysThe GNSS this signal originates from.
[in]oidAn ObsID describing the signal (band, code, etc.)
[in]nmtThe navigation message format of this signal.

Definition at line 63 of file NavSignalID.cpp.

Member Function Documentation

◆ isWild()

bool gnsstk::NavSignalID::isWild ( ) const
virtual

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

Reimplemented in gnsstk::NavSatelliteID.

Definition at line 100 of file NavSignalID.cpp.

◆ operator!=()

bool gnsstk::NavSignalID::operator!= ( const NavSignalID right) const
inline

Inequality check (all data members)

Definition at line 83 of file NavSignalID.hpp.

◆ operator<()

bool gnsstk::NavSignalID::operator< ( const NavSignalID right) const
inline

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

Definition at line 77 of file NavSignalID.hpp.

◆ operator==()

bool gnsstk::NavSignalID::operator== ( const NavSignalID right) const
inline

Equality check (all data members)

Definition at line 80 of file NavSignalID.hpp.

◆ order()

int gnsstk::NavSignalID::order ( const NavSignalID right) const
protected

Generic comparison function that will tell us < = >

Parameters
[in]rightThe object to compare with this.
Returns
<0 for this < right, == 0 for this == right, >0 for this > right.

Definition at line 83 of file NavSignalID.cpp.

Member Data Documentation

◆ nav

NavType gnsstk::NavSignalID::nav

Navigation message structure of this signal.

Definition at line 96 of file NavSignalID.hpp.

◆ obs

ObsID gnsstk::NavSignalID::obs

Carrier, tracking code, etc.

Definition at line 95 of file NavSignalID.hpp.

◆ system

SatelliteSystem gnsstk::NavSignalID::system

GNSS for this signal.

Definition at line 94 of file NavSignalID.hpp.


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


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:45