get_placeholder

abstractmethod Project.get_placeholder(placeholder_id: str) → PlaceholderInfo

Get placeholder information.

Note

Method is supported for Ansys optiSLang version >= 26.1 only.

Parameters:

placeholder_idstr

ID of the placeholder.

Returns:

PlaceholderInfo

Named tuple containing placeholder information with separate fields for placeholder_id, user_level, type, description, range, value, and expression.

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.