DatapinLink#
- class DatapinLink(stub: ansys.api.modelcenter.v0.grpc_modelcenter_workflow_pb2_grpc.ModelCenterWorkflowServiceStub, lhs_id: str, rhs: str)#
Bases: ansys.modelcenter.workflow.api.IDatapinLink
Defines a link between the datapins in the workflow.
Note
This class should not be directly instantiated by clients. Get a
Workflow
object from an instantiatedEngine
instance and use it to get a valid instance of this object.
Overview#
Break the link. |
|
Suspend the link. |
|
Resume the link if it is suspended. |
|
Check whether the link is suspended. |
Import detail#
from ansys.modelcenter.workflow.grpc_modelcenter.datapin_link import DatapinLink
Property detail#
- property DatapinLink.lhs: str#
Left-hand side of the link.
The left-hand side receives a value from the right-hand side (analogous to a variable assignment in most languages). This is always a simple datapin name, except in cases where the link target is a single array index, in which case it is the name of the datapin plus an array index.
Method detail#
- DatapinLink.__eq__(other)#
Return self==value.
- DatapinLink.__str__()#
Return str(self).
- DatapinLink.break_link() None #
Break the link.
Breaking the link removes the dependencies between the left-hand and right-hand side of the link. The object becomes invalid and cannot be used after calling this method.
- DatapinLink.suspend() None #
Suspend the link.
Suspending the link causes the engine to behave as if it is not present. This method is idempotent. It is safe to call this method multiple times, even if the link is already suspended.