Chemical Data Processing Library C++ API - Version 1.2.0
Public Member Functions | List of all members
CDPL::Pharm::PSDMolecularGraphOutputHandler Class Reference

A handler for the output of molecular graph dara in the PSD-format of the CDPL. More...

#include <PSDMolecularGraphOutputHandler.hpp>

+ Inheritance diagram for CDPL::Pharm::PSDMolecularGraphOutputHandler:

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< Chem::MolecularGraph >
virtual ~DataOutputHandler ()
 Virtual destructor. More...
 

Additional Inherited Members

- Public Types inherited from CDPL::Base::DataOutputHandler< Chem::MolecularGraph >
typedef DataWriter< Chem::MolecularGraphWriterType
 
typedef std::shared_ptr< DataOutputHandlerSharedPointer
 

Detailed Description

A handler for the output of molecular graph dara in the PSD-format of the CDPL.

Member Function Documentation

◆ getDataFormat()

const Base::DataFormat& CDPL::Pharm::PSDMolecularGraphOutputHandler::getDataFormat ( ) const
virtual

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< Chem::MolecularGraph >.

◆ createWriter() [1/2]

WriterType::SharedPointer CDPL::Pharm::PSDMolecularGraphOutputHandler::createWriter ( std::iostream &  ios) const
virtual

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< Chem::MolecularGraph >.

◆ createWriter() [2/2]

WriterType::SharedPointer CDPL::Pharm::PSDMolecularGraphOutputHandler::createWriter ( const std::string &  file_name,
std::ios_base::openmode  mode 
) const
virtual

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< Chem::MolecularGraph >.


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