InputsMakeLabelSpace#

class ansys.dpf.core.operators.utility.make_label_space.InputsMakeLabelSpace(op: ansys.dpf.core.dpf_operator.Operator)#

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to make_label_space operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_label_space()
>>> my_base_label = dict()
>>> op.inputs.base_label.connect(my_base_label)
>>> my_label_name = str()
>>> op.inputs.label_name.connect(my_label_name)
>>> my_label_value1 = int()
>>> op.inputs.label_value1.connect(my_label_value1)
>>> my_label_value2 = int()
>>> op.inputs.label_value2.connect(my_label_value2)

Overview#

connect

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

base_label

Allows to connect base_label input to the operator.

label_name

Allows to connect label_name input to the operator.

label_value1

Allows to connect label_value1 input to the operator.

label_value2

Allows to connect label_value2 input to the operator.

__str__

__call__

__getitem__

Import detail#

from ansys.dpf.core.operators.utility.make_label_space import InputsMakeLabelSpace

Property detail#

property InputsMakeLabelSpace.base_label: ansys.dpf.core.inputs.Input[dict | ansys.dpf.core.fields_container.FieldsContainer | ansys.dpf.core.scopings_container.ScopingsContainer]#

Allows to connect base_label input to the operator.

Used as a base label (extracted from Fields/Scoping Container, or directly from Label Space) that is concatenated with provided values.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.make_label_space()
>>> op.inputs.base_label.connect(my_base_label)
>>> # or
>>> op.inputs.base_label(my_base_label)
property InputsMakeLabelSpace.label_name: ansys.dpf.core.inputs.Input[str]#

Allows to connect label_name 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_label_space()
>>> op.inputs.label_name.connect(my_label_name)
>>> # or
>>> op.inputs.label_name(my_label_name)
property InputsMakeLabelSpace.label_value1: ansys.dpf.core.inputs.Input[int]#

Allows to connect label_value1 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_label_space()
>>> op.inputs.label_value1.connect(my_label_value1)
>>> # or
>>> op.inputs.label_value1(my_label_value1)
property InputsMakeLabelSpace.label_value2: ansys.dpf.core.inputs.Input[int]#

Allows to connect label_value2 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_label_space()
>>> op.inputs.label_value2.connect(my_label_value2)
>>> # or
>>> op.inputs.label_value2(my_label_value2)

Method detail#

InputsMakeLabelSpace.__str__()#
InputsMakeLabelSpace.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.

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