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

Detailed Description

Wrapper for the 1-bit health status in GPS CNav2 subframe 2 or 3.

Definition at line 50 of file GPSCNav2Health.hpp.

#include <GPSCNav2Health.hpp>

Inheritance diagram for gnsstk::GPSCNav2Health:
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
 
SVHealth getHealth () const override
 
 GPSCNav2Health ()
 Initialize to unhealthy. More...
 
void setEph (bool e)
 
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

bool health
 1-bit health. 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

◆ GPSCNav2Health()

gnsstk::GPSCNav2Health::GPSCNav2Health ( )

Initialize to unhealthy.

Definition at line 46 of file GPSCNav2Health.cpp.

Member Function Documentation

◆ clone()

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

Create a deep copy of this object.

Implements gnsstk::NavData.

Definition at line 56 of file GPSCNav2Health.hpp.

◆ dump()

void gnsstk::GPSCNav2Health::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 54 of file GPSCNav2Health.cpp.

◆ getHealth()

SVHealth gnsstk::GPSCNav2Health::getHealth ( ) const
inlineoverridevirtual

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

Returns
Healthy if no health bits are set.

Implements gnsstk::NavHealthData.

Definition at line 75 of file GPSCNav2Health.hpp.

◆ setEph()

void gnsstk::GPSCNav2Health::setEph ( bool  e)

Alter the message length depending on whether this health data as having originated from an ephemeris or almanac message.

Parameters
[in]eIf true, this health was derived from ephemeris data.

Definition at line 97 of file GPSCNav2Health.cpp.

◆ validate()

bool gnsstk::GPSCNav2Health::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 63 of file GPSCNav2Health.hpp.

Member Data Documentation

◆ health

bool gnsstk::GPSCNav2Health::health

1-bit health.

Definition at line 86 of file GPSCNav2Health.hpp.


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


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