Buffer appropriate for caching frame data.
More...
#include <MemoryBuffer.hh>
|
| MemoryBufferT (std::ios::openmode Mode, const BT &Source, bool ParentAutoDelete=true) |
| Default constructor.
|
|
| MemoryBufferT (std::ios::openmode Mode, bool ParentAutoDelete=true) |
| Default constructor.
|
|
| MemoryBufferT (Seeder &Seed, bool ParentAutoDelete=true) |
| Default constructor.
|
|
virtual | ~MemoryBufferT () |
| Destructor.
|
|
bool | FilterInternally () const |
| Returns true if filtering happens internally; false otherwise.
|
|
std::string | str () |
|
void | str (const std::string &S) |
|
| MemoryBufferT (std::ios::openmode Mode, const BT &Source, bool ParentAutoDelete=true) |
| Default constructor.
|
|
| MemoryBufferT (std::ios::openmode Mode, bool ParentAutoDelete=true) |
| Default constructor.
|
|
| MemoryBufferT (Seeder &Seed, bool ParentAutoDelete=true) |
| Default constructor.
|
|
virtual | ~MemoryBufferT () |
| Destructor.
|
|
bool | FilterInternally () const |
| Returns true if filtering happens internally; false otherwise.
|
|
std::string | str () |
|
void | str (const std::string &S) |
|
bool | AutoDelete () const |
|
void | AutoDelete (bool Value) |
|
bool | AutoDelete () const |
|
void | AutoDelete (bool Value) |
|
virtual void | FilterAdd (FrameCPP::Common::StreamFilter *Filter) |
| Adds a filter to the stream.
|
|
virtual void | FilterAdd (FrameCPP::Common::StreamFilter *Filter) |
| Adds a filter to the stream.
|
|
virtual void | FilterRemove (FrameCPP::Common::StreamFilter *Filter) |
| Removes a filter from the stream.
|
|
virtual void | FilterRemove (FrameCPP::Common::StreamFilter *Filter) |
| Removes a filter from the stream.
|
|
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) |
|
void | FilterBuffer (const char *Begin, const char *End) |
|
const std::string & | BufferId () const |
| Retrieve the string identification of the buffer.
|
|
const std::string & | BufferId () const |
| Retrieve the string identification of the buffer.
|
|
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
-
BT | Internal storage type to hold the buffer contents. |
imb.
str( frame_file_data );
Definition FrameStream.hh:224
Buffer appropriate for caching frame data.
Definition MemoryBuffer.hh:72
std::string str()
Definition MemoryBuffer.cc:126
◆ buffer_size_type [1/2]
◆ buffer_size_type [2/2]
◆ buffer_type [1/2]
template<typename BT = std::stringbuf>
◆ buffer_type [2/2]
template<typename BT = std::stringbuf>
◆ char_type [1/2]
template<typename BT = std::stringbuf>
◆ char_type [2/2]
template<typename BT = std::stringbuf>
◆ filters_type [1/2]
Type specifying the container holding the active filters.
◆ filters_type [2/2]
Type specifying the container holding the active filters.
◆ MemoryBufferT() [1/6]
template<typename BT = std::stringbuf>
Default constructor.
- Parameters
-
[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. |
- Returns
- New class instance.
◆ MemoryBufferT() [2/6]
Default constructor.
- Parameters
-
[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. |
- Returns
- New class instance.
The default constructor will initialize all the parts used in the general case.
◆ MemoryBufferT() [3/6]
Default constructor.
- Parameters
-
[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. |
- Returns
- New class instance.
The default constructor will initialize all the parts used in the general case.
◆ ~MemoryBufferT() [1/2]
Destructor.
Be careful to release all the resources that were created for this object.
◆ MemoryBufferT() [4/6]
template<typename BT = std::stringbuf>
Default constructor.
- Parameters
-
[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. |
- Returns
- New class instance.
◆ MemoryBufferT() [5/6]
template<typename BT = std::stringbuf>
Default constructor.
- Parameters
-
[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. |
- Returns
- New class instance.
◆ MemoryBufferT() [6/6]
template<typename BT = std::stringbuf>
Default constructor.
- Parameters
-
[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. |
- Returns
- New class instance.
◆ ~MemoryBufferT() [2/2]
template<typename BT = std::stringbuf>
◆ AutoDelete() [1/4]
bool FrameCPP::Common::FrameBufferInterface::AutoDelete |
( |
| ) |
const |
|
inlineinherited |
◆ AutoDelete() [2/4]
bool FrameCPP::Common::FrameBufferInterface::AutoDelete |
( |
| ) |
const |
|
inherited |
◆ AutoDelete() [3/4]
void FrameCPP::Common::FrameBufferInterface::AutoDelete |
( |
bool | Value | ) |
|
|
inlineinherited |
◆ AutoDelete() [4/4]
void FrameCPP::Common::FrameBufferInterface::AutoDelete |
( |
bool | Value | ) |
|
|
inherited |
◆ buffer() [1/2]
◆ buffer() [2/2]
template<typename BT = std::stringbuf>
◆ 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.
◆ bufferId() [1/2]
void FrameCPP::Common::FrameBufferInterface::bufferId |
( |
const std::string & | Id | ) |
|
|
inlineprotectedinherited |
◆ bufferId() [2/2]
void FrameCPP::Common::FrameBufferInterface::bufferId |
( |
const std::string & | Id | ) |
|
|
protectedinherited |
◆ filter() [1/4]
Perform filtering operations on the stream.
◆ filter() [2/4]
template<typename BT = std::stringbuf>
Perform filtering operations on the stream.
◆ filter() [3/4]
virtual void FrameCPP::Common::FrameBufferInterface::filter |
( |
const char_type * | Start, |
|
|
const char_type * | End ) |
|
pure virtualinherited |
◆ filter() [4/4]
void FrameCPP::Common::FrameBufferInterface::filter |
( |
const DT & | Data | ) |
|
|
inlineinherited |
◆ FilterAdd() [1/2]
◆ FilterAdd() [2/2]
◆ FilterBuffer() [1/2]
void FrameCPP::Common::FrameBufferInterface::FilterBuffer |
( |
const char * | Begin, |
|
|
const char * | End ) |
|
inherited |
◆ FilterBuffer() [2/2]
void FrameCPP::Common::FrameBufferInterface::FilterBuffer |
( |
const char * | Begin, |
|
|
const char * | End ) |
|
inherited |
◆ FilterInternally() [1/2]
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.
◆ FilterInternally() [2/2]
template<typename BT = std::stringbuf>
◆ FilterRemove() [1/2]
◆ FilterRemove() [2/2]
◆ setbuf() [1/2]
Routine to register if the caller has specified a buffer.
◆ setbuf() [2/2]
template<typename BT = std::stringbuf>
Routine to register if the caller has specified a buffer.
◆ str() [1/4]
◆ str() [2/4]
template<typename BT = std::stringbuf>
◆ str() [3/4]
◆ str() [4/4]
template<typename BT = std::stringbuf>
◆ IStream
template<typename BT = std::stringbuf>
◆ OStream
template<typename BT = std::stringbuf>
◆ buffer_cache
template<typename BT = std::stringbuf>
◆ buffer_user_supplied
template<typename BT = std::stringbuf>
State of user supplied buffer.
◆ m_auto_delete
bool FrameCPP::Common::FrameBufferInterface::m_auto_delete |
|
privateinherited |
◆ M_BUFFER_SIZE_DEFAULT
static const 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
static const buffer_size_type FrameCPP::Common::FrameBufferInterface::M_BUFFER_SIZE_SYSTEM |
|
staticinherited |
◆ m_filters
filters_type FrameCPP::Common::FrameBufferInterface::m_filters |
|
protectedinherited |
◆ m_stream_id
std::string FrameCPP::Common::FrameBufferInterface::m_stream_id |
|
privateinherited |
The documentation for this class was generated from the following files: