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

Detailed Description

Class containing data elements unique to GPS LNav ephemerides.

Definition at line 51 of file GPSLNavEph.hpp.

#include <GPSLNavEph.hpp>

Inheritance diagram for gnsstk::GPSLNavEph:
Inheritance graph
[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
 
void dumpSVStatus (std::ostream &s) const override
 
void fixFit ()
 
CommonTime getUserTime () const override
 
 GPSLNavEph ()
 Sets the nav message type and all other data members to 0. More...
 
bool validate () const override
 
- Public Member Functions inherited from gnsstk::GPSLNavData
 GPSLNavData ()
 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 alert2
 Alert flag from SF2 HOW. More...
 
bool alert3
 Alert flag from SF3 HOW. More...
 
long aodo
 Age of Data Offset in seconds (-1=uninitialized). More...
 
bool asFlag2
 Anti-spoof flag from SF2 HOW. More...
 
bool asFlag3
 Anti-spoof flag from SF3 HOW. More...
 
GPSLNavL2Codes codesL2
 Code on L2 in-phase component. More...
 
uint8_t fitIntFlag
 Fit interval flag from subframe 2. More...
 
uint8_t healthBits
 6 SV health bits from subframe 1, word 3. More...
 
uint16_t iodc
 Issue Of Data-Clock for the ephemeris. More...
 
uint16_t iode
 Issue Of Data-Ephemeris. More...
 
bool isf2
 Integrity status flag from subframe 2. More...
 
bool isf3
 Integrity status flag from subframe 3. More...
 
bool L2Pdata
 
uint32_t pre2
 The TLM preamble from word 1 of subframe 2. More...
 
uint32_t pre3
 The TLM preamble from word 1 of subframe 3. More...
 
double tgd
 Ionospheric group delay in seconds. More...
 
uint32_t tlm2
 The TLM message from word 1 of subframe 2. More...
 
uint32_t tlm3
 The TLM message from word 1 of subframe 3. More...
 
uint8_t uraIndex
 4-bit URA index from subframe 1, word 3. More...
 
CommonTime xmit2
 Transmit time for subframe 2. More...
 
CommonTime xmit3
 Transmit time for subframe 3. More...
 
- Public Attributes inherited from gnsstk::GPSLNavData
bool alert
 Alert flag from HOW. More...
 
bool asFlag
 Anti-spoof flag from HOW. More...
 
bool isf
 Integrity status flag. More...
 
uint32_t pre
 The TLM preamble from word 1 of the subframe. More...
 
uint32_t tlm
 The TLM message from word 1 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::GPSLNavData
static const GNSSTK_EXPORT double refEccQZSS = 0.06
 Reference eccentricity for reduced almanac in IS-QZSS-200. More...
 
static const GNSSTK_EXPORT double refioffsetGPS = 0.3 * PI
 inclination offset, this + delta i = i0, defined in IS-GPS-200. More...
 
static const GNSSTK_EXPORT double refioffsetQZSS = 0.25 * PI
 inclination offset, this + delta i = i0, defined in IS-QZSS. 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

◆ GPSLNavEph()

gnsstk::GPSLNavEph::GPSLNavEph ( )

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

Definition at line 49 of file GPSLNavEph.cpp.

Member Function Documentation

◆ clone()

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

Create a deep copy of this object.

Implements gnsstk::NavData.

Definition at line 57 of file GPSLNavEph.hpp.

◆ dump()

void gnsstk::GPSLNavEph::dump ( std::ostream &  s,
DumpDetail  dl 
) const
overridevirtual

Print the contents of this NavData object in a (usually) human-readable format.

Parameters
[in,out]sThe stream to write the data to.
[in]dlThe level of detail the output should contain.

Reimplemented from gnsstk::NavData.

Definition at line 137 of file GPSLNavEph.cpp.

◆ dumpSVStatus()

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

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

Parameters
[in,out]sThe stream to write the data to.
Note
we add 6 seconds to xmitTime because we're printing the HOW time not the transmit time. Also we're really just guessing about the SF2 and SF3 HOW times.

Reimplemented from gnsstk::OrbitDataKepler.

Definition at line 190 of file GPSLNavEph.cpp.

◆ fixFit()

void gnsstk::GPSLNavEph::fixFit ( )

Fill the beginFit and endFit values for this object.

Precondition
Toe, iodc, fitIntFlag and xmitTime must all be set.

Definition at line 92 of file GPSLNavEph.cpp.

◆ getUserTime()

CommonTime gnsstk::GPSLNavEph::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 + 6s.

Reimplemented from gnsstk::NavData.

Definition at line 84 of file GPSLNavEph.cpp.

◆ validate()

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

Definition at line 76 of file GPSLNavEph.cpp.

Member Data Documentation

◆ alert2

bool gnsstk::GPSLNavEph::alert2

Alert flag from SF2 HOW.

Definition at line 104 of file GPSLNavEph.hpp.

◆ alert3

bool gnsstk::GPSLNavEph::alert3

Alert flag from SF3 HOW.

Definition at line 105 of file GPSLNavEph.hpp.

◆ aodo

long gnsstk::GPSLNavEph::aodo

Age of Data Offset in seconds (-1=uninitialized).

Definition at line 115 of file GPSLNavEph.hpp.

◆ asFlag2

bool gnsstk::GPSLNavEph::asFlag2

Anti-spoof flag from SF2 HOW.

Definition at line 106 of file GPSLNavEph.hpp.

◆ asFlag3

bool gnsstk::GPSLNavEph::asFlag3

Anti-spoof flag from SF3 HOW.

Definition at line 107 of file GPSLNavEph.hpp.

◆ codesL2

GPSLNavL2Codes gnsstk::GPSLNavEph::codesL2

Code on L2 in-phase component.

Definition at line 108 of file GPSLNavEph.hpp.

◆ fitIntFlag

uint8_t gnsstk::GPSLNavEph::fitIntFlag

Fit interval flag from subframe 2.

Definition at line 100 of file GPSLNavEph.hpp.

◆ healthBits

uint8_t gnsstk::GPSLNavEph::healthBits

6 SV health bits from subframe 1, word 3.

Definition at line 101 of file GPSLNavEph.hpp.

◆ iodc

uint16_t gnsstk::GPSLNavEph::iodc

Issue Of Data-Clock for the ephemeris.

Definition at line 98 of file GPSLNavEph.hpp.

◆ iode

uint16_t gnsstk::GPSLNavEph::iode

Issue Of Data-Ephemeris.

Definition at line 99 of file GPSLNavEph.hpp.

◆ isf2

bool gnsstk::GPSLNavEph::isf2

Integrity status flag from subframe 2.

Definition at line 96 of file GPSLNavEph.hpp.

◆ isf3

bool gnsstk::GPSLNavEph::isf3

Integrity status flag from subframe 3.

Definition at line 97 of file GPSLNavEph.hpp.

◆ L2Pdata

bool gnsstk::GPSLNavEph::L2Pdata

L2 P data flag from subframe 1, word 3.

Note
This retains the behavior as described in IS-GPS-200K 20.3.3.3.1.6, in that true (1) indicates the LNAV data stream was commanded OFF on the P-code of the in-phase component of the L2 channel

Definition at line 114 of file GPSLNavEph.hpp.

◆ pre2

uint32_t gnsstk::GPSLNavEph::pre2

The TLM preamble from word 1 of subframe 2.

Definition at line 92 of file GPSLNavEph.hpp.

◆ pre3

uint32_t gnsstk::GPSLNavEph::pre3

The TLM preamble from word 1 of subframe 3.

Definition at line 93 of file GPSLNavEph.hpp.

◆ tgd

double gnsstk::GPSLNavEph::tgd

Ionospheric group delay in seconds.

Definition at line 103 of file GPSLNavEph.hpp.

◆ tlm2

uint32_t gnsstk::GPSLNavEph::tlm2

The TLM message from word 1 of subframe 2.

Definition at line 94 of file GPSLNavEph.hpp.

◆ tlm3

uint32_t gnsstk::GPSLNavEph::tlm3

The TLM message from word 1 of subframe 3.

Definition at line 95 of file GPSLNavEph.hpp.

◆ uraIndex

uint8_t gnsstk::GPSLNavEph::uraIndex

4-bit URA index from subframe 1, word 3.

Definition at line 102 of file GPSLNavEph.hpp.

◆ xmit2

CommonTime gnsstk::GPSLNavEph::xmit2

Transmit time for subframe 2.

Definition at line 90 of file GPSLNavEph.hpp.

◆ xmit3

CommonTime gnsstk::GPSLNavEph::xmit3

Transmit time for subframe 3.

Definition at line 91 of file GPSLNavEph.hpp.


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


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