Class BaseSaveframe

The base class for the saveframe classes.

Instance Methods

__init__(self, datanodes)
Initialise the class, placing the pystarlib data nodes into the namespace.

int add(self, **keywords)
Add data to the saveframe.

str create_title(self)
Create the saveframe title.

tuple extract_data(self, datanode)
Read all the tags from the datanodes.

list find_mapping(self, datanode)
Determine the mapping between the tag categories of the NMR-STAR file and the bmrblib class.

tuple loop(self)
Loop over the saveframes, yielding the data.

pre_ops(self)
A dummy method for performing no saveframe specific operations prior to XML creation.

dict read(self)
Read all the data from the saveframe.

reset(self)
Reset all data structures to None.

Method Details

__init__(self, datanodes)
(Constructor)

Initialise the class, placing the pystarlib data nodes into the namespace.

Parameters:

• datanodes (list) - The pystarlib data nodes object.

add(self, **keywords)

Add data to the saveframe.

If the keywords are within the tag dictionary structure as the variable name, then the data will be checked, translated and stored in that variable. If not, then a warning will be given.

Returns: int

The saveframe count.

create_title(self)

Create the saveframe title.

Returns: str

The title.

extract_data(self, datanode)

Read all the tags from the datanodes.

Parameters:

• datanode (Datanode instance) - The datanode.

Returns: tuple

The data.

find_mapping(self, datanode)

Determine the mapping between the tag categories of the NMR-STAR file and the bmrblib class.

Parameters:

• datanode (Datanode instance) - The datanode.

Returns: list

The mapping structure.

loop(self)

Loop over the saveframes, yielding the data.

Returns: tuple

The saveframe data.

read(self)

Read all the data from the saveframe.

Returns: dict

A dictionary of all the data.