ConfigOptionSpec

class ansys.dpf.core.operator_specification.ConfigOptionSpec(name: str, type_names: list, default_value_str: str, document: str)

Documentation of a configuration option available for a given Operator.

(ansys.dpf.core.Operator)

name

Name of the Configuration Option.

Type:

str

type_names

List of accepted types.

Type:

list[str]

default_value_str

Gives the stringified value of the default.

Type:

str

document

Documents the Configuration Option.

Type:

str

Examples

>>> from ansys.dpf import core as dpf
>>> operator = dpf.operators.math.add()
>>> config_spec = operator.specification.config_specification
>>> config_spec.keys()
dict_keys(['binary_operation', 'inplace', 'mutex', 'num_threads', 'permissive',     'run_in_parallel', 'use_cache', 'work_by_index'])
>>> config_spec['inplace']
ConfigOptionSpec(name='inplace', type_names=['bool'], default_value_str='false',     document='The output is written over the input to save memory if this config is set to true.')

Overview

Attributes

name
type_names
default_value_str
document

Special methods

__repr__

Provide more detail in the representation of the instance.

Import detail

from ansys.dpf.core.operator_specification import ConfigOptionSpec

Attribute detail

ConfigOptionSpec.name: str

ConfigOptionSpec.type_names: list

ConfigOptionSpec.default_value_str: str

ConfigOptionSpec.document: str

Method detail

ConfigOptionSpec.__repr__()

Provide more detail in the representation of the instance.