Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | List of all members
gnsstk::RinexNavHeader Class Reference
Formatted File I/O

Detailed Description

This class models the RINEX NAV header for a RINEX NAV file.

See also
rinex_nav_test.cpp and rinex_nav_read_write.cpp for examples.
gnsstk::RinexNavData and gnsstk::RinexNavStream classes.

Definition at line 63 of file RinexNavHeader.hpp.

#include <RinexNavHeader.hpp>

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

Public Types

enum  validBits {
  versionValid = 0x01, runByValid = 0x02, commentValid = 0x04, ionAlphaValid = 0x08,
  ionBetaValid = 0x010, deltaUTCValid = 0x020, leapSecondsValid = 0x040, endValid = 0x080000000,
  allValid20 = 0x080000003, allValid21 = 0x080000003, allValid211 = 0x080000003
}
 These are validity bits used in checking the RINEX NAV header. More...
 

Public Member Functions

virtual void dump (std::ostream &s) const
 This function dumps the contents of the header. More...
 
virtual bool isHeader () const
 RinexNavHeader is a "header" so this function always returns true. More...
 
 RinexNavHeader ()
 Constructor. More...
 
virtual ~RinexNavHeader ()
 Destructor. More...
 
- Public Member Functions inherited from gnsstk::RinexNavBase
virtual ~RinexNavBase ()
 in deference to our coding standards, this is declared virtual More...
 
- Public Member Functions inherited from gnsstk::FFData
void getRecord (FFStream &s)
 
virtual bool isData () const
 
void putRecord (FFStream &s) const
 
virtual ~FFData (void)
 virtual desctuctor More...
 

Public Attributes

RNDouble A0
 
RNDouble A1
 
std::vector< std::string > commentList
 
std::string date
 
std::string fileAgency
 
std::string fileProgram
 
std::string fileType
 
FormattedDouble ionAlpha [4]
 
FormattedDouble ionBeta [4]
 
long leapSeconds
 
long UTCRefTime
 
long UTCRefWeek
 
unsigned long valid
 Tell me, Am I valid? More...
 
double version
 RINEX Version. More...
 

Static Public Attributes

static const GNSSTK_EXPORT std::string commentString = "COMMENT"
 
static const GNSSTK_EXPORT std::string deltaUTCString = "DELTA-UTC: A0,A1,T,W"
 
static const GNSSTK_EXPORT std::string endOfHeader = "END OF HEADER"
 
static const GNSSTK_EXPORT std::string ionAlphaString = "ION ALPHA"
 
static const GNSSTK_EXPORT std::string ionBetaString = "ION BETA"
 
static const GNSSTK_EXPORT std::string leapSecondsString = "LEAP SECONDS"
 
static const GNSSTK_EXPORT std::string runByString = "PGM / RUN BY / DATE"
 
static const GNSSTK_EXPORT std::string versionString = "RINEX VERSION / TYPE"
 

Protected Member Functions

virtual void reallyGetRecord (FFStream &s)
 
virtual void reallyPutRecord (FFStream &s) const
 

Member Enumeration Documentation

◆ validBits

enum gnsstk::RinexNavHeader::validBits

These are validity bits used in checking the RINEX NAV header.

Enumerator
versionValid 

Set if the RINEX version is valid.

runByValid 

Set if the Run-by value is valid.

commentValid 

Set if the comments are valid. Very subjective.

ionAlphaValid 

Set if the Ion Alpha value is valid.

ionBetaValid 

Set if the Ion Beta value is valid.

deltaUTCValid 

Set if the Delta UTC value is valid.

leapSecondsValid 

Set if the Leap Seconds value is valid.

endValid 

Set if the end value is valid.

allValid20 

This bitset checks that all required header items are available for a Rinex 2.0 version file

allValid21 

This bitset checks that all required header items are available for a Rinex 2.1 version file

allValid211 

This bitset checks that all required header items are available for a Rinex 2.11 version file

Definition at line 82 of file RinexNavHeader.hpp.

Constructor & Destructor Documentation

◆ RinexNavHeader()

gnsstk::RinexNavHeader::RinexNavHeader ( )

Constructor.

Definition at line 67 of file RinexNavHeader.cpp.

◆ ~RinexNavHeader()

virtual gnsstk::RinexNavHeader::~RinexNavHeader ( )
inlinevirtual

Destructor.

Definition at line 70 of file RinexNavHeader.hpp.

