DPF C++ client library 2023 R2

ansys::dpf::Operator Class Reference

Last update: 10.07.2023

Wrap an elementary operation. More...

#include <dpf_api.h>

Inheritance diagram for ansys::dpf::Operator:
ansys::dpf::DpfTypes

Public Member Functions

 Operator (std::string const &identifier)
 
 Operator (std::string const &identifier, OperatorConfig const &config)
 
 Operator (std::string const &identifier, OperatorConfig const &config, Client const *const client)
 
 Operator (std::string const &identifier, Client const *const client)
 
 Operator (int id, Client const *const client)
 
 Operator (Operator &&)
 
 Operator (Operator const &)
 
Operator & operator= (Operator const &)
 
Operator & operator= (Operator &&)
 
void run ()
 
void invalidate ()
 
Operator derivate ()
 
OperatorState status () const
 
void connect (dp_index input_pin, Operator const &op, dp_index output_pin)
 
void connect (Operator const &op)
 
void connect (dp_index input_pin, Field const &data)
 
void connect (dp_index input_pin, FieldsContainer const &data)
 
void connect (dp_index input_pin, ScopingsContainer const &data)
 
void connect (dp_index input_pin, MeshesContainer const &data)
 
void connect (dp_index input_pin, DataSources const &data)
 
void connect (dp_index input_pin, MeshedRegion const &data)
 
void connect (dp_index input_pin, Scoping const &data)
 
void connect (dp_index input_pin, Streams const &data)
 
void connect (dp_index input_pin, PropertyField const &data)
 
void connect (dp_index input_pin, Support const &data)
 
void connect (dp_index input_pin, CyclicSupport const &data)
 
void connect (dp_index input_pin, TimeFreqSupport const &data)
 
void connect (dp_index input_pin, StringField const &data)
 
void connect (dp_index input_pin, CustomTypeField const &data)
 
void connect (dp_index input_pin, LabelSpace const &data)
 
void connect (dp_index input_pin, Workflow const &data)
 
void connect (dp_index input_pin, RemoteWorkflow const &data)
 
void connect (dp_index input_pin, Location const &data)
 
void connect (dp_index input_pin, PropertyType const &data)
 
void connect (dp_index input_pin, Label const &data)
 
void connect (dp_index input_pin, dp_int data)
 
void connect (dp_index input_pin, bool data)
 
void connect (dp_index input_pin, dp_double data)
 
void connect (dp_index input_pin, std::string const &data)
 
void connect (dp_index input_pin, std::vector< dp_int > const &data)
 
void connect (dp_index input_pin, std::vector< dp_double > const &data)
 
void connect (dp_index input_pin, std::vector< std::string > const &data)
 
void connect (dp_index input_pin, IAnsDispatch *data)
 
void connect (dp_index input_pin, Any const &data)
 
void connect (dp_index input_pin, DataTree const &data)
 
void connect (dp_index input_pin, UnitSystem const &data)
 
void connectOperatorAsInput (dp_index input_pin, Operator const &data)
 
template<typename DataT >
void connectCustom (dp_index input_pin, DataT const &d)
 
void connect (dp_index input_pin, Operator const &op, dp_index output_pin, DpfError &error)
 
void connect (dp_index input_pin, Field const &data, DpfError &error)
 
void connect (dp_index input_pin, FieldsContainer const &data, DpfError &error)
 
void connect (dp_index input_pin, ScopingsContainer const &data, DpfError &error)
 
void connect (dp_index input_pin, MeshesContainer const &data, DpfError &error)
 
void connect (dp_index input_pin, DataSources const &data, DpfError &error)
 
void connect (dp_index input_pin, MeshedRegion const &data, DpfError &error)
 
void connect (dp_index input_pin, Streams const &data, DpfError &error)
 
void connect (dp_index input_pin, Scoping const &data, DpfError &error)
 
void connect (dp_index input_pin, PropertyField const &data, DpfError &error)
 
