poolelement
This module is part of the Python Pool library. It defines the base classes for
Classes
PoolBaseElement
- class PoolBaseElement(**kwargs)[source]
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)[source]
Acquires the this element lock
- Parameters:
blocking (bool) – whether or not to block if lock is already acquired [default: True]
- property simulation_mode
element simulation mode
- get_state(cache=True, propagate=1)[source]
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:
- Returns:
the current object state
- Return type:
sardana.State
- inspect_state()[source]
Looks at the current cached value of state
- Returns:
the current object state
- Return type:
sardana.State
- property state
element state
- inspect_status()[source]
Looks at the current cached value of status
- Returns:
the current object status
- Return type:
- get_status(cache=True, propagate=1)[source]
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:
- Returns:
the current object status
- Return type:
- property status
element status
- calculate_state_info(status_info=None)[source]
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 (tuple<State, str>) – given status information [default: None, meaning use current state status.
- Returns:
a transformed state information
- Return type:
tuple<State, str>
PoolElement
- class PoolElement(**kwargs)[source]
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).
- init_attribute_values(attr_values=None)[source]
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.
- get_dependent_elements()[source]
Get elements which depend on this element.
Get elements e.g. pseudo elements or groups, which depend on this element.
- Returns:
dependent elements
- Return type:
seq<sardana.pool.poolbaseelement.PoolBaseElement>
- 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)