InputsMakeForEachRange

class ansys.dpf.core.operators.utility.make_for_each_range.InputsMakeForEachRange(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to make_for_each_range operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_for_each_range()
>>> my_try_generate_iterable = bool()
>>> op.inputs.try_generate_iterable.connect(my_try_generate_iterable)
>>> my_iterable = dpf.()
>>> op.inputs.iterable.connect(my_iterable)
>>> my_operator_to_iterate = dpf.Operator()
>>> op.inputs.operator_to_iterate.connect(my_operator_to_iterate)
>>> my_pin_index = int()
>>> op.inputs.pin_index.connect(my_pin_index)
>>> my_valueA = dpf.()
>>> op.inputs.valueA.connect(my_valueA)
>>> my_valueB = dpf.()
>>> op.inputs.valueB.connect(my_valueB)
>>> my_valueC1 = dpf.()
>>> op.inputs.valueC1.connect(my_valueC1)
>>> my_valueC2 = dpf.()
>>> op.inputs.valueC2.connect(my_valueC2)

Overview

Methods

connect

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

Properties

try_generate_iterable	Allows to connect try_generate_iterable input to the operator.
iterable	Allows to connect iterable input to the operator.
operator_to_iterate	Allows to connect operator_to_iterate input to the operator.
pin_index	Allows to connect pin_index input to the operator.
valueA	Allows to connect valueA input to the operator.
valueB	Allows to connect valueB input to the operator.
valueC1	Allows to connect valueC1 input to the operator.
valueC2	Allows to connect valueC2 input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.make_for_each_range import InputsMakeForEachRange

Property detail

property InputsMakeForEachRange.try_generate_iterable: ansys.dpf.core.inputs.Input[bool]

Allows to connect try_generate_iterable input to the operator.

if true, already iterable values connected in pin 3 like vectors, Scoping, TimefreqSupport, Containers and DataSources are split to iterate on it (default is true)

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_for_each_range()
>>> op.inputs.try_generate_iterable.connect(my_try_generate_iterable)
>>> # or
>>> op.inputs.try_generate_iterable(my_try_generate_iterable)

property InputsMakeForEachRange.iterable: ansys.dpf.core.inputs.Input

Allows to connect iterable input to the operator.

Iterable object, generated by make_for_each_range oeprator, that can be combined with the one currently generated.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_for_each_range()
>>> op.inputs.iterable.connect(my_iterable)
>>> # or
>>> op.inputs.iterable(my_iterable)

property InputsMakeForEachRange.operator_to_iterate: ansys.dpf.core.inputs.Input[ansys.dpf.core.dpf_operator.Operator]

Allows to connect operator_to_iterate input to the operator.

Operator that must be reconnected with the range values.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_for_each_range()
>>> op.inputs.operator_to_iterate.connect(my_operator_to_iterate)
>>> # or
>>> op.inputs.operator_to_iterate(my_operator_to_iterate)

property InputsMakeForEachRange.pin_index: ansys.dpf.core.inputs.Input[int]

Allows to connect pin_index 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.make_for_each_range()
>>> op.inputs.pin_index.connect(my_pin_index)
>>> # or
>>> op.inputs.pin_index(my_pin_index)

property InputsMakeForEachRange.valueA: ansys.dpf.core.inputs.Input

Allows to connect valueA 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.make_for_each_range()
>>> op.inputs.valueA.connect(my_valueA)
>>> # or
>>> op.inputs.valueA(my_valueA)

property InputsMakeForEachRange.valueB: ansys.dpf.core.inputs.Input

Allows to connect valueB 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.make_for_each_range()
>>> op.inputs.valueB.connect(my_valueB)
>>> # or
>>> op.inputs.valueB(my_valueB)

property InputsMakeForEachRange.valueC1: ansys.dpf.core.inputs.Input

Allows to connect valueC1 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.make_for_each_range()
>>> op.inputs.valueC1.connect(my_valueC1)
>>> # or
>>> op.inputs.valueC1(my_valueC1)

property InputsMakeForEachRange.valueC2: ansys.dpf.core.inputs.Input

Allows to connect valueC2 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.make_for_each_range()
>>> op.inputs.valueC2.connect(my_valueC2)
>>> # or
>>> op.inputs.valueC2(my_valueC2)

Method detail

InputsMakeForEachRange.__str__()

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

InputsMakeForEachRange.__call__(inpt)

InputsMakeForEachRange.__getitem__(item) → Input