![]() |
RDKit
Open-source cheminformatics and machine learning.
|
#include <MolWriters.h>
Public Member Functions | |
| SmilesWriter (const std::string &fileName, const std::string &delimiter=" ", const std::string &nameHeader="Name", bool includeHeader=true, bool isomericSmiles=true, bool kekuleSmiles=false) | |
| SmilesWriter (std::ostream *outStream, std::string delimiter=" ", std::string nameHeader="Name", bool includeHeader=true, bool takeOwnership=false, bool isomericSmiles=true, bool kekuleSmiles=false) | |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| ~SmilesWriter () override | |
| void | setProps (const STR_VECT &propNames) override |
| set a vector of property names that are need to be written out for each molecule | |
| void | write (const ROMol &mol, int confId=defaultConfId) override |
| write a new molecule to the file | |
| void | flush () override |
| flush the ostream | |
| void | close () override |
| close our stream (the writer cannot be used again) | |
| unsigned int | numMols () const override |
| get the number of molecules written so far | |
Public Member Functions inherited from RDKit::MolWriter | |
| virtual | ~MolWriter () |
The SmilesWriter is for writing molecules and properties to delimited text files.
Definition at line 48 of file MolWriters.h.
| RDKit::SmilesWriter::SmilesWriter | ( | const std::string & | fileName, |
| const std::string & | delimiter = " ", | ||
| const std::string & | nameHeader = "Name", | ||
| bool | includeHeader = true, | ||
| bool | isomericSmiles = true, | ||
| bool | kekuleSmiles = false ) |
| fileName | : filename to write to ("-" to write to stdout) |
| delimiter | : delimiter to use in the text file |
| nameHeader | : used to label the name column in the output. If this is provided as the empty string, no names will be written. |
| includeHeader | : toggles inclusion of a header line in the output |
| isomericSmiles | : toggles generation of isomeric SMILES |
| kekuleSmiles | : toggles the generation of kekule SMILES |
| RDKit::SmilesWriter::SmilesWriter | ( | std::ostream * | outStream, |
| std::string | delimiter = " ", | ||
| std::string | nameHeader = "Name", | ||
| bool | includeHeader = true, | ||
| bool | takeOwnership = false, | ||
| bool | isomericSmiles = true, | ||
| bool | kekuleSmiles = false ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
override |
|
inlineoverridevirtual |
close our stream (the writer cannot be used again)
Implements RDKit::MolWriter.
Definition at line 105 of file MolWriters.h.
References flush().
|
inlineoverridevirtual |
flush the ostream
Implements RDKit::MolWriter.
Definition at line 90 of file MolWriters.h.
References PRECONDITION.
Referenced by close().
|
inlineoverridevirtual |
get the number of molecules written so far
Implements RDKit::MolWriter.
Definition at line 117 of file MolWriters.h.
|
overridevirtual |
set a vector of property names that are need to be written out for each molecule
Implements RDKit::MolWriter.
|
overridevirtual |