ansys.dpf.core.workflow_topology.ExposedPin#

class ansys.dpf.core.workflow_topology.ExposedPin(container: ansys.dpf.core.generic_data_container.GenericDataContainer)#

Bases: ansys.dpf.core.custom_container_base.CustomContainerBase

Represents an exposed input or output pin in a workflow.

This class provides access to the name and the associated operator, as well as its pin ID.

_name: str | None = None#
_operator: ansys.dpf.core.dpf_operator.Operator | None = None#
_pin_id: int | None = None#
property name: str#

Retrieve the name of the exposed pin.

Returns:

The name of the exposed pin.

Return type:

str

property operator: ansys.dpf.core.dpf_operator.Operator#

Retrieve the operator associated with the exposed pin.

Returns:

The operator associated with this exposed pin.

Return type:

Operator

property pin_id: int#

Retrieve the pin ID of the operator.

Returns:

The pin ID of the operator.

Return type:

int

__str__() str#

Return a string representation of the exposed pin.

This includes the name and associated operator, with its pin ID.

Returns:

String representation of the exposed pin.

Return type:

str