Buffer appropriate for caching frame data.
More...
#include <MemoryBuffer.hh>
Inherits FrameCPP::Common::FrameBufferInterface, std::stringbuf, FrameCPP::Common::FrameBufferInterface, std::stringbuf, FrameCPP::Common::FrameBufferInterface, and std::stringbuf.
|
| 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.
|
|
| 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 | 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...
|
|
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...
|
|
const std::string & | BufferId () const |
| Retrieve the string identification of the buffer. More...
|
|
|
static const buffer_size_type | M_BUFFER_SIZE_DEFAULT = 256 * 1024 |
| The default size for buffered input and output.
|
|
|
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.
|
|
typedef std::list< FrameCPP::Common::StreamFilter * > | filters_type |
| Type specifying the container holding the active filters.
|
|
|
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.
|
|
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.
|
|
|
filters_type | m_filters |
| Container holding all active filters.
|
|
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 );
IFrameStream ifs_mem( false, &imb );
Buffer appropriate for caching frame data.
Definition: MemoryBuffer.hh:72
◆ MemoryBufferT() [1/9]
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/9]
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/9]
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()
Destructor.
Be careful to release all the resources that were created for this object.
◆ MemoryBufferT() [4/9]
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/9]
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/9]
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() [7/9]
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() [8/9]
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() [9/9]
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.
◆ BufferId() [1/3]
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/3]
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() [3/3]
const std::string & FrameCPP::Common::FrameBufferInterface::BufferId |
( |
| ) |
const |
|
inherited |
Retrieve the string identification of the buffer.
- Returns
- An identifier associated with the open buffer.
◆ FilterAdd() [1/3]
void FrameCPP::Common::FrameBufferInterface::FilterAdd |
( |
FrameCPP::Common::StreamFilter * |
Filter | ) |
|
|
virtualinherited |
Adds a filter to the stream.
- Parameters
-
[in] | Filter | Filter function to add to the stream |
◆ FilterAdd() [2/3]
virtual void FrameCPP::Common::FrameBufferInterface::FilterAdd |
( |
FrameCPP::Common::StreamFilter * |
Filter | ) |
|
|
virtualinherited |
Adds a filter to the stream.
- Parameters
-
[in] | Filter | Filter function to add to the stream |
◆ FilterAdd() [3/3]
virtual void FrameCPP::Common::FrameBufferInterface::FilterAdd |
( |
FrameCPP::Common::StreamFilter * |
Filter | ) |
|
|
virtualinherited |
Adds a filter to the stream.
- Parameters
-
[in] | Filter | Filter function to add to the stream |
◆ 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.
◆ FilterRemove() [1/3]
void FrameCPP::Common::FrameBufferInterface::FilterRemove |
( |
FrameCPP::Common::StreamFilter * |
Filter | ) |
|
|
virtualinherited |
Removes a filter from the stream.
- Parameters
-
[in] | Filter | Filter function to remove from the stream |
◆ FilterRemove() [2/3]
virtual void FrameCPP::Common::FrameBufferInterface::FilterRemove |
( |
FrameCPP::Common::StreamFilter * |
Filter | ) |
|
|
virtualinherited |
Removes a filter from the stream.
- Parameters
-
[in] | Filter | Filter function to remove from the stream |
◆ FilterRemove() [3/3]
virtual void FrameCPP::Common::FrameBufferInterface::FilterRemove |
( |
FrameCPP::Common::StreamFilter * |
Filter | ) |
|
|
virtualinherited |
Removes a filter from the stream.
- Parameters
-
[in] | Filter | Filter function to remove from the stream |
The documentation for this class was generated from the following files:
- /build/ldas-tools-framecpp/debian/tmp/usr/include/framecpp/Common/MemoryBuffer.hh
- /build/ldas-tools-framecpp/obj-x86_64-linux-gnu/include/framecpp/Common/MemoryBuffer.hh
- /build/ldas-tools-framecpp/src/Common/MemoryBuffer.hh
- /build/ldas-tools-framecpp/src/Common/MemoryBuffer.cc