Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | List of all members
gnsstk::YumaData Class Reference

Detailed Description

This class stores, reads, and writes Yuma records.

See also
tests/Yuma for examples
YumaStream.
YumaHeader for information on writing Yuma files.

Definition at line 70 of file YumaData.hpp.

#include <YumaData.hpp>

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

Public Member Functions

virtual void dump (std::ostream &s) const
 
virtual bool isData () const
 This class is "data" so this function always returns "true". More...
 
 operator AlmOrbit () const
 
 YumaData ()
 Constructor. More...
 
virtual ~YumaData ()
 Destructor. More...
 
- Public Member Functions inherited from gnsstk::YumaBase
virtual ~YumaBase ()
 in deference to our coding standards, this is declared virtual More...
 
- Public Member Functions inherited from gnsstk::FFData
void getRecord (FFStream &s)
 
virtual bool isHeader () const
 
void putRecord (FFStream &s) const
 
virtual ~FFData (void)
 virtual desctuctor More...
 

Public Attributes

double AF0
 
double AF1
 
double Ahalf
 
double ecc
 
double i_offset
 
double i_total
 
double M0
 
double OMEGA0
 
double OMEGAdot
 
short PRN
 
short SV_health
 
long Toa
 
double w
 
short week
 
long xmit_time
 

Static Public Attributes

static GNSSTK_EXPORT short nearFullWeek = 0
 
static const GNSSTK_EXPORT std::string sAf0 = "Af0(s):"
 
static const GNSSTK_EXPORT std::string sAf1 = "Af1(s/s):"
 
static const GNSSTK_EXPORT std::string sArgP = "Argument of Perigee(rad):"
 
static const GNSSTK_EXPORT std::string sEcc = "Eccentricity:"
 
static const GNSSTK_EXPORT std::string sHlth = "Health:"
 
static const GNSSTK_EXPORT std::string sID = "ID:"
 
static const GNSSTK_EXPORT std::string sMnAn = "Mean Anom(rad):"
 
static const GNSSTK_EXPORT std::string sOrbI = "Orbital Inclination(rad):"
 
static const GNSSTK_EXPORT std::string sRRA = "Rate of Right Ascen(r/s):"
 
static const GNSSTK_EXPORT std::string sRtAs = "Right Ascen at Week(rad):"
 
static const GNSSTK_EXPORT std::string sSqrA = "SQRT(A) (m 1/2):"
 
static const GNSSTK_EXPORT std::string sTOA = "Time of Applicability(s):"
 
static const GNSSTK_EXPORT std::string sweek = "week:"
 

Protected Member Functions

std::string lineParser (const std::string &line, const std::string &s) const
 
virtual void reallyGetRecord (FFStream &s)
 
void reallyPutRecord (FFStream &s) const
 

Constructor & Destructor Documentation

◆ YumaData()

gnsstk::YumaData::YumaData ( )
inline

Constructor.

Definition at line 74 of file YumaData.hpp.

◆ ~YumaData()

virtual gnsstk::YumaData::~YumaData ( )
inlinevirtual

Destructor.

Definition at line 77 of file YumaData.hpp.

Member Function Documentation

◆ dump()

void gnsstk::YumaData::dump ( std::ostream &  s) const
virtual

Debug output function. Dump the contents of each of the Yuma class to a given ostream s.

Reimplemented from gnsstk::FFData.

Definition at line 264 of file YumaData.cpp.

◆ isData()

virtual bool gnsstk::YumaData::isData ( ) const
inlinevirtual

This class is "data" so this function always returns "true".

Reimplemented from gnsstk::FFData.

Definition at line 125 of file YumaData.hpp.

◆ lineParser()

string gnsstk::YumaData::lineParser ( const std::string &  line,
const std::string &  s 
) const
protected
Exceptions
FFStreamError

Definition at line 154 of file YumaData.cpp.

◆ operator AlmOrbit()

gnsstk::YumaData::operator AlmOrbit ( ) const

cast *this into an AlmOrbit

Returns
the constructed AlmOrbit object

Definition at line 283 of file YumaData.cpp.

◆ reallyGetRecord()

void gnsstk::YumaData::reallyGetRecord ( FFStream s)
protectedvirtual

This functions obtains a Yuma almanac record from the given FFStream. If there is an error in reading from the stream, it is reset to its original position and its fail-bit is set.

Exceptions
std::exception
StringExceptionwhen a StringUtils function fails
FFStreamErrorwhen exceptions(failbit) is set and a read or formatting error occurs. This also resets the stream to its pre-read position.

