tau

The main tau module. It contains a reduced set of wrappers around the real tau model classes and information regarding the current release.

Modules

• core
• widget

Classes

Manager()

Returns the one and only TauManager

It is a shortcut to:

import tau.core
manager = tau.core.TauManager()

Returns:the TauManager Return type:tau.core.TauManager

See also

tau.core.TauManager

Factory(scheme=None)

Returns the one and only Factory for the given scheme

It is a shortcut to:

import tau.core
manager = tau.core.TauManager()
factory = manager.getFactory(scheme)

Parameter:scheme (str) – a string representing the scheme. Default value is None meaning tango scheme Returns:a tau factory Return type:tau.core.TauFactory

Device(device_name)

Returns the tau device for the given device name

It is a shortcut to:

import tau.core
manager = tau.core.TauManager()
factory = manager.getFactory()
device  = factory.getDevice(device_name)

Parameter:device_name (str) – the device name Returns:a tau device Return type:tau.core.TauDevice

Database(db_name=None)

Returns the tau database

It is a shortcut to:

import tau.core
manager = tau.core.TauManager()
factory = manager.getFactory()
db  = factory.getDatabase(db_name)

Parameter:db_name (str or None) – database name. If None (default) it will use the TANGO_HOST value Returns:a tau database Return type:tau.core.TauDatabase

Attribute(dev_or_attr_name, attr_name=None)

Returns the tau attribute for either the pair (device name, attribute name) or full attribute name

• Attribute(full_attribute_name)
• Attribute(device_name, attribute_name)

It is a shortcut to:

import tau.core
manager = tau.core.TauManager()
factory = manager.getFactory()
attribute  = factory.getAttribute(full_attribute_name)

or:

import tau.core
manager = tau.core.TauManager()
factory = manager.getFactory()
device  = factory.getDevice(device_name)
attribute = device.getAttribute(attribute_name)

Parameters:

• dev_or_attr_name (str or TauDevice) – the device name or full attribute name
• attr_name (str) – attribute name

Returns:

a tau attribute

Return type:

tau.core.TauAttribute

Configuration(attr_or_conf_name, conf_name=None)

Returns the tau configuration for either the pair (attribute name, conf name) or full conf name

• Configuration(full_conf_name)
• Configuration(attribute_name, conf_name)

It is a shortcut to:

import tau.core
manager = tau.core.TauManager()
factory = manager.getFactory()
conf  = factory.getConfiguration(attr_or_conf_name)

or:

import tau.core
manager = tau.core.TauManager()
factory = manager.getFactory()
attribute  = factory.getAttribute(attribute_name)
conf = attribute.getConfig(conf_name)

Parameters:

• attr_or_conf_name (str) – the full attribute name or full conf name
• conf_name (str or None) – conf name

Returns:

a tau configuration

Return type:

tau.core.TauConfiguration

Object(klass, name)

Returns an tau object of given class for the given name

It is a shortcut to:

import tau.core
manager = tau.core.TauManager()
factory = manager.getFactory()
obj  = factory.getObject(klass, name)

Parameters:

• klass (class TauModel) – a tau model subclass (TauDevice, for example)
• name (str) – the full object name

Returns:

a tau object

Return type:

tau.core.TauModel

Functions

setLogLevel(cls, level)

sets the new log level (the root log level)

Parameter:level (int) – the new log level