Class ansys::dpf::OperatorMain
Last update: 25.03.2026
Members
- assertInstantiateInternalOperator
- config
- connectAllInputs
- delegateRun
- getInput
- getInputAsAny
- getInputBool
- getInputCollection
- getInputCustom
- getInputCustomContainer
- getInputCustomTypeField
- getInputCustomTypeFieldsContainer
- getInputDataSources
- getInputDataTree
- getInputDouble
- getInputField
- getInputFieldsContainer
- getInputGenericDataContainer
- getInputInteger
- getInputLabelSpace
- getInputLongLong
- getInputMeshedRegion
- getInputMeshesContainer
- getInputOperator
- getInputPropertyField
- getInputRemoteOperator
- getInputRemoteWorkflow
- getInputScoping
- getInputScopingsContainer
- getInputStreams
- getInputString
- getInputStringField
- getInputSupport
- getInputTimeFreqSupport
- getInputVecDouble
- getInputVecInt
- getInputVecString
- getInputWorkflow
- getNumInputs
- hasInput
- instantiateInternalOperator
- operator=
- operator=
- OperatorMain
- OperatorMain
- OperatorMain
- operatorName
- setFailed
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutput
- setOutputCustom
- setSuccessed
- testInput
- ~OperatorMain
Friends
Friend ConstructHelpers::construct_trait
Public functions
Function OperatorMain
ansys::dpf::OperatorMain::OperatorMain(opaque::DpfOperatorData *)
Parameters:
- opaque::DpfOperatorData *
Return type:
Function ~OperatorMain
ansys::dpf::OperatorMain::~OperatorMain()
Return type:
Function OperatorMain
ansys::dpf::OperatorMain::OperatorMain(OperatorMain const &)=delete
Parameters:
- OperatorMain const &
Return type:
Function OperatorMain
ansys::dpf::OperatorMain::OperatorMain(OperatorMain &&)=delete
Parameters:
- OperatorMain &&
Return type:
Function operator=
OperatorMain & ansys::dpf::OperatorMain::operator=(OperatorMain const &)=delete
Parameters:
- OperatorMain const &
Return type: OperatorMain &
Function operator=
OperatorMain & ansys::dpf::OperatorMain::operator=(OperatorMain &&)=delete
Parameters:
- OperatorMain &&
Return type: OperatorMain &
Function instantiateInternalOperator
Operator ansys::dpf::OperatorMain::instantiateInternalOperator(const std::string &) const
Only method that should be used to instantiate operators inside another Operator run method.
Propagates operator attributes: ansys::dpf::OperatorConfig and licensing settings to the instantiated Operator.
Parameters:
- const std::string &
Return type: Operator
Function assertInstantiateInternalOperator
Operator ansys::dpf::OperatorMain::assertInstantiateInternalOperator(const std::string &) const
Only method that should be used to instantiate operators inside another Operator run method.
Propagates operator attributes: ansys::dpf::OperatorConfig and licensing settings to the instantiated Operator. Exceptions:
- DpfException: when the operator doesn't exist.
Parameters:
- const std::string &
Return type: Operator
Function setSuccessed
void ansys::dpf::OperatorMain::setSuccessed()
Set state of operator to success.
Return type: void
Function setFailed
void ansys::dpf::OperatorMain::setFailed()
Set state of operator to fail.
Return type: void
Function getNumInputs
dp_int ansys::dpf::OperatorMain::getNumInputs()
Returns:
Number of operator input pins.
Return type: dp_int
Function getInput
DataT ansys::dpf::OperatorMain::getInput(dp_index pin_index)
Returns:
Input of type DataT given by pin index.
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: DataT
Function getInputField
Field ansys::dpf::OperatorMain::getInputField(dp_index pin_index)
Returns:
Input field given by pin index.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: Field
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, Field &f)
Set field for output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- Field & f: [in] Field to assign to output pin.
Return type: void
Function getInputDataSources
DataSources ansys::dpf::OperatorMain::getInputDataSources(dp_index pin_index)
Returns:
Data sources for input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: DataSources
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, DataSources const &f)
Set data sources for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- DataSources const & f: [in] Data sources to assign to output pin.
Return type: void
Function getInputFieldsContainer
FieldsContainer ansys::dpf::OperatorMain::getInputFieldsContainer(dp_index pin_index)
Returns:
Fields container for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: FieldsContainer
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, FieldsContainer const &f)
Set fields container for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- FieldsContainer const & f: [in] Fields container to assign to output pin.
Return type: void
Function getInputScoping
Scoping ansys::dpf::OperatorMain::getInputScoping(dp_index pin_index)
Returns:
Scoping for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: Scoping
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, Scoping const &f)
Set scoping for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- Scoping const & f: [in] Scoping to assign to output pin.
Return type: void
Function getInputScopingsContainer
ScopingsContainer ansys::dpf::OperatorMain::getInputScopingsContainer(dp_index pin_index)
Returns:
Scopings container for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: ScopingsContainer
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, ScopingsContainer const &f)
Set scopings container for given input pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- ScopingsContainer const & f: [in] Scopings container to assign to output pin.
Return type: void
Function getInputMeshedRegion
MeshedRegion ansys::dpf::OperatorMain::getInputMeshedRegion(dp_index pin_index)
Returns:
Meshed region for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: MeshedRegion
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, MeshedRegion const &f)
Set meshed region for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- MeshedRegion const & f: [in] Meshed region to assign to output pin.
Return type: void
Function getInputTimeFreqSupport
TimeFreqSupport ansys::dpf::OperatorMain::getInputTimeFreqSupport(dp_index pin_index)
Returns:
Time frequency support for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: TimeFreqSupport
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, TimeFreqSupport const &f)
Set time freqency support for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- TimeFreqSupport const & f: [in] Time frequency support to assign to output pin.
Return type: void
Function getInputMeshesContainer
MeshesContainer ansys::dpf::OperatorMain::getInputMeshesContainer(dp_index pin_index)
Returns:
Meshes container for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: MeshesContainer
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, MeshesContainer const &f)
Set meshes container for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- MeshesContainer const & f: [in] Meshes container to assign to output pin.
Return type: void
Function getInputSupport
Support ansys::dpf::OperatorMain::getInputSupport(dp_index pin_index)
Returns:
Support for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: Support
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, Support const &f)
Set support for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- Support const & f: [in] Support to assign to output pin.
Return type: void
Function getInputStringField
StringField ansys::dpf::OperatorMain::getInputStringField(dp_index pin_index)
Returns:
StringField for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: StringField
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, StringField const &f)
Set StringField object for given output pin with its real type.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- StringField const & f: [in] StringField to assign to output pin.
Return type: void
Function getInputCustomTypeField
CustomTypeField ansys::dpf::OperatorMain::getInputCustomTypeField(dp_index pin_index)
Returns:
CustomTypeField for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: CustomTypeField
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, CustomTypeField const &f)
Set CustomTypeField object for given output pin with its real type.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- CustomTypeField const & f: [in] CustomTypeField to assign to output pin.
Return type: void
Function getInputCustomTypeFieldsContainer
CustomTypeFieldsContainer ansys::dpf::OperatorMain::getInputCustomTypeFieldsContainer(dp_index pin_index)
Returns:
CustomTypeFieldsContainer for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: CustomTypeFieldsContainer
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, CustomTypeFieldsContainer const &f)
Set CustomTypeFieldsContainer object for given output pin with its real type.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- CustomTypeFieldsContainer const & f: [in] CustomTypeFieldsContainer to assign to output pin.
Return type: void
Function getInputAsAny
Any ansys::dpf::OperatorMain::getInputAsAny(dp_index pin_index)
Returns:
Any for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get valuer.
Return type: Any
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, Any const &f)
Set Any object for given output pin with its real type.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- Any const & f: [in] Any to assign to output pin.
Return type: void
Function getInputStreams
Streams ansys::dpf::OperatorMain::getInputStreams(dp_index pin_index)
Returns:
Streams for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: Streams
Function getInputWorkflow
Workflow ansys::dpf::OperatorMain::getInputWorkflow(dp_index pin_index)
Returns:
Workflow for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: Workflow
Function getInputOperator
Operator ansys::dpf::OperatorMain::getInputOperator(dp_index pin_index)
Returns:
Operator for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: Operator
Function getInputRemoteWorkflow
RemoteWorkflow ansys::dpf::OperatorMain::getInputRemoteWorkflow(dp_index pin_index)
Returns:
RemoteWorkflow for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: RemoteWorkflow
Function getInputRemoteOperator
RemoteOperator ansys::dpf::OperatorMain::getInputRemoteOperator(dp_index pin_index)
Returns:
RemoteOperator for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: RemoteOperator
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, Streams const &f)
Set streams for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- Streams const & f: [in] Streams to assign to output pin.
Return type: void
Function getInputLabelSpace
LabelSpace ansys::dpf::OperatorMain::getInputLabelSpace(dp_index pin_index)
Returns:
Streams for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: LabelSpace
Function getInputPropertyField
PropertyField ansys::dpf::OperatorMain::getInputPropertyField(dp_index pin_index)
Returns:
Property field for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: PropertyField
Function getInputGenericDataContainer
GenericDataContainer ansys::dpf::OperatorMain::getInputGenericDataContainer(dp_index pin_index)
Returns:
GenericDataContainer for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: GenericDataContainer
Function getInputCustomContainer
CustomContainerT ansys::dpf::OperatorMain::getInputCustomContainer(dp_index pin_index)
Returns:
GenericDataContainer for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: CustomContainerT
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, GenericDataContainer const &f)
Set GenericDataContainer for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- GenericDataContainer const & f: [in] GenericDataContainer to assign to output pin.
Return type: void
Function getInputCollection
Collection< DataT > ansys::dpf::OperatorMain::getInputCollection(dp_index pin_index)
Returns:
Collection for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: Collection< DataT >
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, Collection< DataT > const &f)
Set GenericDataContainer for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- Collection< DataT > const & f: [in] GenericDataContainer to assign to output pin.
Return type: void
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, PropertyField const &f)
Set property field for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- PropertyField const & f: [in] Property field to assign to output pin.
Return type: void
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, Workflow const &f)
Set property field for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- Workflow const & f: [in] Property field to assign to output pin.
Return type: void
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, MeshInfo const &f)
Set MeshInfo for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- MeshInfo const & f: [in] Mesh info to assign to output pin.
Return type: void
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, ResultInfo const &f)
Set ResultInfo for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- ResultInfo const & f: [in] ResultInfo to assign to output pin.
Return type: void
Function getInputDataTree
DataTree ansys::dpf::OperatorMain::getInputDataTree(dp_index pin_index)
Returns:
DataTree for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: DataTree
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, DataTree const &f)
Set DataTree for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- DataTree const & f: [in] Meshes container to assign to output pin.
Return type: void
Function getInputString
std::string ansys::dpf::OperatorMain::getInputString(dp_index pin_index)
Returns:
String value for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: std::string
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, std::string const &f)
Set string value for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- std::string const & f: [in] String value to assign to output pin.
Return type: void
Function getInputInteger
dp_int ansys::dpf::OperatorMain::getInputInteger(dp_index pin_index)
Returns:
Integer value for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: dp_int
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, dp_int f)
Set integer value for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- dp_int f: [in] Integer value to assign to output pin.
Return type: void
Function getInputDouble
dp_double ansys::dpf::OperatorMain::getInputDouble(dp_index pin_index)
Returns:
Double value for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: dp_double
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, dp_double f)
Set double value for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- dp_double f: [in] Double value to assign to output pin.
Return type: void
Function getInputLongLong
long long int ansys::dpf::OperatorMain::getInputLongLong(dp_index pin_index)
Returns:
Long long int value for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: long long int
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, long long int f)
Set long long int value for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- long long int f: [in] Long long int value to assign to output pin.
Return type: void
Function getInputVecInt
std::vector< int > ansys::dpf::OperatorMain::getInputVecInt(dp_index pin_index)
Returns:
Vector of integers for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: std::vector< int >
Function getInputVecDouble
std::vector< double > ansys::dpf::OperatorMain::getInputVecDouble(dp_index pin_index)
Returns:
Vector of doubles for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: std::vector< double >
Function getInputVecString
std::vector< std::string > ansys::dpf::OperatorMain::getInputVecString(dp_index pin_index)
Returns:
Vector of strings for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: std::vector< std::string >
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, std::vector< int > const &out)
Set vector of integers for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- std::vector< int > const & out: [in] Vector of integers to assign to output pin.
Return type: void
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, std::vector< double > const &out)
Set vector of doubles for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- std::vector< double > const & out: [in] Vector of doubles to assign to output pin.
Return type: void
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, std::vector< std::string > const &out)
Set vector of string for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- std::vector< std::string > const & out: [in] Vector of string to assign to output pin.
Return type: void
Function getInputBool
bool ansys::dpf::OperatorMain::getInputBool(dp_index pin_index)
Returns:
Boolean value for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: bool
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, bool f)
Set boolean value for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- bool f: [in] Boolean value to assign to output pin.
Return type: void
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, RemoteWorkflow const &f)
Set RemoteWorkflow value for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- RemoteWorkflow const & f: [in] RemoteWorkflow value to assign to output pin.
Return type: void
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, RemoteOperator const &f)
Set RemoteOperator value for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- RemoteOperator const & f: [in] RemoteOperator value to assign to output pin.
Return type: void
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, Operator const &f)
Set Operator value for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- Operator const & f: [in] Operator value to assign to output pin.
Return type: void
Function setOutput
void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, CustomContainerBase const &f)
Set CustomContainerBase value for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- CustomContainerBase const & f: [in] Operator value to assign to output pin.
Return type: void
Function delegateRun
void ansys::dpf::OperatorMain::delegateRun(Operator op, bool forwardInputs=true)
run the input op and take its state and outputs as his
Parameters:
- Operator op: [in] Operator to use.
- bool forwardInputs = true : [in] Choose if the input definition of this operator should be given to op.
Return type: void
Function getInputCustom
DataT ansys::dpf::OperatorMain::getInputCustom(dp_index pin_index)
Returns:
Typed data for given input pin.
Parameters:
- dp_index pin_index: [in] Input pin for which to get value.
Return type: DataT
Function setOutputCustom
void ansys::dpf::OperatorMain::setOutputCustom(dp_index pin_index, DataT const &d)
@ details Set typed data for given output pin.
Parameters:
- dp_index pin_index: [in] Output pin for which to set value.
- DataT const & d: [in] Typed data to assign to output pin.
Return type: void
Function testInput
bool ansys::dpf::OperatorMain::testInput(dp_int pin_index)
Returns:
Indication that input pin contains typed data.
Parameters:
- dp_int pin_index: [in] Input pin for which to check data type.
Return type: bool
Function hasInput
bool ansys::dpf::OperatorMain::hasInput(dp_int pin_index)
Returns:
Indication that input pin exists.
Parameters:
- dp_int pin_index: [in] Input pin for which to check data type.
Return type: bool
Function connectAllInputs
void ansys::dpf::OperatorMain::connectAllInputs(ansys::dpf::Operator &op)
@ connects all inputs connected to this operatorMain instance to another Operator
Parameters:
- ansys::dpf::Operator & op: [in] Operator on which the inputs are connected.
Return type: void
Function operatorName
std::string ansys::dpf::OperatorMain::operatorName() const
Returns:
The Operator name used to record.
Return type: std::string
Function config
OperatorConfig ansys::dpf::OperatorMain::config() const
Returns:
The Operator Config used to create this operator.
Return type: OperatorConfig