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 instantiated Engine instance and use it to get a valid instance of this object.

Overview#

Methods

`break_link`	Break the link.
`suspend`	Suspend the link.
`resume`	Resume the link if it is suspended.
`is_suspended`	Check whether the link is suspended.

Properties

`lhs`	Left-hand side of the link.
`rhs`	Right-hand side (source) of the link equation.

Special methods

`__eq__`	Return self==value.
`__str__`	Return str(self).

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.

property DatapinLink.rhs: str#

Right-hand side (source) of the link equation.

This is a simple equation containing the names of the other datapins that this link depends on.

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.

DatapinLink.resume() → None#

Resume the link if it is suspended.

This method is idempotent. it is safe to call this method multiple times, even if the link is already suspended.

DatapinLink.is_suspended() → bool#

Check whether the link is suspended.

Returns:

bool: True if the link is suspended, and False otherwise.