reset

TcpOslServer.reset(actor_uid: str | None = None, hid: str | None = None, run_async: bool = False) → str | None

Reset complete project or a specific actor state.

For a complete project reset, do not specify the actor_uid and hid entries.

Parameters:

actor_uid: Optional[str], optional

Actor uid entry. A Hierarchical ID (hid) is required. By default None.

hid: Optional[str], optional

Hid entry. The actor uid is required. By default None.

run_async: bool, optional

Whether to perform the reset as an asynchronous, non-blocking long running operation. If True, this method returns immediately with the ID of the long running operation instead of waiting for the reset to complete. Use get_long_running_operation_status() or wait_for_long_running_operation() to poll for or await its completion. By default False.

Note

Argument is supported for Ansys optiSLang version >= 27.1 only.

Returns:

Optional[str]

ID of the long running operation if run_async is True, None otherwise.

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.