Package user_functions :: Module data :: Class Uf_info
[hide private]
[frames] | no frames]

Class Uf_info

source code


The user function data singleton class.

Instance Methods [hide private]
user_functions.objects.Class_container instance
add_class(self, name)
Add a new user function class.
source code
user_functions.objects.Uf_container instance
add_uf(self, name)
Add the user function to the object.
source code
tuple of str and Class_container instance
class_loop(self)
Iterator method for looping over the user function classes.
source code
Class_container instance
get_class(self, name)
Return the user function class data object corresponding to the given name.
source code
Uf_container instance
get_uf(self, name)
Return the user function data object corresponding to the given name.
source code
tuple of str and Uf_container instance
uf_loop(self, uf_class=None)
Iterator method for looping over the user functions.
source code
 
validate(self)
Validate that all of the user functions have been correctly set up.
source code

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

Static Methods [hide private]
a new object with type S, a subtype of T
__new__(self, *args, **kargs)
Replacement method for implementing the singleton design pattern.
source code
Class Variables [hide private]
  _instance = Uf_info()
  _class_names = ['align_tensor', 'angles', 'bmrb', 'bruker', 'c...
  _classes = {'align_tensor': <user_functions.objects.Class_cont...
  _uf = {'align_tensor.copy': <user_functions.objects.Uf_contain...
  _uf_names = ['align_tensor.copy', 'align_tensor.delete', 'alig...
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__new__(self, *args, **kargs)
Static Method

source code 

Replacement method for implementing the singleton design pattern.

Returns: a new object with type S, a subtype of T
Overrides: object.__new__

add_class(self, name)

source code 

Add a new user function class.

Parameters:
  • name (str) - The name of the user function class.
Returns: user_functions.objects.Class_container instance
The user function class data object.

add_uf(self, name)

source code 

Add the user function to the object.

Parameters:
  • name (str) - The name of the user function.
Returns: user_functions.objects.Uf_container instance
The user function data object.

class_loop(self)

source code 

Iterator method for looping over the user function classes.

Returns: tuple of str and Class_container instance
The class name and data container.

get_class(self, name)

source code 

Return the user function class data object corresponding to the given name.

Parameters:
  • name (str) - The name of the user function class.
Returns: Class_container instance
The class data container.

get_uf(self, name)

source code 

Return the user function data object corresponding to the given name.

Parameters:
  • name (str) - The name of the user function.
Returns: Uf_container instance
The user function data container.

uf_loop(self, uf_class=None)

source code 

Iterator method for looping over the user functions.

Parameters:
  • uf_class (str or None) - If given, restrict the iterator to a user function class.
Returns: tuple of str and Uf_container instance
The user function name and data container.

Class Variable Details [hide private]

_class_names

Value:
['align_tensor',
 'angles',
 'bmrb',
 'bruker',
 'chemical_shift',
 'consistency_tests',
 'dasha',
 'deselect',
...

_classes

Value:
{'align_tensor': <user_functions.objects.Class_container instance at 0\
x7f33e5c05758>,
 'angles': <user_functions.objects.Class_container instance at 0x7f33e\
5753290>,
 'bmrb': <user_functions.objects.Class_container instance at 0x7f33e59\
bccf8>,
 'bruker': <user_functions.objects.Class_container instance at 0x7f33e\
5b92290>,
...

_uf

Value:
{'align_tensor.copy': <user_functions.objects.Uf_container object at 0\
x7f33e5bf9d50>,
 'align_tensor.delete': <user_functions.objects.Uf_container object at\
 0x7f33e574c850>,
 'align_tensor.display': <user_functions.objects.Uf_container object a\
t 0x7f33e574c8d0>,
 'align_tensor.fix': <user_functions.objects.Uf_container object at 0x\
7f33e574c950>,
...

_uf_names

Value:
['align_tensor.copy',
 'align_tensor.delete',
 'align_tensor.display',
 'align_tensor.fix',
 'align_tensor.init',
 'align_tensor.matrix_angles',
 'align_tensor.reduction',
 'align_tensor.set_domain',
...