Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::FrameReader

FrameReader
Contained in: FrameCPP::Version_3_4_5
Derived from: FrameCPP::Version_3_4_5::FrameReaderBase FrameCPP::VFrameReader
Derived by: none

#include "../../../../../lib/framecpp/src/Version3_4_5/framereader.hh"


public function member index:

inline FrameReader(std::istream& in, bool autoReset = false); Constructor
virtual ~FrameReader(); Destructor
inline bool isEndOfFile() const; See if FrEndOfFile structure was read, ie. the end of frame file reached
inline Frame* readFrame(); Read a Frame
 

Description:

This class is used to hide all of the functions which are not needed by a user just reading a frame. Most of the functionality of FrameReaderBase is used by the frame objects themselves. This functionality should not be used by the user.


Function Member Descriptions:


FrameCPP::Version_3_4_5::FrameReader::FrameReader - Constructor


inline FrameReader(std::istream& in, bool autoReset = false);

Exceptions:
ExceptionDescription
read_failureRead failed.
read_failureRead failed.



FrameCPP::Version_3_4_5::FrameReader::~FrameReader - Destructor


virtual ~FrameReader();

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::FrameReader::isEndOfFile - See if FrEndOfFile structure was read, ie. the end of frame file reached


inline bool isEndOfFile() const;

Return value:
boolTrue if FrEndOfFile was read.

Exceptions:
ExceptionDescription
None.
None



FrameCPP::Version_3_4_5::FrameReader::readFrame - Read a Frame


inline Frame* readFrame();

Return value:
Frame*Newly allocated.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.
read_failureRead failed.
std::bad_allocOut of memory.
read_failureRead failed.