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

Detailed Description

Wrapper for the combined Signal Health Status (SHS) and Data Validity Status (DVS) associated with Galileo satellites.

Definition at line 53 of file GalFNavHealth.hpp.

#include <GalFNavHealth.hpp>

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

Public Member Functions

NavDataPtr clone () const override
 Create a deep copy of this object. More...
 
void dump (std::ostream &s, DumpDetail dl) const override
 
 GalFNavHealth ()
 Initialize to unhealthy using a value typically not seen in health. More...
 
SVHealth getHealth () const override
 
bool validate () const override
 
- Public Member Functions inherited from gnsstk::NavHealthData
std::list< std::string > compare (const NavDataPtr &right) const override
 
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 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...
 

Public Attributes

GalDataValid dataValidityStatus
 Data Validity Status (DVS) More...
 
GalHealthStatus sigHealthStatus
 Signal health status (SHS) More...
 
uint8_t sisaIndex
 Signal in space accuracy index (OS-SIS-ICD tbl 76) More...
 
- Public Attributes inherited from gnsstk::NavData
NavMessageID signal
 Source signal identification for this navigation message data. More...
 
CommonTime timeStamp
 
std::string weekFmt
 

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...
 
- 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

◆ GalFNavHealth()

gnsstk::GalFNavHealth::GalFNavHealth ( )

Initialize to unhealthy using a value typically not seen in health.

Todo:
Figure out a way to initialize sisaIndex such that not having the value doesn't result in the health status being tagged as Degraded.

Definition at line 47 of file GalFNavHealth.cpp.

Member Function Documentation

◆ clone()

NavDataPtr gnsstk::GalFNavHealth::clone ( ) const
inlineoverridevirtual

Create a deep copy of this object.

Implements gnsstk::NavData.

Definition at line 59 of file GalFNavHealth.hpp.

◆ dump()

void gnsstk::GalFNavHealth::dump ( std::ostream &  s,
DumpDetail  dl 
) const
overridevirtual

Print the contents of this object in a human-readable format.

Parameters
[in,out]sThe stream to write the data to.
[in]dlThe level of detail the output should contain.

Reimplemented from gnsstk::NavData.

Definition at line 61 of file GalFNavHealth.cpp.

◆ getHealth()

SVHealth gnsstk::GalFNavHealth::getHealth ( ) const
overridevirtual

Defines the status of NavData::signal, specifically sat (not xmitSat).

Returns
Rolled-up health status based on internal data.

Implements gnsstk::NavHealthData.

Definition at line 118 of file GalFNavHealth.cpp.

◆ validate()

bool gnsstk::GalFNavHealth::validate ( ) const
inlineoverridevirtual

Checks the contents of this message against known validity rules as defined in the appropriate ICD.

Returns
true always as there is nothing to check in this class.

Implements gnsstk::NavData.

Definition at line 66 of file GalFNavHealth.hpp.

Member Data Documentation

◆ dataValidityStatus

GalDataValid gnsstk::GalFNavHealth::dataValidityStatus

Data Validity Status (DVS)

Definition at line 83 of file GalFNavHealth.hpp.

◆ sigHealthStatus

GalHealthStatus gnsstk::GalFNavHealth::sigHealthStatus

Signal health status (SHS)

Definition at line 81 of file GalFNavHealth.hpp.

◆ sisaIndex

uint8_t gnsstk::GalFNavHealth::sisaIndex

Signal in space accuracy index (OS-SIS-ICD tbl 76)

Definition at line 85 of file GalFNavHealth.hpp.


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


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