## On this page

  

 

 # ansys::dpf::OperatorSpecification Class Reference

 Last update: 16.07.2025 

`#include <dpf_api.h>`

Inheritance diagram for ansys::dpf::OperatorSpecification:

 ![](/sites/default/files/migrate-content/dpf_cpp_client_library_2024_r2/classansys_1_1dpf_1_1OperatorSpecification.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

<a id="a9c474e5a973f7dfb5fdfa84c133a9c4d" name="a9c474e5a973f7dfb5fdfa84c133a9c4d"></a> **OperatorSpecification** ([OperatorSpecification](classansys_1_1dpf_1_1OperatorSpecification.xhtml) const &amp;) <a id="a87b1c58da59dea93a073ea51534715f6" name="a87b1c58da59dea93a073ea51534715f6"></a> **OperatorSpecification** ([OperatorSpecification](classansys_1_1dpf_1_1OperatorSpecification.xhtml) &amp;&amp;) noexcept <a id="a4c907e7bab1f5a3a606ea51b4848d437" name="a4c907e7bab1f5a3a606ea51b4848d437"></a>[OperatorSpecification](classansys_1_1dpf_1_1OperatorSpecification.xhtml) &amp; **operator=** ([OperatorSpecification](classansys_1_1dpf_1_1OperatorSpecification.xhtml) const &amp;) <a id="a82cdc5f2a8c768c10096e45b6e4a37f6" name="a82cdc5f2a8c768c10096e45b6e4a37f6"></a>[OperatorSpecification](classansys_1_1dpf_1_1OperatorSpecification.xhtml) &amp; **operator=** ([OperatorSpecification](classansys_1_1dpf_1_1OperatorSpecification.xhtml) &amp;&amp;) noexcept std::vector&lt; [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &gt; [inputPins](classansys_1_1dpf_1_1OperatorSpecification.xhtml#ab34a33daaef024443cebecd265786e18) () const std::vector&lt; [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &gt; [outputPins](classansys_1_1dpf_1_1OperatorSpecification.xhtml#af1f0a429df6979e64b52713fc95e981a) () const void [setInputPins](classansys_1_1dpf_1_1OperatorSpecification.xhtml#ac3e45d154d2904aedd470563c8d566b5) (std::vector&lt; [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &gt; const &amp;pins) void [setOutputPins](classansys_1_1dpf_1_1OperatorSpecification.xhtml#a5a47b3bacdaf74b6039f73facd30a881) (std::vector&lt; [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &gt; const &amp;pins) std::string [getDocumentation](classansys_1_1dpf_1_1OperatorSpecification.xhtml#a398ea2f358ea35f62384436d99ca2bbf) () const void [setDocumentation](classansys_1_1dpf_1_1OperatorSpecification.xhtml#af2335159650a865b5c7eab060d85da07) (std::string const &amp;text) std::string [getProperty](classansys_1_1dpf_1_1OperatorSpecification.xhtml#a2f4a8c5f7334cbddb79b610d90fe9fc2) (std::string const &amp;key) const void [setProperty](classansys_1_1dpf_1_1OperatorSpecification.xhtml#aa931a524a869f2881c49bfef21f790d0) (std::string const &amp;key, std::string const &amp;value) std::vector&lt; [ConfigOptionSpecification](structansys_1_1dpf_1_1ConfigOptionSpecification.xhtml) &gt; [configOptions](classansys_1_1dpf_1_1OperatorSpecification.xhtml#ad5b6239b64de0216aae2325f8936611c) () const void [addSupportedConfigOption](classansys_1_1dpf_1_1OperatorSpecification.xhtml#ac608a98bb19ea5c878f2424e209f52d8) (std::string const &amp;option\_name, bool default\_value, std::string const &amp;documentation="") void [addSupportedConfigOption](classansys_1_1dpf_1_1OperatorSpecification.xhtml#a69d4382377d7375074fa8da84f5c5732) (std::string const &amp;option\_name, int default\_value, std::string const &amp;documentation="") void [addSupportedConfigOption](classansys_1_1dpf_1_1OperatorSpecification.xhtml#adcf58df937bb7bd6b2bb21b849ce7130) (std::string const &amp;option\_name, double default\_value, std::string const &amp;documentation="") ![-](/sites/default/files/migrate-content/dpf_cpp_client_library_2024_r2/closed.png) Public Member Functions inherited from [ansys::dpf::DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml)virtual bool [empty](classansys_1_1dpf_1_1DpfTypes.xhtml#a39cd546c42518e2332be8f287db95459) () const virtual bool [hasInternalObject](classansys_1_1dpf_1_1DpfTypes.xhtml#ae198f89868d85c7db6dc1a934a1d3c15) () const virtual std::string [describe](classansys_1_1dpf_1_1DpfTypes.xhtml#a9977945710983bc03d2940fa007847b2) () const so::API const \* [callAPI](classansys_1_1dpf_1_1DpfTypes.xhtml#aea34d37e0c080126eff70db34bf46597) () const bool [isOnCommonAPI](classansys_1_1dpf_1_1DpfTypes.xhtml#a9f9789ff61cc9d400a2a344830706b73) () const bool [getClient](classansys_1_1dpf_1_1DpfTypes.xhtml#a968afd9daa0b0f13b65a2ac61369d73a) ([Client](classansys_1_1dpf_1_1Client.xhtml) &amp;client) const bool [hasBeenMovedLocally](classansys_1_1dpf_1_1DpfTypes.xhtml#a1a5634202c15404b6b24e8f50e51cb66) () const bool [isSameObject](classansys_1_1dpf_1_1DpfTypes.xhtml#aa64d5f8fcd7d85ad6ebf708494dbefd7) ([DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml) const &amp;rhs) const <a id="details" name="details"></a>## Detailed Description

Definition of a new operator.

See also[How-tos](group__group__4__how__tos.xhtml)

## Member Function Documentation

<a id="ac608a98bb19ea5c878f2424e209f52d8" name="ac608a98bb19ea5c878f2424e209f52d8"></a>## [◆ ](#ac608a98bb19ea5c878f2424e209f52d8)addSupportedConfigOption() \[1/3\]

 void ansys::dpf::OperatorSpecification::addSupportedConfigOption  ( std::string const &amp;  *option\_name*,    bool  *default\_value*,    std::string const &amp;  *documentation* = `""`   ) 

Add a supported config option to the operator. @See [OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml)

Parameters \[in\]option\_name@See [OperatorConfig::options](classansys_1_1dpf_1_1OperatorConfig.xhtml#ae02e4297e6fa9030d1ff3179fefe04b5). \[in\]default\_valueDefault value. \[in\]documentationDescription of the config option. If nothing is specified default values will be looked for. 



<a id="adcf58df937bb7bd6b2bb21b849ce7130" name="adcf58df937bb7bd6b2bb21b849ce7130"></a>## [◆ ](#adcf58df937bb7bd6b2bb21b849ce7130)addSupportedConfigOption() \[2/3\]

 void ansys::dpf::OperatorSpecification::addSupportedConfigOption  ( std::string const &amp;  *option\_name*,    double  *default\_value*,    std::string const &amp;  *documentation* = `""`   ) 

Add a supported config option to the operator. @See [OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml)

Parameters \[in\]option\_name@See [OperatorConfig::options](classansys_1_1dpf_1_1OperatorConfig.xhtml#ae02e4297e6fa9030d1ff3179fefe04b5). \[in\]default\_valueDefault value. \[in\]documentationDescription of the config option. If nothing is specified default values will be looked for. 



<a id="a69d4382377d7375074fa8da84f5c5732" name="a69d4382377d7375074fa8da84f5c5732"></a>## [◆ ](#a69d4382377d7375074fa8da84f5c5732)addSupportedConfigOption() \[3/3\]

 void ansys::dpf::OperatorSpecification::addSupportedConfigOption  ( std::string const &amp;  *option\_name*,    int  *default\_value*,    std::string const &amp;  *documentation* = `""`   ) 

Add a supported config option to the operator. @See [OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml)

Parameters \[in\]option\_name@See [OperatorConfig::options](classansys_1_1dpf_1_1OperatorConfig.xhtml#ae02e4297e6fa9030d1ff3179fefe04b5). \[in\]default\_valueDefault value. \[in\]documentationDescription of the config option. If nothing is specified default values will be looked for. 



<a id="ad5b6239b64de0216aae2325f8936611c" name="ad5b6239b64de0216aae2325f8936611c"></a>## [◆ ](#ad5b6239b64de0216aae2325f8936611c)configOptions()

 std::vector&lt; [ConfigOptionSpecification](structansys_1_1dpf_1_1ConfigOptionSpecification.xhtml) &gt; ansys::dpf::OperatorSpecification::configOptions  ( )  const

Gets the currently defined configuration options specifications.

ReturnsVector of operator configuration option specifications. 



<a id="a398ea2f358ea35f62384436d99ca2bbf" name="a398ea2f358ea35f62384436d99ca2bbf"></a>## [◆ ](#a398ea2f358ea35f62384436d99ca2bbf)getDocumentation()

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

ReturnsDescription of operator. 



<a id="a2f4a8c5f7334cbddb79b610d90fe9fc2" name="a2f4a8c5f7334cbddb79b610d90fe9fc2"></a>## [◆ ](#a2f4a8c5f7334cbddb79b610d90fe9fc2)getProperty()

 std::string ansys::dpf::OperatorSpecification::getProperty  ( std::string const &amp;  *key*)  const

Returns[Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") property given by key. Parameters \[in\]keyKey of property to get. 



<a id="ab34a33daaef024443cebecd265786e18" name="ab34a33daaef024443cebecd265786e18"></a>## [◆ ](#ab34a33daaef024443cebecd265786e18)inputPins()

 std::vector&lt; [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &gt; ansys::dpf::OperatorSpecification::inputPins  ( )  const

Gets the currently defined input pins of the operator.

ReturnsVector of input pin definitions. 



<a id="af1f0a429df6979e64b52713fc95e981a" name="af1f0a429df6979e64b52713fc95e981a"></a>## [◆ ](#af1f0a429df6979e64b52713fc95e981a)outputPins()

 std::vector&lt; [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &gt; ansys::dpf::OperatorSpecification::outputPins  ( )  const

Gets the currently defined output pins of the operator.

ReturnsVector of output pin definitions. 



<a id="af2335159650a865b5c7eab060d85da07" name="af2335159650a865b5c7eab060d85da07"></a>## [◆ ](#af2335159650a865b5c7eab060d85da07)setDocumentation()

 void ansys::dpf::OperatorSpecification::setDocumentation  ( std::string const &amp;  *text*) 

Sets the description of operator.

Parameters \[in\]textString describing the operator. 



<a id="ac3e45d154d2904aedd470563c8d566b5" name="ac3e45d154d2904aedd470563c8d566b5"></a>## [◆ ](#ac3e45d154d2904aedd470563c8d566b5)setInputPins()

 void ansys::dpf::OperatorSpecification::setInputPins  ( std::vector&lt; [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &gt; const &amp;  *pins*) 

Sets the input pin definitions of the operator.

Parameters \[in\]pinsVector of input pins. 



<a id="a5a47b3bacdaf74b6039f73facd30a881" name="a5a47b3bacdaf74b6039f73facd30a881"></a>## [◆ ](#a5a47b3bacdaf74b6039f73facd30a881)setOutputPins()

 void ansys::dpf::OperatorSpecification::setOutputPins  ( std::vector&lt; [PinDefinition](structansys_1_1dpf_1_1PinDefinition.xhtml) &gt; const &amp;  *pins*) 

Sets the output pin definitions of the operator.

Parameters \[in\]pinsVector of input pins. 



<a id="aa931a524a869f2881c49bfef21f790d0" name="aa931a524a869f2881c49bfef21f790d0"></a>## [◆ ](#aa931a524a869f2881c49bfef21f790d0)setProperty()

 void ansys::dpf::OperatorSpecification::setProperty  ( std::string const &amp;  *key*,    std::string const &amp;  *value*   ) 

Set property for given key.

Parameters \[in\]keyKey for which to set property. \[in\]valueProperty value.