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

Detailed Description

Abstract base class for classes that provide satellite health information.

Definition at line 52 of file NavHealthData.hpp.

#include <NavHealthData.hpp>

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

Public Member Functions

std::list< std::string > compare (const NavDataPtr &right) const override
 
virtual SVHealth getHealth () const =0
 
CommonTime getNearTime () const override
 
bool isSameData (const NavDataPtr &right) const override
 
 NavHealthData ()
 Set our message type to health so we don't have to in every leaf. 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
 
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

◆ NavHealthData()

gnsstk::NavHealthData::NavHealthData ( )
inline

Set our message type to health so we don't have to in every leaf.

Definition at line 56 of file NavHealthData.hpp.

Member Function Documentation

◆ compare()

std::list<std::string> gnsstk::NavHealthData::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 75 of file NavHealthData.hpp.

◆ getHealth()

virtual SVHealth gnsstk::NavHealthData::getHealth ( ) const
pure virtual

◆ getNearTime()

CommonTime gnsstk::NavHealthData::getNearTime ( ) const
inlineoverridevirtual

Returns the time for the data to be used when searching in "Nearest" mode.

Reimplemented from gnsstk::NavData.

Definition at line 61 of file NavHealthData.hpp.

◆ isSameData()

bool gnsstk::NavHealthData::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 69 of file NavHealthData.hpp.


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


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