Convenience wrapper that combines a Util::CompressionOStream of type CompStream with a stream-based writer WriterImpl so that data written via this Base::DataWriter is automatically compressed on the fly. More...

#include <CompressedDataWriter.hpp>

Inheritance diagram for CDPL::Util::CompressedDataWriter< WriterImpl, CompStream, DataType >:

Public Member Functions
	CompressedDataWriter (std::ostream &os)
	Constructs the `CompressedDataWriter` instance that compresses output written to os via CompStream and forwards the resulting stream to a freshly constructed WriterImpl. More...

CompressedDataWriter &	write (const DataType &obj)
	Writes obj via the wrapped writer. More...

void	close ()
	Closes the wrapped writer and finalizes the compression stream. More...

	operator const void * () const
	Tells whether the writer is in a good (writable) state. More...

bool	operator! () const
	Tells whether the writer is in a bad (non-writable) state. More...

Public Member Functions inherited from CDPL::Base::DataWriter< typename WriterImpl::DataType >
virtual DataWriter &	write (const DataType &obj)=0
	Writes the data object obj. More...

Public Member Functions inherited from CDPL::Base::DataIOBase
std::size_t	registerIOCallback (const IOCallbackFunction &func)
	Registers an I/O callback target function. More...

void	unregisterIOCallback (std::size_t id)
	Unregisters the I/O callback function specified by id. More...

void	invokeIOCallbacks (double progress) const
	Invokes all registered I/O callback functions with the argument `*this`. More...

void	clearIOCallbacks ()
	Clears all registered I/O callback functions. More...

Public Member Functions inherited from CDPL::Base::ControlParameterContainer
std::size_t	getNumParameters () const
	Returns the number of container entries. More...

template<typename T >
void	setParameter (const LookupKey &key, T &&val)
	Sets the value of the control-parameter specified by key to val. More...

const Any &	getParameter (const LookupKey &key, bool throw_=false, bool local=false) const
	Returns the value of the control-parameter specified by key. More...

template<typename T >
const T &	getParameter (const LookupKey &key, bool local=false) const
	Returns the value of the control-parameter specified by key as a `const` reference to an object of type T. More...

template<typename T >
const T &	getParameterOrDefault (const LookupKey &key, const T &def_val, bool local=false) const
	Returns the value of the control-parameter specified by key as a `const` reference to an object of type T, or the default value def_val if a stored value does not exist. More...

bool	removeParameter (const LookupKey &key)
	Removes the entry for the control-parameter specified by key. More...

void	clearParameters ()
	Erases all container entries. More...

bool	isParameterSet (const LookupKey &key, bool local=false) const
	Tells whether or not a value has been assigned to the control-parameter specified by key. More...

void	addParameters (const ControlParameterContainer &cntnr)
	Adds the control-parameter value entries in the `ControlParameterContainer` instance cntnr. More...

void	copyParameters (const ControlParameterContainer &cntnr)
	Replaces the current set of properties by a copy of the entries in cntnr. More...

ConstParameterIterator	getParametersBegin () const
	Returns a constant iterator pointing to the beginning of the entries. More...

ConstParameterIterator	getParametersEnd () const
	Returns a constant iterator pointing to the end of the entries. More...

ConstParameterIterator	begin () const
	Returns a constant iterator pointing to the beginning of the entries. More...

ConstParameterIterator	end () const
	Returns a constant iterator pointing to the end of the entries. More...

void	setParent (const ControlParameterContainer *cntnr)
	Sets or removes the parent control-parameter container used to resolve requests for missing entries. More...

const ControlParameterContainer *	getParent () const
	Returns a pointer to the parent control-parameter container. More...

std::size_t	registerParameterChangedCallback (const ParameterChangedCallbackFunction &func)
	Registers a callback target function that gets invoked when the value of a control-parameter has changed. More...

void	unregisterParameterChangedCallback (std::size_t id)
	Unregisters the callback specified by id. More...

std::size_t	registerParameterRemovedCallback (const ParameterRemovedCallbackFunction &func)
	Registers a callback target function that gets invoked when a control-parameter entry has been removed. More...

void	unregisterParameterRemovedCallback (std::size_t id)
	Unregisters the callback specified by id. More...

std::size_t	registerParentChangedCallback (const ParentChangedCallbackFunction &func)
	Registers a callback target function that gets invoked when the parent container has been changed or was detached. More...

void	unregisterParentChangedCallback (std::size_t id)
	Unregisters the callback specified by id. More...

const ControlParameterContainer &	getParameters () const
	Returns a `const` reference to itself. More...

Additional Inherited Members
Public Types inherited from CDPL::Base::DataWriter< typename WriterImpl::DataType >
typedef std::shared_ptr< DataWriter >	SharedPointer
	A reference-counted smart pointer [SHPTR] for dynamically allocated `DataWriter` instances. More...

typedef typename WriterImpl::DataType	DataType
	The type of the written data objects. More...

Public Types inherited from CDPL::Base::DataIOBase
typedef std::function< void(const DataIOBase &, double)>	IOCallbackFunction
	A functor class used to wrap I/O callback target functions. More...

