Package Chem :: Module rdmolfiles :: Class SmilesWriter
[hide private]
[frames] | no frames]

Class SmilesWriter



 object --+    
          |    
??.instance --+
              |
             SmilesWriter

A class for writing molecules to text files.



Instance Methods [hide private]
 
NumMols(...)
Returns the number of molecules written so far.
 
SetProps(...)
Sets the properties to be written to the output file...
 
__init__(...)
Constructor.
 
flush(...)
Flushes the output file (forces the disk file to be updated).
 
write(...)
Writes a molecule to the output file.

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables [hide private]
  __instance_size__ = 44
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

NumMols(...)

 
Returns the number of molecules written so far.


C++ signature:
    NumMols(RDKit::SmilesWriter {lvalue}) -> unsigned int

SetProps(...)

 
Sets the properties to be written to the output file

  ARGUMENTS:

    - props: a list or tuple of property names


C++ signature:
    SetProps(RDKit::SmilesWriter {lvalue}, boost::python::api::object) -> void*

__init__(...)
(Constructor)

 
Constructor.

   ARGUMENTS:

     - fileName: name of the output file.

     - delimiter: (optional) delimiter to be used to separate entries on each line.

     - nameHeader: (optional) text to use for the name column in the header line.

     - includeHeader: (optional) toggles inclusion of a header line in the output file.


C++ signature:
    __init__(_object*, std::string fileName, std::string delimiter=' ', std::string nameHeader='Name', bool includeHeader=True) -> void*

Overrides: object.__init__

flush(...)

 
Flushes the output file (forces the disk file to be updated).


C++ signature:
    flush(RDKit::SmilesWriter {lvalue}) -> void*

write(...)

 
Writes a molecule to the output file.

  ARGUMENTS:

    - mol: the Mol to be written
    - confId: (optional) ignored 


C++ signature:
    write(RDKit::SmilesWriter {lvalue} self, RDKit::ROMol {lvalue} mol, int confId=-1) -> void*