poolcontroller
¶
This module is part of the Python Pool library. It defines the base classes for
Classes
PoolController¶
-
class
PoolController
(**kwargs)[source]¶ Bases:
sardana.pool.poolcontroller.PoolBaseController
Controller class mediator for sardana controller plugins
-
ctrl
¶ actual controller object
-
ctrl_info
¶ controller information object
-
set_operator
(operator)[source]¶ Defines the current operator object for this controller. For example, in acquisition, it should be a
PoolMeasurementGroup
object.Parameters: operator (object) – the new operator object
-
operator
¶ current controller operator
-
raw_read_axis_states
(axes=None, ctrl_states=None)[source]¶ Unsafe method. Reads the state for the given axes. If axes is None, reads the state of all active axes.
Parameters: axes (seq<int> or None) – the list of axis to get the state. Default is None meaning all active axis in this controller Returns: a tuple of two elements: a map containing the controller state information for each axis and a boolean telling if an error occured Return type: dict<PoolElement, state info>, bool
-
read_axis_states
(pool_ctrl, *args, **kwargs)[source]¶ Reads the state for the given axes. If axes is None, reads the state of all active axes.
Parameters: axes (seq<int> or None) – the list of axis to get the state. Default is None meaning all active axis in this controller Returns: a map containing the controller state information for each axis Return type: dict<PoolElement, state info>
-
raw_read_axis_values
(axes=None, ctrl_values=None)[source]¶ Unsafe method. Reads the value for the given axes. If axes is None, reads the value of all active axes.
Parameters: axes (seq<int> or None) – the list of axis to get the value. Default is None meaning all active axis in this controller Returns: a map containing the controller value information for each axis Return type: dict<PoolElement, SardanaValue>
-
read_axis_values
(pool_ctrl, *args, **kwargs)[source]¶ Reads the value for the given axes. If axes is None, reads the value of all active axes.
Parameters: axes (seq<int> or None) – the list of axis to get the value. Default is None meaning all active axis in this controller Returns: a map containing the controller value information for each axis Return type: dict<PoolElement, SardanaValue>
-
stop
(pool_ctrl, *args, **kwargs)¶
-
stop_axes
(pool_ctrl, *args, **kwargs)[source]¶ Stops the given axes. If axes is None, stops all active axes.
Parameters: axes (seq<int> or None) – the list of axis to stop. Default is None meaning all active axis in this controller
-
stop_elements
(pool_ctrl, *args, **kwargs)[source]¶ Stops the given elements. If axes is None, stops all active axes.
Parameters: elements – the list of elements to stop. Default is None meaning all active axis in this controller
-
abort_axes
(pool_ctrl, *args, **kwargs)[source]¶ Aborts the given axes. If axes is None, aborts all active axes.
Parameters: axes (seq<int> or None) – the list of axis to abort. Default is None meaning all active axis in this controller
-
abort_elements
(pool_ctrl, *args, **kwargs)[source]¶ Aborts the given elements. If axes is None, aborts all active axes.
Parameters: elements – the list of elements to abort. Default is None meaning all active axis in this controller
-
abort
(pool_ctrl, *args, **kwargs)¶
-