ldas-tools-framecpp  2.6.2
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
FrameCPP::Common::MemoryBufferT< BT > Class Template Referenceabstract

Buffer appropriate for caching frame data. More...

#include <MemoryBuffer.hh>

Inheritance diagram for FrameCPP::Common::MemoryBufferT< BT >:
FrameCPP::Common::FrameBufferInterface FrameCPP::Common::DynamicMemoryBufferT< BT >

Classes

class  BufferSeeder
 Seed an input buffer for MemoryBufferT from buffers. More...
 
class  Seeder
 Seed an input buffer for MemoryBufferT. More...
 

Public Types

typedef BT buffer_type
 
typedef buffer_type::char_type char_type
 
typedef INT_4U buffer_size_type
 

Public Member Functions

 MemoryBufferT (std::ios::openmode Mode, const BT &Source, bool ParentAutoDelete=true)
 Default constructor. More...
 
 MemoryBufferT (std::ios::openmode Mode, bool ParentAutoDelete=true)
 Default constructor. More...
 
 MemoryBufferT (Seeder &Seed, bool ParentAutoDelete=true)
 Default constructor. More...
 
virtual ~MemoryBufferT ()
 Destructor. More...
 
bool FilterInternally () const
 Returns true if filtering happens internally; false otherwise. More...
 
std::string str ()
 
void str (const std::string &S)
 
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...
 
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 = ~buffer_size_type( 0 )
 

Protected Types

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

Protected Member Functions

virtual MemoryBufferTsetbuf (char_type *S, std::streamsize N)
 Routine to register if the caller has specified a buffer. More...
 
virtual void buffer ()
 Initialization of the buffer. More...
 
void bufferId (const std::string &Id)
 

Protected Attributes

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

Friends

class IStream
 
class OStream
 

Detailed Description

template<typename BT = std::stringbuf>
class FrameCPP::Common::MemoryBufferT< BT >

Buffer appropriate for caching frame data.

If the buffer is for input, then the buffer needs to be initialized with the contents. The initialization needs to be done as via the call to the str( ) method before the buffer is associated with an IFrameStream object.

Template Parameters
BTInternal storage type to hold the buffer contents.
MemoryBuffer imb( std::ios:in);
imb.str( frame_file_data );
IFrameStream ifs_mem( false, &imb );

Member Typedef Documentation

◆ buffer_size_type

◆ buffer_type

template<typename BT = std::stringbuf>
typedef BT FrameCPP::Common::MemoryBufferT< BT >::buffer_type

◆ char_type

template<typename BT = std::stringbuf>
typedef buffer_type::char_type FrameCPP::Common::MemoryBufferT< BT >::char_type

◆ filters_type

Type specifying the container holding the active filters.

Constructor & Destructor Documentation

◆ MemoryBufferT() [1/3]

template<typename BT = std::stringbuf>
FrameCPP::Common::MemoryBufferT< BT >::MemoryBufferT ( std::ios::openmode  Mode,
const BT &  Source,
bool  ParentAutoDelete = true 
)

Default constructor.

Parameters
[in]SeedMethod use for input buffers to move data into the new instance.
[in]ParentAutoDeleteTrue if dynamic memory associated with the temporary buffer should be release once this object goes out of scope.
Returns
New class instance.

◆ MemoryBufferT() [2/3]

template<typename BT >
FrameCPP::Common::MemoryBufferT< BT >::MemoryBufferT ( std::ios::openmode  Mode,
bool  ParentAutoDelete = true 
)

Default constructor.

Parameters
[in]ModeSpecify the I/O mode of the buffer.
[in]ParentAutoDeleteTrue if dynamic memory associated with the temporary buffer should be release once this object goes out of scope.
Returns
New class instance.

The default constructor will initialize all the parts used in the general case.

◆ MemoryBufferT() [3/3]

template<typename BT >
FrameCPP::Common::MemoryBufferT< BT >::MemoryBufferT ( Seeder Seed,
bool  ParentAutoDelete = true 
)

Default constructor.

Parameters
[in]SeedMethod use for input buffers to move data into the new instance.
[in]ParentAutoDeleteTrue if dynamic memory associated with the temporary buffer should be release once this object goes out of scope.
Returns
New class instance.

The default constructor will initialize all the parts used in the general case.

◆ ~MemoryBufferT()

template<typename BT >
FrameCPP::Common::MemoryBufferT< BT >::~MemoryBufferT ( )
virtual

Destructor.

Be careful to release all the resources that were created for this object.

Member Function Documentation

◆ AutoDelete() [1/2]

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

◆ AutoDelete() [2/2]

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

◆ buffer()

template<typename BT >
void FrameCPP::Common::MemoryBufferT< BT >::buffer ( )
protectedvirtual

Initialization of the buffer.

Implements FrameCPP::Common::FrameBufferInterface.

◆ BufferId()

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()

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

◆ filter() [1/2]

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

◆ filter() [2/2]

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

◆ FilterAdd()

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

Adds a filter to the stream.

Parameters
[in]FilterFilter function to add to the stream

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

◆ FilterBuffer()

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

◆ FilterInternally()

template<typename BT >
bool FrameCPP::Common::MemoryBufferT< BT >::FilterInternally ( ) const
virtual

Returns true if filtering happens internally; false otherwise.

Filtering currently is not optimized at the this layer so this method will always return false.

Implements FrameCPP::Common::FrameBufferInterface.

◆ FilterRemove()

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

Removes a filter from the stream.

Parameters
[in]FilterFilter function to remove from the stream

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

◆ setbuf()

template<typename BT >
MemoryBufferT< BT > * FrameCPP::Common::MemoryBufferT< BT >::setbuf ( char_type S,
std::streamsize  N 
)
protectedvirtual

Routine to register if the caller has specified a buffer.

◆ str() [1/2]

template<typename BT >
std::string FrameCPP::Common::MemoryBufferT< BT >::str ( )

◆ str() [2/2]

template<typename BT >
void FrameCPP::Common::MemoryBufferT< BT >::str ( const std::string &  S)

Friends And Related Function Documentation

◆ IStream

template<typename BT = std::stringbuf>
friend class IStream
friend

◆ OStream

template<typename BT = std::stringbuf>
friend class OStream
friend

Member Data Documentation

◆ M_BUFFER_SIZE_DEFAULT

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

The default size for buffered input and output.

◆ M_BUFFER_SIZE_SYSTEM

const buffer_size_type FrameCPP::Common::FrameBufferInterface::M_BUFFER_SIZE_SYSTEM = ~buffer_size_type( 0 )
staticinherited

◆ m_filters

filters_type FrameCPP::Common::FrameBufferInterface::m_filters
protectedinherited

Container holding all active filters.


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