find_nodes_by_name

abstractmethod System.find_nodes_by_name(name: str, search_depth: int = 1) → Tuple[Node, ...]

Find nodes in the system with a specified name.

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

Parameters:

namestr

Name 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:

Tuple[Node, …]

Tuple of nodes with the specified name.

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.