ldas-tools-framecpp  2.7.0
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
FrameCPP::Common::FrameBufferInterface Class Referenceabstract

#include <FrameBufferInterface.hh>

Inheritance diagram for FrameCPP::Common::FrameBufferInterface:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Common::FrameBufferInterface:
Collaboration graph
[legend]

Classes

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

Public Types

typedef std::streambuf::char_type char_type
 
typedef INT_4U buffer_size_type
 
typedef std::streambuf::char_type char_type
 
typedef INT_4U buffer_size_type
 

Public Member Functions

 FrameBufferInterface ()
 
virtual ~FrameBufferInterface ()
 
bool AutoDelete () const
 
void AutoDelete (bool Value)
 
virtual void FilterAdd (FrameCPP::Common::StreamFilter *Filter)
 Adds a filter to the stream. More...
 
virtual void FilterRemove (FrameCPP::Common::StreamFilter *Filter)
 Removes a filter from the stream. More...
 
virtual bool FilterInternally () const =0
 
virtual void buffer ()=0
 
template<class DT >
void filter (const DT &Data)
 
virtual void filter (const char_type *Start, const char_type *End)=0
 
void FilterBuffer (const char *Begin, const char *End)
 
const std::string & BufferId () const
 Retrieve the string identification of the buffer. More...
 
 FrameBufferInterface ()
 
virtual ~FrameBufferInterface ()
 
bool AutoDelete () const
 
void AutoDelete (bool Value)
 
virtual void FilterAdd (FrameCPP::Common::StreamFilter *Filter)
 Adds a filter to the stream. More...
 
virtual void FilterRemove (FrameCPP::Common::StreamFilter *Filter)
 Removes a filter from the stream. More...
 
virtual bool FilterInternally () const =0
 
virtual void buffer ()=0
 
template<class DT >
void filter (const DT &Data)
 
virtual void filter (const char_type *Start, const char_type *End)=0
 
void FilterBuffer (const char *Begin, const char *End)
 
const std::string & BufferId () const
 Retrieve the string identification of the buffer. More...
 

Static Public Attributes

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

Protected Types

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

Protected Member Functions

void bufferId (const std::string &Id)
 
void bufferId (const std::string &Id)
 

Protected Attributes

filters_type m_filters
 Container holding all active filters. More...
 

Private Attributes

bool m_auto_delete
 
std::string m_stream_id
 

Member Typedef Documentation

◆ buffer_size_type [1/2]

◆ buffer_size_type [2/2]

◆ char_type [1/2]

typedef std::streambuf::char_type FrameCPP::Common::FrameBufferInterface::char_type

◆ char_type [2/2]

typedef std::streambuf::char_type FrameCPP::Common::FrameBufferInterface::char_type

◆ filters_type [1/2]

Type specifying the container holding the active filters.

◆ filters_type [2/2]

Type specifying the container holding the active filters.

Constructor & Destructor Documentation

◆ FrameBufferInterface() [1/2]

FrameCPP::Common::FrameBufferInterface::FrameBufferInterface ( )

◆ ~FrameBufferInterface() [1/2]

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

◆ FrameBufferInterface() [2/2]

FrameCPP::Common::FrameBufferInterface::FrameBufferInterface ( )

◆ ~FrameBufferInterface() [2/2]

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

Member Function Documentation

◆ AutoDelete() [1/4]

bool FrameCPP::Common::FrameBufferInterface::AutoDelete ( ) const
inline

◆ AutoDelete() [2/4]

bool FrameCPP::Common::FrameBufferInterface::AutoDelete ( ) const

◆ AutoDelete() [3/4]

void FrameCPP::Common::FrameBufferInterface::AutoDelete ( bool  Value)
inline

◆ AutoDelete() [4/4]

void FrameCPP::Common::FrameBufferInterface::AutoDelete ( bool  Value)

◆ buffer() [1/2]

