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

Handler for the output of molecular graph data in the CDPL PSD-format. More...

#include <PSDMolecularGraphOutputHandler.hpp>

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

Public Member Functions

const Base::DataFormatgetDataFormat () const
 Returns the data format advertised by this handler (Pharm::DataFormat::PSD). More...
 
WriterType::SharedPointer createWriter (std::ostream &os) const
 Creates a Pharm::PSDMolecularGraphWriter that writes to the output stream os. More...
 
WriterType::SharedPointer createWriter (const std::string &file_name, std::ios_base::openmode mode) const
 Creates a Pharm::PSDMolecularGraphWriter that writes to the file 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

Handler for the output of molecular graph data in the CDPL PSD-format.

Member Function Documentation

◆ getDataFormat()

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

Returns the data format advertised by this handler (Pharm::DataFormat::PSD).

Returns
A const reference to the PSD Base::DataFormat instance.

Implements CDPL::Base::DataOutputHandler< Chem::MolecularGraph >.

◆ createWriter() [1/2]

WriterType::SharedPointer CDPL::Pharm::PSDMolecularGraphOutputHandler::createWriter ( std::ostream &  os) const
virtual

Creates a Pharm::PSDMolecularGraphWriter that writes to the output stream os.

Parameters
osThe output stream to write to.
Returns
A shared pointer to the constructed writer.

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 Pharm::PSDMolecularGraphWriter that writes to the file file_name.

Parameters
file_nameThe output file to write to.
modeThe open mode of the underlying file stream.
Returns
A shared pointer to the constructed writer.

Implements CDPL::Base::DataOutputHandler< Chem::MolecularGraph >.


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