ReferenceArrayProperty#

class ReferenceArrayProperty(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.IReferenceArrayProperty

Represents a reference array property.

Overview#

set_value_at

Set the state of a particular index.

get_state_at

Get the state of a reference property at a particular index.

Import detail#

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

Method detail#

ReferenceArrayProperty.set_value_at(index: int, new_state: ansys.tools.variableinterop.VariableState) → None#

Set the state of a particular index.

Parameters:
indexint

Index to set the state at.

new_state: atvi.VariableState

New state of the property.

ReferenceArrayProperty.get_state_at(index: int) → ansys.tools.variableinterop.VariableState#

Get the state of a reference property at a particular index.

Parameters:
indexint

Index to get the state at.

Returns:
atvi.VariableState

State of the property at the given index.