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

Class TagObject

source code


An object for filling the translation table.

Instance Methods [hide private]
 
__init__(self, category, var_name=None, tag_name=None, allowed=None, default=None, format='str', missing=True)
Setup the internal variables.
source code
str
tag_name_full(self)
Add the prefix to the tag name and return the full tag name.
source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, category, var_name=None, tag_name=None, allowed=None, default=None, format='str', missing=True)
(Constructor)

source code 

Setup the internal variables.

This stores the variable name, BMRB NMR-STAR tag name, a list of allowable values, the missing flag, and any other tag specific information corresponding to the key.

Parameters:
  • category (TagTranslationTable instance) - The parent tag category class object.
  • 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.
Overrides: object.__init__

tag_name_full(self)

source code 

Add the prefix to the tag name and return the full tag name.

Returns: str
The full tag name with prefix.