InputsSplitInForEachRange

class ansys.dpf.core.operators.utility.split_in_for_each_range.InputsSplitInForEachRange(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to split_in_for_each_range operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.split_in_for_each_range()
>>> 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_scoping = dpf.Scoping()
>>> op.inputs.scoping.connect(my_scoping)
>>> my_chunk_size = int()
>>> op.inputs.chunk_size.connect(my_chunk_size)

Overview

Methods

connect

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

Properties

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.
scoping	Allows to connect scoping input to the operator.
chunk_size	Allows to connect chunk_size input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.split_in_for_each_range import InputsSplitInForEachRange

Property detail

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

Allows to connect iterable input to the operator.

Iterable 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.split_in_for_each_range()
>>> op.inputs.iterable.connect(my_iterable)
>>> # or
>>> op.inputs.iterable(my_iterable)

property InputsSplitInForEachRange.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.split_in_for_each_range()
>>> op.inputs.operator_to_iterate.connect(my_operator_to_iterate)
>>> # or
>>> op.inputs.operator_to_iterate(my_operator_to_iterate)

property InputsSplitInForEachRange.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.split_in_for_each_range()
>>> op.inputs.pin_index.connect(my_pin_index)
>>> # or
>>> op.inputs.pin_index(my_pin_index)

property InputsSplitInForEachRange.scoping: ansys.dpf.core.inputs.Input[ansys.dpf.core.scoping.Scoping]

Allows to connect scoping 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.split_in_for_each_range()
>>> op.inputs.scoping.connect(my_scoping)
>>> # or
>>> op.inputs.scoping(my_scoping)

property InputsSplitInForEachRange.chunk_size: ansys.dpf.core.inputs.Input[int]

Allows to connect chunk_size 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.split_in_for_each_range()
>>> op.inputs.chunk_size.connect(my_chunk_size)
>>> # or
>>> op.inputs.chunk_size(my_chunk_size)

Method detail

InputsSplitInForEachRange.__str__()

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

InputsSplitInForEachRange.__call__(inpt)

InputsSplitInForEachRange.__getitem__(item) → Input