get_actor_status_info#
- TcpOslServer.get_actor_status_info(uid: str, hid: str, include_designs: bool = True, include_design_values: bool = True, include_non_scalar_design_values: bool = False, include_algorithm_info: bool = False) Dict#
Get status info about actor defined by actor uid and state Hid.
- Parameters:
- uid
str Actor uid.
- hid: str
State/Design hierarchical id.
- include_designs: bool
Include (result) designs in status info response.
- include_design_values: bool
Include values in (result) designs.
- include_non_scalar_design_values: bool
Include non scalar values in (result) designs.
- include_algorithm_info: bool
Include algorithm result info in status info response.
- Returns
- ——-
- Dict
Info about actor defined by uid.
- Raises
- ——
- OslCommunicationError
Raised when an error occurs while communicating with server.
- OslCommandError
Raised when the command or query fails.
- TimeoutError
Raised when the timeout float value expires.
- uid