Class ansys::dpf::OperatorSpecification
Last update: 25.03.2026
Definition of a new operator.
Inherits from:
Members
- addSupportedConfigOption
- addSupportedConfigOption
- addSupportedConfigOption
- callAPI
- configOptions
- describe
- empty
- getClient
- getDocumentation
- getProperty
- getVersion
- hasBeenMovedLocally
- hasInternalObject
- inputPins
- isOnCommonAPI
- isSameObject
- operator=
- operator=
- OperatorSpecification
- OperatorSpecification
- OperatorSpecification
- outputPins
- setChangelog
- setDocumentation
- setInputPins
- setOutputPins
- setProperty
- setVersion
- ~DpfTypes
- ~OperatorSpecification
Friends
Friend internal::core
Public functions
Function OperatorSpecification
ansys::dpf::OperatorSpecification::OperatorSpecification()
Return type:
Function ~OperatorSpecification
virtual ansys::dpf::OperatorSpecification::~OperatorSpecification()
Return type:
Function OperatorSpecification
ansys::dpf::OperatorSpecification::OperatorSpecification(OperatorSpecification const &)
Parameters:
- OperatorSpecification const &
Return type:
Function OperatorSpecification
ansys::dpf::OperatorSpecification::OperatorSpecification(OperatorSpecification &&) noexcept
Parameters:
- OperatorSpecification &&
Return type:
Function operator=
OperatorSpecification & ansys::dpf::OperatorSpecification::operator=(OperatorSpecification const &)
Parameters:
- OperatorSpecification const &
Return type: OperatorSpecification &
Function operator=
OperatorSpecification & ansys::dpf::OperatorSpecification::operator=(OperatorSpecification &&) noexcept
Parameters:
- OperatorSpecification &&
Return type: OperatorSpecification &
Function inputPins
std::vector< PinDefinition > ansys::dpf::OperatorSpecification::inputPins() const
Gets the currently defined input pins of the operator. Returns:
Vector of input pin definitions.
Return type: std::vector< PinDefinition >
Function outputPins
std::vector< PinDefinition > ansys::dpf::OperatorSpecification::outputPins() const
Gets the currently defined output pins of the operator. Returns:
Vector of output pin definitions.
Return type: std::vector< PinDefinition >
Function setInputPins
void ansys::dpf::OperatorSpecification::setInputPins(std::vector< PinDefinition > const &pins)
Sets the input pin definitions of the operator.
Parameters:
- std::vector< PinDefinition > const & pins: [in] Vector of input pins.
Return type: void
Function setOutputPins
void ansys::dpf::OperatorSpecification::setOutputPins(std::vector< PinDefinition > const &pins)
Sets the output pin definitions of the operator.
Parameters:
- std::vector< PinDefinition > const & pins: [in] Vector of input pins.
Return type: void
Function getDocumentation
std::string ansys::dpf::OperatorSpecification::getDocumentation() const
Returns:
Description of operator.
Return type: std::string
Function setDocumentation
void ansys::dpf::OperatorSpecification::setDocumentation(std::string const &text)
Sets the description of operator.
Parameters:
- std::string const & text: [in] String describing the operator.
Return type: void
Function getProperty
std::string ansys::dpf::OperatorSpecification::getProperty(std::string const &key) const
Returns:
Operator property given by key.
Parameters:
- std::string const & key: [in] Key of property to get.
Return type: std::string
Function setProperty
void ansys::dpf::OperatorSpecification::setProperty(std::string const &key, std::string const &value)
Set property for given key.
Parameters:
- std::string const & key: [in] Key for which to set property.
- std::string const & value: [in] Property value.
Return type: void
Function configOptions
std::vector< ConfigOptionSpecification > ansys::dpf::OperatorSpecification::configOptions() const
Gets the currently defined configuration options specifications. Returns:
Vector of operator configuration option specifications.
Return type: std::vector< ConfigOptionSpecification >
Function addSupportedConfigOption
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:
- std::string const & option_name: [in] @See OperatorConfig::options.
- bool default_value: [in] Default value.
- std::string const & documentation = "" : [in] Description of the config option. If nothing is specified default values will be looked for.
Return type: void
Function addSupportedConfigOption
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:
- std::string const & option_name: [in] @See OperatorConfig::options.
- int default_value: [in] Default value.
- std::string const & documentation = "" : [in] Description of the config option. If nothing is specified default values will be looked for.
Return type: void
Function addSupportedConfigOption
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:
- std::string const & option_name: [in] @See OperatorConfig::options.
- double default_value: [in] Default value.
- std::string const & documentation = "" : [in] Description of the config option. If nothing is specified default values will be looked for.
Return type: void
Function setVersion
void ansys::dpf::OperatorSpecification::setVersion(const SemanticVersion &semver)
Parameters:
- const SemanticVersion & semver
Return type: void
Function getVersion
SemanticVersion ansys::dpf::OperatorSpecification::getVersion() const
Return type: SemanticVersion
Function setChangelog
void ansys::dpf::OperatorSpecification::setChangelog(const Changelog &changelog)
Parameters:
- const Changelog & changelog
Return type: void