Package bmrblib :: Module base_classes :: Class TagTranslationTable
[hide private]
[frames] | no frames]

Class TagTranslationTable

source code


A special dictionary object for creating the tag translation tables.

Instance Methods [hide private]
new empty dictionary

__init__(self)
Set up the table.
source code
 
add(self, key, var_name=None, tag_name=None, allowed=None, default=None, format='str', missing=True)
Add an entry to the translation table.
source code

Inherited from dict: __cmp__, __contains__, __delitem__, __eq__, __ge__, __getattribute__, __getitem__, __gt__, __iter__, __le__, __len__, __lt__, __ne__, __new__, __repr__, __setitem__, __sizeof__, clear, copy, fromkeys, get, has_key, items, iteritems, iterkeys, itervalues, keys, pop, popitem, setdefault, update, values, viewitems, viewkeys, viewvalues

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

Class Variables [hide private]

Inherited from dict: __hash__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

Set up the table.

Returns:
new empty dictionary

Overrides: object.__init__

add(self, key, var_name=None, tag_name=None, allowed=None, default=None, format='str', missing=True)

source code 

Add an entry to the translation table.

Parameters:
  • key (str) - The dictionary key. This is also the BMRB NMR-STAR database table name.
  • var_name (None or str) - The saveframe variable name corresponding to the key.
  • tag_name (None or str) - The BMRB NMR-STAR tag name corresponding to the key.
  • allowed (None or list) - A list of allowable values for the data.
  • default (anything) - The default value.
  • format (str) - The original python format of the data.
  • missing (bool) - A flag which if True will allow the data to be set to None.