FICHeader Class Reference

#include <FICHeader.hpp>

Inheritance diagram for FICHeader:

[legend]Collaboration diagram for FICHeader:

[legend]List of all members.

---

Detailed Description

This is the Header for the FIC File Model.

There is one 40 character header at the start of each FIC file, ASCII or binary.

See also:

fic_test.cpp, fic_read_write.cpp, and fica_test.cpp for examples.

FICStream, FICAStream, and FICData.

Definition at line 68 of file FICHeader.hpp.

Public Member Functions
	FICHeader ()
	Default constructor.
virtual	~FICHeader ()
	Destructor.
virtual bool	isHeader () const
	FICHeader is a header, so this function always returns true.
virtual void	dump (std::ostream &s) const
	This function does nothing.
Public Attributes
std::string	header
	The header string.
Static Public Attributes
const int	headerSize = 40
	constant for the header size.
Protected Member Functions
virtual void	reallyPutRecord (FFStream &s) const throw (std::exception, gpstk::StringUtils::StringException, gpstk::FFStreamError)
	Writes the header string to the FFStream s.
virtual void	reallyGetRecord (FFStream &s) throw (std::exception, gpstk::StringUtils::StringException, gpstk::FFStreamError)
	Retrieve the header string from the FFStream s.

---

Constructor & Destructor Documentation

FICHeader (   )  [inline]

Default constructor. Definition at line 72 of file FICHeader.hpp.

virtual ~FICHeader (   )  [inline, virtual]

Destructor. Definition at line 75 of file FICHeader.hpp.

---

Member Function Documentation

void dump (  std::ostream &  s  )  const [virtual]

This function does nothing. Reimplemented from FFData. Definition at line 93 of file FICHeader.cpp. References FICHeader::header.

virtual bool isHeader (  void   )  const [inline, virtual]

FICHeader is a header, so this function always returns true. Reimplemented from FFData. Definition at line 78 of file FICHeader.hpp.

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

Retrieve the header string from the FFStream s. If the read fails for some reason, the stream will be reset to its original position, and its fail-bit will be set. Exceptions: 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 98 of file FICHeader.cpp. References FFTextStream::formattedGetLine(), GPSTK_THROW, FICHeader::header, FICStreamBase::header, and FICStreamBase::headerRead.

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

Writes the header string to the FFStream s. Implements FFData. Definition at line 66 of file FICHeader.cpp. References GPSTK_THROW, and gpstk::StringUtils::leftJustify().

---

Member Data Documentation

std::string header

The header string. Definition at line 86 of file FICHeader.hpp. Referenced by FICHeader::dump(), and FICHeader::reallyGetRecord().

const int headerSize = 40 [static]

constant for the header size. Definition at line 58 of file FICHeader.cpp.

---

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

• FICHeader.hpp
• FICHeader.cpp

---