Class ansys::dpf::Operator
Last update: 25.03.2026
Wrap an elementary operation.
The Operator is the main object used to create, transform and stream the data. It can be seen as an integrated circuit in electronics with a range of pins in input and in output. The inputs and outputs attributes are then used to connect the operator with various sources, including other operators, data sources, fields, or provided data.
Inherits from:
Inherited by:
Members
- callAPI
- config
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connect
- connectCustom
- connectOperatorAsInput
- derivate
- describe
- disconnect
- empty
- emptyOperator
- getChangelog
- getClient
- getCustomOutput
- getId
- getOutput
- getOutputAsAny
- getOutputBool
- getOutputBool
- getOutputCustomContainer
- getOutputCustomTypeField
- getOutputCustomTypeField
- getOutputCustomTypeFieldsContainer
- getOutputCustomTypeFieldsContainer
- getOutputCyclicSupport
- getOutputCyclicSupport
- getOutputDataSources
- getOutputDataSources
- getOutputDataTree
- getOutputDataTree
- getOutputDouble
- getOutputDouble
- getOutputDoubleVector
- getOutputDoubleVector
- getOutputField
- getOutputField
- getOutputFieldsContainer
- getOutputFieldsContainer
- getOutputGenericDataContainer
- getOutputGenericDataContainer
- getOutputInt
- getOutputInt
- getOutputIntVector
- getOutputIntVector
- getOutputMapping
- getOutputMapping
- getOutputMeshedRegion
- getOutputMeshedRegion
- getOutputMeshesContainer
- getOutputMeshesContainer
- getOutputMeshInfo
- getOutputMeshInfo
- getOutputOperator
- getOutputPropertyField
- getOutputPropertyField
- getOutputResultInfo
- getOutputResultInfo
- getOutputScoping
- getOutputScoping
- getOutputScopingsContainer
- getOutputScopingsContainer
- getOutputStreams
- getOutputStreams
- getOutputString
- getOutputString
- getOutputStringField
- getOutputStringField
- getOutputSupport
- getOutputSupport
- getOutputTimeFreqSupport
- getOutputTimeFreqSupport
- getOutputWorkflow
- getOutputWorkflow
- getRemoteId
- hasBeenMovedLocally
- hasInternalObject
- hasOutputWhenEvaluated
- invalidate
- isOnCommonAPI
- isSameObject
- name
- Operator
- Operator
- Operator
- Operator
- Operator
- Operator
- Operator
- Operator
- operator=
- operator=
- run
- status
- ~DpfTypes
- ~Operator
Friends
Friend ConstructHelpers::construct_trait
Public functions
Function Operator
ansys::dpf::Operator::Operator()
Return type:
Function Operator
ansys::dpf::Operator::Operator(std::string const &identifier)
Create a new operator with its name. Returns:
empty Operator if identifier is not found. Use ansys::dpf::core::assertInstantiate for safer usage.
Parameters:
- std::string const & identifier: [in] Name of operator.
Return type:
Function Operator
ansys::dpf::Operator::Operator(std::string const &identifier, OperatorConfig const &config)
Create a new operator If the Operator doesn't exist, the created instance is empty. Use ansys::dpf::core::assertInstantiate for safer usage.
Parameters:
- std::string const & identifier: [in] Name of operator.
- OperatorConfig const & config: [in] Additional configuration information.
Return type:
Function Operator
ansys::dpf::Operator::Operator(std::string const &identifier, OperatorConfig const &config, Client const *const client)
Create a new operator If the Operator doesn't exist, the created instance is empty. Use ansys::dpf::core::assertInstantiate for safer usage.
Parameters:
- std::string const & identifier: [in] Name of operator.
- OperatorConfig const & config: [in] Additional configuration information.
- Client const *const client: [in] Client instance designating the IP, port and protocol to use.
Return type:
Function Operator
ansys::dpf::Operator::Operator(std::string const &identifier, Client const *const client)
Create a new operator with its name on a server. If the Operator doesn't exist, the created instance is empty. Use ansys::dpf::core::assertInstantiate for safer usage.
Parameters:
- std::string const & identifier: [in] Name of operator.
- Client const *const client: [in] Client instance designating the IP, port and protocol to use.
Return type:
Function Operator
ansys::dpf::Operator::Operator(int id, Client const *const client)
Retrieve an existing instance of Operator on a server.
Parameters:
- int id: [in] Id of the Operator on the server's database.
- Client const *const client: [in] Client instance designating the IP, port and protocol to use.
Return type:
Function Operator
ansys::dpf::Operator::Operator(Operator &&) noexcept
Parameters:
- Operator &&
Return type:
Function Operator
ansys::dpf::Operator::Operator(Operator const &)
Parameters:
- Operator const &
Return type:
Function operator=
Operator & ansys::dpf::Operator::operator=(Operator const &)
Parameters:
- Operator const &
Return type: Operator &
Function operator=
Operator & ansys::dpf::Operator::operator=(Operator &&) noexcept
Parameters:
- Operator &&
Return type: Operator &
Function ~Operator
virtual ansys::dpf::Operator::~Operator()
Return type:
Function run
void ansys::dpf::Operator::run()
Perform operation.
Return type: void
Function invalidate
void ansys::dpf::Operator::invalidate()
Invalidate results of operation.
Return type: void
Function derivate
Operator ansys::dpf::Operator::derivate()
Generate derivative of current operator and its ancestors.
Return type: Operator
Function status
OperatorState ansys::dpf::Operator::status() const
Return type: OperatorState
Function getId
int ansys::dpf::Operator::getId() const
Return type: int
Function name
std::string ansys::dpf::Operator::name() const
Get name of the operator.
Return type: std::string
Function getChangelog
Changelog ansys::dpf::Operator::getChangelog() const
get operator changelog
Return type: Changelog
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Operator const &op, dp_index output_pin)
Connect operators output_pin to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- Operator const & op: [in] Operator to connect to input pin.
- dp_index output_pin: [in] ouput pin of operator to connect to input_pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(Operator const &op)
Connection operator output pin 0 to input pin 0. Exceptions:
Parameters:
- Operator const & op: [in] Operator whose output pin 0 is connection to input pin 0.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Field const &data)
Connect Field data to input_pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, FieldsContainer const &data)
Connect FieldsContainer data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- FieldsContainer const & data: [in] FieldsContainer data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, ScopingsContainer const &data)
Connect ScopingsContainer data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- ScopingsContainer const & data: [in] ScopingsContainer data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, MeshesContainer const &data)
Connect MeshesContainer data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- MeshesContainer const & data: [in] MeshesContainer data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, DataSources const &data)
Connect DataSources data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- DataSources const & data: [in] DataSources data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, MeshedRegion const &data)
Connect MeshedRegion data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- MeshedRegion const & data: [in] MeshedRegion data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Scoping const &data)
Connect Scoping data to input_pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Streams const &data)
Connect Streams data to input_pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, PropertyField const &data)
Connect PropertyField data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- PropertyField const & data: [in] PropertyField data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Support const &data)
Connect Support data to input_pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, CyclicSupport const &data)
Connect CyclicSupport data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- CyclicSupport const & data: [in] Support data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, TimeFreqSupport const &data)
Connect TimeFreqSupport data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- TimeFreqSupport const & data: [in] TimeFreqSupport data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, StringField const &data)
Connect StringField data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- StringField const & data: [in] StringField data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, CustomTypeField const &data)
Connect CustomTypeField data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- CustomTypeField const & data: [in] CustomTypeField data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, LabelSpace const &data)
Connect LabelSpace data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- LabelSpace const & data: [in] LabelSpace data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, GenericDataContainer const &data)
Connect GenericDataContainer data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- GenericDataContainer const & data: [in] GenericDataContainer data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, CustomContainerBase const &data)
Connect CustomContainerBase data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- CustomContainerBase const & data: [in] CustomContainerBase data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Workflow const &data)
Connect Workflow data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- Workflow const & data: [in] Workflow data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, RemoteWorkflow const &data)
Connect RemoteWorkflow data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- RemoteWorkflow const & data: [in] Workflow data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, ResultInfo const &data)
Connect ResultInfo data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- ResultInfo const & data: [in] ResultInfo data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, CustomTypeFieldsContainer const &data)
Connect CustomTypeFieldsContainer data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- CustomTypeFieldsContainer const & data: [in] CustomTypeFieldsContainer data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Location const &data)
Connect Location data to input_pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, PropertyType const &data)
Connect PropertyTypes data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- PropertyType const & data: [in] PropertyType data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Label const &data)
Connect Label data to input_pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, dp_int data)
Connect integer data to input_pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, bool data)
Connect boolean data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- bool data: [in] Boolean data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, dp_double data)
Connect double data to input_pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, std::string const &data)
Connect string data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- std::string const & data: [in] String data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, std::vector< dp_int > const &data)
Connect vector of integer data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- std::vector< dp_int > const & data: [in] Vector of integer data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, std::vector< dp_double > const &data)
Connect vector of double data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- std::vector< dp_double > const & data: [in] Vector of double data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, std::vector< std::string > const &data)
Connect vecotr of string data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- std::vector< std::string > const & data: [in] Vector of string data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, IAnsDispatch *data)
Connect IAnsDispatch data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- IAnsDispatch * data: [in] IAnsDispatch data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Any const &data)
Connect Any data to input_pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, DataTree const &data)
Connect DataTree data to input_pin. Exceptions:
Parameters:
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, UnitSystem const &data)
Connect UnitSystem data to input_pin. Exceptions:
Parameters:
- dp_index input_pin: [in] Input pin.
- UnitSystem const & data: [in] UnitSystem data to connect to pin.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Collection< DataT > const &data)
Parameters:
- dp_index input_pin: [in] Input pin.
- Collection< DataT > const & data
Return type: void
Function connectOperatorAsInput
void ansys::dpf::Operator::connectOperatorAsInput(dp_index input_pin, Operator const &data)
Connect an Operator instance as an input to input_pin. Exceptions:
Parameters:
Return type: void
Function connectCustom
void ansys::dpf::Operator::connectCustom(dp_index input_pin, DataT const &d)
Connect custom data to input_pin. Exceptions:
Parameters:
- dp_index input_pin
- DataT const & d
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Operator const &op, dp_index output_pin, DpfError &error)
Connect operators output_pin to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- Operator const & op: [in] Operator to connect to input pin.
- dp_index output_pin: [in] ouput pin of operator to connect to input_pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Field const &data, DpfError &error)
Connect Field data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- Field const & data: [in] Field data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, FieldsContainer const &data, DpfError &error)
Connect FieldsContainer data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- FieldsContainer const & data: [in] FieldsContainer data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, ScopingsContainer const &data, DpfError &error)
Connect ScopingsContainer data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- ScopingsContainer const & data: [in] ScopingsContainer data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, MeshesContainer const &data, DpfError &error)
Connect MeshesContainer output_pin to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- MeshesContainer const & data: [in] MeshesContainer data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, DataSources const &data, DpfError &error)
Connect DataSources data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- DataSources const & data: [in] DataSources data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, MeshedRegion const &data, DpfError &error)
Connect MeshedRegion data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- MeshedRegion const & data: [in] MeshedRegion data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Streams const &data, DpfError &error)
Connect Streams data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- Streams const & data: [in] Streams data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Scoping const &data, DpfError &error)
Connect Scoping data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- Scoping const & data: [in] Scoping data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, PropertyField const &data, DpfError &error)
Connect PropertyField data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- PropertyField const & data: [in] PropertyField data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Support const &data, DpfError &error)
Connect Support data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- Support const & data: [in] Support data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, CyclicSupport const &data, DpfError &error)
Connect CyclicSupport data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- CyclicSupport const & data: [in] Support data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, TimeFreqSupport const &data, DpfError &error)
Connect TimeFreqSupport data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- TimeFreqSupport const & data: [in] TimeFreqSupport data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, StringField const &data, DpfError &error)
Connect StringField data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- StringField const & data: [in] StringField data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, CustomTypeField const &data, DpfError &error)
Connect CustomTypeField data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- CustomTypeField const & data: [in] CustomTypeField data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, LabelSpace const &data, DpfError &error)
Connect TimeFreqSupport data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- LabelSpace const & data: [in] LabelSpace data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Workflow const &data, DpfError &error)
Connect Workflow data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- Workflow const & data: [in] Workflow data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, RemoteWorkflow const &data, DpfError &error)
Connect RemoteWorkflow data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- RemoteWorkflow const & data: [in] RemoteWorkflow data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, CustomTypeFieldsContainer const &data, DpfError &error)
Connect CustomTypeFieldsContainer data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- CustomTypeFieldsContainer const & data: [in] CustomTypeFieldsContainer data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, bool data, DpfError &error)
Connect boolean data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- bool data: [in] Boolean data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, dp_int data, DpfError &error)
Connect integer data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- dp_int data: [in] Integer data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, dp_double data, DpfError &error)
Connect double data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- dp_double data: [in] Double data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, std::string const &data, DpfError &error)
Connect string data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- std::string const & data: [in] String data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, std::vector< dp_int > const &data, DpfError &error)
Connect vector of integer data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- std::vector< dp_int > const & data: [in] Vector of integer data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, std::vector< dp_double > const &data, DpfError &error)
Connect vector of double data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- std::vector< dp_double > const & data: [in] vector of double data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, std::vector< std::string > const &data, DpfError &error)
Connect vbector of string data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- std::vector< std::string > const & data: [in] Vector of string data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, IAnsDispatch *data, DpfError &error)
Connect IAnsDispatch data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- IAnsDispatch * data: [in] IAnsDispatch data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, Any const &data, DpfError &error)
Connect Any data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- Any const & data: [in] Any data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, DataTree const &data, DpfError &error)
Connect DataTree data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- DataTree const & data: [in] DataTree data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, GenericDataContainer const &data, DpfError &error)
Connect GenericDataContainer data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- GenericDataContainer const & data: [in] GenericDataContainer data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, CustomContainerBase const &data, DpfError &error)
Connect CustomContainerBase data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- CustomContainerBase const & data: [in] CustomContainerBase data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function connect
void ansys::dpf::Operator::connect(dp_index input_pin, DataT const &data, DpfError &error)
Connect Collection data to input_pin.
Parameters:
- dp_index input_pin: [in] Input pin.
- DataT const & data: [in] CustomContainerBase data to connect to pin.
- DpfError & error: [out] Status of call.
Return type: void
Function getOutputField
Field ansys::dpf::Operator::getOutputField(dp_index pin_index)
Returns:
Field output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: Field
Function getOutputPropertyField
PropertyField ansys::dpf::Operator::getOutputPropertyField(dp_index pin_index)
Returns:
PropertyField output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: PropertyField
Function getOutputScoping
Scoping ansys::dpf::Operator::getOutputScoping(dp_index pin_index)
Returns:
Scoping output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: Scoping
Function getOutputFieldsContainer
FieldsContainer ansys::dpf::Operator::getOutputFieldsContainer(dp_index pin_index)
Returns:
FieldsContainer output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: FieldsContainer
Function getOutputScopingsContainer
ScopingsContainer ansys::dpf::Operator::getOutputScopingsContainer(dp_index pin_index)
Returns:
ScopingsContainer output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: ScopingsContainer
Function getOutputMeshesContainer
MeshesContainer ansys::dpf::Operator::getOutputMeshesContainer(dp_index pin_index)
Returns:
MeshesContainer output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: MeshesContainer
Function getOutputTimeFreqSupport
TimeFreqSupport ansys::dpf::Operator::getOutputTimeFreqSupport(dp_index pin_index)
Returns:
TimeFreqSupport output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: TimeFreqSupport
Function getOutputMeshedRegion
MeshedRegion ansys::dpf::Operator::getOutputMeshedRegion(dp_index pin_index)
Returns:
MeshedRegion output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: MeshedRegion
Function getOutputStreams
Streams ansys::dpf::Operator::getOutputStreams(dp_index pin_index)
Returns:
Streams output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: Streams
Function getOutputResultInfo
ResultInfo ansys::dpf::Operator::getOutputResultInfo(dp_index pin_index)
Returns:
ResultInfo output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: ResultInfo
Function getOutputMapping
Mapping ansys::dpf::Operator::getOutputMapping(dp_index pin_index)
Returns:
Mapping output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: Mapping
Function getOutputDataTree
DataTree ansys::dpf::Operator::getOutputDataTree(dp_index pin_index)
Returns:
DataTree output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: DataTree
Function getOutputWorkflow
Workflow ansys::dpf::Operator::getOutputWorkflow(dp_index pin_index)
Returns:
Workflow output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: Workflow
Function getOutputOperator
Operator ansys::dpf::Operator::getOutputOperator(dp_index pin_index)
Returns:
Operator output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: Operator
Function getOutputSupport
Support ansys::dpf::Operator::getOutputSupport(dp_index pin_index)
Returns:
Support output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: Support
Function getOutputCyclicSupport
CyclicSupport ansys::dpf::Operator::getOutputCyclicSupport(dp_index pin_index)
Returns:
CyclicSupport output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: CyclicSupport
Function getOutputDataSources
DataSources ansys::dpf::Operator::getOutputDataSources(dp_index pin_index)
Returns:
DataSources output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: DataSources
Function getOutputStringField
StringField ansys::dpf::Operator::getOutputStringField(dp_index pin_index)
Returns:
StringField output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: StringField
Function getOutputCustomTypeField
CustomTypeField ansys::dpf::Operator::getOutputCustomTypeField(dp_index pin_index)
Returns:
CustomTypeField output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: CustomTypeField
Function getOutputMeshInfo
MeshInfo ansys::dpf::Operator::getOutputMeshInfo(dp_index pin_index)
Returns:
MeshInfo output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: MeshInfo
Function getOutputGenericDataContainer
GenericDataContainer ansys::dpf::Operator::getOutputGenericDataContainer(dp_index pin_index)
Returns:
GenericDataContainer output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: GenericDataContainer
Function getOutputCustomTypeFieldsContainer
CustomTypeFieldsContainer ansys::dpf::Operator::getOutputCustomTypeFieldsContainer(dp_index pin_index)
Returns:
CustomTypeFieldsContainer output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: CustomTypeFieldsContainer
Function getOutputCustomContainer
CustomContainerT ansys::dpf::Operator::getOutputCustomContainer(dp_index pin_index)
Returns:
CustomContainerBase output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: CustomContainerT
Function getOutputString
std::string ansys::dpf::Operator::getOutputString(dp_index pin_index)
Returns:
String output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: std::string
Function getOutputDouble
dp_double ansys::dpf::Operator::getOutputDouble(dp_index pin_index)
Returns:
Double output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: dp_double
Function getOutputInt
dp_int ansys::dpf::Operator::getOutputInt(dp_index pin_index)
Returns:
Integer output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: dp_int
Function getOutputBool
bool ansys::dpf::Operator::getOutputBool(dp_index pin_index)
Returns:
Boolean output on pin_index.
Exceptions:
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: bool
Function getOutputIntVector
DpfVector< int > ansys::dpf::Operator::getOutputIntVector(dp_index pin_index)
Returns:
Integers vector result as DpfVector for given output pin.
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: DpfVector< int >
Function getOutputDoubleVector
DpfVector< double > ansys::dpf::Operator::getOutputDoubleVector(dp_index pin_index)
Returns:
Doubles vector result as DpfVector for given output pin.
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: DpfVector< double >
Function getOutputAsAny
Any ansys::dpf::Operator::getOutputAsAny(dp_index pin_index)
Returns:
Any result for given output pin.
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: Any
Function getCustomOutput
DataT ansys::dpf::Operator::getCustomOutput(dp_int index)
Returns:
Custom data output on index.
Exceptions:
Parameters:
- dp_int index: [in] Pin from which to get output.
Return type: DataT
Function getOutput
DataT ansys::dpf::Operator::getOutput(dp_index pin_index)
Returns:
Typed result for given output pin.
Parameters:
- dp_index pin_index: [in] Pin from which to get output.
Return type: DataT
Function getOutputField
Field ansys::dpf::Operator::getOutputField(dp_index pin_index, DpfError &error)
Returns:
Field output on pin_index.
Parameters:
Return type: Field
Function getOutputPropertyField
PropertyField ansys::dpf::Operator::getOutputPropertyField(dp_index pin_index, DpfError &error)
Returns:
PropertyField output on pin_index.
Parameters:
Return type: PropertyField
Function getOutputScoping
Scoping ansys::dpf::Operator::getOutputScoping(dp_index pin_index, DpfError &error)
Returns:
Scoping output on pin_index.
Parameters:
Return type: Scoping
Function getOutputFieldsContainer
FieldsContainer ansys::dpf::Operator::getOutputFieldsContainer(dp_index pin_index, DpfError &error)
Returns:
FieldsContainer output on pin_index.
Parameters:
Return type: FieldsContainer
Function getOutputScopingsContainer
ScopingsContainer ansys::dpf::Operator::getOutputScopingsContainer(dp_index pin_index, DpfError &error)
Returns:
ScopingsContainer output on pin_index.
Parameters:
Return type: ScopingsContainer
Function getOutputMeshesContainer
MeshesContainer ansys::dpf::Operator::getOutputMeshesContainer(dp_index pin_index, DpfError &error)
Returns:
MeshesContainer output on pin_index.
Parameters:
Return type: MeshesContainer
Function getOutputTimeFreqSupport
TimeFreqSupport ansys::dpf::Operator::getOutputTimeFreqSupport(dp_index pin_index, DpfError &error)
Returns:
TimeFreqSupport output on pin_index.
Parameters:
Return type: TimeFreqSupport
Function getOutputMeshedRegion
MeshedRegion ansys::dpf::Operator::getOutputMeshedRegion(dp_index pin_index, DpfError &error)
Returns:
MeshedRegion output on pin_index.
Parameters:
Return type: MeshedRegion
Function getOutputStreams
Streams ansys::dpf::Operator::getOutputStreams(dp_index pin_index, DpfError &error)
Returns:
Streams output on pin_index.
Parameters:
Return type: Streams
Function getOutputResultInfo
ResultInfo ansys::dpf::Operator::getOutputResultInfo(dp_index pin_index, DpfError &error)
Returns:
ResultInfo output on pin_index.
Parameters:
Return type: ResultInfo
Function getOutputMapping
Mapping ansys::dpf::Operator::getOutputMapping(dp_index pin_index, DpfError &error)
Returns:
Mapping output on pin_index.
Parameters:
Return type: Mapping
Function getOutputDataTree
DataTree ansys::dpf::Operator::getOutputDataTree(dp_index pin_index, DpfError &error)
Returns:
DataTree output on pin_index.
Parameters:
Return type: DataTree
Function getOutputWorkflow
Workflow ansys::dpf::Operator::getOutputWorkflow(dp_index pin_index, DpfError &error)
Returns:
Workflow output on pin_index.
Parameters:
Return type: Workflow
Function getOutputSupport
Support ansys::dpf::Operator::getOutputSupport(dp_index pin_index, DpfError &error)
Returns:
Support output on pin_index.
Parameters:
Return type: Support
Function getOutputCyclicSupport
CyclicSupport ansys::dpf::Operator::getOutputCyclicSupport(dp_index pin_index, DpfError &error)
Returns:
CyclicSupport output on pin_index.
Parameters:
Return type: CyclicSupport
Function getOutputDataSources
DataSources ansys::dpf::Operator::getOutputDataSources(dp_index pin_index, DpfError &error)
Returns:
DataSources output on pin_index.
Parameters:
Return type: DataSources
Function getOutputStringField
StringField ansys::dpf::Operator::getOutputStringField(dp_index pin_index, DpfError &error)
Returns:
StringField output on pin_index.
Parameters:
Return type: StringField
Function getOutputCustomTypeField
CustomTypeField ansys::dpf::Operator::getOutputCustomTypeField(dp_index pin_index, DpfError &error)
Returns:
CustomTypeField output on pin_index.
Parameters:
Return type: CustomTypeField
Function getOutputMeshInfo
MeshInfo ansys::dpf::Operator::getOutputMeshInfo(dp_index pin_index, DpfError &error)
Returns:
MeshInfo output on pin_index.
Parameters:
Return type: MeshInfo
Function getOutputGenericDataContainer
GenericDataContainer ansys::dpf::Operator::getOutputGenericDataContainer(dp_index pin_index, DpfError &error)
Returns:
GenericDataContainer output on pin_index.
Parameters:
Return type: GenericDataContainer
Function getOutputCustomTypeFieldsContainer
CustomTypeFieldsContainer ansys::dpf::Operator::getOutputCustomTypeFieldsContainer(dp_index pin_index, DpfError &error)
Returns:
CustomTypeFieldsContainer output on pin_index.
Parameters:
Return type: CustomTypeFieldsContainer
Function getOutputString
std::string ansys::dpf::Operator::getOutputString(dp_index pin_index, DpfError &error)
Returns:
String output on pin_index.
Parameters:
Return type: std::string
Function getOutputDouble
dp_double ansys::dpf::Operator::getOutputDouble(dp_index pin_index, DpfError &error)
Returns:
Double output on pin_index.
Parameters:
Return type: dp_double
Function getOutputBool
bool ansys::dpf::Operator::getOutputBool(dp_index pin_index, DpfError &error)
Returns:
Boolean output on pin_index.
Parameters:
Return type: bool
Function getOutputInt
int ansys::dpf::Operator::getOutputInt(dp_index pin_index, DpfError &error)
Returns:
int output on pin_index.
Parameters:
Return type: int
Function getOutputIntVector
DpfVector< int > ansys::dpf::Operator::getOutputIntVector(dp_index pin_index, DpfError &error)
Returns:
Integers vector result as DpfVector for given output pin.
Parameters:
Return type: DpfVector< int >
Function getOutputDoubleVector
DpfVector< double > ansys::dpf::Operator::getOutputDoubleVector(dp_index pin_index, DpfError &error)
Returns:
Doubles vector result as DpfVector for given output pin.
Parameters:
Return type: DpfVector< double >
Function disconnect
void ansys::dpf::Operator::disconnect(dp_index pin_index)
Disconnect pin from operator.
Parameters:
- dp_index pin_index: [in] pin to disconnect.
Return type: void
Function hasOutputWhenEvaluated
bool ansys::dpf::Operator::hasOutputWhenEvaluated(dp_index pin_index)
Determines if output will be available on pin_index when operator evaluated. Returns:
Indication of output available on pin.
Parameters:
- dp_index pin_index: [in] pin on which to check for output.
Return type: bool
Function config
OperatorConfig ansys::dpf::Operator::config() const
Get configuration information for operator. Returns:
Return type: OperatorConfig
Function getRemoteId
dp_id ansys::dpf::Operator::getRemoteId() const
Return type: dp_id
Public static functions
Function emptyOperator
static Operator ansys::dpf::Operator::emptyOperator()
Create an empty operator. Returns:
Empty Operator
Return type: Operator