core.base_ua_object.BaseUaObject

class documentation

class BaseUaObject(Generic[_ServerType]):

Base class for all UA objects, both client- and server-side.

Method	`__init__`	Cooperative constructor.
Method	`parent.setter`	Set the parent of the UA object. Given `parent` must be an instance of `BaseUaObject`.
Method	`server.setter`	Undocumented
Method	`ua_node.setter`	Set main OPC UA node to an existing node (due to XML import, etc.). Only possible once.
Property	`full_name`	Undocumented
Property	`logger`	Logger associated with the `UaObject` instance.
Property	`name`	Name of the object.
Property	`parent`	Return the untyped parent of the UA object.
Property	`path`	Return the full path of the object.
Property	`server`	Return the associated server.
Property	`ua_node`	Return the internal OPC UA node.
Instance Variable	`_logger`	Undocumented
Instance Variable	`_name`	Undocumented
Instance Variable	`_parent`	Undocumented
Instance Variable	`_server`	Undocumented
Instance Variable	`_ua_node`	Undocumented

def __init__(self, *, name: str | None = None, server: _ServerType | None = None, parent: BaseUaObject[_ServerType] | None = None, **kwargs): ¶

Cooperative constructor.

Parameters
name:`str \| None`	The name of the UA object. Defaults to the class name.
server:`_ServerType \| None`	The associated server of the UA object. Note that there must be at least one non `None` in the hierarchy.
parent:`BaseUaObject[_ServerType] \| None`	The parent of the UA object. Only Machines are allowed to have no parent. Can be set later before asynchronous initialization.
**kwargs	Undocumented

def parent(self, parent: BaseUaObject[_ServerType]): ¶

Set the parent of the UA object. Given parent must be an instance of BaseUaObject.

def server(self, server: _ServerType): ¶

Undocumented

def ua_node(self, ua_node: Node): ¶

Set main OPC UA node to an existing node (due to XML import, etc.). Only possible once.

@property
@deprecated('Use path instead')

full_name: str = ¶

Undocumented

@property

logger: BoundLogger = ¶

Logger associated with the UaObject instance.

@property

name: str = ¶

Name of the object.

@property

parent: BaseUaObject[_ServerType] | None = ¶

Return the untyped parent of the UA object.

@property

path: PurePosixPath = ¶

Return the full path of the object.

@property

server: _ServerType = ¶

Return the associated server.

@property

ua_node: Node = ¶

Return the internal OPC UA node.

_logger: structlog.BoundLogger = ¶

Undocumented

_name: str = ¶

Undocumented

_parent: BaseUaObject[_ServerType] | None = ¶

Undocumented

_server: _ServerType | None = ¶

Undocumented

_ua_node: Node | None = ¶

Undocumented