ldas-tools-framecpp
2.7.0
|
Buffer appropriate for caching frame data. More...
#include <MemoryBuffer.hh>
Inherits FrameCPP::Common::FrameBufferInterface, and stringbuf.
Classes | |
class | BufferSeeder |
Seed an input buffer for MemoryBufferT from buffers. More... | |
class | Seeder |
Seed an input buffer for MemoryBufferT. More... | |
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... | |
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. | |
bool | FilterInternally () const |
Returns true if filtering happens internally; false otherwise. | |
virtual void | FilterAdd (FrameCPP::Common::StreamFilter *Filter) |
Adds a filter to the stream. More... | |
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 void | FilterRemove (FrameCPP::Common::StreamFilter *Filter) |
Removes a filter from the stream. More... | |
const std::string & | BufferId () const |
Retrieve the string identification of the buffer. More... | |
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. | |
Protected Member Functions | |
virtual MemoryBufferT * | setbuf (char_type *S, std::streamsize N) |
Routine to register if the caller has specified a buffer. | |
virtual void | buffer () |
Initialization of the buffer. | |
virtual MemoryBufferT * | setbuf (char_type *S, std::streamsize N) |
Routine to register if the caller has specified a buffer. | |
virtual void | buffer () |
Initialization of the buffer. | |
Protected Attributes | |
filters_type | m_filters |
Container holding all active filters. | |
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.
BT | Internal storage type to hold the buffer contents. |
FrameCPP::Common::MemoryBufferT< BT >::MemoryBufferT | ( | std::ios::openmode | Mode, |
const BT & | Source, | ||
bool | ParentAutoDelete = true |
||
) |
Default constructor.
[in] | Seed | Method use for input buffers to move data into the new instance. |
[in] | ParentAutoDelete | True if dynamic memory associated with the temporary buffer should be release once this object goes out of scope. |
FrameCPP::Common::MemoryBufferT< BT >::MemoryBufferT | ( | std::ios::openmode | Mode, |
bool | ParentAutoDelete = true |
||
) |
Default constructor.
[in] | Mode | Specify the I/O mode of the buffer. |
[in] | ParentAutoDelete | True if dynamic memory associated with the temporary buffer should be release once this object goes out of scope. |
The default constructor will initialize all the parts used in the general case.
FrameCPP::Common::MemoryBufferT< BT >::MemoryBufferT | ( | Seeder & | Seed, |
bool | ParentAutoDelete = true |
||
) |
Default constructor.
[in] | Seed | Method use for input buffers to move data into the new instance. |
[in] | ParentAutoDelete | True if dynamic memory associated with the temporary buffer should be release once this object goes out of scope. |
The default constructor will initialize all the parts used in the general case.
|
virtual |
Destructor.
Be careful to release all the resources that were created for this object.
FrameCPP::Common::MemoryBufferT< BT >::MemoryBufferT | ( | std::ios::openmode | Mode, |
const BT & | Source, | ||
bool | ParentAutoDelete = true |
||
) |
Default constructor.
[in] | Seed | Method use for input buffers to move data into the new instance. |
[in] | ParentAutoDelete | True if dynamic memory associated with the temporary buffer should be release once this object goes out of scope. |
FrameCPP::Common::MemoryBufferT< BT >::MemoryBufferT | ( | std::ios::openmode | Mode, |
bool | ParentAutoDelete = true |
||
) |
Default constructor.
[in] | Mode | Specify the I/O mode of the buffer. |
[in] | ParentAutoDelete | True if dynamic memory associated with the temporary buffer should be release once this object goes out of scope. |
FrameCPP::Common::MemoryBufferT< BT >::MemoryBufferT | ( | Seeder & | Seed, |
bool | ParentAutoDelete = true |
||
) |
Default constructor.
[in] | Seed | Method use for input buffers to move data into the new instance. |
[in] | ParentAutoDelete | True if dynamic memory associated with the temporary buffer should be release once this object goes out of scope. |
|
inlineinherited |
Retrieve the string identification of the buffer.
|
inherited |
Retrieve the string identification of the buffer.
|
virtualinherited |
Adds a filter to the stream.
[in] | Filter | Filter function to add to the stream |
|
virtualinherited |
Adds a filter to the stream.
[in] | Filter | Filter function to add to the stream |
bool FrameCPP::Common::MemoryBufferT< BT >::FilterInternally |
Returns true if filtering happens internally; false otherwise.
Filtering currently is not optimized at the this layer so this method will always return false.
|
virtualinherited |
Removes a filter from the stream.
[in] | Filter | Filter function to remove from the stream |
|
virtualinherited |
Removes a filter from the stream.
[in] | Filter | Filter function to remove from the stream |