find_node_by_uid

abstract RootSystem.find_node_by_uid(uid: str, search_depth: int = 1) → Node | None

Find a node in the system with a specified unique ID.

This method searches only in the descendant nodes for the current system.

Parameters:

uidstr

Unique ID of the node.

search_depth: int, optional

Depth of the node subtree to search. The default is 1, which corresponds to direct children nodes of the current system. Set to -1 to search throughout the full depth.

Returns:

Optional[Node]

Node with the specified unique ID. If this ID isn’t located in any descendant node, None is returned.

Raises:

OslCommunicationError

Raised when an error occurs while communicating with the server.

OslCommandError

Raised when a command or query fails.

TimeoutError

Raised when the timeout float value expires.

TypeError

Raised when an unknown type of component is found.