SEMHeader Class Reference
[SEM Almanac files]

#include <SEMHeader.hpp>

Inheritance diagram for SEMHeader:

Inheritance graph
[legend]
Collaboration diagram for SEMHeader:

Collaboration graph
[legend]
List of all members.

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 57 of file SEMHeader.hpp.

Public Member Functions

 SEMHeader ()
 Constructor.
virtual ~SEMHeader ()
 Destructor.
virtual void dump (std::ostream &s) const
 Debug output function.
virtual bool isHeader () const
 This class is a "header" so this function always returns "true".

Public Attributes

short numRecords
std::string Title
short week
long Toa

Static Public Attributes

short nearFullWeek = 0
 This is is the nearest full GPS week to the 10-bit week available in the SEM file.

Protected Member Functions

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


Constructor & Destructor Documentation

SEMHeader  )  [inline]
 

Constructor.

Definition at line 61 of file SEMHeader.hpp.

virtual ~SEMHeader  )  [inline, virtual]
 

Destructor.

Definition at line 64 of file SEMHeader.hpp.


Member Function Documentation

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

Definition at line 103 of file SEMHeader.cpp.

References SEMHeader::numRecords, SEMHeader::Title, SEMHeader::Toa, and SEMHeader::week.

virtual bool isHeader void   )  const [inline, virtual]
 

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

Reimplemented from FFData.

Definition at line 86 of file SEMHeader.hpp.

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

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:
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 67 of file SEMHeader.cpp.

References gpstk::StringUtils::asInt(), FFTextStream::formattedGetLine(), SEMStream::header, and SEMStream::headerRead.

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

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

Implements FFData.

Definition at line 44 of file SEMHeader.cpp.

References gpstk::StringUtils::leftJustify(), and gpstk::StringUtils::rightJustify().


Member Data Documentation

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 SEMHeader.cpp.

short numRecords
 

Definition at line 72 of file SEMHeader.hpp.

Referenced by SEMHeader::dump().

std::string Title
 

Definition at line 73 of file SEMHeader.hpp.

Referenced by SEMHeader::dump().

long Toa
 

Definition at line 75 of file SEMHeader.hpp.

Referenced by SEMHeader::dump(), and SEMData::reallyGetRecord().

short week
 

Definition at line 74 of file SEMHeader.hpp.

Referenced by SEMHeader::dump(), SEMAlmanacStore::loadFile(), and SEMData::reallyGetRecord().


The documentation for this class was generated from the following files:
Generated on Wed Feb 8 03:31:41 2012 for GPS ToolKit Software Library by  doxygen 1.3.9.1