server.ua_variable_containers.UaVariableContainer

class documentation

class UaVariableContainer(UaObject, ParentMixin[UaObject]):

Known subclasses: server.ua_variable_containers.Attributes, server.ua_variable_containers.FinalResultData, server.ua_variable_containers.Identification, server.ua_variable_containers.Monitoring, server.ua_variable_containers.ParameterSet

Constructor: UaVariableContainer(name, minimum_access_level, writable, **kwargs)

View In Hierarchy

Base class for UaVariable containers. Also provides a Pythonic container interface.

Method	`__contains__`	Whether a variable with given `name` exists in this container.
Method	`__getitem__`	Get a `UaVariable` by the given `name`.
Method	`__init__`	Cooperative constructor.
Method	`__iter__`	Iterate over the contained `UaVariable`.
Method	`__len__`	Return the number of contained `UaVariable`.
Async Method	`add`	Add the given `variable` to the container. Can be used to add existing variables to other containers.
Async Method	`read_all`	Read all contained variables and return a mapping from variable name to value.
Async Method	`reset_all`	Reset all contained `UaVariable` to their initial value.
Async Method	`write_all`	Write to all given `mapping` of variables name and their values.
Method	`_check_required_variables`	Check we have all required existing variables based on annotations.
Async Method	`_init_existing_variables`	Undocumented
Async Method	`_lifecycle_container`	Undocumented

def __contains__(self, key: object) -> bool: ¶

Whether a variable with given name exists in this container.

def __getitem__(self, name: str) -> UaVariable: ¶

Get a UaVariable by the given name.

Raises
`KeyError`	If no variable with given name exists.

def __init__(self, *, name: str, minimum_access_level: int | None = None, writable: bool = False, **kwargs): ¶

overridden in server.ua_variable_containers.Attributes, server.ua_variable_containers.FinalResultData, server.ua_variable_containers.Identification, server.ua_variable_containers.Monitoring, server.ua_variable_containers.ParameterSet

Cooperative constructor.

Parameters
name:`str`	The name of the container.
minimum_access_level:`int \| None`	The minimum access level of the container.
writable:`bool`	Whether the all `UaVariable` of this container have external OPC UA write access.
**kwargs	Undocumented

def __iter__(self) -> Iterator[UaVariable]: ¶

Iterate over the contained UaVariable.

def __len__(self) -> int: ¶

Return the number of contained UaVariable.

async def add(self, variable: UaVariable, *, exist_ok: bool = False, remove_existing: bool = False): ¶

Add the given variable to the container. Can be used to add existing variables to other containers.

If the variable is not initialized yet, it will be initialized with this container as parent.

Parameters
variable:`UaVariable`	UaVariable to add to the container.
exist_ok:`bool`	Whether to reuse an existing OPC UA variable node if found during initialization.
remove_existing:`bool`	Whether to remove existing OPC UA variable node if found during initialization.

async def read_all(self) -> Mapping[str, Any]: ¶

Read all contained variables and return a mapping from variable name to value.

async def reset_all(self): ¶

Reset all contained UaVariable to their initial value.

async def write_all(self, mapping: Mapping[str, Any]): ¶

Write to all given mapping of variables name and their values.

Raises
`KeyError`	If no variable with given name in `mapping` exists.
`OutOfRangeError`	if value of `mapping` is not within the range of the corresponding variable.

def _check_required_variables(self, annotations: dict[str, object]): ¶

Check we have all required existing variables based on annotations.

async def _init_existing_variables(self): ¶

Undocumented

@lifecycle

async def _lifecycle_container(self) -> AsyncGenerator[None]: ¶

Undocumented