Public Member Functions | Public Attributes | List of all members
gnsstk::GPSCNavEph Class Reference

Detailed Description

Class containing data elements unique to GPS CNav ephemerides.

Note
The standard xmitTime data member (in OrbitDataKepler) corresponds to the transmit time of message type 10.

Definition at line 52 of file GPSCNavEph.hpp.

#include <GPSCNavEph.hpp>

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

Public Member Functions

NavDataPtr clone () const override
 Create a deep copy of this object. More...
 
void dumpSVStatus (std::ostream &s) const override
 
void fixFit ()
 
CommonTime getUserTime () const override
 
 GPSCNavEph ()
 Sets the nav message type and all other data members to 0. More...
 
bool validate () const override
 
- Public Member Functions inherited from gnsstk::GPSCNavData
 GPSCNavData ()
 Initialize data members. More...
 
- Public Member Functions inherited from gnsstk::OrbitDataGPS
bool getXvt (const CommonTime &when, Xvt &xvt, const ObsID &oid=ObsID()) override
 
 OrbitDataGPS ()
 
double svRelativity (const CommonTime &when) const override
 
- Public Member Functions inherited from gnsstk::OrbitDataKepler
std::list< std::string > compare (const NavDataPtr &right) const override
 
void dump (std::ostream &s, DumpDetail dl) const override
 
virtual void dumpClock (std::ostream &s) const
 
virtual void dumpHarmonics (std::ostream &s) const
 
virtual void dumpOrbit (std::ostream &s) const
 
virtual std::string getDataType () const
 
CommonTime getNearTime () const override
 
bool getXvt (const CommonTime &when, const EllipsoidModel &ell, Xvt &xvt, const ObsID &oid=ObsID())
 
bool isSameData (const NavDataPtr &right) const override
 
 OrbitDataKepler ()
 Initialize all data members to 0. More...
 
double svClockBias (const CommonTime &when) const
 
double svClockDrift (const CommonTime &when) const
 
virtual double svRelativity (const CommonTime &when, const EllipsoidModel &ell) const
 
- 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 alert11
 Alert flag from message type 11. More...
 
bool alertClk
 Alert flag from the clock message. More...
 
double deltaA
 Semi-major axis relative to reference (Aref). More...
 
double dOMEGAdot
 Rate of right ascension relative to -2.6e-9*pi. More...
 
bool healthL1
 L1 signal health from message type 10. More...
 
bool healthL2
 L2 signal health from message type 10. More...
 
bool healthL5
 L5 signal health from message type 10. More...
 
bool integStat
 Integrity status flag. More...
 
bool phasingL2C
 L2C phasing. More...
 
uint32_t pre11
 The preamble from the start of message type 11. More...
 
uint32_t preClk
 
CommonTime top
 Time of prediction. More...
 
int8_t uraED
 5-bit URA index from message type 10. More...
 
int8_t uraNED0
 non-elevation dependent URA from clock message. More...
 
uint8_t uraNED1
 non-elevation dependent URA from clock message. More...
 
uint8_t uraNED2
 non-elevation dependent URA from clock message. More...
 
CommonTime xmit11
 Transmit time for message 11. More...
 
CommonTime xmitClk
 Transmit time for the clock message. More...
 
- Public Attributes inherited from gnsstk::GPSCNavData
bool alert
 Alert flag. More...
 
uint32_t pre
 The preamble from the start of the subframe. More...
 
- Public Attributes inherited from gnsstk::OrbitDataKepler
double A
 Semi-major axis (m) More...
 
double Adot
 Rate of semi-major axis (m/sec) More...
 
double af0
 SV clock error (sec) More...
 
double af1
 SV clock drift (sec/sec) More...
 
double af2
 SV clock drift rate (sec/sec**2) More...
 
double Ahalf
 Square Root of semi-major axis (m**.5) More...
 
double Cic
 Cosine inclination (rad) More...
 
double Cis
 Sine inclination (rad) More...
 
double Crc
 Cosine radius (m) More...
 
double Crs
 Sine radius (m) More...
 
