InputsResultInfoProvider

class ansys.dpf.core.operators.metadata.result_info_provider.InputsResultInfoProvider(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to result_info_provider operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.result_info_provider()
>>> my_streams_container = dpf.StreamsContainer()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)

Overview

Methods

connect

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

Properties

streams_container	Allows to connect streams_container input to the operator.
data_sources	Allows to connect data_sources input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.metadata.result_info_provider import InputsResultInfoProvider

Property detail

property InputsResultInfoProvider.streams_container: ansys.dpf.core.inputs.Input[ansys.dpf.core.streams_container.StreamsContainer]

Allows to connect streams_container input to the operator.

streams (result file container) (optional)

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.result_info_provider()
>>> op.inputs.streams_container.connect(my_streams_container)
>>> # or
>>> op.inputs.streams_container(my_streams_container)

property InputsResultInfoProvider.data_sources: ansys.dpf.core.inputs.Input[ansys.dpf.core.data_sources.DataSources]

Allows to connect data_sources input to the operator.

If the stream is null, retrieves the file path from the data sources.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.result_info_provider()
>>> op.inputs.data_sources.connect(my_data_sources)
>>> # or
>>> op.inputs.data_sources(my_data_sources)

Method detail

InputsResultInfoProvider.__str__()

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

InputsResultInfoProvider.__call__(inpt)

InputsResultInfoProvider.__getitem__(item) → Input