void connect (dp_index input_pin, Support const &data, DpfError &error)
 
void connect (dp_index input_pin, CyclicSupport const &data, DpfError &error)
 
void connect (dp_index input_pin, TimeFreqSupport const &data, DpfError &error)
 
void connect (dp_index input_pin, StringField const &data, DpfError &error)
 
void connect (dp_index input_pin, CustomTypeField const &data, DpfError &error)
 
void connect (dp_index input_pin, LabelSpace const &data, DpfError &error)
 
void connect (dp_index input_pin, Workflow const &data, DpfError &error)
 
void connect (dp_index input_pin, RemoteWorkflow const &data, DpfError &error)
 
void connect (dp_index input_pin, bool data, DpfError &error)
 
void connect (dp_index input_pin, dp_int data, DpfError &error)
 
void connect (dp_index input_pin, dp_double data, DpfError &error)
 
void connect (dp_index input_pin, std::string const &data, DpfError &error)
 
void connect (dp_index input_pin, std::vector< dp_int > const &data, DpfError &error)
 
void connect (dp_index input_pin, std::vector< dp_double > const &data, DpfError &error)
 
void connect (dp_index input_pin, std::vector< std::string > const &data, DpfError &error)
 
void connect (dp_index input_pin, IAnsDispatch *data, DpfError &error)
 
void connect (dp_index input_pin, Any const &data, DpfError &error)
 
void connect (dp_index input_pin, DataTree const &data, DpfError &error)
 
Field getOutputField (dp_index pin_index)
 
PropertyField getOutputPropertyField (dp_index pin_index)
 
Scoping getOutputScoping (dp_index pin_index)
 
FieldsContainer getOutputFieldsContainer (dp_index pin_index)
 
ScopingsContainer getOutputScopingsContainer (dp_index pin_index)
 
MeshesContainer getOutputMeshesContainer (dp_index pin_index)
 
TimeFreqSupport getOutputTimeFreqSupport (dp_index pin_index)
 
MeshedRegion getOutputMeshedRegion (dp_index pin_index)
 
Streams getOutputStreams (dp_index pin_index)
 
ResultInfo getOutputResultInfo (dp_index pin_index)
 
Mapping getOutputMapping (dp_index pin_index)
 
DataTree getOutputDataTree (dp_index pin_index)
 
Workflow getOutputWorkflow (dp_index pin_index)
 
Operator getOutputOperator (dp_index pin_index)
 
Support getOutputSupport (dp_index pin_index)
 
CyclicSupport getOutputCyclicSupport (dp_index pin_index)
 
DataSources getOutputDataSources (dp_index pin_index)
 
StringField getOutputStringField (dp_index pin_index)
 
CustomTypeField getOutputCustomTypeField (dp_index pin_index)
 
std::string getOutputString (dp_index pin_index)
 
dp_double getOutputDouble (dp_index pin_index)
 
dp_int getOutputInt (dp_index pin_index)
 
bool getOutputBool (dp_index pin_index)
 
DpfVector< int > getOutputIntVector (dp_index pin_index)
 
DpfVector< double > getOutputDoubleVector (dp_index pin_index)
 
Any getOutputAsAny (dp_index pin_index)
 
template<typename DataT >
DataT getCustomOutput (dp_int index)
 
template<typename DataT >
DataT getOutput (dp_index pin_index)
 
Field getOutputField (dp_index pin_index, DpfError &error)
 
PropertyField getOutputPropertyField (dp_index pin_index, DpfError &error)
 
Scoping getOutputScoping (dp_index pin_index, DpfError &error)
 
FieldsContainer getOutputFieldsContainer (dp_index pin_index, DpfError &error)
 
ScopingsContainer getOutputScopingsContainer (dp_index pin_index, DpfError &error)
 
MeshesContainer getOutputMeshesContainer (dp_index pin_index, DpfError &error)
 
