poolgroupelement
This module is part of the Python Pool library. It defines the base classes for
Classes
PoolBaseGroup
- class PoolBaseGroup(**kwargs)[source]
Bases:
PoolContainer- get_user_element_ids()[source]
Returns the sequence of user element IDs
- Return type:
Sequence[int]- Returns:
the sequence of user element IDs
- property user_element_ids: Sequence[int]
Returns the sequence of user element IDs
- Returns:
the sequence of user element IDs
- get_user_elements()[source]
Returns the sequence of user elements
- Return type:
Sequence[PoolElement]- Returns:
the sequence of user elements
- get_user_elements_attribute_iterator()[source]
Returns an iterator over the main attribute of each user element.
- Return type:
Iterator[SardanaAttribute]- Returns:
an iterator over the main attribute of each user element.
- get_user_elements_attribute()
Returns an iterator over the main attribute of each user element.
- Return type:
Iterator[SardanaAttribute]- Returns:
an iterator over the main attribute of each user element.
- get_user_elements_attribute_sequence()[source]
Returns a sequence of main attribute of each user element.
In loops use preferably
get_user_elements_attribute_iterator()for performance and memory reasons.- Return type:
Sequence[SardanaAttribute]- Returns:
a sequence of main attribute of each user element.
- get_user_elements_attribute_map()[source]
Returns a dictionary of main attribute of each user element.
- Return type:
Dict[PoolElement,SardanaAttribute]- Returns:
a dictionary of main attribute of each user element.
- get_physical_elements()[source]
Returns a dictionary or physical elements where key is a controller object and value is a sequence of pool elements
- Return type:
Dict[PoolController,Sequence[PoolElement]]- Returns:
a dictionary of physical elements
- get_physical_elements_iterator()[source]
Returns an iterator over the physical elements.
Warning
The order is non deterministic.
- Return type:
Iterator[PoolElement]- Returns:
an iterator over the physical elements.
- get_physical_elements_attribute_iterator()[source]
Returns an iterator over the main attribute of each physical element.
Warning
The order is non deterministic.
- Return type:
Iterator[SardanaAttribute]- Returns:
an iterator over the main attribute of each physical element.
PoolGroupElement
- class PoolGroupElement(**kwargs)[source]
Bases:
PoolBaseElement,PoolBaseGroup