An interface for writing data objects of a given type to an arbitrary data sink. More...

#include <DataWriter.hpp>

Inheritance diagram for CDPL::Base::DataWriter< T >:

Public Types
typedef std::shared_ptr< DataWriter >	SharedPointer
	A reference-counted smart pointer [SHPTR] for dynamically allocated `DataWriter` instances. More...

typedef T	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...

Public Member Functions
virtual DataWriter &	write (const DataType &obj)=0
	Writes the data object obj. More...

virtual void	close ()
	Writes format dependent data (if required) to mark the end of output. More...

virtual	operator const void * () const =0
	Returns a pointer whose value indicates the error state of the writer. More...

virtual bool	operator! () const =0
	Tells whether the writer is in a bad state. 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...

Protected Member Functions
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 T>
class CDPL::Base::DataWriter< T >

An interface for writing data objects of a given type to an arbitrary data sink.

DataWriter is the common interface of classes which write objects of a given type (specified by the template parameter T) to some data sink (e.g. a file) that expects the data to be encoded in a particular storage format.

From the DataWriter interface point of view, the data sink is continuous output stream in which the data objects are written as data records. For the output of a given data object the method write() has to be called with the object passed as an argument.

If the write() operation fails, the writer instance is set into an error state that can be queried by the operators operator const void*() and bool operator!(). Additionally, a DataWriter implementation may decide to throw an exception of type Base::IOError to report the error condition.

Template Parameters

T	The type of the written data objects.

Member Typedef Documentation

◆ SharedPointer

template<typename T >

typedef std::shared_ptr<DataWriter> CDPL::Base::DataWriter< T >::SharedPointer

A reference-counted smart pointer [SHPTR] for dynamically allocated DataWriter instances.

◆ DataType

template<typename T >

typedef T CDPL::Base::DataWriter< T >::DataType

The type of the written data objects.

Member Function Documentation

◆ write()

template<typename T >

virtual DataWriter& CDPL::Base::DataWriter< T >::write ( const DataType & obj )

pure virtual

Writes the data object obj.

Parameters

obj	The data object to write.

Returns: A reference to itself.

Exceptions

Base::IOError if an I/O error occurred.

Implemented in CDPL::Util::MultiFormatDataWriter< DataType >, CDPL::Vis::SVGReactionWriter, CDPL::Vis::PSReactionWriter, CDPL::Vis::PNGReactionWriter, CDPL::Vis::PDFReactionWriter, CDPL::Vis::SVGMolecularGraphWriter, CDPL::Vis::PSMolecularGraphWriter, CDPL::Vis::PNGMolecularGraphWriter, CDPL::Vis::PDFMolecularGraphWriter, CDPL::Pharm::PSDMolecularGraphWriter, CDPL::Biomol::PDBMolecularGraphWriter, and CDPL::Biomol::MMTFMolecularGraphWriter.

◆ close()

template<typename T >

virtual void CDPL::Base::DataWriter< T >::close ( )

inlinevirtual

Writes format dependent data (if required) to mark the end of output.

Exceptions

Base::IOError if an I/O error occurred.

Reimplemented in CDPL::Util::MultiFormatDataWriter< DataType >, CDPL::Util::FileDataWriter< WriterImpl, DataType >, CDPL::Util::CompressedDataWriter< WriterImpl, CompStream, DataType >, CDPL::Pharm::PSDMolecularGraphWriter, and CDPL::Pharm::PMLFeatureContainerWriter.

◆ operator const void *()

template<typename T >

virtual CDPL::Base::DataWriter< T >::operator const void * ( ) const

pure virtual

Returns a pointer whose value indicates the error state of the writer.

The operator allows to write expressions like:

if (writer) { ...

if (writer.write(...)) { ...

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

Note: The returned pointer is not meant to be dereferenced, it is just a state indicator.

See also: operator!()

◆ operator!()

template<typename T >

virtual bool CDPL::Base::DataWriter< T >::operator! ( ) const

pure virtual

Tells whether the writer is in a bad state.

The operator allows to write expressions like:

if (!writer) { ...

if (!writer.write(...)) { ...

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

See also: operator const void*()

◆ operator=()

template<typename T >

CDPL::Base::DataWriter< T > & CDPL::Base::DataWriter< T >::operator= ( const DataWriter< T > & writer )

protected

Assignment operator.

Parameters

writer The DataWriter instance to copy.

Returns: A reference to itself.

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

DataWriter.hpp

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

template<typename T> class CDPL::Base::DataWriter< T >

Member Typedef Documentation

◆ SharedPointer

◆ DataType

Member Function Documentation

◆ write()

◆ close()

◆ operator const void *()

◆ operator!()

◆ operator=()

template<typename T>
class CDPL::Base::DataWriter< T >