This module is part of the Python Pool libray. It defines the class for an abstract action over a set of pool elements
Functions
Classes
Returns the global pool of threads for Sardana
Returns: | the global pool of threads object |
---|---|
Return type: | taurus.core.util.ThreadPool |
Bases: taurus.core.util.log.Logger
A generic class to handle any type of operation (like motion or acquisition)
Returns the main element for this action
Returns: | sardana.pool.poolelement.PoolElement |
---|
Returns the main element for this action
Returns: | sardana.pool.poolelement.PoolElement |
---|
Returns the pool object for thi action
Returns: | sardana.pool.pool.Pool |
---|
Adds a new element to this action.
Parameters: | element (sardana.pool.poolelement.PoolElement) – the new element to be added |
---|
Removes an element from this action. If the element is not part of this action, a ValueError is raised.
Parameters: | element (sardana.pool.poolelement.PoolElement) – the new element to be removed |
---|---|
Raises: | ValueError |
Returns a sequence of all elements involved in this action.
Parameters: | copy_of (bool) – If False (default) the internal container of elements is returned. If True, a copy of the internal container is returned instead |
---|---|
Returns: | a sequence of all elements involved in this action. |
Return type: | seq<sardana.pool.poolelement.PoolElement> |
Returns a list of all controller elements involved in this action.
Returns: | a list of all controller elements involved in this action. |
---|---|
Return type: | list<sardana.pool.poolelement.PoolController> |
Returns a dict of all controller elements involved in this action.
Returns: | a dict of all controller elements involved in this action. |
---|---|
Return type: | dict<sardana.pool.poolelement.PoolController, seq<sardana.pool.poolelement.PoolElement>> |
Determines if this action is running or not
Returns: | True if action is running or False otherwise |
---|---|
Return type: | bool |
Start procedure for this action. Default implementation raises NotImplementedError
Raises: | NotImplementedError |
---|
Attaches/Detaches a finish hook
Parameters: | hook (callable or None) – a callable object or None |
---|
Finishes the action execution. If a finish hook is defined it safely executes it. Otherwise nothing happens
Determines if the action has been stopped from outside
Returns: | True if action has been stopped from outside or False otherwise |
---|---|
Return type: | bool |
Determines if the action has been aborted from outside
Returns: | True if action has been aborted from outside or False otherwise |
---|---|
Return type: | bool |
Determines if the action has been interruped from outside (either from an abort or a stop).
Returns: | True if action has been interruped from outside or False otherwise |
---|---|
Return type: | bool |
Action loop for this action. Default implementation raises NotImplementedError
Raises: | NotImplementedError |
---|
Reads state information of all elements involved in this action
Parameters: |
|
---|---|
Returns: | a map containing state information per element |
Return type: | dict<sardana.pool.poolelement.PoolElement, stateinfo> |
Unsafe. Reads state information of all elements involved in this action
Parameters: |
|
---|---|
Returns: | a map containing state information per element |
Return type: | dict<sardana.pool.poolelement.PoolElement, stateinfo> |
Reads value information of all elements involved in this action
Parameters: |
|
---|---|
Returns: | a map containing value information per element |
Return type: | dict<:class:~`sardana.pool.poolelement.PoolElement`, (value object, Exception or None)> |
Unsafe. Reads value information of all elements involved in this action
Parameters: |
|
---|---|
Returns: | a map containing value information per element |
Return type: | dict<:class:~`sardana.pool.poolelement.PoolElement, sardana.sardanavalue.SardanaValue > |
Reads value information of all elements involved in this action
Parameters: |
|
---|---|
Returns: | a map containing value information per element |
Return type: | dict<:class:~`sardana.pool.poolelement.PoolElement`, (value object, Exception or None)> |
Unsafe. Reads value information of all elements involved in this action
Parameters: |
|
---|---|
Returns: | a map containing value information per element |
Return type: | dict<:class:~`sardana.pool.poolelement.PoolElement, sardana.sardanavalue.SardanaValue > |