create_placeholder_from_actor_property#

TcpOslServer.create_placeholder_from_actor_property(actor_uid: str, property_name: str, placeholder_id: str | None = None, create_as_expression: bool = False) str#

Create a placeholder from an actor property.

Note

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

Parameters:
actor_uidstr

Unique identifying actor of the object.

property_namestr

Name of the actor property to create placeholder from.

placeholder_idOptional[str], optional

Desired placeholder ID, by default None.

create_as_expressionbool, optional

Whether to create the placeholder as an expression, by default False.

Returns:
str

ID of the created placeholder.

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.