poolgroupelement
¶
This module is part of the Python Pool library. It defines the base classes for
Classes
PoolBaseGroup¶

-
class
PoolBaseGroup
(**kwargs)[source]¶ Bases:
sardana.pool.poolcontainer.PoolContainer
-
get_user_element_ids
()[source]¶ Returns the sequence of user element IDs
- Returns
the sequence of user element IDs
- Return type
sequence<
int
>
-
property
user_element_ids
¶ Returns the sequence of user element IDs
- Returns
the sequence of user element IDs
- Return type
sequence<
int
>
-
get_user_elements
()[source]¶ Returns the sequence of user elements
- Returns
the sequence of user elements
- Return type
sequence<
PoolElement
>
-
get_user_elements_attribute_iterator
()[source]¶ Returns an iterator over the main attribute of each user element.
- Returns
an iterator over the main attribute of each user element.
- Return type
iter<
SardanaAttribute
>
-
get_user_elements_attribute
()¶ Returns an iterator over the main attribute of each user element.
- Returns
an iterator over the main attribute of each user element.
- Return type
iter<
SardanaAttribute
>
-
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.- Returns
a sequence of main attribute of each user element.
- Return type
sequence<
SardanaAttribute
>
-
get_user_elements_attribute_map
()[source]¶ Returns a dictionary of main attribute of each user element.
- Returns
a dictionary of main attribute of each user element.
- Return type
dict<
PoolElement
,SardanaAttribute
>
-
get_physical_elements
()[source]¶ Returns a dictionary or physical elements where key is a controller object and value is a sequence of pool elements
- Returns
a dictionary of physical elements
- Return type
dict<
PoolElement
>
-
get_physical_elements_iterator
()[source]¶ Returns an iterator over the physical elements.
Warning
The order is non deterministic.
- Returns
an iterator over the physical elements.
- Return type
iter<
PoolElement
>
-
get_physical_elements_attribute_iterator
()[source]¶ Returns an iterator over the main attribute of each physical element.
Warning
The order is non deterministic.
- Returns
an iterator over the main attribute of each physical element.
- Return type
iter<
SardanaAttribute
>
-