Public Member Functions | List of all members
gnsstk::OrbitData Class Referenceabstract

Detailed Description

Abstract base class for classes that compute satellite positions. Only the interface is defined as some systems use Keplerian orbital elements, while others use tables.

Definition at line 53 of file OrbitData.hpp.

#include <OrbitData.hpp>

Inheritance diagram for gnsstk::OrbitData:
Inheritance graph
[legend]

Public Member Functions

std::list< std::string > compare (const NavDataPtr &right) const override
 
virtual bool getXvt (const CommonTime &when, Xvt &xvt, const ObsID &oid=ObsID())=0
 
bool isSameData (const NavDataPtr &right) const override
 
- 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
 
virtual CommonTime getNearTime () 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::SatMetaDataStoregetSatMetaDataStore ()
 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::SatMetaDataStoresatMetaDataStore = nullptr
 Set this to a valid store to get PRN->SVN translations in dump(). More...
 
- Protected Attributes inherited from gnsstk::NavData
double msgLenSec
 

Member Function Documentation

◆ compare()

std::list<std::string> gnsstk::OrbitData::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]rightThe 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.

Reimplemented in gnsstk::OrbitDataKepler.

Definition at line 75 of file OrbitData.hpp.

◆ getXvt()

virtual bool gnsstk::OrbitData::getXvt ( const CommonTime when,
Xvt xvt,
const ObsID oid = ObsID() 
)
pure virtual

Compute the satellites position and velocity at a time.

Parameters
[in]whenThe time at which to compute the xvt.
[out]xvtThe resulting computed position/velocity.
[in]oidWhen it is possible to have different antenna phase centers on a single SV, this parameter allows you to specify a different APC than the navigation data was being transmitted from.
Returns
true if successful, false if required nav data was unavailable.

Implemented in FakeODK, gnsstk::OrbitDataKepler, gnsstk::OrbitDataSP3, gnsstk::OrbitDataBDS, gnsstk::OrbitDataGal, gnsstk::OrbitDataGPS, gnsstk::GLOFNavAlm, gnsstk::GLOCNavAlm, gnsstk::GLOCNavEph, gnsstk::BDSD2NavEph, and gnsstk::GLOFNavEph.

◆ isSameData()

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

Reimplemented in gnsstk::OrbitDataKepler.

Definition at line 69 of file OrbitData.hpp.


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


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