ldas-tools-framecpp
2.6.2
|
Buffer appropriate for caching frame data. More...
#include <FrameBuffer.hh>
Public Types | |
typedef FrameBuffer< BT > | buffer_type |
Type of self. More... | |
typedef BT | element_type |
typedef BT::char_type | char_type |
type representing a character in the stream. More... | |
typedef BT::int_type | int_type |
integer type More... | |
typedef BT::pos_type | pos_type |
type appropriate for holding stream position information More... | |
typedef BT::off_type | off_type |
type apprpriate to hold stream offset request More... | |
typedef INT_4U | buffer_size_type |
Public Member Functions | |
FrameBuffer (std::ios::openmode Mode, bool ParentAutoDelete=true) | |
constructor 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... | |
bool | FilterInternally () const |
Returns true if filtering happens internally; false otherwise. More... | |
FrameBuffer< BT > * | close () |
FrameBuffer< BT > * | open (const std::string &Filename, std::ios::openmode Mode) |
void | UseMemoryMappedIO (bool Value) |
template<> | |
FrameBuffer< std::filebuf > * | close () |
template<> | |
FrameBuffer< std::filebuf > * | open (const std::string &Filename, std::ios::openmode Mode) |
template<> | |
void | UseMemoryMappedIO (bool Value) |
template<> | |
void | UseMemoryMappedIO (bool Value) |
template<> | |
FrameBuffer< LDASTools::AL::filebuf > * | close () |
template<> | |
FrameBuffer< LDASTools::AL::filebuf > * | open (const std::string &Filename, std::ios::openmode Mode) |
template<> | |
bool | FilterInternally () const |
bool | AutoDelete () const |
void | AutoDelete (bool Value) |
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 FrameBuffer< BT > * | setbuf (char_type *S, std::streamsize N) |
Routine to register if the caller has specified a buffer. More... | |
virtual void | buffer () |
Establish buffering. More... | |
void | bufferId (const std::string &Id) |
Protected Attributes | |
filters_type | m_filters |
Container holding all active filters. More... | |
Friends | |
class | IStream |
class | OStream |
Buffer appropriate for caching frame data.
|
inherited |
typedef FrameBuffer< BT > FrameCPP::Common::FrameBuffer< BT >::buffer_type |
Type of self.
typedef BT::char_type FrameCPP::Common::FrameBuffer< BT >::char_type |
type representing a character in the stream.
typedef BT FrameCPP::Common::FrameBuffer< BT >::element_type |
|
protectedinherited |
Type specifying the container holding the active filters.
typedef BT::int_type FrameCPP::Common::FrameBuffer< BT >::int_type |
integer type
typedef BT::off_type FrameCPP::Common::FrameBuffer< BT >::off_type |
type apprpriate to hold stream offset request
typedef BT::pos_type FrameCPP::Common::FrameBuffer< BT >::pos_type |
type appropriate for holding stream position information
FrameCPP::Common::FrameBuffer< BT >::FrameBuffer | ( | std::ios::openmode | Mode, |
bool | ParentAutoDelete = true |
||
) |
constructor
|
inlineinherited |
|
inlineinherited |
|
protectedvirtual |
Establish buffering.
Implements FrameCPP::Common::FrameBufferInterface.
|
inlineinherited |
Retrieve the string identification of the buffer.
|
inlineprotectedinherited |
FrameBuffer< std::filebuf > * FrameCPP::Common::FrameBuffer< std::filebuf >::close | ( | ) |
FrameBuffer<BT>* FrameCPP::Common::FrameBuffer< BT >::close | ( | ) |
FrameBuffer< LDASTools::AL::filebuf > * FrameCPP::Common::FrameBuffer< LDASTools::AL::filebuf >::close | ( | ) |
|
inlineinherited |
|
pure virtualinherited |
|
virtual |
Adds a filter to the stream.
[in] | Filter | Filter function to add to the stream |
Reimplemented from FrameCPP::Common::FrameBufferInterface.
|
inherited |
|
virtual |
Implements FrameCPP::Common::FrameBufferInterface.
|
virtual |
Returns true if filtering happens internally; false otherwise.
Implements FrameCPP::Common::FrameBufferInterface.
|
virtual |
Removes a filter from the stream.
[in] | Filter | Filter function to remove from the stream |
Reimplemented from FrameCPP::Common::FrameBufferInterface.
FrameBuffer< std::filebuf > * FrameCPP::Common::FrameBuffer< std::filebuf >::open | ( | const std::string & | Filename, |
std::ios::openmode | Mode | ||
) |
FrameBuffer<BT>* FrameCPP::Common::FrameBuffer< BT >::open | ( | const std::string & | Filename, |
std::ios::openmode | Mode | ||
) |
FrameBuffer< LDASTools::AL::filebuf > * FrameCPP::Common::FrameBuffer< LDASTools::AL::filebuf >::open | ( | const std::string & | Filename, |
std::ios::openmode | Mode | ||
) |
|
protectedvirtual |
Routine to register if the caller has specified a buffer.
void FrameCPP::Common::FrameBuffer< std::filebuf >::UseMemoryMappedIO | ( | bool | Value | ) |
void FrameCPP::Common::FrameBuffer< LDASTools::AL::filebuf >::UseMemoryMappedIO | ( | bool | Value | ) |
void FrameCPP::Common::FrameBuffer< BT >::UseMemoryMappedIO | ( | bool | Value | ) |
|
friend |
|
friend |
|
staticinherited |
The default size for buffered input and output.
|
staticinherited |
|
protectedinherited |
Container holding all active filters.