InputsMergeCollections

class ansys.dpf.core.operators.utility.merge_collections.InputsMergeCollections(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to merge_collections operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_collections()
>>> my_collections1 = dpf.AnyCollection()
>>> op.inputs.collections1.connect(my_collections1)
>>> my_collections2 = dpf.AnyCollection()
>>> op.inputs.collections2.connect(my_collections2)

Overview

Methods

connect

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

Properties

collections1	Allows to connect collections1 input to the operator.
collections2	Allows to connect collections2 input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.merge_collections import InputsMergeCollections

Property detail

property InputsMergeCollections.collections1: ansys.dpf.core.inputs.Input

Allows to connect collections1 input to the operator.

a vector of collections to merge or collections from pin 0 to …

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_collections()
>>> op.inputs.collections1.connect(my_collections1)
>>> # or
>>> op.inputs.collections1(my_collections1)

property InputsMergeCollections.collections2: ansys.dpf.core.inputs.Input

Allows to connect collections2 input to the operator.

a vector of collections to merge or collections from pin 0 to …

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.merge_collections()
>>> op.inputs.collections2.connect(my_collections2)
>>> # or
>>> op.inputs.collections2(my_collections2)

Method detail

InputsMergeCollections.__str__()

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

InputsMergeCollections.__call__(inpt)

InputsMergeCollections.__getitem__(item) → Input