Class ansys::dpf::OperatorConfig
Last update: 25.03.2026
used to configure options on how the operator is running.
Inherits from:
Inner classes
Members
- callAPI
- describe
- empty
- getBoolValue
- getClient
- getDoubleValue
- getIntValue
- hasBeenMovedLocally
- hasInternalObject
- hasOption
- isOnCommonAPI
- isSameObject
- numOptions
- operator=
- operator=
- OperatorConfig
- OperatorConfig
- OperatorConfig
- OperatorConfig
- options
- optionsAndValues
- set
- set
- set
- ~DpfTypes
Friends
Public functions
Function OperatorConfig
ansys::dpf::OperatorConfig::OperatorConfig()
Return type:
Function OperatorConfig
ansys::dpf::OperatorConfig::OperatorConfig(Client const *const client)
Parameters:
Return type:
Function OperatorConfig
ansys::dpf::OperatorConfig::OperatorConfig(OperatorConfig &&) noexcept
Parameters:
- OperatorConfig &&
Return type:
Function OperatorConfig
ansys::dpf::OperatorConfig::OperatorConfig(OperatorConfig const &)
Parameters:
- OperatorConfig const &
Return type:
Function operator=
OperatorConfig & ansys::dpf::OperatorConfig::operator=(OperatorConfig const &)
Parameters:
- OperatorConfig const &
Return type: OperatorConfig &
Function operator=
OperatorConfig & ansys::dpf::OperatorConfig::operator=(OperatorConfig &&) noexcept
Parameters:
- OperatorConfig &&
Return type: OperatorConfig &
Function numOptions
int ansys::dpf::OperatorConfig::numOptions() const
Returns:
Number of avalable options.
Return type: int
Function options
std::vector< std::string > ansys::dpf::OperatorConfig::options()
Returns:
Vector of option names.
Return type: std::vector< std::string >
Function optionsAndValues
std::map< std::string, std::string > ansys::dpf::OperatorConfig::optionsAndValues()
Returns:
Map of option and printable values.
Return type: std::map< std::string, std::string >
Function set
void ansys::dpf::OperatorConfig::set(std::string const &option, dp_int value)
Sets option to integer value.
Parameters:
- std::string const & option: [in] Option name.
- dp_int value: [in] Value for option.
Return type: void
Function set
void ansys::dpf::OperatorConfig::set(std::string const &option, dp_double value)
Sets option to double value.
Parameters:
- std::string const & option: [in] Option name.
- dp_double value: [in] Value for option.
Return type: void
Function set
void ansys::dpf::OperatorConfig::set(std::string const &option, bool value)
Sets option to boolean value.
Parameters:
- std::string const & option: [in] Option name.
- bool value: [in] Value for option.
Return type: void
Function getIntValue
int ansys::dpf::OperatorConfig::getIntValue(std::string const &option) const
Returns:
Integer value of given option.
Parameters:
- std::string const & option: [in] Option name.
Return type: int
Function getDoubleValue
double ansys::dpf::OperatorConfig::getDoubleValue(std::string const &option) const
Returns:
Double value of given option.
Parameters:
- std::string const & option: [in] Option name.
Return type: double
Function getBoolValue
bool ansys::dpf::OperatorConfig::getBoolValue(std::string const &option) const
Returns:
Boolean value of given option.
Parameters:
- std::string const & option: [in] Option name.
Return type: bool
Function hasOption
bool ansys::dpf::OperatorConfig::hasOption(std::string const &option) const
Returns:
Boolean value if given optin exists in config.
Parameters:
- std::string const & option: [in] Option name.
Return type: bool