Class Uf_tables

The data singleton holding all of the description tables.

Instance Methods

user_functions.objects.Table instance add_table(self, label=None, caption=None, caption_short=None, spacing=True, longtable=False)
Add a new table to the object.

user_functions.objects.Table instance get_table(self, label)
Return the table matching the given label.

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

Static Methods

a new object with type S, a subtype of T __new__(self, *args, **kargs)
Replacement method for implementing the singleton design pattern.

Class Variables

_instance = Uf_tables()

_labels = ['table: bool operators', 'table: frame order parame...

_tables = {'table: J(w) parameter value setting': <user_functi...

Properties

Inherited from object: __class__

Method Details

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

Replacement method for implementing the singleton design pattern.

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

Overrides: object.__new__

add_table(self, label=None, caption=None, caption_short=None, spacing=True, longtable=False)

Add a new table to the object.

Parameters:

• label (str) - The unique label of the table. This is used to identify tables, and is also used in the table referencing in the LaTeX compilation of the user manual.
• caption (str) - The caption for the table.
• caption_short (str) - The optional short caption for the table, used in the LaTeX user manual list of tables section for example.
• spacing (bool) - A flag which if True will cause empty rows to be placed between elements.
• longtable (bool) - A special LaTeX flag which if True will cause the longtables package to be used to spread a table across multiple pages. This should only be used for tables that do not fit on a single page.

Returns: user_functions.objects.Table instance

The table object.

get_table(self, label)

Return the table matching the given label.

Parameters:

• label (str) - The unique label of the table.

Returns: user_functions.objects.Table instance

The table data container.

Class Variable Details

_labels

Value:

['table: bool operators',
 'table: frame order parameters',
 'table: frame order parameter value setting with defaults',
 'table: model-free parameters',
 'table: model-free parameter writing',
 'table: model-free parameters and min stats',
 'table: all model-free parameters',
 'table: model-free parameter value setting',
...

_tables

Value:

{'table: J(w) parameter value setting': <user_functions.objects.Table 
object at 0x7f4090f7be90>,
 'table: J(w) parameter value setting with defaults': <user_functions.
objects.Table object at 0x7f4090f7bf10>,
 'table: J(w) parameters': <user_functions.objects.Table object at 0x7
f4090f7be10>,
 'table: Molmol colours': <user_functions.objects.Table object at 0x7f
409134aad0>,
...