PoolDevice

Generic Tango Pool Device base classes

Classes

PoolDevice PoolDeviceClass

PoolElementDevice PoolElementDeviceClass

PoolGroupDevice PoolGroupDeviceClass

PoolDevice

class PoolDevice(dclass, name)

Bases: sardana.tango.core.SardanaDevice.SardanaDevice

Base Tango Pool device class

ExtremeErrorStates = (<_mock._Mock object>, <_mock._Mock object>)

list of extreme error states

BusyStates = (<_mock._Mock object>, <_mock._Mock object>)

list of busy states

BusyRetries = 3

Maximum number of retries in a busy state

init(name)

initialize the device once in the object lifetime. Override when necessary but always call the method from your super class

Parameters:name (str) – device name

pool_device

The tango pool device

pool

The sardana pool object

get_element()

Returns the underlying pool element object

Returns:the underlying pool element object Return type:PoolElement

set_element(element)

Associates this device with the sardana element

Parameters:element (PoolElement) – the sardana element

element

The underlying sardana element

init_device()

Initialize the device. Called during startup after init() and every time the tango Init command is executed. Override when necessary but always call the method from your super class

delete_device()

Clean the device. Called during shutdown and every time the tango Init command is executed. Override when necessary but always call the method from your super class

Abort()

The tango abort command. Aborts the active operation

is_Abort_allowed()

Returns True if it is allowed to execute the tango abort command

Returns:True if it is allowed to execute the tango abort command or False otherwise Return type:bool

Stop()

The tango stop command. Stops the active operation

is_Stop_allowed()

Returns True if it is allowed to execute the tango stop command

Returns:True if it is allowed to execute the tango stop command or False otherwise Return type:bool

get_dynamic_attributes()

Returns the standard dynamic and fully dynamic attributes for this device. The return is a tuple of two dictionaries:

• standard attributes: caseless dictionary with key being the attribute name and value is a tuple of attribute name(str), tango information, attribute information
• dynamic attributes: caseless dictionary with key being the attribute name and value is a tuple of attribute name(str), tango information, attribute information

tango information

seq< CmdArgType, AttrDataFormat, AttrWriteType >

attribute information

attribute information as returned by the sardana controller

Returns:the standard dynamic and fully dynamic attributes Return type:seq< CaselessDict, CaselessDict>

initialize_dynamic_attributes()

Initializes this device dynamic attributes

remove_unwanted_dynamic_attributes(new_std_attrs, new_dyn_attrs)

Removes unwanted dynamic attributes from previous device creation

add_dynamic_attribute(attr_name, data_info, attr_info, read, write, is_allowed)

Adds a single dynamic attribute

Parameters:

• attr_name (str) – the attribute name
• data_info (seq< CmdArgType, AttrDataFormat, AttrWriteType >) – tango attribute information
• attr_info – attribute information
• read – read method for the attribute
• write – write method for the attribute
• is_allowed – is allowed method

add_standard_attribute(attr_name, data_info, attr_info, read, write, is_allowed)

Adds a single standard dynamic attribute

Parameters:

• attr_name (str) – the attribute name
• data_info (seq< CmdArgType, AttrDataFormat, AttrWriteType >) – tango attribute information
• attr_info – attribute information
• read – read method for the attribute
• write – write method for the attribute
• is_allowed – is allowed method

read_DynamicAttribute(attr)

Generic read dynamic attribute. Default implementation raises NotImplementedError

Parameters:attr (Attribute) – attribute to be read Raises:NotImplementedError

write_DynamicAttribute(attr)

Generic write dynamic attribute. Default implementation raises NotImplementedError

Parameters:attr (Attribute) – attribute to be written Raises:NotImplementedError

is_DynamicAttribute_allowed(req_type)

Generic is dynamic attribute allowed. Default implementation calls _is_allowed()

Parameters:req_type – request type

dev_state()

Calculates and returns the device state. Called by Tango on a read state request.