TimeFreqSupport getOutputTimeFreqSupport (dp_index pin_index, DpfError &error)
 
MeshedRegion getOutputMeshedRegion (dp_index pin_index, DpfError &error)
 
Streams getOutputStreams (dp_index pin_index, DpfError &error)
 
ResultInfo getOutputResultInfo (dp_index pin_index, DpfError &error)
 
Mapping getOutputMapping (dp_index pin_index, DpfError &error)
 
DataTree getOutputDataTree (dp_index pin_index, DpfError &error)
 
Workflow getOutputWorkflow (dp_index pin_index, DpfError &error)
 
Support getOutputSupport (dp_index pin_index, DpfError &error)
 
CyclicSupport getOutputCyclicSupport (dp_index pin_index, DpfError &error)
 
DataSources getOutputDataSources (dp_index pin_index, DpfError &error)
 
StringField getOutputStringField (dp_index pin_index, DpfError &error)
 
CustomTypeField getOutputCustomTypeField (dp_index pin_index, DpfError &error)
 
std::string getOutputString (dp_index pin_index, DpfError &error)
 
dp_double getOutputDouble (dp_index pin_index, DpfError &error)
 
bool getOutputBool (dp_index pin_index, DpfError &error)
 
DpfVector< int > getOutputIntVector (dp_index pin_index, DpfError &error)
 
DpfVector< double > getOutputDoubleVector (dp_index pin_index, DpfError &error)
 
void disconnect (dp_index pin_index)
 
bool hasOutputWhenEvaluated (dp_index pin_index)
 
OperatorConfig config () const
 
dp_id getRemoteId () const
 
- 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
 

Static Public Member Functions

static Operator emptyOperator ()
 

Detailed Description

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.

Examples
AveragingTest.cpp, CompleteRST.cpp, DataApis.cpp, DataExport.cpp, OperatorsApis.cpp, ResultTest.cpp, and WorkflowExamples.cpp.

Constructor & Destructor Documentation

◆ Operator() [1/5]

ansys::dpf::Operator::Operator ( std::string const &  identifier)

Create a new operator with its name.

Parameters
[in]identifierName of operator.

◆ Operator() [2/5]

ansys::dpf::Operator::Operator ( std::string const &  identifier,
OperatorConfig const &  config 
)

Create a new operator

Parameters
[in]identifierName of operator.
[in]configAdditional configuration information.

◆ Operator() [3/5]

ansys::dpf::Operator::Operator ( std::string const &  identifier,
OperatorConfig const &  config,
Client const *const  client 
)

Create a new operator

Parameters
[in]identifierName of operator.
[in]configAdditional configuration information.
[in]clientClient instance designating the IP, port and protocol to use.

◆ Operator() [4/5]

ansys::dpf::Operator::Operator ( std::string const &  identifier,
Client const *const  client 
)

Create a new operator with its name on a server.

Parameters
[in]identifierName of operator.
[in]clientClient instance designating the IP, port and protocol to use.

◆ Operator() [5/5]

ansys::dpf::Operator::Operator ( int  id,
Client const *const  client 
)

Retrieve an existing instance of Operator on a server.

Parameters
[in]idId of the Operator on the server's database.
[in]clientClient instance designating the IP, port and protocol to use.

Member Function Documentation

◆ config()

OperatorConfig ansys::dpf::Operator::config ( ) const

Get configuration information for operator.

Returns
OperatorConfig

◆ connect() [1/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Any const &  data 
)

Connect Any data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataAny data to connect to pin.

◆ connect() [2/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Any const &  data,
DpfError &  error 
)

Connect Any data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataAny data to connect to pin.
[out]errorStatus of call.

◆ connect() [3/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
bool  data 
)

Connect boolean data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataBoolean data to connect to pin.

◆ connect() [4/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
bool  data,
DpfError &  error 
)

Connect boolean data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataBoolean data to connect to pin.
[out]errorStatus of call.