Member Function Documentation

◆ dump()

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

This function dumps the contents of the header.

Reimplemented from gnsstk::FFData.

Definition at line 303 of file RinexNavHeader.cpp.

◆ isHeader()

virtual bool gnsstk::RinexNavHeader::isHeader ( ) const
inlinevirtual

RinexNavHeader is a "header" so this function always returns true.

Reimplemented from gnsstk::FFData.

Definition at line 73 of file RinexNavHeader.hpp.

◆ reallyGetRecord()

void gnsstk::RinexNavHeader::reallyGetRecord ( FFStream &  s)
protectedvirtual

This function reads the RINEX NAV header from the given FFStream. If an error is encountered in reading from the stream, the stream 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 192 of file RinexNavHeader.cpp.

◆ reallyPutRecord()

void gnsstk::RinexNavHeader::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 88 of file RinexNavHeader.cpp.

Member Data Documentation

◆ A0

RNDouble gnsstk::RinexNavHeader::A0

Definition at line 113 of file RinexNavHeader.hpp.

◆ A1

RNDouble gnsstk::RinexNavHeader::A1

Definition at line 114 of file RinexNavHeader.hpp.

◆ commentList

std::vector<std::string> gnsstk::RinexNavHeader::commentList

Definition at line 110 of file RinexNavHeader.hpp.

◆ commentString

const string gnsstk::RinexNavHeader::commentString = "COMMENT"
static

Definition at line 124 of file RinexNavHeader.hpp.

◆ date

std::string gnsstk::RinexNavHeader::date

Definition at line 109 of file RinexNavHeader.hpp.

◆ deltaUTCString

const string gnsstk::RinexNavHeader::deltaUTCString = "DELTA-UTC: A0,A1,T,W"
static

Definition at line 130 of file RinexNavHeader.hpp.

◆ endOfHeader

const string gnsstk::RinexNavHeader::endOfHeader = "END OF HEADER"
static

Definition at line 134 of file RinexNavHeader.hpp.

◆ fileAgency

std::string gnsstk::RinexNavHeader::fileAgency

Definition at line 108 of file RinexNavHeader.hpp.

◆ fileProgram

std::string gnsstk::RinexNavHeader::fileProgram

Definition at line 107 of file RinexNavHeader.hpp.

◆ fileType

std::string gnsstk::RinexNavHeader::fileType

Definition at line 106 of file RinexNavHeader.hpp.

◆ ionAlpha

FormattedDouble gnsstk::RinexNavHeader::ionAlpha[4]

Definition at line 111 of file RinexNavHeader.hpp.

◆ ionAlphaString

const string gnsstk::RinexNavHeader::ionAlphaString = "ION ALPHA"
static

Definition at line 126 of file RinexNavHeader.hpp.

◆ ionBeta

FormattedDouble gnsstk::RinexNavHeader::ionBeta[4]

Definition at line 112 of file RinexNavHeader.hpp.

◆ ionBetaString

const string gnsstk::RinexNavHeader::ionBetaString = "ION BETA"
static

Definition at line 128 of file RinexNavHeader.hpp.

◆ leapSeconds

long gnsstk::RinexNavHeader::leapSeconds

Definition at line 117 of file RinexNavHeader.hpp.

◆ leapSecondsString

const string gnsstk::RinexNavHeader::leapSecondsString = "LEAP SECONDS"
static

Definition at line 132 of file RinexNavHeader.hpp.

◆ runByString

const string gnsstk::RinexNavHeader::runByString = "PGM / RUN BY / DATE"
static

Definition at line 122 of file RinexNavHeader.hpp.

◆ UTCRefTime

long gnsstk::RinexNavHeader::UTCRefTime

Definition at line 115 of file RinexNavHeader.hpp.

◆ UTCRefWeek

long gnsstk::RinexNavHeader::UTCRefWeek

Definition at line 116 of file RinexNavHeader.hpp.

◆ valid

unsigned long gnsstk::RinexNavHeader::valid

Tell me, Am I valid?

Definition at line 79 of file RinexNavHeader.hpp.

◆ version

double gnsstk::RinexNavHeader::version

RINEX Version.

Definition at line 104 of file RinexNavHeader.hpp.

◆ versionString

const string gnsstk::RinexNavHeader::versionString = "RINEX VERSION / TYPE"
static

Definition at line 120 of file RinexNavHeader.hpp.

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

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