YumaData Class Reference
[Yuma almanac files]

#include <YumaData.hpp>

Inheritance diagram for YumaData:

Inheritance graph
[legend]
Collaboration diagram for YumaData:

Collaboration graph
[legend]
List of all members.

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 55 of file YumaData.hpp.

Public Member Functions

 YumaData ()
 Constructor.
virtual ~YumaData ()
 Destructor.
virtual void dump (std::ostream &s) const
 Debug output function.
virtual bool isData () const
 This class is "data" so this function always returns "true".
 operator AlmOrbit () const
 cast *this into an AlmOrbit

Public Attributes

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

Static Public Attributes

short nearFullWeek = 0
 This is is the nearest full GPS week to the 10-bit week available in the SEM file.
const std::string sID = "ID:"
const std::string sHlth = "Health:"
const std::string sEcc = "Eccentricity:"
const std::string sTOA = "Time of Applicability(s):"
const std::string sOrbI = "Orbital Inclination(rad):"
const std::string sRRA = "Rate of Right Ascen(r/s):"
const std::string sSqrA = "SQRT(A) (m 1/2):"
const std::string sRtAs = "Right Ascen at Week(rad):"
const std::string sArgP = "Argument of Perigee(rad):"
const std::string sMnAn = "Mean Anom(rad):"
const std::string sAf0 = "Af0(s):"
const std::string sAf1 = "Af1(s/s):"
const std::string sweek = "week:"

Protected Member Functions

void reallyPutRecord (FFStream &s) const throw (std::exception, FFStreamError, gpstk::StringUtils::StringException)
 Writes a correctly formatted record from this data to stream s.
virtual void reallyGetRecord (FFStream &s) throw (std::exception, FFStreamError, gpstk::StringUtils::StringException)
 This functions obtains a Yuma almanac record from the given FFStream.
std::string lineParser (const std::string &line, const std::string &s) const throw (FFStreamError)


Constructor & Destructor Documentation

YumaData  )  [inline]
 

Constructor.

Definition at line 59 of file YumaData.hpp.

virtual ~YumaData  )  [inline, virtual]
 

Destructor.

Definition at line 62 of file YumaData.hpp.


Member Function Documentation

void 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 FFData.

Definition at line 185 of file YumaData.cpp.

References YumaData::AF0, YumaData::AF1, YumaData::Ahalf, YumaData::ecc, YumaData::i_offset, YumaData::M0, YumaData::OMEGA0, YumaData::OMEGAdot, YumaData::PRN, YumaData::SV_health, YumaData::Toa, YumaData::w, YumaData::week, and YumaData::xmit_time.

virtual bool isData void   )  const [inline, virtual]
 

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

Reimplemented from FFData.

Definition at line 109 of file YumaData.hpp.

string lineParser const std::string &  line,
const std::string &  s
const throw (FFStreamError) [protected]
 

Definition at line 85 of file YumaData.cpp.

References GPSTK_THROW, gpstk::min(), and gpstk::StringUtils::stripLeading().

operator AlmOrbit  )  const
 

cast *this into an AlmOrbit

Returns:
the constructed AlmOrbit object

Definition at line 204 of file YumaData.cpp.

References YumaData::AF0, YumaData::AF1, YumaData::Ahalf, YumaData::ecc, YumaData::i_offset, YumaData::M0, YumaData::OMEGA0, YumaData::OMEGAdot, YumaData::PRN, YumaData::SV_health, YumaData::Toa, YumaData::w, YumaData::week, and YumaData::xmit_time.

void reallyGetRecord FFStream s  )  throw (std::exception, FFStreamError, gpstk::StringUtils::StringException) [protected, virtual]
 

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:
StringException when a StringUtils function fails
FFStreamError when exceptions(failbit) is set and a read or formatting error occurs. This also resets the stream to its pre-read position.

Implements FFData.

Definition at line 103 of file YumaData.cpp.

References gpstk::StringUtils::asDouble(), gpstk::StringUtils::asInt(), and FFTextStream::formattedGetLine().

void reallyPutRecord FFStream s  )  const throw (std::exception, FFStreamError, gpstk::StringUtils::StringException) [protected, virtual]
 

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

Implements FFData.

Definition at line 58 of file YumaData.cpp.


Member Data Documentation

double AF0
 

Definition at line 96 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

double AF1
 

Definition at line 97 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

double Ahalf
 

Definition at line 92 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

double ecc
 

Definition at line 88 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

double i_offset
 

Definition at line 90 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

double M0
 

Definition at line 95 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

short 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 42 of file YumaData.cpp.

double OMEGA0
 

Definition at line 93 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

double OMEGAdot
 

Definition at line 91 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

short PRN
 

Definition at line 85 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

const std::string sAf0 = "Af0(s):" [static]
 

Definition at line 54 of file YumaData.cpp.

const std::string sAf1 = "Af1(s/s):" [static]
 

Definition at line 55 of file YumaData.cpp.

const std::string sArgP = "Argument of Perigee(rad):" [static]
 

Definition at line 52 of file YumaData.cpp.

const std::string sEcc = "Eccentricity:" [static]
 

Definition at line 46 of file YumaData.cpp.

const std::string sHlth = "Health:" [static]
 

Definition at line 45 of file YumaData.cpp.

const std::string sID = "ID:" [static]
 

Definition at line 44 of file YumaData.cpp.

const std::string sMnAn = "Mean Anom(rad):" [static]
 

Definition at line 53 of file YumaData.cpp.

const std::string sOrbI = "Orbital Inclination(rad):" [static]
 

Definition at line 48 of file YumaData.cpp.

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

Definition at line 49 of file YumaData.cpp.

const std::string sRtAs = "Right Ascen at Week(rad):" [static]
 

Definition at line 51 of file YumaData.cpp.

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

Definition at line 50 of file YumaData.cpp.

const std::string sTOA = "Time of Applicability(s):" [static]
 

Definition at line 47 of file YumaData.cpp.

short SV_health
 

Definition at line 87 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

const std::string sweek = "week:" [static]
 

Definition at line 56 of file YumaData.cpp.

long Toa
 

Definition at line 89 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

double w
 

Definition at line 94 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().

short week
 

Definition at line 86 of file YumaData.hpp.

Referenced by YumaData::dump(), YumaAlmanacStore::loadFile(), and YumaData::operator AlmOrbit().

long xmit_time
 

Definition at line 98 of file YumaData.hpp.

Referenced by YumaData::dump(), and YumaData::operator AlmOrbit().


The documentation for this class was generated from the following files:
Generated on Sun May 19 03:31:56 2013 for GPS ToolKit Software Library by  doxygen 1.3.9.1