poolelement

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

Classes

PoolBaseElement

PoolElement

PoolBaseElement

class PoolBaseElement(**kwargs)

Bases: PoolObject

A Pool object that besides the name, reference to the pool, ID, full_name and user_full_name has:

• _simulation_mode : boolean telling if in simulation mode

• _state : element state

• _status : element status

lock(blocking=True)

Acquires the this element lock

Parameters:

blocking (bool) – whether or not to block if lock is already acquired [default: True]

Return type:

bool

unlock()

get_action_cache()

Returns the internal action cache object

serialize(*args, **kwargs)

init_attribute_values(attr_values=None)

Initialize attributes with values.

Parameters:

attr_values (Optional[Dict[str, Any]]) – map of attribute names and values

Return type:

None

get_simulation_mode(cache=True, propagate=1)

Returns the simulation mode for this object.

Parameters:

• cache (bool) – not used [default: True]

• propagate (int) – [default: 1]

Return type:

bool

Returns:

the current simulation mode

set_simulation_mode(simulation_mode, propagate=1)

put_simulation_mode(simulation_mode)

property simulation_mode: bool

element simulation mode

get_state(cache=True, propagate=1)

Returns the state for this object. If cache is True (default) it returns the current state stored in cache (it will force an update if cache is empty). If propagate > 0 and if the state changed since last read, it will propagate the state event to all listeners.

Parameters:

• cache (bool) – tells if return value from local cache or update from HW read [default: True]

• propagate (int) – if > 0 propagates the event in case it changed since last HW read. Values bigger that mean the event if sent should be a priority event [default: 1]

Return type:

State

Returns:

the current object state

inspect_state()

Looks at the current cached value of state

Return type:

State

Returns:

the current object state

set_state(state, propagate=1)

put_state(state)

property state: Enumeration('State', ['On', 'Off', 'Close', 'Open', 'Insert', 'Extract', 'Moving', 'Standby', 'Fault', 'Init', 'Running', 'Alarm', 'Disable', 'Unknown', 'Invalid'])

element state

inspect_status()

Looks at the current cached value of status

Return type:

str

Returns:

the current object status

get_status(cache=True, propagate=1)

Returns the status for this object. If cache is True (default) it returns the current status stored in cache (it will force an update if cache is empty). If propagate > 0 and if the status changed since last read, it will propagate the status event to all listeners.

Parameters:

• cache (bool) – tells if return value from local cache or update from HW read [default: True]

• propagate (int) – if > 0 propagates the event in case it changed since last HW read. Values bigger that mean the event if sent should be a priority event [default: 1]

Return type:

str

Returns:

the current object status

set_status(status, propagate=1)

put_status(status)

property status: str

element status

calculate_state_info(status_info=None)

Transforms the given state information. This specific base implementation transforms the given state,status tuple into a state, new_status tuple where new_status is “self.name is state plus the given status. It is assumed that the given status comes directly from the controller status information.

Parameters:

status_info (Optional[Tuple[State, str]]) – given status information [default: None, meaning use current state status.

Return type:

Tuple[State, str]

Returns:

a transformed state information

set_state_info(state_info, propagate=1, safe=False)

read_state_info()

put_state_info(state_info)

get_default_attribute()

get_default_acquisition_channel()

stop()

was_stopped()

abort()

was_aborted()

release()

was_released()

was_interrupted()

Tells if action ended by an abort or stop

is_action_running()

Determines if the element action is running or not.

is_in_operation()

Returns True if this element is involved in any operation

is_in_local_operation()

get_operation()

set_operation(operation)

clear_operation()

PoolElement

class PoolElement(**kwargs)

Bases: PoolBaseElement

A Pool element is an Pool object which is controlled by a controller. Therefore it contains a _ctrl_id and a _axis (the id of the element in the controller).

serialize(*args, **kwargs)

get_parent()

Returns this pool object parent.

Returns:

this objects parent

get_controller()

get_controller_id()

get_axis()

is_deleted()

set_deleted(deleted)

set_action_cache(action_cache)

get_source()

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 (Optional[Dict[str, Any]]) – map of attribute names and values

Return type:

None

get_dependent_elements()

Get elements which depend on this element.

Get elements e.g. pseudo elements or groups, which depend on this element.

Return type:

Sequence[PoolBaseElement]

Returns:

dependent elements

has_dependent_elements()

get_instrument()

set_instrument(instrument, propagate=1)

stop()

abort()

get_par(name)

set_par(name, value)

get_extra_par(name)

set_extra_par(name, value)

property axis

element axis

property controller

element controller

property controller_id

element controller id

property instrument

element instrument

property deleted

element is deleted from pool (experimental API)