◆ connect() [5/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
CustomTypeField const &  data 
)

Connect CustomTypeField data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataCustomTypeField data to connect to pin.

◆ connect() [6/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
CustomTypeField const &  data,
DpfError &  error 
)

Connect CustomTypeField data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataCustomTypeField data to connect to pin.
[out]errorStatus of call.

◆ connect() [7/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
CyclicSupport const &  data 
)

Connect CyclicSupport data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataSupport data to connect to pin.

◆ connect() [8/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
CyclicSupport const &  data,
DpfError &  error 
)

Connect CyclicSupport data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataSupport data to connect to pin.
[out]errorStatus of call.

◆ connect() [9/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
DataSources const &  data 
)

Connect DataSources data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataDataSources data to connect to pin.

◆ connect() [10/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
DataSources const &  data,
DpfError &  error 
)

Connect DataSources data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataDataSources data to connect to pin.
[out]errorStatus of call.

◆ connect() [11/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
DataTree const &  data 
)

Connect DataTree data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataDataTree data to connect to pin.

◆ connect() [12/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
DataTree const &  data,
DpfError &  error 
)

Connect DataTree data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataDataTree data to connect to pin.
[out]errorStatus of call.

◆ connect() [13/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
dp_double  data 
)

Connect double data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataDouble data to connect to pin.

◆ connect() [14/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
dp_double  data,
DpfError &  error 
)

Connect double data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataDouble data to connect to pin.
[out]errorStatus of call.

◆ connect() [15/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
dp_int  data 
)

Connect integer data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataInteger data to connect to pin.

◆ connect() [16/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
dp_int  data,
DpfError &  error 
)

Connect integer data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataInteger data to connect to pin.
[out]errorStatus of call.

◆ connect() [17/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Field const &  data 
)

Connect Field data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataField data to connect to pin.

◆ connect() [18/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Field const &  data,
DpfError &  error 
)

Connect Field data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataField data to connect to pin.
[out]errorStatus of call.

◆ connect() [19/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
FieldsContainer const &  data 
)

Connect FieldsContainer data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataFieldsContainer data to connect to pin.

◆ connect() [20/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
FieldsContainer const &  data,
DpfError &  error 
)

Connect FieldsContainer data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataFieldsContainer data to connect to pin.
[out]errorStatus of call.

◆ connect() [21/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
IAnsDispatch *  data 
)

Connect IAnsDispatch data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataIAnsDispatch data to connect to pin.

◆ connect() [22/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
IAnsDispatch *  data,
DpfError &  error 
)

Connect IAnsDispatch data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataIAnsDispatch data to connect to pin.
[out]errorStatus of call.

◆ connect() [23/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Label const &  data 
)

Connect Label data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataLabel data to connect to pin.

◆ connect() [24/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
LabelSpace const &  data 
)

Connect LabelSpace data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataLabelSpace data to connect to pin.

◆ connect() [25/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
LabelSpace const &  data,
DpfError &  error 
)

Connect TimeFreqSupport data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataLabelSpace data to connect to pin.
[out]errorStatus of call.

◆ connect() [26/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Location const &  data 
)

Connect Location data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataLocation data to connect to pin.

◆ connect() [27/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
MeshedRegion const &  data 
)

Connect MeshedRegion data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataMeshedRegion data to connect to pin.

◆ connect() [28/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
MeshedRegion const &  data,
DpfError &  error 
)

Connect MeshedRegion data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataMeshedRegion data to connect to pin.
[out]errorStatus of call.

◆ connect() [29/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
MeshesContainer const &  data 
)

Connect MeshesContainer data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataMeshesContainer data to connect to pin.

◆ connect() [30/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
MeshesContainer const &  data,
DpfError &  error 
)

Connect MeshesContainer output_pin to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataMeshesContainer data to connect to pin.
[out]errorStatus of call.

