type ResidueList

List type data container for residue specific data.

Instance Methods

new empty list __init__(self)
Set up the first residue data container.

__repr__(self)
The string representation of the object.

add_item(self, res_name=None, res_num=None)
Append an empty ResidueContainer to the ResidueList.

bool is_empty(self)
Method for testing if this ResidueList object is empty.

from_xml(self, res_nodes, file_version=None)
Recreate a residue list data structure from the XML residue nodes.

to_xml(self, doc, element, pipe_type=None)
Create XML elements for each residue.

Inherited from list: __add__, __contains__, __delitem__, __delslice__, __eq__, __ge__, __getattribute__, __getitem__, __getslice__, __gt__, __iadd__, __imul__, __iter__, __le__, __len__, __lt__, __mul__, __ne__, __new__, __reversed__, __rmul__, __setitem__, __setslice__, __sizeof__, append, count, extend, index, insert, pop, remove, reverse, sort

Class Variables

Inherited from list: __hash__

Method Details

__init__(self)
(Constructor)

Set up the first residue data container.

Returns: new empty list

Overrides: list.__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: list.__repr__

is_empty(self)

Method for testing if this ResidueList object is empty.

Returns: bool

True if this list only has one ResidueContainer and the residue number and name have not been set, False otherwise.

from_xml(self, res_nodes, file_version=None)

Recreate a residue list data structure from the XML residue nodes.

Parameters:

• res_nodes (xml.dom.minicompat.NodeList instance) - The residue XML nodes.
• file_version (int) - The relax XML version of the XML file.

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

Create XML elements for each residue.

Parameters:

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