Returns:the device state Return type:DevState

dev_status()

Calculates and returns the device status. Called by Tango on a read status request.

Returns:the device status Return type:str

wait_for_operation()

Waits for an operation to finish. It uses the maxumum number of retries. Sleeps 0.01s between retries.

Raises:Exception in case of a timeout

Restore()

Restore tango command. Restores the attributes to their former glory. This applies to memorized writable attributes which have a set point stored in the database

get_restore_data()

get_attributes_to_restore()

restore_attribute(attribute, write_meth, db_value)

PoolDeviceClass

class PoolDeviceClass(name)

Bases: sardana.tango.core.SardanaDevice.SardanaDeviceClass

Base Tango Pool Device Class class

class_property_list = {}

Sardana device class properties definition

See also

server

device_property_list = {'Force_HW_Read': [<_mock._Mock object at 0x7f9ba9cba8d0>, 'Force a hardware read of value even when in operation (motion/acquisition', False], 'Id': [<_mock._Mock object at 0x7f9ba9cbaa50>, 'Internal ID', 0]}

Sardana device properties definition

See also

server

cmd_list = {'Abort': [[<_mock._Mock object at 0x7f9ba9cbaf50>, ''], [<_mock._Mock object at 0x7f9ba9cbaf50>, '']], 'Restore': [[<_mock._Mock object at 0x7f9ba9cbaf50>, ''], [<_mock._Mock object at 0x7f9ba9cbaf50>, '']], 'Stop': [[<_mock._Mock object at 0x7f9ba9cbaf50>, ''], [<_mock._Mock object at 0x7f9ba9cbaf50>, '']]}

Sardana device command definition

See also

server

attr_list = {}

Sardana device attribute definition

See also

server

standard_attr_list = {}

PoolElementDevice

class PoolElementDevice(dclass, name)

Bases: sardana.tango.pool.PoolDevice.PoolDevice

Base Tango Pool Element Device class

init_device()

Initialize the device. Called during startup after init() and every time the tango Init command is executed. Override when necessary but always call the method from your super class

read_Instrument(attr)

Read the value of the Instrument tango attribute. Returns the instrument full name or empty string if this element doesn’t belong to any instrument

Parameters:attr (Attribute) – tango instrument attribute

write_Instrument(attr)

Write the value of the Instrument tango attribute. Sets a new instrument full name or empty string if this element doesn’t belong to any instrument. The instrument must have been previously created.

Parameters:attr (Attribute) – tango instrument attribute

get_dynamic_attributes()

Override of PoolDevice.get_dynamic_attributes. Returns the standard dynamic and fully dynamic attributes for this device. The return is a tuple of two dictionaries:

• standard attributes: caseless dictionary with key being the attribute name and value is a tuple of attribute name(str), tango information, attribute information
• dynamic attributes: caseless dictionary with key being the attribute name and value is a tuple of attribute name(str), tango information, attribute information

tango information

seq< CmdArgType, AttrDataFormat, AttrWriteType >

attribute information

attribute information as returned by the sardana controller

Returns:the standard dynamic and fully dynamic attributes Return type:seq< CaselessDict, CaselessDict>

read_DynamicAttribute(attr)

Read a generic dynamic attribute. Calls the controller of this element to get the dynamic attribute value

Parameters:attr (Attribute) – tango attribute

write_DynamicAttribute(attr)

Write a generic dynamic attribute. Calls the controller of this element to get the dynamic attribute value

Parameters:attr (Attribute) – tango attribute

read_SimulationMode(attr)

Read the current simulation mode.

Parameters:attr (Attribute) – tango attribute

write_SimulationMode(attr)

Sets the simulation mode.

Parameters:attr (Attribute) – tango attribute

PoolElementDeviceClass

class PoolElementDeviceClass(name)

Bases: sardana.tango.pool.PoolDevice.PoolDeviceClass

Base Tango Pool Element Device Class class

