reset

abstractmethod Project.reset(run_async: bool = False) → str | None

Reset the project.

Parameters:

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. 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 the server.

OslCommandError

Raised when a command or query fails.

OslVersionError

Raised when run_async is True and the connected Ansys optiSLang server is older than version 27.1.

TimeoutError

Raised when the timeout float value expires.