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

#include <GalINavHealth.hpp>

Inheritance diagram for gnsstk::GalINavHealth:

Public Member Functions
NavDataPtr	clone () const override
	Create a deep copy of this object. More...

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

	GalINavHealth ()
	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...

Static Public Member Functions
static SVHealth	galHealth (GalHealthStatus shs, GalDataValid dvs, uint8_t sisa)

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

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

◆ GalINavHealth()

gnsstk::GalINavHealth::GalINavHealth ( )

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 46 of file GalINavHealth.cpp.

Member Function Documentation

◆ clone()

NavDataPtr gnsstk::GalINavHealth::clone ( ) const

inlineoverridevirtual

Create a deep copy of this object.

Implements gnsstk::NavData.

Definition at line 59 of file GalINavHealth.hpp.

◆ dump()

void gnsstk::GalINavHealth::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 60 of file GalINavHealth.cpp.

◆ galHealth()

SVHealth gnsstk::GalINavHealth::galHealth	(	GalHealthStatus	shs,
		GalDataValid	dvs,
		uint8_t	sisa
	)

static

Static version of getHealth for convenience.

Parameters

[in]	shs	The Signal Health Status of a given signal.
[in]	dvs	The Data Validity Status of a given signal.
[in]	sisa	The Signal In Space Accuracy Index of a given signal

Note: Galileo-OS-SDD refers to a SIS status as "Marginal", where we use the SVHealth enumeration name "Degraded".

Returns: Rolled-up health status based on internal data.

Definition at line 124 of file GalINavHealth.cpp.

◆ getHealth()

SVHealth gnsstk::GalINavHealth::getHealth ( ) const

overridevirtual

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

Note: Galileo-OS-SDD refers to a SIS status as "Marginal", where we use the SVHealth enumeration name "Degraded".

Returns: Rolled-up health status based on internal data.

Implements gnsstk::NavHealthData.

Definition at line 117 of file GalINavHealth.cpp.

◆ validate()

bool gnsstk::GalINavHealth::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 GalINavHealth.hpp.

Member Data Documentation

◆ dataValidityStatus

GalDataValid gnsstk::GalINavHealth::dataValidityStatus

Data Validity Status (DVS)

Definition at line 95 of file GalINavHealth.hpp.

◆ sigHealthStatus

GalHealthStatus gnsstk::GalINavHealth::sigHealthStatus

Signal health status (SHS)

Definition at line 93 of file GalINavHealth.hpp.

◆ sisaIndex

uint8_t gnsstk::GalINavHealth::sisaIndex

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

Definition at line 97 of file GalINavHealth.hpp.

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