InputsSetAttribute#

class ansys.dpf.core.operators.utility.set_attribute.InputsSetAttribute(op: ansys.dpf.core.dpf_operator.Operator)#

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to set_attribute operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.set_attribute()
>>> my_fields_container = dpf.FieldsContainer()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> my_property_name = str()
>>> op.inputs.property_name.connect(my_property_name)
>>> my_property_identifier = dict()
>>> op.inputs.property_identifier.connect(my_property_identifier)

Overview#

connect

Connect any input (an entity or an operator output) to any input pin of this operator.

fields_container

Allows to connect fields_container input to the operator.

property_name

Allows to connect property_name input to the operator.

property_identifier

Allows to connect property_identifier input to the operator.

__str__

__call__

__getitem__

Import detail#

from ansys.dpf.core.operators.utility.set_attribute import InputsSetAttribute

Property detail#

property InputsSetAttribute.fields_container: ansys.dpf.core.inputs.Input[ansys.dpf.core.fields_container.FieldsContainer]#

Allows to connect fields_container input to the operator.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.set_attribute()
>>> op.inputs.fields_container.connect(my_fields_container)
>>> # or
>>> op.inputs.fields_container(my_fields_container)
property InputsSetAttribute.property_name: ansys.dpf.core.inputs.Input[str]#

Allows to connect property_name input to the operator.

Supported property names are: “labels”, “base_name”, “field_names”.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.set_attribute()
>>> op.inputs.property_name.connect(my_property_name)
>>> # or
>>> op.inputs.property_name(my_property_name)
property InputsSetAttribute.property_identifier: ansys.dpf.core.inputs.Input[dict | str | ansys.dpf.core.string_field.StringField]#

Allows to connect property_identifier input to the operator.

Value of the property to be set: vector of string or LabelSpace for “labels”, a result name string for “base_name” (sets the container name and renames all fields with time/complex/label suffixes), a StringField for “field_names” to manually set the field names.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.set_attribute()
>>> op.inputs.property_identifier.connect(my_property_identifier)
>>> # or
>>> op.inputs.property_identifier(my_property_identifier)

Method detail#

InputsSetAttribute.__str__()#
InputsSetAttribute.connect(inpt)#

Connect any input (an entity or an operator output) to any input pin of this operator.

Searches for the input type corresponding to the output.

Deprecated since version Deprecated: in favor of explicit output-to-input connections.

InputsSetAttribute.__call__(inpt)#
InputsSetAttribute.__getitem__(item) → Input#