poolcontroller

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

Classes

PoolController

Inheritance diagram of PoolController
class PoolController(**kwargs)[source]

Bases: sardana.pool.poolcontroller.PoolBaseController

Controller class mediator for sardana controller plugins

serialize(*args, **kwargs)[source]
re_init()[source]
get_ctrl_types()[source]
is_timerable()[source]
is_referable()[source]
is_pseudo()[source]
is_online()[source]
get_ctrl()[source]
set_ctrl(ctrl)[source]
property ctrl

actual controller object

get_ctrl_info()[source]
property 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

get_operator()[source]
property operator

current controller operator

set_log_level(level)[source]
get_log_level()[source]
get_library_name()[source]
get_class_name()[source]
get_axis_attributes(axis)[source]
get_ctrl_attr(name)[source]
set_ctrl_attr(name, value)[source]
get_axis_attr(axis, name)[source]
set_axis_attr(axis, name, value)[source]
set_ctrl_par(name, value)[source]
get_ctrl_par(name)[source]
set_axis_par(axis, name, value)[source]
get_axis_par(axis, name)[source]
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(axes=None)[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(axes=None)[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>

raw_read_axis_value_refs(axes=None, ctrl_values=None)[source]

Unsafe method. Reads the value refs for the given axes. If axes is None, reads the value of all active axes.

Note

The raw_read_axis_value_refs method has been included in Sardana on a provisional basis. Backwards incompatible changes (up to and including removal of the class) may occur if deemed necessary by the core developers.

Todo

This method should be available only on the controllers which are referable.

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_axes(axes)[source]

Stops the given axes.

Parameters

axes (list<axes>) – the list of axes to stopped.

Returns

list of axes that could not be stopped

Return type

list<int>

stop_element(element)[source]

Stops the given element.

Parameters

element (PoolElement) – element to stop

Raises

Exception – not able to stop element

stop_elements(elements=None)[source]

Stops the given elements. If elements is None, stops all active elements.

Parameters

elements (seq<PoolElement> or None) – the list of elements to stop. Default is None meaning all active elements in this controller

Returns

list of elements that could not be stopped

Return type

list<PoolElements>

stop(elements=None)

Stops the given elements. If elements is None, stops all active elements.

Parameters

elements (seq<PoolElement> or None) – the list of elements to stop. Default is None meaning all active elements in this controller

Returns

list of elements that could not be stopped

Return type

list<PoolElements>

abort_axes(axes)[source]

Aborts the given axes.

Parameters

axes (list<axes>) – the list of axes to aborted.

Returns

list of axes that could not be aborted

Return type

list<int>

abort_element(element)[source]

Aborts the given elements.

Parameters

element (PoolElement) – element to abort

Raises

Exception – not able to abort element

abort_elements(elements=None)[source]

Abort the given elements. If elements is None, stops all active elements.

Parameters

elements (seq<PoolElement> or None) – the list of elements to stop. Default is None meaning all active elements in this controller

Returns

list of elements that could not be aborted

Return type

list<PoolElements>

abort(elements=None)

Abort the given elements. If elements is None, stops all active elements.

Parameters

elements (seq<PoolElement> or None) – the list of elements to stop. Default is None meaning all active elements in this controller

Returns

list of elements that could not be aborted

Return type

list<PoolElements>

emergency_break(elements=None)[source]

Stops the given elements. If elements is None, stops all active elements. If stop could not be executed, an abort is attempted.

Parameters

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

Returns

elements that could neither be stopped nor aborted

Return type

list<PoolElement>

send_to_controller(stream)[source]
raw_move(axis_pos)[source]
move(axis_pos)[source]
has_backlash()[source]
wants_rounding()[source]
define_position(axis, position)[source]
write_one(axis, value)[source]
get_default_timer()[source]

Get default timer as announced by the controller (plug-in).

Only for Timerable controllers, e.g. CounterTimerController, OneDController, TwoDController.

Returns

axis of the default timer or None if not defined

Return type

int or None

PoolPseudoMotorController

Inheritance diagram of PoolPseudoMotorController
class PoolPseudoMotorController(**kwargs)[source]

Bases: sardana.pool.poolcontroller.PoolController

serialize(*args, **kwargs)[source]
calc_all_pseudo(physical_pos, curr_pseudo_pos)[source]
calc_all_physical(pseudo_pos, curr_physical_pos)[source]
calc_pseudo(axis, physical_pos, curr_pseudo_pos)[source]
calc_physical(axis, pseudo_pos, curr_physical_pos)[source]

PoolPseudoCounterController

Inheritance diagram of PoolPseudoCounterController
class PoolPseudoCounterController(**kwargs)[source]

Bases: sardana.pool.poolcontroller.PoolController

serialize(*args, **kwargs)[source]
calc(axis, values)[source]
calc_all(values)[source]