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: PoolBaseController

Controller class mediator for sardana controller plugins

serialize(*args, **kwargs)

re_init()

get_ctrl_types()

is_timerable()

is_referable()

is_pseudo()

is_online()

get_ctrl()

set_ctrl(ctrl)

property ctrl

actual controller object

get_ctrl_info()

property 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()

property operator

current controller operator

set_log_level(pool_ctrl, *args, **kwargs)

get_log_level(pool_ctrl, *args, **kwargs)

property log_level

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.__int__(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by ‘+’ or ‘-’ and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal. >>> int(‘0b100’, base=0) 4

get_library_name()

get_class_name()

init_attribute_values(attr_values=None)

Initialize attributes with (default) values.

Set values to attributes as passed in attr_values. In lack of attribute value apply default value. In lack of default value do nothing.

Parameters:

attr_values (dict {str: object}) – map of attribute names and values

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_read_axis_value_refs(axes=None, ctrl_values=None)

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)

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(pool_ctrl, *args, **kwargs)

Stops the given element.

Parameters:

element (PoolElement) – element to stop

Raises:

Exception – not able to stop element

stop_elements(pool_ctrl, *args, **kwargs)

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(pool_ctrl, *args, **kwargs)

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(pool_ctrl, *args, **kwargs)

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(pool_ctrl, *args, **kwargs)

Aborts the given elements.

Parameters:

element (PoolElement) – element to abort

Raises:

Exception – not able to abort element

abort_elements(pool_ctrl, *args, **kwargs)

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(pool_ctrl, *args, **kwargs)

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(pool_ctrl, *args, **kwargs)

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(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)

get_default_timer()

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

class PoolPseudoMotorController(**kwargs)

Bases: PoolController

property motor_ids

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: PoolController

property counter_ids

serialize(*args, **kwargs)

calc(pool_ctrl, *args, **kwargs)

calc_all(values)