device_property_list = {'Axis': [<_mock._Mock object at 0x7f9ba9cbaa50>, 'Axis in the controller', [0]], 'Ctrl_id': [<_mock._Mock object at 0x7f9ba9cbaa50>, 'Controller ID', [0]], 'Force_HW_Read': [<_mock._Mock object at 0x7f9ba9cba8d0>, 'Force a hardware read of value even when in operation (motion/acquisition', False], 'Id': [<_mock._Mock object at 0x7f9ba9cbaa50>, 'Internal ID', 0], 'Instrument_id': [<_mock._Mock object at 0x7f9ba9cbaa50>, 'Controller ID', [0]]}

Sardana device properties definition

See also

server

attr_list = {'Instrument': [[<_mock._Mock object at 0x7f9ba9cbaad0>, <_mock._Mock object at 0x7f9ba9cbb110>, <_mock._Mock object at 0x7f9ba9cbb0d0>], {'Display level': <_mock._Mock object at 0x7f9ba4f5a390>, 'label': 'Instrument'}], 'SimulationMode': [[<_mock._Mock object at 0x7f9ba9cba8d0>, <_mock._Mock object at 0x7f9ba9cbb110>, <_mock._Mock object at 0x7f9ba9cbb0d0>], {'label': 'Simulation mode'}]}

Sardana device attribute definition

See also

server

cmd_list = {'Abort': [[<_mock._Mock object at 0x7f9ba9cbaf50>, ''], [<_mock._Mock object at 0x7f9ba9cbaf50>, '']], 'Restore': [[<_mock._Mock object at 0x7f9ba9cbaf50>, ''], [<_mock._Mock object at 0x7f9ba9cbaf50>, '']], 'Stop': [[<_mock._Mock object at 0x7f9ba9cbaf50>, ''], [<_mock._Mock object at 0x7f9ba9cbaf50>, '']]}

get_standard_attr_info(attr)

Returns information about the standard attribute

Parameters:attr (str) – attribute name Returns:a sequence of tango data_type, data format

PoolGroupDevice

class PoolGroupDevice(dclass, name)

Bases: sardana.tango.pool.PoolDevice.PoolDevice

Base Tango Pool Group Device class

read_ElementList(attr)

Read the element list.

Parameters:attr (Attribute) – tango attribute

get_element_names()

Returns the list of element names.

Returns:a list of attribute names

elements_changed(evt_src, evt_type, evt_value)

Callback for when the elements of this group changed

PoolGroupDeviceClass

class PoolGroupDeviceClass(name)

Bases: sardana.tango.pool.PoolDevice.PoolDeviceClass

Base Tango Pool Group Device Class class

device_property_list = {'Elements': [<_mock._Mock object at 0x7f9ba9cbae50>, 'elements in the group', []], 'Force_HW_Read': [<_mock._Mock object at 0x7f9ba9cba8d0>, 'Force a hardware read of value even when in operation (motion/acquisition', False], 'Id': [<_mock._Mock object at 0x7f9ba9cbaa50>, 'Internal ID', 0]}

Sardana device properties definition

See also

server

cmd_list = {'Abort': [[<_mock._Mock object at 0x7f9ba9cbaf50>, ''], [<_mock._Mock object at 0x7f9ba9cbaf50>, '']], 'Restore': [[<_mock._Mock object at 0x7f9ba9cbaf50>, ''], [<_mock._Mock object at 0x7f9ba9cbaf50>, '']], 'Stop': [[<_mock._Mock object at 0x7f9ba9cbaf50>, ''], [<_mock._Mock object at 0x7f9ba9cbaf50>, '']]}

Sardana device command definition

See also

server

attr_list = {'ElementList': [[<_mock._Mock object at 0x7f9ba9cbaad0>, <_mock._Mock object at 0x7f9ba9cbb150>, <_mock._Mock object at 0x7f9ba9cbb050>, 4096]]}

Sardana device attribute definition

See also

server