    

 ## On this page

  

 

 # Class ansys::dpf::OperatorSpecification

 Last update: 25.03.2026 

<a id="classansys-dpf-operatorspecification"></a>

![](https://img.shields.io/badge/language-C%2B%2B-blue "C++")![](https://img.shields.io/badge/-public-brightgreen "public")

Definition of a new operator.

**Inherits from**:

- [ansys::dpf::DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes)

## Members

- [addSupportedConfigOption](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1ac608a98bb19ea5c878f2424e209f52d8)
- [addSupportedConfigOption](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a69d4382377d7375074fa8da84f5c5732)
- [addSupportedConfigOption](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1adcf58df937bb7bd6b2bb21b849ce7130)
- [callAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aea34d37e0c080126eff70db34bf46597)
- [configOptions](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1ad5b6239b64de0216aae2325f8936611c)
- [describe](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9977945710983bc03d2940fa007847b2)
- [empty](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a39cd546c42518e2332be8f287db95459)
- [getClient](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a968afd9daa0b0f13b65a2ac61369d73a)
- [getDocumentation](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a398ea2f358ea35f62384436d99ca2bbf)
- [getProperty](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a2f4a8c5f7334cbddb79b610d90fe9fc2)
- [getVersion](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a87d6a5e4c061fb356735fbb53ccc50b3)
- [hasBeenMovedLocally](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a1a5634202c15404b6b24e8f50e51cb66)
- [hasInternalObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ae198f89868d85c7db6dc1a934a1d3c15)
- [inputPins](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1ab34a33daaef024443cebecd265786e18)
- [isOnCommonAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9f9789ff61cc9d400a2a344830706b73)
- [isSameObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aa64d5f8fcd7d85ad6ebf708494dbefd7)
- [operator=](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a4c907e7bab1f5a3a606ea51b4848d437)
- [operator=](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a82cdc5f2a8c768c10096e45b6e4a37f6)
- [OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a5ff57b38ca2dff01bf4f62dda841249e)
- [OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a9c474e5a973f7dfb5fdfa84c133a9c4d)
- [OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a87b1c58da59dea93a073ea51534715f6)
- [outputPins](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1af1f0a429df6979e64b52713fc95e981a)
- [setChangelog](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a360172f91b5c055d425e4a0b5c20466c)
- [setDocumentation](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1af2335159650a865b5c7eab060d85da07)
- [setInputPins](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1ac3e45d154d2904aedd470563c8d566b5)
- [setOutputPins](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a5a47b3bacdaf74b6039f73facd30a881)
- [setProperty](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1aa931a524a869f2881c49bfef21f790d0)
- [setVersion](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1ab952e05fe762a0081c24d99bf7bb9158)
- [~DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ab7c83b6ea160c2b115e056f6c312112f)
- [~OperatorSpecification](classansys-dpf-operatorspecification.md#classansys-dpf-operatorspecification-1a80996301dbad63232dd6b9bf90cf944d)

## Friends

<a id="classansys-dpf-operatorspecification-1af3b971156c82470379e0fc202fb6abb3"></a>

### Friend internal::core

![](https://img.shields.io/badge/language-C%2B%2B-blue "C++")![](https://img.shields.io/badge/-public-brightgreen "public")

## Public functions

<a id="classansys-dpf-operatorspecification-1a5ff57b38ca2dff01bf4f62dda841249e"></a>

### Function OperatorSpecification

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::OperatorSpecification::OperatorSpecification()

```

**Return type**:

<a id="classansys-dpf-operatorspecification-1a80996301dbad63232dd6b9bf90cf944d"></a>

### Function ~OperatorSpecification

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
virtual ansys::dpf::OperatorSpecification::~OperatorSpecification()

```

**Return type**:

<a id="classansys-dpf-operatorspecification-1a9c474e5a973f7dfb5fdfa84c133a9c4d"></a>

### Function OperatorSpecification

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::OperatorSpecification::OperatorSpecification(OperatorSpecification const &)

```

**Parameters**:

- OperatorSpecification const &amp;

**Return type**:

<a id="classansys-dpf-operatorspecification-1a87b1c58da59dea93a073ea51534715f6"></a>

### Function OperatorSpecification

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
ansys::dpf::OperatorSpecification::OperatorSpecification(OperatorSpecification &&) noexcept

```

**Parameters**:

- OperatorSpecification &amp;&amp;

**Return type**:

<a id="classansys-dpf-operatorspecification-1a4c907e7bab1f5a3a606ea51b4848d437"></a>

### Function operator=

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
OperatorSpecification & ansys::dpf::OperatorSpecification::operator=(OperatorSpecification const &)

```

**Parameters**:

- OperatorSpecification const &amp;

**Return type**: OperatorSpecification &amp;

<a id="classansys-dpf-operatorspecification-1a82cdc5f2a8c768c10096e45b6e4a37f6"></a>

### Function operator=

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
OperatorSpecification & ansys::dpf::OperatorSpecification::operator=(OperatorSpecification &&) noexcept

```

**Parameters**:

- OperatorSpecification &amp;&amp;

**Return type**: OperatorSpecification &amp;

<a id="classansys-dpf-operatorspecification-1ab34a33daaef024443cebecd265786e18"></a>

### Function inputPins

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
std::vector< PinDefinition > ansys::dpf::OperatorSpecification::inputPins() const

```

Gets the currently defined input pins of the operator. **Returns**:

Vector of input pin definitions.

**Return type**: std::vector&lt; [PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition) &gt;

<a id="classansys-dpf-operatorspecification-1af1f0a429df6979e64b52713fc95e981a"></a>

### Function outputPins

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
std::vector< PinDefinition > ansys::dpf::OperatorSpecification::outputPins() const

```

Gets the currently defined output pins of the operator. **Returns**:

Vector of output pin definitions.

**Return type**: std::vector&lt; [PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition) &gt;

<a id="classansys-dpf-operatorspecification-1ac3e45d154d2904aedd470563c8d566b5"></a>

### Function setInputPins

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::OperatorSpecification::setInputPins(std::vector< PinDefinition > const &pins)

```

Sets the input pin definitions of the operator.

**Parameters**:

- std::vector&lt; [PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition) &gt; const &amp; **pins**: \[in\] Vector of input pins.

**Return type**: void

<a id="classansys-dpf-operatorspecification-1a5a47b3bacdaf74b6039f73facd30a881"></a>

### Function setOutputPins

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::OperatorSpecification::setOutputPins(std::vector< PinDefinition > const &pins)

```

Sets the output pin definitions of the operator.

**Parameters**:

- std::vector&lt; [PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition) &gt; const &amp; **pins**: \[in\] Vector of input pins.

**Return type**: void

<a id="classansys-dpf-operatorspecification-1a398ea2f358ea35f62384436d99ca2bbf"></a>

### Function getDocumentation

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
std::string ansys::dpf::OperatorSpecification::getDocumentation() const

```

**Returns**:

Description of operator.

**Return type**: std::string

<a id="classansys-dpf-operatorspecification-1af2335159650a865b5c7eab060d85da07"></a>

### Function setDocumentation

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::OperatorSpecification::setDocumentation(std::string const &text)

```

Sets the description of operator.

**Parameters**:

- std::string const &amp; **text**: \[in\] String describing the operator.

**Return type**: void

<a id="classansys-dpf-operatorspecification-1a2f4a8c5f7334cbddb79b610d90fe9fc2"></a>

### Function getProperty

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
std::string ansys::dpf::OperatorSpecification::getProperty(std::string const &key) const

```

**Returns**:

[Operator](classansys-dpf-operator.md#classansys-dpf-operator) property given by key.

**Parameters**:

- std::string const &amp; **key**: \[in\] Key of property to get.

**Return type**: std::string

<a id="classansys-dpf-operatorspecification-1aa931a524a869f2881c49bfef21f790d0"></a>

### Function setProperty

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::OperatorSpecification::setProperty(std::string const &key, std::string const &value)

```

Set property for given key.

**Parameters**:

- std::string const &amp; **key**: \[in\] Key for which to set property.
- std::string const &amp; **value**: \[in\] Property value.

**Return type**: void

<a id="classansys-dpf-operatorspecification-1ad5b6239b64de0216aae2325f8936611c"></a>

### Function configOptions

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
std::vector< ConfigOptionSpecification > ansys::dpf::OperatorSpecification::configOptions() const

```

Gets the currently defined configuration options specifications. **Returns**:

Vector of operator configuration option specifications.

**Return type**: std::vector&lt; [ConfigOptionSpecification](structansys-dpf-configoptionspecification.md#structansys-dpf-configoptionspecification) &gt;

<a id="classansys-dpf-operatorspecification-1ac608a98bb19ea5c878f2424e209f52d8"></a>

### Function addSupportedConfigOption

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::OperatorSpecification::addSupportedConfigOption(std::string const &option_name, bool default_value, std::string const &documentation="")

```

Add a supported config option to the operator. @See [OperatorConfig](classansys-dpf-operatorconfig.md#classansys-dpf-operatorconfig)

**Parameters**:

- std::string const &amp; **option\_name**: \[in\] @See [OperatorConfig::options](classansys-dpf-operatorconfig.md#classansys-dpf-operatorconfig-1ae02e4297e6fa9030d1ff3179fefe04b5).
- bool **default\_value**: \[in\] Default value.
- std::string const &amp; **documentation** = "" : \[in\] Description of the config option. If nothing is specified default values will be looked for.

**Return type**: void

<a id="classansys-dpf-operatorspecification-1a69d4382377d7375074fa8da84f5c5732"></a>

### Function addSupportedConfigOption

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::OperatorSpecification::addSupportedConfigOption(std::string const &option_name, int default_value, std::string const &documentation="")

```

Add a supported config option to the operator. @See [OperatorConfig](classansys-dpf-operatorconfig.md#classansys-dpf-operatorconfig)

**Parameters**:

- std::string const &amp; **option\_name**: \[in\] @See [OperatorConfig::options](classansys-dpf-operatorconfig.md#classansys-dpf-operatorconfig-1ae02e4297e6fa9030d1ff3179fefe04b5).
- int **default\_value**: \[in\] Default value.
- std::string const &amp; **documentation** = "" : \[in\] Description of the config option. If nothing is specified default values will be looked for.

**Return type**: void

<a id="classansys-dpf-operatorspecification-1adcf58df937bb7bd6b2bb21b849ce7130"></a>

### Function addSupportedConfigOption

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::OperatorSpecification::addSupportedConfigOption(std::string const &option_name, double default_value, std::string const &documentation="")

```

Add a supported config option to the operator. @See [OperatorConfig](classansys-dpf-operatorconfig.md#classansys-dpf-operatorconfig)

**Parameters**:

- std::string const &amp; **option\_name**: \[in\] @See [OperatorConfig::options](classansys-dpf-operatorconfig.md#classansys-dpf-operatorconfig-1ae02e4297e6fa9030d1ff3179fefe04b5).
- double **default\_value**: \[in\] Default value.
- std::string const &amp; **documentation** = "" : \[in\] Description of the config option. If nothing is specified default values will be looked for.

**Return type**: void

<a id="classansys-dpf-operatorspecification-1ab952e05fe762a0081c24d99bf7bb9158"></a>

### Function setVersion

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::OperatorSpecification::setVersion(const SemanticVersion &semver)

```

**Parameters**:

- const [SemanticVersion](classansys-dpf-semanticversion.md#classansys-dpf-semanticversion) &amp; **semver**

**Return type**: void

<a id="classansys-dpf-operatorspecification-1a87d6a5e4c061fb356735fbb53ccc50b3"></a>

### Function getVersion

![](https://img.shields.io/badge/-public-brightgreen "public")![](https://img.shields.io/badge/-const-lightblue "const")

```cpp
SemanticVersion ansys::dpf::OperatorSpecification::getVersion() const

```

**Return type**: [SemanticVersion](classansys-dpf-semanticversion.md#classansys-dpf-semanticversion)

<a id="classansys-dpf-operatorspecification-1a360172f91b5c055d425e4a0b5c20466c"></a>

### Function setChangelog

![](https://img.shields.io/badge/-public-brightgreen "public")

```cpp
void ansys::dpf::OperatorSpecification::setChangelog(const Changelog &changelog)

```

**Parameters**:

- const [Changelog](classansys-dpf-changelog.md#classansys-dpf-changelog) &amp; **changelog**

**Return type**: void