◆ connect() [31/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Operator const &  op,
dp_index  output_pin 
)

Connect operators output_pin to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]opOperator to connect to input pin.
[in]output_pinouput pin of operator to connect to input_pin.

◆ connect() [32/61]

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
[in]input_pinInput pin.
[in]opOperator to connect to input pin.
[in]output_pinouput pin of operator to connect to input_pin.
[out]errorStatus of call.

◆ connect() [33/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
PropertyField const &  data 
)

Connect PropertyField data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataPropertyField data to connect to pin.

◆ connect() [34/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
PropertyField const &  data,
DpfError &  error 
)

Connect PropertyField data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataPropertyField data to connect to pin.
[out]errorStatus of call.

◆ connect() [35/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
PropertyType const &  data 
)

Connect PropertyTypes data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataPropertyType data to connect to pin.

◆ connect() [36/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
RemoteWorkflow const &  data 
)

Connect RemoteWorkflow data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataWorkflow data to connect to pin.

◆ connect() [37/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
RemoteWorkflow const &  data,
DpfError &  error 
)

Connect RemoteWorkflow data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataRemoteWorkflow data to connect to pin.
[out]errorStatus of call.

◆ connect() [38/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Scoping const &  data 
)

Connect Scoping data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataScoping data to connect to pin.

◆ connect() [39/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Scoping const &  data,
DpfError &  error 
)

Connect Scoping data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataScoping data to connect to pin.
[out]errorStatus of call.

◆ connect() [40/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
ScopingsContainer const &  data 
)

Connect ScopingsContainer data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataScopingsContainer data to connect to pin.

◆ connect() [41/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
ScopingsContainer const &  data,
DpfError &  error 
)

Connect ScopingsContainer data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataScopingsContainer data to connect to pin.
[out]errorStatus of call.

◆ connect() [42/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
std::string const &  data 
)

Connect string data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataString data to connect to pin.

◆ connect() [43/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
std::string const &  data,
DpfError &  error 
)

Connect string data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataString data to connect to pin.
[out]errorStatus of call.

◆ connect() [44/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
std::vector< dp_double > const &  data 
)

Connect vector of double data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataVector of double data to connect to pin.

◆ connect() [45/61]

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
[in]input_pinInput pin.
[in]datavector of double data to connect to pin.
[out]errorStatus of call.

◆ connect() [46/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
std::vector< dp_int > const &  data 
)

Connect vector of integer data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataVector of integer data to connect to pin.

◆ connect() [47/61]

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
[in]input_pinInput pin.
[in]dataVector of integer data to connect to pin.
[out]errorStatus of call.

◆ connect() [48/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
std::vector< std::string > const &  data 
)

Connect vecotr of string data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataVector of string data to connect to pin.

◆ connect() [49/61]

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
[in]input_pinInput pin.
[in]dataVector of string data to connect to pin.
[out]errorStatus of call.

◆ connect() [50/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Streams const &  data 
)

Connect Streams data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataStreams data to connect to pin.

◆ connect() [51/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Streams const &  data,
DpfError &  error 
)

Connect Streams data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataStreams data to connect to pin.
[out]errorStatus of call.

◆ connect() [52/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
StringField const &  data 
)

Connect StringField data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataStringField data to connect to pin.

◆ connect() [53/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
StringField const &  data,
DpfError &  error 
)

Connect StringField data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataStringField data to connect to pin.
[out]errorStatus of call.

◆ connect() [54/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Support const &  data 
)

Connect Support data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataSupport data to connect to pin.

◆ connect() [55/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Support const &  data,
DpfError &  error 
)

Connect Support data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataSupport data to connect to pin.
[out]errorStatus of call.

◆ connect() [56/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
TimeFreqSupport const &  data 
)

Connect TimeFreqSupport data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataTimeFreqSupport data to connect to pin.

