Class PipeContainer

Class containing all the program data.

Instance Methods

__init__(self)
Set up all the PipeContainer data structures.

__repr__(self)
The string representation of the object.

_back_compat_hook(self, file_version=None)
Method for converting old data structures to the new ones.

_back_compat_hook_ri_data(self)
Converting the old relaxation data structures to the new ones.

from_xml(self, pipe_node, file_version=None, dir=None)
Read a pipe container XML element and place the contents into this pipe.

bool is_empty(self)
Method for testing if the data pipe is empty.

to_xml(self, doc, element, pipe_type=None)
Create a XML element for the current data pipe.

xml_create_hybrid_element(self, doc, element)
Create an XML element for the data pipe hybridisation information.

Inherited from prototype.Prototype: __clone__, __deepcopy__

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

Properties

Inherited from object: __class__

Method Details

__init__(self)
(Constructor)

Set up all the PipeContainer data structures.

Overrides: object.__init__

__repr__(self)
(Representation operator)

The string representation of the object.

Rather than using the standard Python conventions (either the string representation of the value or the "<...desc...>" notation), a rich-formatted description of the object is given.

Overrides: object.__repr__

_back_compat_hook(self, file_version=None)

Method for converting old data structures to the new ones.

Parameters:

• file_version (int) - The relax XML version of the XML file.

from_xml(self, pipe_node, file_version=None, dir=None)

Read a pipe container XML element and place the contents into this pipe.

Parameters:

• pipe_node (xml.dom.minidom.Element instance) - The data pipe XML node.
• file_version (int) - The relax XML version of the XML file.
• dir (str) - The name of the directory containing the results file (needed for loading external files).

is_empty(self)

Method for testing if the data pipe is empty.

Returns: bool

True if the data pipe is empty, False otherwise.

to_xml(self, doc, element, pipe_type=None)

Create a XML element for the current data pipe.

Parameters:

• doc (xml.dom.minidom.Document instance) - The XML document object.
• element (XML element object) - The XML element to add the pipe XML element to.
• pipe_type (str) - The type of the pipe being converted to XML.

xml_create_hybrid_element(self, doc, element)

Create an XML element for the data pipe hybridisation information.

Parameters:

• doc (xml.dom.minidom.Document instance) - The XML document object.
• element (XML element object) - The element to add the hybridisation info to.