double Cuc
 Cosine latitude (rad) More...
 
double Cus
 Sine latitude (rad) More...
 
double dn
 Correction to mean motion (rad/sec) More...
 
double dndot
 Rate of correction to mean motion (rad/sec/sec) More...
 
double ecc
 Eccentricity. More...
 
RefFrameSys frame
 
SVHealth health
 SV health status. More...
 
double i0
 Inclination (rad) More...
 
double idot
 Rate of inclination angle (rad/sec) More...
 
double M0
 Mean anomaly (rad) More...
 
double OMEGA0
 Longitude of ascending node at weekly epoch (rad) More...
 
double OMEGAdot
 Rate of Rt ascension (rad/sec) More...
 
CommonTime Toc
 Clock epoch. More...
 
CommonTime Toe
 Orbit epoch. More...
 
double w
 Argument of perigee (rad) More...
 
CommonTime xmitTime
 Time of transmission of the start of the data. 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::NavFit
CommonTime beginFit
 Time at beginning of fit interval. More...
 
CommonTime endFit
 Time at end of fit interval. More...
 

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...
 
- Static Public Attributes inherited from gnsstk::GPSCNavData
static const GNSSTK_EXPORT double refAGPS = 26559710
 
static const GNSSTK_EXPORT double refAQZSS = 42164200
 
static const GNSSTK_EXPORT double refdeltaiGPS = 0.0056 * PI
 
static const GNSSTK_EXPORT double refdeltaiQZSS = 0.0056 * PI
 
static const GNSSTK_EXPORT double refEccGPS = 0
 
static const GNSSTK_EXPORT double refEccQZSS = 0.075
 
static const GNSSTK_EXPORT double refi0GPS = 0.3 * PI
 
static const GNSSTK_EXPORT double refi0QZSS = 0.25 * PI
 
static const GNSSTK_EXPORT double refOMEGAdotEphGPS = -2.6e-9 * PI
 
static const GNSSTK_EXPORT double refOMEGAdotEphQZSS = -2.6e-9 * PI
 Ephemeris OMEGA dot reference value for QZSS (radians). More...
 
static const GNSSTK_EXPORT double refOMEGAdotRedAlmGPS = -2.6e-9 * PI
 
static const GNSSTK_EXPORT double refOMEGAdotRedAlmQZSS = -8.7e-10 * PI
 Reduced almanac OMEGA dot reference value for QZSS (radians). More...
 
static const GNSSTK_EXPORT double refwGPS = 0
 Argument of perigee reference value (radians, guessed at). More...
 
static const GNSSTK_EXPORT double refwQZSS = 2.0 * PI * 270.0 / 360.0
 Argument of perigee reference value in IS-QZSS (radians). More...
 
- Static Public Attributes inherited from gnsstk::OrbitDataKepler
static const size_t fw = 16
 Field width of floating point numbers (precision + 8). More...
 
static const size_t precision = 8
 Precision used when printing floating point numbers. 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::SatMetaDataStoresatMetaDataStore = 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

◆ GPSCNavEph()

gnsstk::GPSCNavEph::GPSCNavEph ( )

Sets the nav message type and all other data members to 0.

Definition at line 48 of file GPSCNavEph.cpp.

Member Function Documentation

◆ clone()

NavDataPtr gnsstk::GPSCNavEph::clone ( ) const
inlineoverridevirtual

Create a deep copy of this object.

Implements gnsstk::NavData.

Definition at line 58 of file GPSCNavEph.hpp.

◆ dumpSVStatus()

void gnsstk::GPSCNavEph::dumpSVStatus ( std::ostream &  s) const
overridevirtual

Dump SV status information (e.g. health).

Parameters
[in,out]sThe stream to write the data to.

Reimplemented from gnsstk::OrbitDataKepler.

Definition at line 129 of file GPSCNavEph.cpp.

◆ fixFit()

void gnsstk::GPSCNavEph::fixFit ( )

Fill the beginFit and endFit values for this object.