◆ connect() [57/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
TimeFreqSupport const &  data,
DpfError &  error 
)

Connect TimeFreqSupport data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataTimeFreqSupport data to connect to pin.
[out]errorStatus of call.

◆ connect() [58/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
UnitSystem const &  data 
)

Connect UnitSystem data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataUnitSystem data to connect to pin.

◆ connect() [59/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Workflow const &  data 
)

Connect Workflow data to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataWorkflow data to connect to pin.

◆ connect() [60/61]

void ansys::dpf::Operator::connect ( dp_index  input_pin,
Workflow const &  data,
DpfError &  error 
)

Connect Workflow data to input_pin.

Parameters
[in]input_pinInput pin.
[in]dataWorkflow data to connect to pin.
[out]errorStatus of call.

◆ connect() [61/61]

void ansys::dpf::Operator::connect ( Operator const &  op)

Connection operator output pin 0 to input pin 0.

Exceptions
DpfException
Parameters
[in]opOperator whose output pin 0 is connection to input pin 0.

◆ connectCustom()

template<typename DataT >
void ansys::dpf::Operator::connectCustom ( dp_index  input_pin,
DataT const &  d 
)
inline

Connect custom data to input_pin.

Exceptions
DpfException

◆ connectOperatorAsInput()

void ansys::dpf::Operator::connectOperatorAsInput ( dp_index  input_pin,
Operator const &  data 
)

Connect an Operator instance as an input to input_pin.

Exceptions
DpfException
Parameters
[in]input_pinInput pin.
[in]dataOperator data to connect to pin.

◆ derivate()

Operator ansys::dpf::Operator::derivate ( )

Generate derivative of current operator and its ancestors.

◆ disconnect()

void ansys::dpf::Operator::disconnect ( dp_index  pin_index)

Disconnect pin from operator.

Parameters
[in]pin_indexpin to disconnect.

◆ emptyOperator()

static Operator ansys::dpf::Operator::emptyOperator ( )
static

Create an empty operator.

Returns
Empty Operator

◆ getCustomOutput()

template<typename DataT >
DataT ansys::dpf::Operator::getCustomOutput ( dp_int  index)
inline
Returns
Custom data output on index.
Exceptions
DpfException
Parameters
[in]indexPin from which to get output.

◆ getOutput()

template<typename DataT >
DataT ansys::dpf::Operator::getOutput ( dp_index  pin_index)
Returns
Typed result for given output pin.
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputAsAny()

Any ansys::dpf::Operator::getOutputAsAny ( dp_index  pin_index)
Returns
Any result for given output pin.
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputBool() [1/2]

bool ansys::dpf::Operator::getOutputBool ( dp_index  pin_index)
Returns
Boolean output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputBool() [2/2]

bool ansys::dpf::Operator::getOutputBool ( dp_index  pin_index,
DpfError &  error 
)
Returns
Boolean output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputCustomTypeField() [1/2]

CustomTypeField ansys::dpf::Operator::getOutputCustomTypeField ( dp_index  pin_index)
Returns
CustomTypeField output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputCustomTypeField() [2/2]

CustomTypeField ansys::dpf::Operator::getOutputCustomTypeField ( dp_index  pin_index,
DpfError &  error 
)
Returns
CustomTypeField output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputCyclicSupport() [1/2]

CyclicSupport ansys::dpf::Operator::getOutputCyclicSupport ( dp_index  pin_index)
Returns
CyclicSupport output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputCyclicSupport() [2/2]

CyclicSupport ansys::dpf::Operator::getOutputCyclicSupport ( dp_index  pin_index,
DpfError &  error 
)
Returns
CyclicSupport output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputDataSources() [1/2]

DataSources ansys::dpf::Operator::getOutputDataSources ( dp_index  pin_index)
Returns
DataSources output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputDataSources() [2/2]

DataSources ansys::dpf::Operator::getOutputDataSources ( dp_index  pin_index,
DpfError &  error 
)
Returns
DataSources output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputDataTree() [1/2]

