Chemical Data Processing Library C++ API - Version 1.2.0
Public Types | Public Member Functions | List of all members
CDPL::Util::DefaultDataOutputHandler< WriterImpl, FORMAT, DataType > Class Template Reference

DefaultDataOutputHandler. More...

#include <DefaultDataOutputHandler.hpp>

+ Inheritance diagram for CDPL::Util::DefaultDataOutputHandler< WriterImpl, FORMAT, DataType >:

Public Types

typedef Base::DataOutputHandler< DataType >::WriterType WriterType
 
- Public Types inherited from CDPL::Base::DataOutputHandler< typename WriterImpl::DataType >
typedef DataWriter< typename WriterImpl::DataType > WriterType
 
typedef std::shared_ptr< DataOutputHandlerSharedPointer
 

Public Member Functions

const Base::DataFormatgetDataFormat () const
 Returns a Base::DataFormat object that provides information about the handled output data format. More...
 
WriterType::SharedPointer createWriter (std::iostream &ios) const
 Creates a Base::DataWriter instance that will write the data to the I/O stream ios. More...
 
WriterType::SharedPointer createWriter (const std::string &file_name, std::ios_base::openmode mode) const
 Creates a Base::DataWriter instance that will write the data to the file specified by file_name. More...
 
- Public Member Functions inherited from CDPL::Base::DataOutputHandler< typename WriterImpl::DataType >
virtual ~DataOutputHandler ()
 Virtual destructor. More...
 

Detailed Description

template<typename WriterImpl, const Base::DataFormat & FORMAT, typename DataType = typename WriterImpl::DataType>
class CDPL::Util::DefaultDataOutputHandler< WriterImpl, FORMAT, DataType >

DefaultDataOutputHandler.

Member Typedef Documentation

◆ WriterType

template<typename WriterImpl , const Base::DataFormat & FORMAT, typename DataType = typename WriterImpl::DataType>
typedef Base::DataOutputHandler<DataType>::WriterType CDPL::Util::DefaultDataOutputHandler< WriterImpl, FORMAT, DataType >::WriterType

Member Function Documentation

◆ getDataFormat()

template<typename WriterImpl , const Base::DataFormat & FORMAT, typename DataType = typename WriterImpl::DataType>
const Base::DataFormat& CDPL::Util::DefaultDataOutputHandler< WriterImpl, FORMAT, DataType >::getDataFormat ( ) const
inlinevirtual

Returns a Base::DataFormat object that provides information about the handled output data format.

Returns
A Base::DataFormat object that provides information about the handled data format.

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

◆ createWriter() [1/2]

template<typename WriterImpl , const Base::DataFormat & FORMAT, typename DataType = typename WriterImpl::DataType>
WriterType::SharedPointer CDPL::Util::DefaultDataOutputHandler< WriterImpl, FORMAT, DataType >::createWriter ( std::iostream &  ios) const
inlinevirtual

Creates a Base::DataWriter instance that will write the data to the I/O stream ios.

Parameters
iosThe I/O stream to write to.
Returns
A shared pointer to the created Base::DataWriter instance.

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

◆ createWriter() [2/2]

template<typename WriterImpl , const Base::DataFormat & FORMAT, typename DataType = typename WriterImpl::DataType>
WriterType::SharedPointer CDPL::Util::DefaultDataOutputHandler< WriterImpl, FORMAT, DataType >::createWriter ( const std::string &  file_name,
std::ios_base::openmode  mode 
) const
inlinevirtual

Creates a Base::DataWriter instance that will write the data to the file specified by file_name.

Parameters
file_nameThe full path of the file to write to.
modeFlags specifying the file open-mode.
Returns
A shared pointer to the created Base::DataWriter instance.

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


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