poolcontroller

This module is part of the Python Pool library. It defines the base classes for

Classes

PoolController

PoolPseudoMotorController

PoolPseudoCounterController

PoolController

class PoolController(**kwargs)

Bases: sardana.pool.poolcontroller.PoolBaseController

Controller class mediator for sardana controller plugins

serialize(*args, **kwargs)

re_init()

get_ctrl_types()

is_timerable()

is_online()

get_ctrl()

ctrl

actual controller object

get_ctrl_info()

ctrl_info

controller information object

set_operator(operator)

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

get_operator()

operator

current controller operator

set_log_level(pool_ctrl, *args, **kwargs)

get_log_level(pool_ctrl, *args, **kwargs)

get_library_name()

get_class_name()

get_axis_attributes(pool_ctrl, *args, **kwargs)

get_ctrl_attr(pool_ctrl, *args, **kwargs)

set_ctrl_attr(pool_ctrl, *args, **kwargs)

get_axis_attr(pool_ctrl, *args, **kwargs)

set_axis_attr(pool_ctrl, *args, **kwargs)

set_ctrl_par(pool_ctrl, *args, **kwargs)

get_ctrl_par(pool_ctrl, *args, **kwargs)

set_axis_par(pool_ctrl, *args, **kwargs)

get_axis_par(pool_ctrl, *args, **kwargs)

raw_read_axis_states(axes=None, ctrl_states=None)

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)

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)

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)

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>

raw_stop_all()

raw_stop_one(axis)

stop_all(pool_ctrl, *args, **kwargs)

stop(pool_ctrl, *args, **kwargs)

stop_one(pool_ctrl, *args, **kwargs)

stop_axes(pool_ctrl, *args, **kwargs)

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)

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

raw_abort_all()

raw_abort_one(axis)

abort_all(pool_ctrl, *args, **kwargs)

abort_one(pool_ctrl, *args, **kwargs)

abort_axes(pool_ctrl, *args, **kwargs)

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)

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)

emergency_break(pool_ctrl, *args, **kwargs)

Stops the given elements. If axes is None, stops all active axes. If stop raises exception, an abort is attempted.

Parameters:elements – the list of elements to stop. Default is None meaning all active axis in this controller

send_to_controller(pool_ctrl, *args, **kwargs)

raw_move(axis_pos)

move(pool_ctrl, *args, **kwargs)

has_backlash()

wants_rounding()

define_position(pool_ctrl, *args, **kwargs)

write_one(axis, value)

PoolPseudoMotorController

class PoolPseudoMotorController(**kwargs)

Bases: sardana.pool.poolcontroller.PoolController

serialize(*args, **kwargs)

calc_all_pseudo(pool_ctrl, *args, **kwargs)

calc_all_physical(pool_ctrl, *args, **kwargs)

calc_pseudo(pool_ctrl, *args, **kwargs)

calc_physical(pool_ctrl, *args, **kwargs)

PoolPseudoCounterController

class PoolPseudoCounterController(**kwargs)

Bases: sardana.pool.poolcontroller.PoolController

serialize(*args, **kwargs)

calc(pool_ctrl, *args, **kwargs)

calc_all(values)