Class SpinList

List type data container for spin system specific data.

Instance Methods

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

__repr__(self)
The string representation of the object.

SpinContainer instance add_item(self, spin_name=None, spin_num=None, select=True)
Appending an empty container to the list.

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

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

to_xml(self, doc, element)
Create XML elements for each spin.

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

Inherited from object: __delattr__, __format__, __reduce__, __reduce_ex__, __setattr__, __str__, __subclasshook__

Class Variables

Inherited from list: __hash__

Properties

Inherited from object: __class__

Method Details

__init__(self)
(Constructor)

Set up the first spin system data container.

Returns: new empty list

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__

add_item(self, spin_name=None, spin_num=None, select=True)

Appending an empty container to the list.

Parameters:

• spin_name (str or None) - The name of the new spin.
• spin_num (str or None) - The number of the new spin.
• select (bool) - The selection flag.

Returns: SpinContainer instance

The new container.

is_empty(self)

Method for testing if this SpinList object is empty.

Returns: bool

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

from_xml(self, spin_nodes, file_version=None)

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

Parameters:

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

to_xml(self, doc, element)

Create XML elements for each spin.

Parameters:

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