ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameBuffer< BT > Class Template Referenceabstract

Buffer appropriate for caching frame data. More...

#include <FrameBuffer.hh>

Public Types

typedef FrameBuffer< BT > buffer_type
 Type of self.
 
typedef FrameBuffer< BT > buffer_type
 Type of self.
 
typedef BT::char_type char_type
 type representing a character in the stream.
 
typedef BT::char_type char_type
 type representing a character in the stream.
 
typedef BT::int_type int_type
 integer type
 
typedef BT::int_type int_type
 integer type
 
typedef BT::pos_type pos_type
 type appropriate for holding stream position information
 
typedef BT::pos_type pos_type
 type appropriate for holding stream position information
 
typedef BT::off_type off_type
 type apprpriate to hold stream offset request
 
typedef BT::off_type off_type
 type apprpriate to hold stream offset request
 

Public Member Functions

 FrameBuffer (std::ios::openmode Mode, bool ParentAutoDelete=true)
 constructor
 
 FrameBuffer (std::ios::openmode Mode, bool ParentAutoDelete=true)
 constructor
 
bool FilterInternally () const
 Returns true if filtering happens internally; false otherwise.
 
bool FilterInternally () const
 Returns true if filtering happens internally; false otherwise.
 
const std::string & BufferId () const
 Retrieve the string identification of the buffer.
 
const std::string & BufferId () const
 Retrieve the string identification of the buffer.
 

Static Public Attributes

static const buffer_size_type M_BUFFER_SIZE_DEFAULT = 256 * 1024
 The default size for buffered input and output.
 

Protected Types

typedef std::list< FrameCPP::Common::StreamFilter * > filters_type
 Type specifying the container holding the active filters.
 
typedef std::list< FrameCPP::Common::StreamFilter * > filters_type
 Type specifying the container holding the active filters.
 

Protected Member Functions

virtual FrameBuffer< BT > * setbuf (char_type *S, std::streamsize N)
 Routine to register if the caller has specified a buffer.
 
virtual FrameBuffer< BT > * setbuf (char_type *S, std::streamsize N)
 Routine to register if the caller has specified a buffer.
 
virtual void buffer ()
 Establish buffering.
 
virtual void buffer ()
 Establish buffering.
 

Protected Attributes

filters_type m_filters
 Container holding all active filters.
 

Detailed Description

Buffer appropriate for caching frame data.

Member Function Documentation

◆ BufferId() [1/2]

const std::string & FrameCPP::Common::FrameBufferInterface::BufferId ( ) const
inlineinherited

Retrieve the string identification of the buffer.

Returns
An identifier associated with the open buffer.

◆ BufferId() [2/2]

const std::string & FrameCPP::Common::FrameBufferInterface::BufferId ( ) const
inherited

Retrieve the string identification of the buffer.

Returns
An identifier associated with the open buffer.

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