ReferenceProperty

class ReferenceProperty(element_id: ansys.api.modelcenter.v0.element_messages_pb2.ElementId, name: str, engine: ansys.modelcenter.workflow.grpc_modelcenter.engine.Engine)

Bases: ReferencePropertyBase, ansys.modelcenter.workflow.api.IReferenceProperty

Represents a reference property.

Overview

Methods

get_state	Get the state of the property.
set_state	Set the state of the property.

Import detail

from ansys.modelcenter.workflow.grpc_modelcenter.reference_property import ReferenceProperty

Method detail

ReferenceProperty.get_state() → ansys.tools.variableinterop.VariableState

Get the state of the property.

The returned state may be invalid. The engine does not attempt to run the workflow to validate the property.

Returns:

atvi.VariableState

State of the property.

ReferenceProperty.set_state(new_state: ansys.tools.variableinterop.VariableState) → None

Set the state of the property.

Parameters:

new_stateatvi.VariableState

New state of the property.