InputsCustomtypefieldGetAttribute

class ansys.dpf.core.operators.utility.customtypefield_get_attribute.InputsCustomtypefieldGetAttribute(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to customtypefield_get_attribute operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.customtypefield_get_attribute()
>>> my_custom_type_field = dpf.CustomTypeField()
>>> op.inputs.custom_type_field.connect(my_custom_type_field)
>>> my_property_name = str()
>>> op.inputs.property_name.connect(my_property_name)

Overview

Methods

connect

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

Properties

custom_type_field	Allows to connect custom_type_field input to the operator.
property_name	Allows to connect property_name input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.customtypefield_get_attribute import InputsCustomtypefieldGetAttribute

Property detail

property InputsCustomtypefieldGetAttribute.custom_type_field: ansys.dpf.core.inputs.Input[ansys.dpf.core.custom_type_field.CustomTypeField]

Allows to connect custom_type_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.customtypefield_get_attribute()
>>> op.inputs.custom_type_field.connect(my_custom_type_field)
>>> # or
>>> op.inputs.custom_type_field(my_custom_type_field)

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

Allows to connect property_name input to the operator.

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

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

Method detail

InputsCustomtypefieldGetAttribute.__str__()

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

InputsCustomtypefieldGetAttribute.__call__(inpt)

InputsCustomtypefieldGetAttribute.__getitem__(item) → Input