gnsstk::GPSCNavHealth Class Reference

Detailed Description

Wrapper for the 1-bit health status in GPS CNav message 10.

Note

this contains only the health information for a single signal, though message 10 contains information on three separate carriers. Thus a single message 10 results in three GPSCNavHealth messages.

Definition at line 54 of file GPSCNavHealth.hpp.

#include <GPSCNavHealth.hpp>

Inheritance diagram for gnsstk::GPSCNavHealth:

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
CommonTime	getUserTime () const override
	GPSCNavHealth ()
	Initialize to unhealthy using a value typically not seen in health. More...
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
	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::SatMetaDataStore *	getSatMetaDataStore ()
	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::SatMetaDataStore *	satMetaDataStore = 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

GPSCNavHealth()

gnsstk::GPSCNavHealth::GPSCNavHealth ( )

inline

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

Definition at line 58 of file GPSCNavHealth.hpp.

Member Function Documentation

clone()

NavDataPtr gnsstk::GPSCNavHealth::clone ( ) const

inlineoverridevirtual

Create a deep copy of this object.

Implements gnsstk::NavData.

Definition at line 62 of file GPSCNavHealth.hpp.

dump()

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

overridevirtual

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

Parameters

[in,out]	s	The stream to write the data to.
[in]	dl	The level of detail the output should contain.

Reimplemented from gnsstk::NavData.

Definition at line 55 of file GPSCNavHealth.cpp.

getHealth()

SVHealth gnsstk::GPSCNavHealth::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 91 of file GPSCNavHealth.hpp.

getUserTime()

CommonTime gnsstk::GPSCNavHealth::getUserTime ( ) const

overridevirtual

Returns the time when the navigation message would have first been available to the user equipment, i.e. the time at which the final bit of a given broadcast navigation message is received. This is used by NavDataFactoryWithStore::find() in User mode.

Returns

transmit time + 12s or 6s, depending on whether this is CNAV on L5 or on L2.

Reimplemented from gnsstk::NavData.

Definition at line 46 of file GPSCNavHealth.cpp.

validate()

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

Member Data Documentation

health

bool gnsstk::GPSCNavHealth::health

1-bit health.

Definition at line 95 of file GPSCNavHealth.hpp.

---

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

• GPSCNavHealth.hpp
• GPSCNavHealth.cpp