load

abstractmethod ProxySolverNode.load(args: dict | None = None, run_async: bool = False) → str | None

Explicitly load the node.

Some optiSLang nodes support/need an explicit load prior to being able to register or to make registering more convenient.

Parameters:

args: Optional[dict], optional

Additional arguments, by default None.

run_async: bool, optional

Whether to perform the load as an asynchronous, non-blocking long running operation, returning immediately with the ID of the long running operation instead of waiting for the load 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.

TimeoutError

Raised when the timeout float value expires.