InputsSetProperty

class ansys.dpf.core.operators.utility.set_property.InputsSetProperty(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to set_property operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.set_property()
>>> my_field = dpf.Field()
>>> op.inputs.field.connect(my_field)
>>> my_property_name = str()
>>> op.inputs.property_name.connect(my_property_name)
>>> my_property = str()
>>> op.inputs.property.connect(my_property)

Overview

Methods

connect

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

Properties

field	Allows to connect field input to the operator.
property_name	Allows to connect property_name input to the operator.
property	Allows to connect property input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.set_property import InputsSetProperty

Property detail

property InputsSetProperty.field: ansys.dpf.core.inputs.Input[ansys.dpf.core.field.Field | ansys.dpf.core.fields_container.FieldsContainer]

Allows to connect field 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_property()
>>> op.inputs.field.connect(my_field)
>>> # or
>>> op.inputs.field(my_field)

property InputsSetProperty.property_name: ansys.dpf.core.inputs.Input[str]

Allows to connect property_name input to the operator.

Property to set. Accepted inputs are specific strings namely: ‘unit’, ‘name’, ‘time_freq_support’, ‘scoping’, ‘header’.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.set_property()
>>> op.inputs.property_name.connect(my_property_name)
>>> # or
>>> op.inputs.property_name(my_property_name)

property InputsSetProperty.property: ansys.dpf.core.inputs.Input[str | ansys.dpf.core.time_freq_support.TimeFreqSupport | ansys.dpf.core.scoping.Scoping | ansys.dpf.core.data_tree.DataTree | int | float]

Allows to connect property input to the operator.

Property Value to set. Accepted inputs on this pin are: CTimeFreqSupport, CScoping, DataTree, int, double, string.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.set_property()
>>> op.inputs.property.connect(my_property)
>>> # or
>>> op.inputs.property(my_property)

Method detail

InputsSetProperty.__str__()

InputsSetProperty.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.

InputsSetProperty.__call__(inpt)

InputsSetProperty.__getitem__(item) → Input