`CustomConfigOptionSpec`#

class ansys.dpf.core.operator_specification.CustomConfigOptionSpec(option_name: str, default_value, document: str)#

Bases: ConfigOptionSpec

Custom documentation of a configuration option available for a given operator.

Overview#

Attributes

`name`
`type_names`
`default_value_str`
`document`

Special methods

Provide more detail in the representation of the instance.

Import detail#

from ansys.dpf.core.operator_specification import CustomConfigOptionSpec

Attribute detail#

CustomConfigOptionSpec.name: str#

CustomConfigOptionSpec.type_names: list#

CustomConfigOptionSpec.default_value_str: str#

CustomConfigOptionSpec.document: str#

Method detail#

CustomConfigOptionSpec.__repr__()#: Provide more detail in the representation of the instance.