ansys::dpf::OperatorConfig Class Reference
Last update: 16.07.2025#include <dpf_api.h>
Inheritance diagram for ansys::dpf::OperatorConfig:
Public Member Functions | |
| OperatorConfig (Client const *const client) | |
| OperatorConfig (OperatorConfig &&) | |
| OperatorConfig (OperatorConfig const &) | |
| OperatorConfig & | operator= (OperatorConfig const &) |
| OperatorConfig & | operator= (OperatorConfig &&) |
| int | numOptions () const |
| std::vector< std::string > | options () |
| std::map< std::string, std::string > | optionsAndValues () |
| void | set (std::string const &option, dp_int value) |
| void | set (std::string const &option, dp_double value) |
| void | set (std::string const &option, bool value) |
| int | getIntValue (std::string const &option) const |
| double | getDoubleValue (std::string const &option) const |
| bool | getBoolValue (std::string const &option) const |
| bool | hasOption (std::string const &option) const |
 Public Member Functions inherited from ansys::dpf::DpfTypes | |
| virtual bool | empty () const |
| virtual std::string | describe () const |
| so::API const * | callAPI () const |
| bool | isOnCommonAPI () const |
| bool | getClient (Client &client) const |
| bool | hasBeenMovedLocally () const |
| bool | isSameObject (DpfTypes const &rhs) const |
Detailed Description
used to configure options on how the operator is running.
- Examples
- OperatorsApis.cpp.
Constructor & Destructor Documentation
◆ OperatorConfig()
| ansys::dpf::OperatorConfig::OperatorConfig | ( | Client const *const | client | ) |
- Parameters
-
[in] client Client instance designating the IP, port and protocol to use.
Member Function Documentation
◆ getBoolValue()
| bool ansys::dpf::OperatorConfig::getBoolValue | ( | std::string const & | option | ) | const |
◆ getDoubleValue()
| double ansys::dpf::OperatorConfig::getDoubleValue | ( | std::string const & | option | ) | const |
- Returns
- Double value of given option.
- Parameters
-
[in] option Option name.
◆ getIntValue()
| int ansys::dpf::OperatorConfig::getIntValue | ( | std::string const & | option | ) | const |
- Returns
- Integer value of given option.
- Parameters
-
[in] option Option name.
◆ hasOption()
| bool ansys::dpf::OperatorConfig::hasOption | ( | std::string const & | option | ) | const |
- Returns
- Boolean value if given optin exists in config.
- Parameters
-
[in] option Option name.
◆ numOptions()
| int ansys::dpf::OperatorConfig::numOptions | ( | ) | const |
- Returns
- Number of avalable options.
◆ options()
| std::vector< std::string > ansys::dpf::OperatorConfig::options | ( | ) |
- Returns
- Vector of option names.
◆ optionsAndValues()
| std::map< std::string, std::string > ansys::dpf::OperatorConfig::optionsAndValues | ( | ) |
- Returns
- Map of option and printable values.
◆ set() [1/3]
| void ansys::dpf::OperatorConfig::set | ( | std::string const & | option, |
| bool | value | ||
| ) |
Sets option to boolean value.
- Parameters
-
[in] option Option name. [in] value Value for option.
◆ set() [2/3]
| void ansys::dpf::OperatorConfig::set | ( | std::string const & | option, |
| dp_double | value | ||
| ) |
Sets option to double value.
- Parameters
-
[in] option Option name. [in] value Value for option.
◆ set() [3/3]
| void ansys::dpf::OperatorConfig::set | ( | std::string const & | option, |
| dp_int | value | ||
| ) |
Sets option to integer value.
- Parameters
-
[in] option Option name. [in] value Value for option.
- Examples
- OperatorsApis.cpp.
