FFBinaryStream Class Reference
[Formatted file I/O]

#include <FFBinaryStream.hpp>

Inheritance diagram for FFBinaryStream:

Inheritance graph
[legend]
Collaboration diagram for FFBinaryStream:

Collaboration graph
[legend]
List of all members.

Detailed Description

This is an FFStream that is required to be binary.

It also includes functions for reading and writing binary file. Otherwise, this is the same as FFStream.

Definition at line 66 of file FFBinaryStream.hpp.

Public Member Functions

virtual ~FFBinaryStream ()
 destructor
 FFBinaryStream ()
 Default constructor.
 FFBinaryStream (const char *fn, std::ios::openmode mode=std::ios::in|std::ios::binary)
 Constructor - opens the stream in binary mode if not set.
virtual void open (const char *fn, std::ios::openmode mode)
 Overrides open to ensure binary mode opens.
template<class T>
getData () throw (FFStreamError, EndOfFile)
 Reads a T-object directly from the stream in binary form.
void getData (char *buff, size_t length) throw (FFStreamError, EndOfFile)
template<class T>
void writeData (const T &data) throw (FFStreamError)
 Writes a T-object directly from the stream in binary form.
void writeData (const char *buff, size_t length) throw (FFStreamError)


Constructor & Destructor Documentation

virtual ~FFBinaryStream  )  [inline, virtual]
 

destructor

Definition at line 70 of file FFBinaryStream.hpp.

FFBinaryStream  )  [inline]
 

Default constructor.

Definition at line 73 of file FFBinaryStream.hpp.

FFBinaryStream const char *  fn,
std::ios::openmode  mode = std::ios::in|std::ios::binary
[inline]
 

Constructor - opens the stream in binary mode if not set.

Parameters:
fn file name.
mode file open mode (std::ios)

Definition at line 80 of file FFBinaryStream.hpp.


Member Function Documentation

void getData char *  buff,
size_t  length
throw (FFStreamError, EndOfFile) [inline]
 

Definition at line 102 of file FFBinaryStream.hpp.

References GPSTK_THROW.

T getData  )  throw (FFStreamError, EndOfFile) [inline]
 

Reads a T-object directly from the stream in binary form.

Exceptions:
FFStreamError when the size of the data read from this stream doesn't match the size of a T-object.
Returns:
a T-object

Definition at line 95 of file FFBinaryStream.hpp.

Referenced by MDPHeader::readHeader(), NovatelData::reallyGetRecord(), FICData::reallyGetRecord(), and ATSData::reallyGetRecord().

virtual void open const char *  fn,
std::ios::openmode  mode
[inline, virtual]
 

Overrides open to ensure binary mode opens.

Reimplemented from FFStream.

Reimplemented in AshtechStream, ATSStream, MDPStream, NovatelStream, BinexStream, and FICStream.

Definition at line 85 of file FFBinaryStream.hpp.

void writeData const char *  buff,
size_t  length
throw (FFStreamError) [inline]
 

Definition at line 145 of file FFBinaryStream.hpp.

References GPSTK_THROW.

void writeData const T &  data  )  throw (FFStreamError) [inline]
 

Writes a T-object directly from the stream in binary form.

Parameters:
data the data to be written.
Exceptions:
FFStreamError when the size of the data written to this stream doesn't match the size of a T-object.
Returns:
a T-object

Definition at line 137 of file FFBinaryStream.hpp.

Referenced by FICData::reallyPutRecord().


The documentation for this class was generated from the following file:
Generated on Mon May 20 03:31:47 2013 for GPS ToolKit Software Library by  doxygen 1.3.9.1