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

Detailed Description

This class stores, reads, and writes SEM records.

Warning
The SEM header information and data information don't correctly talk to each other at the time of completion of this file. The current fix is in SEMAlamanacStore.hpp.
See also
tests/SEM for examples
SEMStream.
SEMHeader for information on writing SEM files.

Definition at line 72 of file SEMHeader.hpp.

#include <SEMHeader.hpp>

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

Public Member Functions

virtual void dump (std::ostream &s) const
 
virtual bool isHeader () const
 This class is a "header" so this function always returns "true". More...
 
 SEMHeader ()
 Constructor. More...
 
virtual ~SEMHeader ()
 Destructor. More...
 
- Public Member Functions inherited from gnsstk::SEMBase
virtual ~SEMBase ()
 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

short numRecords
 
std::string Title
 
long Toa
 
short week
 

Static Public Attributes

static GNSSTK_EXPORT short nearFullWeek = 0
 

Protected Member Functions

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

Constructor & Destructor Documentation

◆ SEMHeader()

gnsstk::SEMHeader::SEMHeader ( )
inline

Constructor.

Definition at line 76 of file SEMHeader.hpp.

◆ ~SEMHeader()

virtual gnsstk::SEMHeader::~SEMHeader ( )
inlinevirtual

Destructor.

Definition at line 79 of file SEMHeader.hpp.

Member Function Documentation

◆ dump()

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

Debug output function. Dump the contents of each of the SEM header to a given ostream s.

Reimplemented from gnsstk::FFData.

Definition at line 131 of file SEMHeader.cpp.

◆ isHeader()

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

This class is a "header" so this function always returns "true".

Reimplemented from gnsstk::FFData.

Definition at line 101 of file SEMHeader.hpp.

◆ reallyGetRecord()

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

This functions obtains a SEM header 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 79 of file SEMHeader.cpp.

◆ reallyPutRecord()

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

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

Exceptions
std::exception
StringUtils::StringException
FFStreamError

Implements gnsstk::FFData.

Definition at line 58 of file SEMHeader.cpp.

Member Data Documentation

◆ nearFullWeek

short gnsstk::SEMHeader::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 85 of file SEMHeader.hpp.

◆ numRecords

short gnsstk::SEMHeader::numRecords

Definition at line 87 of file SEMHeader.hpp.

◆ Title

std::string gnsstk::SEMHeader::Title

Definition at line 88 of file SEMHeader.hpp.

◆ Toa

long gnsstk::SEMHeader::Toa

Definition at line 90 of file SEMHeader.hpp.

◆ week

short gnsstk::SEMHeader::week

Definition at line 89 of file SEMHeader.hpp.


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


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