get_input_slot_value

TcpOslServer.get_input_slot_value(uid: str, hid: str, slot_name: str, legacy_design_format: bool = False) → Dict

Get input slot value of actor defined by uid.

Parameters:

uidstr

Actor uid.

hid: str

State/Design hierarchical id.

slot_name: str

Slot name.

legacy_design_format: bool, optional

Whether to use legacy format for designs and design container type slots. Defaults to false.

Note

Argument has effect for Ansys optiSLang version >= 25.2 only.

Returns:

Dict

Input slot value of the actor.

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.