StringDatapin#

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

Bases: ansys.modelcenter.workflow.grpc_modelcenter.base_datapin.BaseDatapin, ansys.modelcenter.workflow.api.IStringDatapin

Represents a gRPC string datapin on 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

`get_metadata`	Get the metadata for the datapin.
`set_metadata`	Set the standard metadata for the datapin.
`set_state`	Set the state of the datapin.

Special methods

__eq__

Return self==value.

Import detail#

from ansys.modelcenter.workflow.grpc_modelcenter.string_datapin import StringDatapin

Method detail#

StringDatapin.__eq__(other)#: Return self==value.

StringDatapin.get_metadata() → ansys.tools.variableinterop.StringMetadata#: Get the metadata for the datapin.

StringDatapin.set_metadata(new_metadata: ansys.tools.variableinterop.CommonVariableMetadata) → None#: Set the standard metadata for the datapin.

StringDatapin.set_state(state: ansys.tools.variableinterop.VariableState) → None#: Set the state of the datapin.