finalize

TcpOslServer.finalize(uid: str, run_async: bool = False) → str | None

Finalize the actor defined by uid.

Parameters:

uid: str

Actor uid.

run_async: bool, optional

Whether to perform the finalize 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 finalize 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.