virtual void FrameCPP::Common::FrameBufferInterface::buffer ( )
pure virtual

◆ buffer() [2/2]

virtual void FrameCPP::Common::FrameBufferInterface::buffer ( )
pure virtual

◆ BufferId() [1/2]

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

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

Retrieve the string identification of the buffer.

Returns
An identifier associated with the open buffer.

◆ bufferId() [1/2]

void FrameCPP::Common::FrameBufferInterface::bufferId ( const std::string &  Id)
inlineprotected

◆ bufferId() [2/2]

void FrameCPP::Common::FrameBufferInterface::bufferId ( const std::string &  Id)
protected

◆ filter() [1/4]

virtual void FrameCPP::Common::FrameBufferInterface::filter ( const char_type Start,
const char_type End 
)
pure virtual

◆ filter() [2/4]

virtual void FrameCPP::Common::FrameBufferInterface::filter ( const char_type Start,
const char_type End 
)
pure virtual

◆ filter() [3/4]

template<class DT >
void FrameCPP::Common::FrameBufferInterface::filter ( const DT Data)
inline

◆ filter() [4/4]

template<class DT >
void FrameCPP::Common::FrameBufferInterface::filter ( const DT Data)

◆ FilterAdd() [1/2]

void FrameCPP::Common::FrameBufferInterface::FilterAdd ( FrameCPP::Common::StreamFilter Filter)
virtual

Adds a filter to the stream.

Parameters
[in]FilterFilter function to add to the stream

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

◆ FilterAdd() [2/2]

virtual void FrameCPP::Common::FrameBufferInterface::FilterAdd ( FrameCPP::Common::StreamFilter Filter)
virtual

Adds a filter to the stream.

Parameters
[in]FilterFilter function to add to the stream

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

◆ FilterBuffer() [1/2]

void FrameCPP::Common::FrameBufferInterface::FilterBuffer ( const char *  Begin,
const char *  End 
)

◆ FilterBuffer() [2/2]

void FrameCPP::Common::FrameBufferInterface::FilterBuffer ( const char *  Begin,
const char *  End 
)

◆ FilterInternally() [1/2]

virtual bool FrameCPP::Common::FrameBufferInterface::FilterInternally ( ) const
pure virtual

◆ FilterInternally() [2/2]

virtual bool FrameCPP::Common::FrameBufferInterface::FilterInternally ( ) const
pure virtual

◆ FilterRemove() [1/2]

void FrameCPP::Common::FrameBufferInterface::FilterRemove ( FrameCPP::Common::StreamFilter Filter)
virtual

Removes a filter from the stream.

Parameters
[in]FilterFilter function to remove from the stream

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

◆ FilterRemove() [2/2]

virtual void FrameCPP::Common::FrameBufferInterface::FilterRemove ( FrameCPP::Common::StreamFilter Filter)
virtual

Removes a filter from the stream.

Parameters
[in]FilterFilter function to remove from the stream

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

Member Data Documentation

◆ m_auto_delete

bool FrameCPP::Common::FrameBufferInterface::m_auto_delete
private

◆ M_BUFFER_SIZE_DEFAULT

static const buffer_size_type FrameCPP::Common::FrameBufferInterface::M_BUFFER_SIZE_DEFAULT = 256 * 1024
static

The default size for buffered input and output.

◆ M_BUFFER_SIZE_SYSTEM

static const buffer_size_type FrameCPP::Common::FrameBufferInterface::M_BUFFER_SIZE_SYSTEM
static
Initial value:

◆ m_filters

filters_type FrameCPP::Common::FrameBufferInterface::m_filters
protected

Container holding all active filters.

◆ m_stream_id

std::string FrameCPP::Common::FrameBufferInterface::m_stream_id
private

The documentation for this class was generated from the following files:
FrameCPP::Common::FrameBufferInterface::buffer_size_type
INT_4U buffer_size_type
Definition: FrameBufferInterface.hh:163