Package cinfony :: Module silverwebel :: Class Outputfile

Class Outputfile

object --+
         |
        Outputfile

Represent a file to which *output* is to be sent.

Although it's possible to write a single molecule to a file by
calling the write() method of a molecule, if multiple molecules
are to be written to the same file you should use the Outputfile
class.

Required parameters:
   format - see the outformats variable for a list of available
            output formats
   filename

Optional parameters:
   overwrite -- if the output file already exists, should it
               be overwritten? (default is False)
               
Methods:
   write(molecule)
   close()

Instance Methods

__init__(self, format, filename, overwrite=False)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

write(self, molecule)
Write a molecule to the output file.

source code

close(self)
Close the Outputfile to further writing.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

init(self, format, filename, overwrite=False)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

write(self, molecule)

source code

Write a molecule to the output file.

Required parameters:
   molecule

Class Outputfile

__init__(self, format, filename, overwrite=False) (Constructor)

write(self, molecule)

init(self, format, filename, overwrite=False)
(Constructor)