Public Member Functions | List of all members
gnsstk::IonoNavData Class Referenceabstract

Detailed Description

Defines the interface for classes that provide the ability to compute ionospheric delay, using data extracted from GNSS navigation messages.

Definition at line 53 of file IonoNavData.hpp.

#include <IonoNavData.hpp>

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

Public Member Functions

std::list< std::string > compare (const NavDataPtr &right) const override
 
virtual double getIonoCorr (const CommonTime &when, const Position &rxgeo, const Position &svgeo, CarrierBand band) const =0
 
 IonoNavData ()
 Set the messageType. More...
 
bool isSameData (const NavDataPtr &right) const override
 
virtual ~IonoNavData ()
 Obligatory virtual destructor. More...
 
- Public Member Functions inherited from gnsstk::NavData
virtual NavDataPtr clone () const =0
 Create a deep copy of this object, whatever it truly is. More...
 
virtual void dump (std::ostream &s, DumpDetail dl) const
 
virtual std::string getClassName () const
 
std::string getDumpTime (DumpDetail dl, const CommonTime &t) const
 
std::string getDumpTimeHdr (DumpDetail dl) const
 
virtual CommonTime getNearTime () const
 
std::string getSignalString () const
 
bool getSVN (const SatID &sat, const gnsstk::CommonTime &when, std::string &svn) const
 
virtual CommonTime getUserTime () const
 
 NavData ()
 Initialize internal data fields. More...
 
virtual bool validate () const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from gnsstk::NavData
static gnsstk::SatMetaDataStoregetSatMetaDataStore ()
 Accessor for python. More...
 
static void setSatMetaDataStore (gnsstk::SatMetaDataStore *smds)
 Accessor for python. More...
 
- Public Attributes inherited from gnsstk::NavData
NavMessageID signal
 Source signal identification for this navigation message data. More...
 
CommonTime timeStamp
 
std::string weekFmt
 
- Static Public Attributes inherited from gnsstk::NavData
static const GNSSTK_EXPORT std::string dumpTimeFmt
 Time format used for the dump method (Full). More...
 
static const GNSSTK_EXPORT std::string dumpTimeFmtBrief
 Time format used for the dump method (Brief). More...
 
static GNSSTK_EXPORT gnsstk::SatMetaDataStoresatMetaDataStore = nullptr
 Set this to a valid store to get PRN->SVN translations in dump(). More...
 
- Protected Attributes inherited from gnsstk::NavData
double msgLenSec
 

Constructor & Destructor Documentation

◆ IonoNavData()

gnsstk::IonoNavData::IonoNavData ( )
inline

Set the messageType.

Definition at line 57 of file IonoNavData.hpp.

◆ ~IonoNavData()

virtual gnsstk::IonoNavData::~IonoNavData ( )
inlinevirtual

Obligatory virtual destructor.

Definition at line 61 of file IonoNavData.hpp.

Member Function Documentation

◆ compare()

std::list<std::string> gnsstk::IonoNavData::compare ( const NavDataPtr right) const
inlineoverridevirtual

Compare two NavData descendent objects. Any differences are summarized and returned as a list of readable text.

Parameters
[in]rightThe data to compare against.
Returns
a text list of mismatched data.
Note
We use shared_ptr to allow for casting without risking memory leaks.

Reimplemented from gnsstk::NavData.

Definition at line 82 of file IonoNavData.hpp.

◆ getIonoCorr()

virtual double gnsstk::IonoNavData::getIonoCorr ( const CommonTime when,
const Position rxgeo,
const Position svgeo,
CarrierBand  band 
) const
pure virtual

Get the ionospheric correction in meters.

Parameters
[in]whenThe time of the observation to correct.
[in]rxgeoThe receiver's geodetic position.
[in]svgeoThe observed satellite's geodetic position.
[in]bandThe carrier band of the signal being corrected.
Returns
The ionospheric delay, in meters, on band.

Implemented in gnsstk::NeQuickIonoNavData, gnsstk::GLOCNavIono, and gnsstk::KlobucharIonoNavData.

◆ isSameData()

bool gnsstk::IonoNavData::isSameData ( const NavDataPtr right) const
inlineoverridevirtual

Returns true if this two objects are

  1. same concrete type, and
  2. same data contents. This is intended as a "data uniqueness test" to allow detection of successive transmissions of same data and avoid duplicate storage. The exact rules for uniqueness will vary by descendent class.
    Note
    We use shared_ptr to allow for casting without risking memory leaks.

Reimplemented from gnsstk::NavData.

Definition at line 76 of file IonoNavData.hpp.


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


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