gnsstk::TimeOffsetData Class Reference

Detailed Description

Defines the interface for classes that provide the ability to convert between time systems, using data extracted from GNSS navigation messages.

Definition at line 60 of file TimeOffsetData.hpp.

#include <TimeOffsetData.hpp>

Inheritance diagram for gnsstk::TimeOffsetData:

Public Member Functions
std::list< std::string >	compare (const NavDataPtr &right) const override
virtual TimeCvtSet	getConversions () const =0
CommonTime	getNearTime () const override
virtual bool	getOffset (TimeSystem fromSys, TimeSystem toSys, const CommonTime &when, double &offset) const =0
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 NavDataPtr	clone () const =0
	Create a deep copy of this object, whatever it truly is. More...
virtual void	dump (std::ostream &s, DumpDetail dl) const
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...
virtual bool	validate () const =0

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...
Public Attributes inherited from gnsstk::NavData
NavMessageID	signal
	Source signal identification for this navigation message data. More...
CommonTime	timeStamp
std::string	weekFmt
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

TimeOffsetData()

gnsstk::TimeOffsetData::TimeOffsetData ( )

inline

Set the messageType.

Definition at line 64 of file TimeOffsetData.hpp.

~TimeOffsetData()

virtual gnsstk::TimeOffsetData::~TimeOffsetData ( )

inlinevirtual

Obligatory virtual destructor.

Definition at line 68 of file TimeOffsetData.hpp.

Member Function Documentation

compare()

std::list<std::string> gnsstk::TimeOffsetData::compare ( const NavDataPtr &  right ) const

inlineoverridevirtual

Compare two NavData descendent objects. Any differences are summarized and returned as a list of readable text.

Parameters

[in]

right

The data to compare against.

Returns

a text list of mismatched data.

Note

We use shared_ptr to allow for casting without risking memory leaks.

Reimplemented from gnsstk::NavData.

Definition at line 107 of file TimeOffsetData.hpp.

getConversions()

virtual TimeCvtSet gnsstk::TimeOffsetData::getConversions ( ) const

pure virtual

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

Note

This method should avoid returning bidirectional conversions, e.g. either TimeCvtKey(GPS,UTC) or TimeCvtKey(UTC,GPS) but not both. The process of reversing the conversion pair will be implemented in the NavDataFactory.

Returns

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

Implemented in gnsstk::RinexTimeOffset, gnsstk::StdNavTimeOffset, gnsstk::GLOFNavUT1TimeOffset, and gnsstk::GLOCNavUT1TimeOffset.

getNearTime()

CommonTime gnsstk::TimeOffsetData::getNearTime ( ) const

inlineoverridevirtual

Returns the time for the data to be used when searching in "Nearest" mode.

Reimplemented from gnsstk::NavData.

Definition at line 73 of file TimeOffsetData.hpp.

getOffset()

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

pure virtual

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, usually in the time system appropriate for a given nav message source. The details of what time system this should be in and any other restrictions will be documented in each leaf class, e.g. GPSLNavTimeOffset.
[out]	offset	The offset in seconds where when(toSys)=when(fromSys)-offset.

Returns

true if an offset is available, false if not.

Implemented in gnsstk::RinexTimeOffset, gnsstk::StdNavTimeOffset, gnsstk::GLOFNavUT1TimeOffset, and gnsstk::GLOCNavUT1TimeOffset.

isSameData()

bool gnsstk::TimeOffsetData::isSameData ( const NavDataPtr &  right ) const

inlineoverridevirtual

Returns true if this two objects are

1. same concrete type, and
2. same data contents. This is intended as a "data uniqueness test" to allow detection of successive transmissions of same data and avoid duplicate storage. The exact rules for uniqueness will vary by descendent class.

   Note

   We use shared_ptr to allow for casting without risking memory leaks.

Reimplemented from gnsstk::NavData.

Definition at line 101 of file TimeOffsetData.hpp.

---

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

• TimeOffsetData.hpp