InputsStreamsProvider

class ansys.dpf.core.operators.metadata.streams_provider.InputsStreamsProvider(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to streams_provider operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.metadata.streams_provider()
>>> 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

data_sources

Allows to connect data_sources input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.metadata.streams_provider import InputsStreamsProvider

Property detail

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

Allows to connect data_sources input to the operator.

Data sources describing one or more result files. Supports single or multiple result keys; may include upstream data sources.

Error conditions when `permissive` config is disabled: - Throws std::runtime_error with message “StreamProvider: empty namespace for result key ‘’” if a result file has no namespace. - Throws std::runtime_error with message “StreamProvider: operator ::stream_provider not found.” if the namespace is not supported. - If all result files are invalid, throws an error even in permissive mode.

Returns:

An Input instance for this pin.

Return type:

input

Examples

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

Method detail

InputsStreamsProvider.__str__()

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

InputsStreamsProvider.__call__(inpt)

InputsStreamsProvider.__getitem__(item) → Input