evaluate_design

TcpOslServer.evaluate_design(evaluate_dict: Dict[str, float], run_async: bool = False) → List[dict] | str

Evaluate requested design.

Parameters:

evaluate_dict: Dict[str, float]

{‘parName’: value, …}

run_async: bool, optional

Whether to perform the evaluation 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 evaluation 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:

Union[List[dict], str]

Output from optislang server, or the ID of the long running operation if run_async is True.

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.