pyicat_plus.metadata.definitions.IcatFieldGroup#

class pyicat_plus.metadata.definitions.IcatFieldGroup(info, nodes)[source]#

Bases: Mapping

A group of ICAT database items

Parameters:
get(k[, d]) → D[k] if k in D, else d.  d defaults to None.#
get_field_with_field_name(field_name)[source]#
Parameters:

field_name (str)

Return type:

Optional[IcatField]

property info: IcatGroup#
items() → a set-like object providing a view on D's items#
iter_field_names()[source]#
Return type:

Iterable[str]

iter_fields()[source]#
Return type:

Iterable[IcatField]

iter_group_names()[source]#
Return type:

Iterable[str]

iter_groups()[source]#
Return type:

Iterable[IcatFieldGroup]

iter_groups_with_type(categories)[source]#
Parameters:

categories (Union[IcatCategory, str, Iterable[Union[IcatCategory, str]]])

Return type:

Iterable[IcatFieldGroup]

iter_items_with_node_id_suffix(node_id_suffix)[source]#
Parameters:

node_id_suffix (Union[str, Iterable[str]])

Return type:

Iterable[IcatFieldGroup]

keys() → a set-like object providing a view on D's keys#
namespace(getter=None, setter=None, property_decorator=None)[source]#
Parameters:

  • getter (Optional[Callable[[Any, str], Any]])

  • setter (Optional[Callable[[Any, str, Any], None]])

  • property_decorator (Optional[Callable])

Return type:

NamespaceWrapper

valid_field_name(field_name)[source]#
Parameters:

field_name (str)

Return type:

bool

values() → an object providing a view on D's values#