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

Class TagCategory

source code


The base class for tag category classes.

Instance Methods [hide private]
new empty dictionary

__init__(self, sf)
Initialise the tag category object, placing the saveframe into its namespace.
source code
int
_N(self)
Determine the length of the variables.
source code
 
create(self)
Create the tag category.
source code
 
extract_tag_data(self, tagtable)
Extract all of the tag data from the tagtable, placing it into the designated variable names.
source code
 
generate_data_ids(self)
Generate the data ID structure.
source code
bool
is_empty(self)
Dummy method for check if the tag category is empty.
source code
 
tag_setup(self, tag_category_label=None, sep=None)
Setup the tag names.
source code

Inherited from TagTranslationTable: add

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]
  tag_category_label = None
hash(x)
  free = False

Inherited from dict: __hash__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, sf)
(Constructor)

source code 

Initialise the tag category object, placing the saveframe into its namespace.

Parameters:
  • sf (saveframe instance) - The saveframe object.
Returns:
new empty dictionary

Overrides: object.__init__

_N(self)

source code 

Determine the length of the variables.

Returns: int
The length.

extract_tag_data(self, tagtable)

source code 

Extract all of the tag data from the tagtable, placing it into the designated variable names.

Parameters:
  • tagtable (Tagtable instance) - The tagtable.

generate_data_ids(self)

source code 

Generate the data ID structure.

Parameters:
  • N (int) - The number of data points.

is_empty(self)

source code 

Dummy method for check if the tag category is empty.

Returns: bool
The state of emptiness (False).

tag_setup(self, tag_category_label=None, sep=None)

source code 

Setup the tag names.

Parameters:
  • tag_category_label (None or str) - The tag name prefix specific for the tag category.
  • sep (str) - The string separating the tag name prefix and suffix.