InputsHtmlDoc

class ansys.dpf.core.operators.utility.html_doc.InputsHtmlDoc(op: ansys.dpf.core.dpf_operator.Operator)

Bases: ansys.dpf.core.inputs._Inputs

Intermediate class used to connect user inputs to html_doc operator.

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.html_doc()
>>> my_output_path = str()
>>> op.inputs.output_path.connect(my_output_path)
>>> my_exposure_level = int()
>>> op.inputs.exposure_level.connect(my_exposure_level)

Overview

Methods

connect

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

Properties

output_path	Allows to connect output_path input to the operator.
exposure_level	Allows to connect exposure_level input to the operator.

Special methods

__str__
__call__
__getitem__

Import detail

from ansys.dpf.core.operators.utility.html_doc import InputsHtmlDoc

Property detail

property InputsHtmlDoc.output_path: ansys.dpf.core.inputs.Input[str]

Allows to connect output_path input to the operator.

default is {working directory}/dataProcessingDoc.html

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.html_doc()
>>> op.inputs.output_path.connect(my_output_path)
>>> # or
>>> op.inputs.output_path(my_output_path)

property InputsHtmlDoc.exposure_level: ansys.dpf.core.inputs.Input[int]

Allows to connect exposure_level input to the operator.

Generate the documentation depending on exposure level : 0 (default) for public operators, 1 includes hidden operator, 2 includes private operator, 3 includes operator without specifications.

Returns:

An Input instance for this pin.

Return type:

input

Examples

>>> from ansys.dpf import core as dpf
>>> op = dpf.operators.utility.html_doc()
>>> op.inputs.exposure_level.connect(my_exposure_level)
>>> # or
>>> op.inputs.exposure_level(my_exposure_level)

Method detail

InputsHtmlDoc.__str__()

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

InputsHtmlDoc.__call__(inpt)

InputsHtmlDoc.__getitem__(item) → Input