InputsTimeFreqSupportGetAttribute

class ansys.dpf.core.operators.metadata.time_freq_support_get_attribute.InputsTimeFreqSupportGetAttribute(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to time_freq_support_get_attribute operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.time_freq_support_get_attribute()
>>> my_time_freq_support = dpf.TimeFreqSupport()
>>> op.inputs.time_freq_support.connect(my_time_freq_support)
>>> my_property_name = str()
>>> op.inputs.property_name.connect(my_property_name)
>>> my_property_identifier = int()
>>> op.inputs.property_identifier.connect(my_property_identifier)
>>> my_property_identifier_2 = int()
>>> op.inputs.property_identifier_2.connect(my_property_identifier_2)

Overview

Methods

connect

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

Properties

time_freq_support	Allows to connect time_freq_support input to the operator.
property_name	Allows to connect property_name input to the operator.
property_identifier	Allows to connect property_identifier input to the operator.
property_identifier_2	Allows to connect property_identifier_2 input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.metadata.time_freq_support_get_attribute import InputsTimeFreqSupportGetAttribute

Property detail

property InputsTimeFreqSupportGetAttribute.time_freq_support: ansys.dpf.core.inputs.Input[ansys.dpf.core.time_freq_support.TimeFreqSupport]

Allows to connect time_freq_support 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.metadata.time_freq_support_get_attribute()
>>> op.inputs.time_freq_support.connect(my_time_freq_support)
>>> # or
>>> op.inputs.time_freq_support(my_time_freq_support)

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

Allows to connect property_name input to the operator.

Supported property names are: “time_freqs”, “imaginary_freqs”, “frequency_tolerance”, “set_id”, “cummulative_index”, “sets_freqs”, “step_id_from_harmonic_index”.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

property InputsTimeFreqSupportGetAttribute.property_identifier: ansys.dpf.core.inputs.Input[int | ansys.dpf.core.scoping.Scoping]

Allows to connect property_identifier input to the operator.

Additional pin for properties “set_id” and “cummulative_index”: the step id, for “sets_freqs”: the sets scoping, for “step_id_from_harmonic_index” : the harmonic index.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.time_freq_support_get_attribute()
>>> op.inputs.property_identifier.connect(my_property_identifier)
>>> # or
>>> op.inputs.property_identifier(my_property_identifier)

property InputsTimeFreqSupportGetAttribute.property_identifier_2: ansys.dpf.core.inputs.Input[int]

Allows to connect property_identifier_2 input to the operator.

Additional pin for properties “set_id” and “cummulative_index”: the substep id (if none, last substep is considered).

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.time_freq_support_get_attribute()
>>> op.inputs.property_identifier_2.connect(my_property_identifier_2)
>>> # or
>>> op.inputs.property_identifier_2(my_property_identifier_2)

Method detail

InputsTimeFreqSupportGetAttribute.__str__()

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

InputsTimeFreqSupportGetAttribute.__call__(inpt)

InputsTimeFreqSupportGetAttribute.__getitem__(item) → Input