poolelement
¶
This module is part of the Python Pool library. It defines the base classes for
Classes
PoolBaseElement¶
-
class
PoolBaseElement
(**kwargs)[source]¶ Bases:
sardana.pool.poolobject.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]
-
get_simulation_mode
(cache=True, propagate=1)[source]¶ Returns the simulation mode for this object.
Parameters: Returns: the current simulation mode
Return type:
-
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
-
state
¶ element state
-
inspect_status
()[source]¶ Looks at the current cached value of status
Returns: the current object status Return type: str
-
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:
-
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:
sardana.pool.poolbaseelement.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).
-
get_parent
()[source]¶ Returns this pool object parent.
Returns: this objects parent Return type: SardanaBaseObject
-
axis
¶ element axis
-
controller
¶ element controller
-
controller_id
¶ element controller id
-
instrument
¶ element instrument
-