FrameCPP::Common::FrameBufferInterface::Scanner Class Reference

Scan buffers conforming to the frame specification. More...

#include <FrameBufferInterface.hh>

Inheritance diagram for FrameCPP::Common::FrameBufferInterface::Scanner:

Public Types
typedef INT_8U	size_type
	type for number of bytes to read and size of buffer
typedef INT_8U	size_type
	type for number of bytes to read and size of buffer
typedef INT_8U	size_type
	type for number of bytes to read and size of buffer

Public Member Functions
	Scanner ()
	Constructor.
virtual	~Scanner ()
	Destructor. More...
delta_t_type	DeltaT () const
	Retrieve the duration of the stream.
virtual void	NextBlock (const char *Buffer, size_type Size)
	Add a buffer to the frame file memory image. More...
size_type	NextBlockSize () const
	Return the number of bytes to be made available.
size_type	Position () const
	Return the current position in the stream being scanned.
bool	Ready () const
	Check if a complete frame file is ready for processing.
virtual void	Reset ()
	Initialize buffer to accumulate a frame file.
start_time_type	StartTime () const
	Retrieve the start time of the stream.
	Scanner ()
	Constructor.
virtual	~Scanner ()
	Destructor. More...
delta_t_type	DeltaT () const
	Retrieve the duration of the stream.
virtual void	NextBlock (const char *Buffer, size_type Size)
	Add a buffer to the frame file memory image. More...
size_type	NextBlockSize () const
	Return the number of bytes to be made available.
size_type	Position () const
	Return the current position in the stream being scanned.
bool	Ready () const
	Check if a complete frame file is ready for processing.
virtual void	Reset ()
	Initialize buffer to accumulate a frame file.
start_time_type	StartTime () const
	Retrieve the start time of the stream.
	Scanner ()
	Constructor.
virtual	~Scanner ()
	Destructor. More...
delta_t_type	DeltaT () const
	Retrieve the duration of the stream.
virtual void	NextBlock (const char *Buffer, size_type Size)
	Add a buffer to the frame file memory image. More...
size_type	NextBlockSize () const
	Return the number of bytes to be made available.
size_type	Position () const
	Return the current position in the stream being scanned.
bool	Ready () const
	Check if a complete frame file is ready for processing.
virtual void	Reset ()
	Initialize buffer to accumulate a frame file.
start_time_type	StartTime () const
	Retrieve the start time of the stream.

Detailed Description

Scan buffers conforming to the frame specification.

Constructor & Destructor Documentation

~Scanner() [1/3]

FrameCPP::Common::FrameBufferInterface::Scanner::~Scanner ( )

inlinevirtual

Destructor.

Note

Need to have an explicit destructor since there are virtual functions.

~Scanner() [2/3]

virtual FrameCPP::Common::FrameBufferInterface::Scanner::~Scanner ( )

virtual

Destructor.

Note

Need to have an explicit destructor since there are virtual functions.

~Scanner() [3/3]

virtual FrameCPP::Common::FrameBufferInterface::Scanner::~Scanner ( )

virtual

Destructor.

Note

Need to have an explicit destructor since there are virtual functions.

Member Function Documentation

NextBlock() [1/3]

void FrameCPP::Common::FrameBufferInterface::Scanner::NextBlock ( const char *  Buffer, size_type  Size  )

virtual

Add a buffer to the frame file memory image.

Parameters

[in]	Buffer	The buffer to scan
[in]	Size	The number of bytes in Buffer

Todo:

Instead of just bailing when failing to read the buffer, need to see if the buffer contains some subset of the ORIGINATOR string so as to allow resyncing to happen

Reimplemented in FrameCPP::Common::DynamicMemoryBufferT< BT >, FrameCPP::Common::DynamicMemoryBufferT< BT >, and FrameCPP::Common::DynamicMemoryBufferT< BT >.

NextBlock() [2/3]

virtual void FrameCPP::Common::FrameBufferInterface::Scanner::NextBlock ( const char *  Buffer, size_type  Size  )

virtual

Add a buffer to the frame file memory image.

Parameters

[in]	Buffer	The buffer to scan
[in]	Size	The number of bytes in Buffer

Reimplemented in FrameCPP::Common::DynamicMemoryBufferT< BT >, FrameCPP::Common::DynamicMemoryBufferT< BT >, and FrameCPP::Common::DynamicMemoryBufferT< BT >.

NextBlock() [3/3]

virtual void FrameCPP::Common::FrameBufferInterface::Scanner::NextBlock ( const char *  Buffer, size_type  Size  )

virtual

Add a buffer to the frame file memory image.

Parameters

[in]	Buffer	The buffer to scan
[in]	Size	The number of bytes in Buffer

Reimplemented in FrameCPP::Common::DynamicMemoryBufferT< BT >, FrameCPP::Common::DynamicMemoryBufferT< BT >, and FrameCPP::Common::DynamicMemoryBufferT< BT >.

---

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

• /build/ldas-tools-framecpp-2.7.0/debian/tmp/usr/include/framecpp/Common/FrameBufferInterface.hh
• /build/ldas-tools-framecpp-2.7.0/src/Common/FrameBufferInterface.cc