Package schrodinger :: Module structure :: Class _BaseWriter

Class _BaseWriter

                 object --+    
                          |    
_ReaderWriterContextManager --+
                              |
                             _BaseWriter

Known Subclasses:

This class provides a common implementation for structure writers.

Instance Methods

[hide private]

setOption(self, option, value)
Set a single option for this writer.

Inherited from _ReaderWriterContextManager: __enter__, __exit__

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

setOption(self, option, value)

Set a single option for this writer. This method is meant for options that may not be supported for all writer formats. See the StructureWriter class documentation for details on the available options.

Raises an OptionError subclass (either UnsupportedOption or UnsupportedOptionValue) if unsuccessful.

Parameters:

option (str) - The name of the option to set.
value - The value for the option. The data type of this parameter depends on the option being set.