Detailed Description

Defines the class used to store time system offset information as stored in RINEX nav headers.

Definition at line 52 of file RinexTimeOffset.hpp.

#include <RinexTimeOffset.hpp>

Inheritance diagram for gnsstk::RinexTimeOffset:

[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

TimeCvtSet	getConversions () const override

bool	getOffset (TimeSystem fromSys, TimeSystem toSys, const CommonTime &when, double &offset) const override

CommonTime	getUserTime () const override

	RinexTimeOffset ()
	Initialize all data to 0. More...

	RinexTimeOffset (const TimeSystemCorrection &right, double leapSec)

bool	validate () const override

virtual	~RinexTimeOffset ()
	Obligatory virtual destructor. More...

Public Member Functions inherited from gnsstk::TimeOffsetData
std::list< std::string >	compare (const NavDataPtr &right) const override

CommonTime	getNearTime () const override

bool	isSameData (const NavDataPtr &right) const override

	TimeOffsetData ()
	Set the messageType. More...

virtual	~TimeOffsetData ()
	Obligatory virtual destructor. 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 Member Functions inherited from gnsstk::TimeSystemCorrection
std::string	asString () const
	Return readable string version of CorrType. More...

std::string	asString4 () const
	Return 4-char string version of CorrType. More...

double	Correction (const CommonTime &ct) const

void	dump (std::ostream &s) const
	dump More...

void	fixTimeSystem ()

void	fromString (const std::string &str)

void	init ()

bool	isConverterFor (const TimeSystem &ts1, const TimeSystem &ts2) const

bool	operator< (const TimeSystemCorrection &tc) const

bool	operator== (const TimeSystemCorrection &tc) const

	TimeSystemCorrection ()
	Empty constructor. More...

	TimeSystemCorrection (std::string str)
	Constructor from string. More...

Public Attributes
double	deltatLS
	Current or past leap second count (UTC only) More...

Public Attributes inherited from gnsstk::NavData
NavMessageID	signal
	Source signal identification for this navigation message data. More...

CommonTime	timeStamp

std::string	weekFmt

Public Attributes inherited from gnsstk::TimeSystemCorrection
double	A0

double	A1

TimeSystem	frTS

std::string	geoProvider
	string 'EGNOS' 'WAAS' or 'MSAS' More...

int	geoUTCid

CommonTime	refTime
	reference time for polynominal More...

TimeSystem	toTS

CorrType	type

Additional Inherited Members
Public Types inherited from gnsstk::TimeSystemCorrection
enum	CorrType { Unknown =0, GPUT, GAUT, SBUT, GLUT, GPGA, GAGP, GLGP, QZGP, QZUT, BDUT, BDGP, IRUT, IRGP }
	Supported time system correction types, cf. RINEX version 3 spec. More...

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 Member Functions inherited from gnsstk::TimeSystemCorrection
static bool	convertTimeSystemToCorrType (TimeSystem src, TimeSystem tgt, TimeSystemCorrection::CorrType &ct)

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

◆ RinexTimeOffset() [1/2]

gnsstk::RinexTimeOffset::RinexTimeOffset ( )

Initialize all data to 0.

Definition at line 48 of file RinexTimeOffset.cpp.

◆ RinexTimeOffset() [2/2]

gnsstk::RinexTimeOffset::RinexTimeOffset	(	const TimeSystemCorrection &	right,
		double	leapSec
	)

Construct from a pre-existing TimeSystemCorrection object and leap seconds.

Parameters

[in]	right	The TimeSystemCorrection obtained from a RINEX NAV header.
[in]	leapSec	The number of leap seconds from the same RINEX NAV header.

Definition at line 55 of file RinexTimeOffset.cpp.

◆ ~RinexTimeOffset()

virtual gnsstk::RinexTimeOffset::~RinexTimeOffset ( )

inlinevirtual

Obligatory virtual destructor.

Definition at line 70 of file RinexTimeOffset.hpp.

Member Function Documentation

◆ clone()

NavDataPtr gnsstk::RinexTimeOffset::clone ( ) const

inlineoverridevirtual

Create a deep copy of this object.

Implements gnsstk::NavData.

Definition at line 58 of file RinexTimeOffset.hpp.

◆ dump()

void gnsstk::RinexTimeOffset::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 78 of file RinexTimeOffset.cpp.

◆ getConversions()

TimeCvtSet gnsstk::RinexTimeOffset::getConversions ( ) const

overridevirtual

The set of time system conversions this class is capable of making.

Returns: a set of supported time system conversion to/from pairs.

Implements gnsstk::TimeOffsetData.

Definition at line 152 of file RinexTimeOffset.cpp.

◆ getOffset()

bool gnsstk::RinexTimeOffset::getOffset	(	TimeSystem	fromSys,
		TimeSystem	toSys,
		const CommonTime &	when,
		double &	offset
	)		const

overridevirtual

Get the offset, in seconds, to apply to times when converting them from fromSys to toSys.

Parameters

[in]	fromSys	The time system to convert from.
[in]	toSys	The time system to convert to.
[in]	when	The time being converted, in the GPS time system.
[out]	offset	The offset in seconds where when(toSys)=when(fromSys)-offset.

Returns: true if an offset is available, false if not.

Implements gnsstk::TimeOffsetData.

Definition at line 131 of file RinexTimeOffset.cpp.

◆ getUserTime()

CommonTime gnsstk::RinexTimeOffset::getUserTime ( ) const

overridevirtual

Returns the time when the time offset data 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.

Note: This information is sketchy at best in RINEX.

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

Todo:: figure out a sensible value, if there is one.

Reimplemented from gnsstk::NavData.

Definition at line 70 of file RinexTimeOffset.cpp.

◆ validate()

bool gnsstk::RinexTimeOffset::validate ( ) const

overridevirtual

Checks the contents of the data against known validity rules.

Returns: true if this message is valid according to criteria.

Todo:: implement some validation

Implements gnsstk::NavData.

Definition at line 62 of file RinexTimeOffset.cpp.

Member Data Documentation

◆ deltatLS

double gnsstk::RinexTimeOffset::deltatLS

Current or past leap second count (UTC only)

Definition at line 113 of file RinexTimeOffset.hpp.

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

Detailed Description

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RinexTimeOffset() [1/2]

◆ RinexTimeOffset() [2/2]

◆ ~RinexTimeOffset()

Member Function Documentation

◆ clone()

◆ dump()

◆ getConversions()

◆ getOffset()

◆ getUserTime()

◆ validate()

Member Data Documentation

◆ deltatLS