Public Types inherited from CDPL::Base::ControlParameterContainer
typedef ParameterMap::value_type	ParameterEntry
	A Base::LookupKey / Base::Any pair used to store the control-parameter values and associated keys. More...

typedef ParameterMap::const_iterator	ConstParameterIterator
	A constant iterator used to iterate over the control-parameter entries. More...

typedef std::function< void(const LookupKey &, const Any &)>	ParameterChangedCallbackFunction
	A functor class that wraps callback target functions which get invoked when the value of a control-parameter has changed. More...

typedef std::function< void(const LookupKey &)>	ParameterRemovedCallbackFunction
	A functor class that wraps callback target functions which get invoked when a control-parameter entry has been removed. More...

typedef std::function< void()>	ParentChangedCallbackFunction
	A functor class that wraps callback target functions which get invoked when the parent container has been changed or was detached. More...

Protected Member Functions inherited from CDPL::Base::DataWriter< typename WriterImpl::DataType >
DataWriter &	operator= (const DataWriter &writer)
	Assignment operator. More...

Protected Member Functions inherited from CDPL::Base::DataIOBase
	DataIOBase ()
	Default constructor. More...

	DataIOBase (const DataIOBase &io_base)
	Copy constructor. More...

	~DataIOBase ()
	Destructor. More...

DataIOBase &	operator= (const DataIOBase &io_base)
	Assignment operator. More...

Protected Member Functions inherited from CDPL::Base::ControlParameterContainer
	ControlParameterContainer ()
	Constructs an empty `ControlParameterContainer` instance. More...

	ControlParameterContainer (const ControlParameterContainer &cntnr)
	Constructs a copy of the `ControlParameterContainer` instance cntnr. More...

virtual	~ControlParameterContainer ()
	Destructor. More...

ControlParameterContainer &	operator= (const ControlParameterContainer &cntnr)
	Assignment operator. More...

Detailed Description

template<typename WriterImpl, typename CompStream, typename DataType = typename WriterImpl::DataType>
class CDPL::Util::CompressedDataWriter< WriterImpl, CompStream, DataType >

Convenience wrapper that combines a Util::CompressionOStream of type CompStream with a stream-based writer WriterImpl so that data written via this Base::DataWriter is automatically compressed on the fly.

Template Parameters

WriterImpl	The underlying stream-based writer implementation type.
CompStream	The Util::CompressionOStream specialization to use (e.g. Util::GZipOStream).
DataType	The data type written by WriterImpl.

Constructor & Destructor Documentation

◆ CompressedDataWriter()

template<typename WriterImpl , typename DecompStream , typename DataType >

CDPL::Util::CompressedDataWriter< WriterImpl, DecompStream, DataType >::CompressedDataWriter ( std::ostream & os )

Constructs the CompressedDataWriter instance that compresses output written to os via CompStream and forwards the resulting stream to a freshly constructed WriterImpl.

Parameters

os	The output stream that will receive the compressed data.

Member Function Documentation

◆ write()

template<typename WriterImpl , typename DecompStream , typename DataType >

CDPL::Util::CompressedDataWriter< WriterImpl, DecompStream, DataType > & CDPL::Util::CompressedDataWriter< WriterImpl, DecompStream, DataType >::write ( const DataType & obj )

Writes obj via the wrapped writer.

Parameters

obj	The object to write.

Returns: A reference to itself.

◆ close()

template<typename WriterImpl , typename DecompStream , typename DataType >

void CDPL::Util::CompressedDataWriter< WriterImpl, DecompStream, DataType >::close

virtual

Closes the wrapped writer and finalizes the compression stream.

Reimplemented from CDPL::Base::DataWriter< typename WriterImpl::DataType >.

◆ operator const void *()

template<typename WriterImpl , typename DecompStream , typename DataType >

CDPL::Util::CompressedDataWriter< WriterImpl, DecompStream, DataType >::operator const void *

virtual

Tells whether the writer is in a good (writable) state.

Returns: A non-nullptr pointer if the writer is in a good state, and nullptr otherwise.

Implements CDPL::Base::DataWriter< typename WriterImpl::DataType >.

◆ operator!()

template<typename WriterImpl , typename DecompStream , typename DataType >

bool CDPL::Util::CompressedDataWriter< WriterImpl, DecompStream, DataType >::operator!

virtual

Tells whether the writer is in a bad (non-writable) state.

Returns: true if the writer is in a bad state, and false otherwise.

Implements CDPL::Base::DataWriter< typename WriterImpl::DataType >.

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

CompressedDataWriter.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename WriterImpl, typename CompStream, typename DataType = typename WriterImpl::DataType> class CDPL::Util::CompressedDataWriter< WriterImpl, CompStream, DataType >

Constructor & Destructor Documentation

◆ CompressedDataWriter()

Member Function Documentation

◆ write()

◆ close()

◆ operator const void *()

◆ operator!()

template<typename WriterImpl, typename CompStream, typename DataType = typename WriterImpl::DataType>
class CDPL::Util::CompressedDataWriter< WriterImpl, CompStream, DataType >