DataTree ansys::dpf::Operator::getOutputDataTree ( dp_index  pin_index)
Returns
DataTree output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputDataTree() [2/2]

DataTree ansys::dpf::Operator::getOutputDataTree ( dp_index  pin_index,
DpfError &  error 
)
Returns
DataTree output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputDouble() [1/2]

dp_double ansys::dpf::Operator::getOutputDouble ( dp_index  pin_index)
Returns
Double output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputDouble() [2/2]

dp_double ansys::dpf::Operator::getOutputDouble ( dp_index  pin_index,
DpfError &  error 
)
Returns
Double output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputDoubleVector() [1/2]

DpfVector< double > ansys::dpf::Operator::getOutputDoubleVector ( dp_index  pin_index)
Returns
Doubles vector result as DpfVector for given output pin.
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputDoubleVector() [2/2]

DpfVector< double > ansys::dpf::Operator::getOutputDoubleVector ( dp_index  pin_index,
DpfError &  error 
)
Returns
Doubles vector result as DpfVector for given output pin.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputField() [1/2]

Field ansys::dpf::Operator::getOutputField ( dp_index  pin_index)
Returns
Field output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputField() [2/2]

Field ansys::dpf::Operator::getOutputField ( dp_index  pin_index,
DpfError &  error 
)
Returns
Field output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputFieldsContainer() [1/2]

FieldsContainer ansys::dpf::Operator::getOutputFieldsContainer ( dp_index  pin_index)
Returns
FieldsContainer output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.
Examples
AveragingTest.cpp, CompleteRST.cpp, OperatorsApis.cpp, and WorkflowExamples.cpp.

◆ getOutputFieldsContainer() [2/2]

FieldsContainer ansys::dpf::Operator::getOutputFieldsContainer ( dp_index  pin_index,
DpfError &  error 
)
Returns
FieldsContainer output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputInt()

dp_int ansys::dpf::Operator::getOutputInt ( dp_index  pin_index)
Returns
Integer output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputIntVector() [1/2]

DpfVector< int > ansys::dpf::Operator::getOutputIntVector ( dp_index  pin_index)
Returns
Integers vector result as DpfVector for given output pin.
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputIntVector() [2/2]

DpfVector< int > ansys::dpf::Operator::getOutputIntVector ( dp_index  pin_index,
DpfError &  error 
)
Returns
Integers vector result as DpfVector for given output pin.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputMapping() [1/2]

Mapping ansys::dpf::Operator::getOutputMapping ( dp_index  pin_index)
Returns
Mapping output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputMapping() [2/2]

Mapping ansys::dpf::Operator::getOutputMapping ( dp_index  pin_index,
DpfError &  error 
)
Returns
Mapping output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputMeshedRegion() [1/2]

MeshedRegion ansys::dpf::Operator::getOutputMeshedRegion ( dp_index  pin_index)
Returns
MeshedRegion output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.
Examples
AveragingTest.cpp, and CompleteRST.cpp.

◆ getOutputMeshedRegion() [2/2]

MeshedRegion ansys::dpf::Operator::getOutputMeshedRegion ( dp_index  pin_index,
DpfError &  error 
)
Returns
MeshedRegion output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputMeshesContainer() [1/2]

MeshesContainer ansys::dpf::Operator::getOutputMeshesContainer ( dp_index  pin_index)
Returns
MeshesContainer output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputMeshesContainer() [2/2]

MeshesContainer ansys::dpf::Operator::getOutputMeshesContainer ( dp_index  pin_index,
DpfError &  error 
)
Returns
MeshesContainer output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputOperator()

Operator ansys::dpf::Operator::getOutputOperator ( dp_index  pin_index)
Returns
Operator output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputPropertyField() [1/2]

PropertyField ansys::dpf::Operator::getOutputPropertyField ( dp_index  pin_index)
Returns
PropertyField output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputPropertyField() [2/2]

