ansys::dpf::OperatorSpecification Class Reference
Last update: 16.07.2025#include <dpf_api.h>
Inheritance diagram for ansys::dpf::OperatorSpecification:
Public Member Functions | |
| OperatorSpecification (OperatorSpecification const &) | |
| OperatorSpecification (OperatorSpecification &&) | |
| OperatorSpecification & | operator= (OperatorSpecification const &) |
| OperatorSpecification & | operator= (OperatorSpecification &&) |
| std::vector< PinDefinition > | inputPins () const |
| std::vector< PinDefinition > | outputPins () const |
| void | setInputPins (std::vector< PinDefinition > const &pins) |
| void | setOutputPins (std::vector< PinDefinition > const &pins) |
| std::string | getDocumentation () const |
| void | setDocumentation (std::string const &text) |
| std::string | getProperty (std::string const &key) const |
| void | setProperty (std::string const &key, std::string const &value) |
| std::vector< ConfigOptionSpecification > | configOptions () const |
| void | addSupportedConfigOption (std::string const &option_name, bool default_value, std::string const &documentation="") |
| void | addSupportedConfigOption (std::string const &option_name, int default_value, std::string const &documentation="") |
| void | addSupportedConfigOption (std::string const &option_name, double default_value, std::string const &documentation="") |
 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
Definition of a new operator.
- See also
- How-tos
Member Function Documentation
◆ addSupportedConfigOption() [1/3]
| 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
- Parameters
-
[in] option_name @See OperatorConfig::options. [in] default_value Default value. [in] documentation Description of the config option. If nothing is specified default values will be looked for.
◆ addSupportedConfigOption() [2/3]
| 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
- Parameters
-
[in] option_name @See OperatorConfig::options. [in] default_value Default value. [in] documentation Description of the config option. If nothing is specified default values will be looked for.
◆ addSupportedConfigOption() [3/3]
| 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
- Parameters
-
[in] option_name @See OperatorConfig::options. [in] default_value Default value. [in] documentation Description of the config option. If nothing is specified default values will be looked for.
◆ configOptions()
| std::vector< ConfigOptionSpecification > ansys::dpf::OperatorSpecification::configOptions | ( | ) | const |
Gets the currently defined configuration options specifications.
- Returns
- Vector of operator configuration option specifications.
◆ getDocumentation()
| std::string ansys::dpf::OperatorSpecification::getDocumentation | ( | ) | const |
- Returns
- Description of operator.
◆ getProperty()
| std::string ansys::dpf::OperatorSpecification::getProperty | ( | std::string const & | key | ) | const |
- Returns
- Operator property given by key.
- Parameters
-
[in] key Key of property to get.
◆ inputPins()
| std::vector< PinDefinition > ansys::dpf::OperatorSpecification::inputPins | ( | ) | const |
Gets the currently defined input pins of the operator.
- Returns
- Vector of input pin definitions.
◆ outputPins()
| std::vector< PinDefinition > ansys::dpf::OperatorSpecification::outputPins | ( | ) | const |
Gets the currently defined output pins of the operator.
- Returns
- Vector of output pin definitions.
◆ setDocumentation()
| void ansys::dpf::OperatorSpecification::setDocumentation | ( | std::string const & | text | ) |
Sets the description of operator.
- Parameters
-
[in] text String describing the operator.
◆ setInputPins()
| void ansys::dpf::OperatorSpecification::setInputPins | ( | std::vector< PinDefinition > const & | pins | ) |
Sets the input pin definitions of the operator.
- Parameters
-
[in] pins Vector of input pins.
◆ setOutputPins()
| void ansys::dpf::OperatorSpecification::setOutputPins | ( | std::vector< PinDefinition > const & | pins | ) |
Sets the output pin definitions of the operator.
- Parameters
-
[in] pins Vector of input pins.
◆ setProperty()
| void ansys::dpf::OperatorSpecification::setProperty | ( | std::string const & | key, |
| std::string const & | value | ||
| ) |
Set property for given key.
- Parameters
-
[in] key Key for which to set property. [in] value Property value.
