## On this page

  

 

 # ansys::dpf::OperatorConfig Class Reference

 Last update: 16.07.2025 

`#include <dpf_api.h>`

Inheritance diagram for ansys::dpf::OperatorConfig:

 ![](/sites/default/files/migrate-content/dpf_cpp_client_library_2025_r1_1/classansys_1_1dpf_1_1OperatorConfig.png)



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

 [OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml#a3612c4dc533aa2cce61167723dccb9a9) ([Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client) <a id="a51d61d8a882880bbf6bbece60306ba92" name="a51d61d8a882880bbf6bbece60306ba92"></a> **OperatorConfig** ([OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml) &amp;&amp;) noexcept <a id="ad050600a10a4b6c5abffe8a92715c24e" name="ad050600a10a4b6c5abffe8a92715c24e"></a> **OperatorConfig** ([OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml) const &amp;) <a id="a6775bcdd902b40d67a1a6621000c95a7" name="a6775bcdd902b40d67a1a6621000c95a7"></a>[OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml) &amp; **operator=** ([OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml) const &amp;) <a id="a533a898113954f598ecff282260a1c83" name="a533a898113954f598ecff282260a1c83"></a>[OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml) &amp; **operator=** ([OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml) &amp;&amp;) noexcept int [numOptions](classansys_1_1dpf_1_1OperatorConfig.xhtml#aadd5caf726b8a6298c1b774dd6fd2710) () const std::vector&lt; std::string &gt; [options](classansys_1_1dpf_1_1OperatorConfig.xhtml#ae02e4297e6fa9030d1ff3179fefe04b5) () std::map&lt; std::string, std::string &gt; [optionsAndValues](classansys_1_1dpf_1_1OperatorConfig.xhtml#a1a374278aa4699eb86506544b1c573e1) () void [set](classansys_1_1dpf_1_1OperatorConfig.xhtml#a13fa51659fa378a6f67b344bbb9ea1be) (std::string const &amp;option, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) value) void [set](classansys_1_1dpf_1_1OperatorConfig.xhtml#a0d8e1b93cb98e68d514566a3b8bd15c3) (std::string const &amp;option, [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) value) void [set](classansys_1_1dpf_1_1OperatorConfig.xhtml#ac299a4de0fbf84d4405d35c7bfe0d9f6) (std::string const &amp;option, bool value) int [getIntValue](classansys_1_1dpf_1_1OperatorConfig.xhtml#a01286ef94df39436cb4696d87e606121) (std::string const &amp;option) const double [getDoubleValue](classansys_1_1dpf_1_1OperatorConfig.xhtml#a8401495df9777cc8a53f35ecaca55460) (std::string const &amp;option) const bool [getBoolValue](classansys_1_1dpf_1_1OperatorConfig.xhtml#a3948249196192234ee24269ba8e994b7) (std::string const &amp;option) const bool [hasOption](classansys_1_1dpf_1_1OperatorConfig.xhtml#add327e8dbb91f54919cce1a6966955e6) (std::string const &amp;option) const ![-](/sites/default/files/migrate-content/dpf_cpp_client_library_2025_r1_1/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

used to configure options on how the operator is running.

Examples[OperatorsApis.cpp](OperatorsApis_8cpp-example.xhtml#_a16).

## Constructor &amp; Destructor Documentation

<a id="a3612c4dc533aa2cce61167723dccb9a9" name="a3612c4dc533aa2cce61167723dccb9a9"></a>## [◆ ](#a3612c4dc533aa2cce61167723dccb9a9)OperatorConfig()

 ansys::dpf::OperatorConfig::OperatorConfig  ( [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*)   explicit 

Parameters \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) instance designating the IP, port and protocol to use. 



## Member Function Documentation

<a id="a3948249196192234ee24269ba8e994b7" name="a3948249196192234ee24269ba8e994b7"></a>## [◆ ](#a3948249196192234ee24269ba8e994b7)getBoolValue()

 bool ansys::dpf::OperatorConfig::getBoolValue  ( std::string const &amp;  *option*)  const

ReturnsBoolean value of given option. Parameters \[in\]optionOption name. Examples[OperatorsApis.cpp](OperatorsApis_8cpp-example.xhtml#a18).



<a id="a8401495df9777cc8a53f35ecaca55460" name="a8401495df9777cc8a53f35ecaca55460"></a>## [◆ ](#a8401495df9777cc8a53f35ecaca55460)getDoubleValue()

 double ansys::dpf::OperatorConfig::getDoubleValue  ( std::string const &amp;  *option*)  const

ReturnsDouble value of given option. Parameters \[in\]optionOption name. 



<a id="a01286ef94df39436cb4696d87e606121" name="a01286ef94df39436cb4696d87e606121"></a>## [◆ ](#a01286ef94df39436cb4696d87e606121)getIntValue()

 int ansys::dpf::OperatorConfig::getIntValue  ( std::string const &amp;  *option*)  const

ReturnsInteger value of given option. Parameters \[in\]optionOption name. 



<a id="add327e8dbb91f54919cce1a6966955e6" name="add327e8dbb91f54919cce1a6966955e6"></a>## [◆ ](#add327e8dbb91f54919cce1a6966955e6)hasOption()

 bool ansys::dpf::OperatorConfig::hasOption  ( std::string const &amp;  *option*)  const

ReturnsBoolean value if given optin exists in config. Parameters \[in\]optionOption name. 



<a id="aadd5caf726b8a6298c1b774dd6fd2710" name="aadd5caf726b8a6298c1b774dd6fd2710"></a>## [◆ ](#aadd5caf726b8a6298c1b774dd6fd2710)numOptions()

 int ansys::dpf::OperatorConfig::numOptions  ( )  const

ReturnsNumber of avalable options. 



<a id="ae02e4297e6fa9030d1ff3179fefe04b5" name="ae02e4297e6fa9030d1ff3179fefe04b5"></a>## [◆ ](#ae02e4297e6fa9030d1ff3179fefe04b5)options()

 std::vector&lt; std::string &gt; ansys::dpf::OperatorConfig::options  ( ) 

ReturnsVector of option names. 



<a id="a1a374278aa4699eb86506544b1c573e1" name="a1a374278aa4699eb86506544b1c573e1"></a>## [◆ ](#a1a374278aa4699eb86506544b1c573e1)optionsAndValues()

 std::map&lt; std::string, std::string &gt; ansys::dpf::OperatorConfig::optionsAndValues  ( ) 

ReturnsMap of option and printable values. 



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

 void ansys::dpf::OperatorConfig::set  ( std::string const &amp;  *option*,    bool  *value*   ) 

Sets option to boolean value.

Parameters \[in\]optionOption name. \[in\]valueValue for option. 



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

 void ansys::dpf::OperatorConfig::set  ( std::string const &amp;  *option*,    [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790)  *value*   ) 

Sets option to double value.

Parameters \[in\]optionOption name. \[in\]valueValue for option. 



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

 void ansys::dpf::OperatorConfig::set  ( std::string const &amp;  *option*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *value*   ) 

Sets option to integer value.

Parameters \[in\]optionOption name. \[in\]valueValue for option. Examples[OperatorsApis.cpp](OperatorsApis_8cpp-example.xhtml#a19).