Implements gnsstk::FFData.

Definition at line 171 of file YumaData.cpp.

◆ reallyPutRecord()

void gnsstk::YumaData::reallyPutRecord ( FFStream s) const
protectedvirtual

Writes a correctly formatted record from this data to stream s.

Exceptions
std::exception
FFStreamError
StringUtils::StringException

Implements gnsstk::FFData.

Definition at line 82 of file YumaData.cpp.

Member Data Documentation

◆ AF0

double gnsstk::YumaData::AF0

Definition at line 112 of file YumaData.hpp.

◆ AF1

double gnsstk::YumaData::AF1

Definition at line 113 of file YumaData.hpp.

◆ Ahalf

double gnsstk::YumaData::Ahalf

Definition at line 108 of file YumaData.hpp.

◆ ecc

double gnsstk::YumaData::ecc

Definition at line 103 of file YumaData.hpp.

◆ i_offset

double gnsstk::YumaData::i_offset

Definition at line 106 of file YumaData.hpp.

◆ i_total

double gnsstk::YumaData::i_total

Definition at line 105 of file YumaData.hpp.

◆ M0

double gnsstk::YumaData::M0

Definition at line 111 of file YumaData.hpp.

◆ nearFullWeek

short gnsstk::YumaData::nearFullWeek = 0
static

This is is the nearest full GPS week to the 10-bit week available in the SEM file. If this value is 0 it is ignored. Otherwise, the 10-bit week is moved into the GPS Epoch centered on the given full week.

Definition at line 83 of file YumaData.hpp.

◆ OMEGA0

double gnsstk::YumaData::OMEGA0

Definition at line 109 of file YumaData.hpp.

◆ OMEGAdot

double gnsstk::YumaData::OMEGAdot

Definition at line 107 of file YumaData.hpp.

◆ PRN

short gnsstk::YumaData::PRN

Definition at line 100 of file YumaData.hpp.

◆ sAf0

const std::string gnsstk::YumaData::sAf0 = "Af0(s):"
static

Definition at line 95 of file YumaData.hpp.

◆ sAf1

const std::string gnsstk::YumaData::sAf1 = "Af1(s/s):"
static

Definition at line 96 of file YumaData.hpp.

◆ sArgP

const std::string gnsstk::YumaData::sArgP = "Argument of Perigee(rad):"
static

Definition at line 93 of file YumaData.hpp.

◆ sEcc

const std::string gnsstk::YumaData::sEcc = "Eccentricity:"
static

Definition at line 87 of file YumaData.hpp.

◆ sHlth

const std::string gnsstk::YumaData::sHlth = "Health:"
static

Definition at line 86 of file YumaData.hpp.

◆ sID

const std::string gnsstk::YumaData::sID = "ID:"
static

Definition at line 85 of file YumaData.hpp.

◆ sMnAn

const std::string gnsstk::YumaData::sMnAn = "Mean Anom(rad):"
static

Definition at line 94 of file YumaData.hpp.

◆ sOrbI

const std::string gnsstk::YumaData::sOrbI = "Orbital Inclination(rad):"
static

Definition at line 89 of file YumaData.hpp.

◆ sRRA

const std::string gnsstk::YumaData::sRRA = "Rate of Right Ascen(r/s):"
static

Definition at line 90 of file YumaData.hpp.

◆ sRtAs

const std::string gnsstk::YumaData::sRtAs = "Right Ascen at Week(rad):"
static

Definition at line 92 of file YumaData.hpp.

◆ sSqrA

const std::string gnsstk::YumaData::sSqrA = "SQRT(A) (m 1/2):"
static

Definition at line 91 of file YumaData.hpp.

◆ sTOA

const std::string gnsstk::YumaData::sTOA = "Time of Applicability(s):"
static

Definition at line 88 of file YumaData.hpp.

◆ SV_health

short gnsstk::YumaData::SV_health

Definition at line 102 of file YumaData.hpp.

◆ sweek

const std::string gnsstk::YumaData::sweek = "week:"
static

Definition at line 97 of file YumaData.hpp.

◆ Toa

long gnsstk::YumaData::Toa

Definition at line 104 of file YumaData.hpp.

◆ w

double gnsstk::YumaData::w

Definition at line 110 of file YumaData.hpp.

◆ week

short gnsstk::YumaData::week

Definition at line 101 of file YumaData.hpp.

◆ xmit_time

long gnsstk::YumaData::xmit_time

Definition at line 114 of file YumaData.hpp.


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


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