ReferenceDatapin

class ansys.modelcenter.workflow.grpc_modelcenter.reference_datapin.ReferenceDatapin(element_id: ansys.api.modelcenter.v0.element_messages_pb2.ElementId, engine: ansys.modelcenter.workflow.grpc_modelcenter.engine.Engine)

Bases: ReferenceDatapinBase, ansys.modelcenter.workflow.api.IReferenceDatapin

Represents a reference datapin.

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

set_state	Set the state of the datapin.
get_state	Get the state of the datapin.
get_reference_properties	Get the reference properties on the reference datapin.

Properties

equation	Reference equation describing the values that the datapin
is_direct	Flag indicating if the datapin is a direct reference.

Special methods

__eq__

Import detail

from ansys.modelcenter.workflow.grpc_modelcenter.reference_datapin import ReferenceDatapin

Property detail

property ReferenceDatapin.equation: str

Reference equation describing the values that the datapin references.

Returns:

str

Reference equation.

property ReferenceDatapin.is_direct: bool

Flag indicating if the datapin is a direct reference.

Direct reference datapins refer to one specific datapin only. Their equations are just the name of one other datapin. Only direct-reference datapins that refer to a datapin that can be set directly can use the set_state() method to set the referenced datapin.

Returns:

bool

True if the datapin is a direct reference, False otherwise.

Method detail

ReferenceDatapin.__eq__(other)

ReferenceDatapin.set_state(state: ansys.tools.variableinterop.VariableState) → None

Set the state of the datapin.

ReferenceDatapin.get_state(hid: str | None = None) → ansys.tools.variableinterop.VariableState

Get the state of the datapin.

ReferenceDatapin.get_reference_properties() → Mapping[str, ansys.modelcenter.workflow.api.IReferenceProperty]

Get the reference properties on the reference datapin.

Returns:

Mapping[str, IReferencePropertyBase]

Mapping of names to reference properties.