PropertyField ansys::dpf::Operator::getOutputPropertyField ( dp_index  pin_index,
DpfError &  error 
)
Returns
PropertyField output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputResultInfo() [1/2]

ResultInfo ansys::dpf::Operator::getOutputResultInfo ( dp_index  pin_index)
Returns
ResultInfo output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.
Examples
CompleteRST.cpp, and ResultTest.cpp.

◆ getOutputResultInfo() [2/2]

ResultInfo ansys::dpf::Operator::getOutputResultInfo ( dp_index  pin_index,
DpfError &  error 
)
Returns
ResultInfo output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputScoping() [1/2]

Scoping ansys::dpf::Operator::getOutputScoping ( dp_index  pin_index)
Returns
Scoping output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputScoping() [2/2]

Scoping ansys::dpf::Operator::getOutputScoping ( dp_index  pin_index,
DpfError &  error 
)
Returns
Scoping output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputScopingsContainer() [1/2]

ScopingsContainer ansys::dpf::Operator::getOutputScopingsContainer ( dp_index  pin_index)
Returns
ScopingsContainer output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.
Examples
AveragingTest.cpp.

◆ getOutputScopingsContainer() [2/2]

ScopingsContainer ansys::dpf::Operator::getOutputScopingsContainer ( dp_index  pin_index,
DpfError &  error 
)
Returns
ScopingsContainer output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputStreams() [1/2]

Streams ansys::dpf::Operator::getOutputStreams ( dp_index  pin_index)
Returns
Streams output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputStreams() [2/2]

Streams ansys::dpf::Operator::getOutputStreams ( dp_index  pin_index,
DpfError &  error 
)
Returns
Streams output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputString() [1/2]

std::string ansys::dpf::Operator::getOutputString ( dp_index  pin_index)
Returns
String output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputString() [2/2]

std::string ansys::dpf::Operator::getOutputString ( dp_index  pin_index,
DpfError &  error 
)
Returns
String output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputStringField() [1/2]

StringField ansys::dpf::Operator::getOutputStringField ( dp_index  pin_index)
Returns
StringField output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputStringField() [2/2]

StringField ansys::dpf::Operator::getOutputStringField ( dp_index  pin_index,
DpfError &  error 
)
Returns
StringField output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputSupport() [1/2]

Support ansys::dpf::Operator::getOutputSupport ( dp_index  pin_index)
Returns
Support output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputSupport() [2/2]

Support ansys::dpf::Operator::getOutputSupport ( dp_index  pin_index,
DpfError &  error 
)
Returns
Support output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputTimeFreqSupport() [1/2]

TimeFreqSupport ansys::dpf::Operator::getOutputTimeFreqSupport ( dp_index  pin_index)
Returns
TimeFreqSupport output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.
Examples
CompleteRST.cpp.

◆ getOutputTimeFreqSupport() [2/2]

TimeFreqSupport ansys::dpf::Operator::getOutputTimeFreqSupport ( dp_index  pin_index,
DpfError &  error 
)
Returns
TimeFreqSupport output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ getOutputWorkflow() [1/2]

Workflow ansys::dpf::Operator::getOutputWorkflow ( dp_index  pin_index)
Returns
Workflow output on pin_index.
Exceptions
DpfException
Parameters
[in]pin_indexPin from which to get output.

◆ getOutputWorkflow() [2/2]

Workflow ansys::dpf::Operator::getOutputWorkflow ( dp_index  pin_index,
DpfError &  error 
)
Returns
Workflow output on pin_index.
Parameters
[in]pin_indexPin from which to get output.
[out]errorStatus of call.

◆ 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
[in]pin_indexpin on which to check for output.

◆ invalidate()

void ansys::dpf::Operator::invalidate ( )

Invalidate results of operation.

◆ run()

void ansys::dpf::Operator::run ( )

Perform operation.

Connect with Ansys