Precondition
xmitTime, xmit11, xmitClk, Toe must all be set.
Todo:
replace all these magic numbers with named constants or enums, with sensible names, not "NINTY_MINUTES" [sic]

Definition at line 91 of file GPSCNavEph.cpp.

◆ getUserTime()

CommonTime gnsstk::GPSCNavEph::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
most recent transmit time + 12s or 6s, depending on whether this is CNAV on L5 or on L2.

Reimplemented from gnsstk::NavData.

Definition at line 81 of file GPSCNavEph.cpp.

◆ validate()

bool gnsstk::GPSCNavEph::validate ( ) const
overridevirtual

Checks the contents of this message against known validity rules as defined in the appropriate ICD.

Todo:
implement some checking.
Returns
true if this message is valid according to ICD criteria.

Reimplemented from gnsstk::GPSCNavData.

Definition at line 73 of file GPSCNavEph.cpp.

Member Data Documentation

◆ alert11

bool gnsstk::GPSCNavEph::alert11

Alert flag from message type 11.

Definition at line 96 of file GPSCNavEph.hpp.

◆ alertClk

bool gnsstk::GPSCNavEph::alertClk

Alert flag from the clock message.

Definition at line 97 of file GPSCNavEph.hpp.

◆ deltaA

double gnsstk::GPSCNavEph::deltaA

Semi-major axis relative to reference (Aref).

Definition at line 100 of file GPSCNavEph.hpp.

◆ dOMEGAdot

double gnsstk::GPSCNavEph::dOMEGAdot

Rate of right ascension relative to -2.6e-9*pi.

Definition at line 101 of file GPSCNavEph.hpp.

◆ healthL1

bool gnsstk::GPSCNavEph::healthL1

L1 signal health from message type 10.

Note
The health flags are true if unhealthy.

Definition at line 89 of file GPSCNavEph.hpp.

◆ healthL2

bool gnsstk::GPSCNavEph::healthL2

L2 signal health from message type 10.

Definition at line 90 of file GPSCNavEph.hpp.

◆ healthL5

bool gnsstk::GPSCNavEph::healthL5

L5 signal health from message type 10.

Definition at line 91 of file GPSCNavEph.hpp.

◆ integStat

bool gnsstk::GPSCNavEph::integStat

Integrity status flag.

Definition at line 98 of file GPSCNavEph.hpp.

◆ phasingL2C

bool gnsstk::GPSCNavEph::phasingL2C

L2C phasing.

Definition at line 99 of file GPSCNavEph.hpp.

◆ pre11

uint32_t gnsstk::GPSCNavEph::pre11

The preamble from the start of message type 11.

Definition at line 86 of file GPSCNavEph.hpp.

◆ preClk

uint32_t gnsstk::GPSCNavEph::preClk

The preamble from the start of the clock message.

Definition at line 87 of file GPSCNavEph.hpp.

◆ top

CommonTime gnsstk::GPSCNavEph::top

Time of prediction.

Definition at line 102 of file GPSCNavEph.hpp.

◆ uraED

int8_t gnsstk::GPSCNavEph::uraED

5-bit URA index from message type 10.

Definition at line 92 of file GPSCNavEph.hpp.

◆ uraNED0

int8_t gnsstk::GPSCNavEph::uraNED0

non-elevation dependent URA from clock message.

Definition at line 93 of file GPSCNavEph.hpp.

◆ uraNED1

uint8_t gnsstk::GPSCNavEph::uraNED1

non-elevation dependent URA from clock message.

Definition at line 94 of file GPSCNavEph.hpp.

◆ uraNED2

uint8_t gnsstk::GPSCNavEph::uraNED2

non-elevation dependent URA from clock message.

Definition at line 95 of file GPSCNavEph.hpp.

◆ xmit11

CommonTime gnsstk::GPSCNavEph::xmit11

Transmit time for message 11.

Definition at line 103 of file GPSCNavEph.hpp.

◆ xmitClk

CommonTime gnsstk::GPSCNavEph::xmitClk

Transmit time for the clock message.

Definition at line 104 of file GPSCNavEph.hpp.


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


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