## On this page

  

 

 # ansys::dpf::Workflow Class Reference

 Last update: 16.07.2025 

Group a set of connected operators in order to define a whole data treatment. [More...](classansys_1_1dpf_1_1Workflow.xhtml#details)

`#include <dpf_api.h>`

Inheritance diagram for ansys::dpf::Workflow:

 ![](/sites/default/files/migrate-content/dpf_cpp_client_library_2024_r2/classansys_1_1dpf_1_1Workflow.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [Workflow](classansys_1_1dpf_1_1Workflow.xhtml#a2846bb6c6a083c909cc69cdd7693e2af) ()  [Workflow](classansys_1_1dpf_1_1Workflow.xhtml#a8a36b36629bde25afe03b12b0ed5a958) (std::string const &amp;workflow\_string)  [Workflow](classansys_1_1dpf_1_1Workflow.xhtml#a9df2ce30e71299cc68d8c8b5ad6d0aab) ([Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client)  [Workflow](classansys_1_1dpf_1_1Workflow.xhtml#a75ca6a59b59ded54d4606acfc8f30d26) (std::string const &amp;workflow\_string, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client)  [Workflow](classansys_1_1dpf_1_1Workflow.xhtml#a463fddfb0fd209fc582de029dfbcc7e6) ([dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) id, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client) <a id="a03109424a314dccffe89415b15c2da20" name="a03109424a314dccffe89415b15c2da20"></a> **Workflow** ([Workflow](classansys_1_1dpf_1_1Workflow.xhtml) const &amp;) <a id="a8007d3612f14f6e13622cdec47502903" name="a8007d3612f14f6e13622cdec47502903"></a> **Workflow** ([Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp;&amp;) noexcept <a id="ac90536fd51276a2e0bfdab91077ee47e" name="ac90536fd51276a2e0bfdab91077ee47e"></a>[Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp; **operator=** ([Workflow](classansys_1_1dpf_1_1Workflow.xhtml) const &amp;) <a id="af0da99134b91621b07df5dc27f88af19" name="af0da99134b91621b07df5dc27f88af19"></a>[Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp; **operator=** ([Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp;&amp;) noexcept [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) [getCopy](classansys_1_1dpf_1_1Workflow.xhtml#a850d7aa707b7b9017bd679defc9d2845) () const void [add](classansys_1_1dpf_1_1Workflow.xhtml#a794c8ac3fdd9459ebfe87f3962936a81) ([Operator](classansys_1_1dpf_1_1Operator.xhtml) &amp;op) void [connectWith](classansys_1_1dpf_1_1Workflow.xhtml#a4175b5645453c094e5ab3da2bc0b139e) ([Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp;left\_workflow) void [connectWith](classansys_1_1dpf_1_1Workflow.xhtml#a01626b04d4825b54d4a967c72c942fec) ([Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp;left\_workflow, std::map&lt; std::string, std::string &gt; const &amp;connections) bool [hasInputPin](classansys_1_1dpf_1_1Workflow.xhtml#ad4082c537432a19c765d590a6901ab22) (std::string const &amp;pin\_name) const bool [hasOutputPin](classansys_1_1dpf_1_1Workflow.xhtml#a971acc185d66d6c1beec47af476a37b5) (std::string const &amp;pin\_name) const std::vector&lt; std::string &gt; [listInputPins](classansys_1_1dpf_1_1Workflow.xhtml#a084608aa05b59222823da959778ec525) () const std::vector&lt; std::string &gt; [listOutputPins](classansys_1_1dpf_1_1Workflow.xhtml#a6a33ca9d55b7a6f59d4fadb0e393a1eb) () const void [nameInputPin](classansys_1_1dpf_1_1Workflow.xhtml#a71a0990995b27105d4c362ad2880e4d7) (std::string const &amp;pin\_name, int operator\_input\_pin, [Operator](classansys_1_1dpf_1_1Operator.xhtml) &amp;op) void [nameOutputPin](classansys_1_1dpf_1_1Workflow.xhtml#a3a223ef1c0200cc16ac1434ef938efca) ([Operator](classansys_1_1dpf_1_1Operator.xhtml) &amp;op, int operator\_output\_pin, std::string const &amp;pin\_name) void [eraseInputPin](classansys_1_1dpf_1_1Workflow.xhtml#a07b6c6b80c65c47282d631b9d3036289) (std::string const &amp;pin\_name) void [eraseOutputPin](classansys_1_1dpf_1_1Workflow.xhtml#ae4aae9e5a3a414fa0ba10db9b219ee2d) (std::string const &amp;pin\_name) void [writeToSwf](classansys_1_1dpf_1_1Workflow.xhtml#ad3b00b52721f7019bd2820f93f8c0aa4) (std::string const &amp;file\_path) const void [writeToGraphViz](classansys_1_1dpf_1_1Workflow.xhtml#a65f7ba38832058e0f233ae45965ef08b) (std::string const &amp;file\_path) const void [writeToJson](classansys_1_1dpf_1_1Workflow.xhtml#a1ddf4b26605e2f28dd54fec4e47310d1) (std::string &amp;jsonString) const void [readFromJson](classansys_1_1dpf_1_1Workflow.xhtml#a6f93a5ffa10086a7f2a40291119f6e53) (const std::string &amp;jsonString) std::string [writeToString](classansys_1_1dpf_1_1Workflow.xhtml#a6aaabec3049d60c96c32f7eb3ae38a0f) () const void [chainWith](classansys_1_1dpf_1_1Workflow.xhtml#a36001ca148e2ca1f6d0518d3aefad5dd) (const [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp;wf) void [chainWith](classansys_1_1dpf_1_1Workflow.xhtml#afdb94d06a19ad7f8288a462d7e58b2aa) (const [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp;wf, const std::pair&lt; std::string, std::string &gt; &amp;in\_out\_names) void [renameInputPin](classansys_1_1dpf_1_1Workflow.xhtml#a22fba3c96a8a6e9eda279fd1c4b5358f) (std::string const &amp;old\_pin\_name, std::string const &amp;new\_pin\_name) void [renameOutputPin](classansys_1_1dpf_1_1Workflow.xhtml#abff62660096b06dd09667061c8e3d8a6) (std::string const &amp;old\_pin\_name, std::string const &amp;new\_pin\_name) void [loadFromSwf](classansys_1_1dpf_1_1Workflow.xhtml#a5cb98918b3285132ff6d00f2b5905b2f) (std::string const &amp;file\_path) <a id="a6ff6d7e57c9639e781573723058c4490" name="a6ff6d7e57c9639e781573723058c4490"></a>void **generateDerivativeFor** (std::string const &amp;output\_name, std::string const &amp;symbol\_name) bool [hasOutputWhenEvaluated](classansys_1_1dpf_1_1Workflow.xhtml#a70af322877ca5e6ee6e7b1f81012c044) (std::string const &amp;pin\_name) [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [numberOfOperators](classansys_1_1dpf_1_1Workflow.xhtml#ab8b59d1d65ffb6df6845d98e321dfc20) () const std::string [operatorNameByIndex](classansys_1_1dpf_1_1Workflow.xhtml#a040282982c7c01c8c0a7ac8724859d87) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) index) const [Operator](classansys_1_1dpf_1_1Operator.xhtml) [firstOperator](classansys_1_1dpf_1_1Workflow.xhtml#a240864c97ab88338e9ba6ef8c4ad9ed3) () const [Operator](classansys_1_1dpf_1_1Operator.xhtml) [lastOperator](classansys_1_1dpf_1_1Workflow.xhtml#a7e7861cf4975e45f30bcc0e19ae55f57) () const [Field](classansys_1_1dpf_1_1Field.xhtml) [getOutputField](classansys_1_1dpf_1_1Workflow.xhtml#a21d864839aa5e8df007f9596ec69a58a) (std::string const &amp;pin\_name) [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) [getOutputFieldsContainer](classansys_1_1dpf_1_1Workflow.xhtml#aa3a9c25bbfb550d6692c063f9c3a9366) (std::string const &amp;pin\_name) [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) [getOutputScoping](classansys_1_1dpf_1_1Workflow.xhtml#a74132c47f9aba3bf91929057a5765d26) (std::string const &amp;pin\_name) [ScopingsContainer](classansys_1_1dpf_1_1ScopingsContainer.xhtml) [getOutputScopingsContainer](classansys_1_1dpf_1_1Workflow.xhtml#a33caface659fe462e68fdbcc0970a1be) (std::string const &amp;pin\_name) [MeshesContainer](classansys_1_1dpf_1_1MeshesContainer.xhtml) [getOutputMeshesContainer](classansys_1_1dpf_1_1Workflow.xhtml#a6c7cb7443fd062fea0ca57d48600d480) (std::string const &amp;pin\_name) [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) [getOutputTimeFreqSupport](classansys_1_1dpf_1_1Workflow.xhtml#ac087d530db5bea30250a6110054f204a) (std::string const &amp;pin\_name) [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) [getOutputMeshedRegion](classansys_1_1dpf_1_1Workflow.xhtml#a6ea222c1a71552dce249843b94a07fa4) (std::string const &amp;pin\_name) [ResultInfo](classansys_1_1dpf_1_1ResultInfo.xhtml) [getOutputResultInfo](classansys_1_1dpf_1_1Workflow.xhtml#aed1256fa413f596e2adfea30249f7709) (std::string const &amp;pin\_name) [Support](classansys_1_1dpf_1_1Support.xhtml) [getOutputSupport](classansys_1_1dpf_1_1Workflow.xhtml#aaf5694a0c8e6c6aca9436c5c83af76b2) (std::string const &amp;pin\_name) [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) [getOutputCyclicSupport](classansys_1_1dpf_1_1Workflow.xhtml#a6d1485f44ae9f6021d7abe5b624ad3dd) (std::string const &amp;pin\_name) [DataSources](classansys_1_1dpf_1_1DataSources.xhtml) [getOutputDataSources](classansys_1_1dpf_1_1Workflow.xhtml#ab5d2dc81bc032dd62781eccc8d08dc72) (std::string const &amp;pin\_name) [Streams](classansys_1_1dpf_1_1Streams.xhtml) [getOutputStreams](classansys_1_1dpf_1_1Workflow.xhtml#ae584dfe4b900829cd8bca00dd3200363) (std::string const &amp;pin\_name) [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) [getOutputPropertyField](classansys_1_1dpf_1_1Workflow.xhtml#acf02bf7c228fb3d944edd838022e7916) (std::string const &amp;pin\_namepin\_name) [Unit](classansys_1_1dpf_1_1Unit.xhtml) [getOutputUnit](classansys_1_1dpf_1_1Workflow.xhtml#abeff5a7ffd64f443c6da0be2e254563c) (std::string const &amp;pin\_name) [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) [getOutputWorkflow](classansys_1_1dpf_1_1Workflow.xhtml#a6291348781887726efc7afe9e31a5fb9) (std::string const &amp;pin\_name) [DataTree](classansys_1_1dpf_1_1DataTree.xhtml) [getOutputDataTree](classansys_1_1dpf_1_1Workflow.xhtml#aae161a44ae32216f89da086d04cc45d2) (std::string const &amp;pin\_name) [StringField](classansys_1_1dpf_1_1StringField.xhtml) [getOutputStringField](classansys_1_1dpf_1_1Workflow.xhtml#add8d5ca19cf8ceba3d69cb6489ea234c) (std::string const &amp;pin\_name) [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) [getOutputCustomTypeField](classansys_1_1dpf_1_1Workflow.xhtml#ab64177b6dcf13680cf698dcdf4dc0c89) (std::string const &amp;pin\_name) GenericDataContainer [getOutputGenericDataContainer](classansys_1_1dpf_1_1Workflow.xhtml#a9661afd7e92eecc870617730041cc103) (std::string const &amp;pin\_name) [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) [getOutputCustomTypeFieldsContainer](classansys_1_1dpf_1_1Workflow.xhtml#a1a190e68bcfc34d41616d008278fbdec) (std::string const &amp;pin\_name) [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [getOutputInt](classansys_1_1dpf_1_1Workflow.xhtml#a763c0ba2b4e2184b40ab4a7a32e356c1) (std::string const &amp;pin\_name) [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) [getOutputDouble](classansys_1_1dpf_1_1Workflow.xhtml#a6fb5083841eecabdec318dd28db6e71a) (std::string const &amp;pin\_name) bool [getOutputBool](classansys_1_1dpf_1_1Workflow.xhtml#a6156eba91101e868899f2a9401180a9e) (std::string const &amp;pin\_name) std::string [getOutputString](classansys_1_1dpf_1_1Workflow.xhtml#a59d4b94233be7f750d0a1af78accd6ba) (std::string const &amp;pin\_index) [Any](classansys_1_1dpf_1_1Any.xhtml) [getOutputAsAny](classansys_1_1dpf_1_1Workflow.xhtml#a5340e6ab9473e5615e62223509d473c2) (std::string const &amp;pin\_name) [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; int &gt; [getOutputIntVector](classansys_1_1dpf_1_1Workflow.xhtml#ad3afdaf27db659d67365c0f76de110ef) (std::string const &amp;pin\_name) [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; double &gt; [getOutputDoubleVector](classansys_1_1dpf_1_1Workflow.xhtml#a4ef3ed3764263f8d09adac332209e564) (std::string const &amp;pin\_name) template&lt;typename DataT &gt; DataT [getCustomOutput](classansys_1_1dpf_1_1Workflow.xhtml#a3d181c629d1808c570ac90e485a6c5f9) (std::string const &amp;pin\_name) template&lt;typename DataT &gt; DataT [getOutput](classansys_1_1dpf_1_1Workflow.xhtml#a312d744b2c8174b3cd5e1d102ff6ae7b) (std::string const &amp;pin\_name) [Field](classansys_1_1dpf_1_1Field.xhtml) [getOutputField](classansys_1_1dpf_1_1Workflow.xhtml#ae6a68dfd55de34b0d6341187c526f555) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) [getOutputFieldsContainer](classansys_1_1dpf_1_1Workflow.xhtml#a9ca347cc825a5222992789d272319855) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) [getOutputScoping](classansys_1_1dpf_1_1Workflow.xhtml#a5c6b0a0ed35ad495a2776d9ec078fc19) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [ScopingsContainer](classansys_1_1dpf_1_1ScopingsContainer.xhtml) [getOutputScopingsContainer](classansys_1_1dpf_1_1Workflow.xhtml#a545556717c00fa45e69d5ef73db01a56) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [MeshesContainer](classansys_1_1dpf_1_1MeshesContainer.xhtml) [getOutputMeshesContainer](classansys_1_1dpf_1_1Workflow.xhtml#aa776a964e764c7e4b48172a0058f4549) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) [getOutputTimeFreqSupport](classansys_1_1dpf_1_1Workflow.xhtml#ae52042f810882873efc0ba757202e886) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) [getOutputMeshedRegion](classansys_1_1dpf_1_1Workflow.xhtml#a7e1b966c6f88bf8913a78fdd1bc9f8ec) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [ResultInfo](classansys_1_1dpf_1_1ResultInfo.xhtml) [getOutputResultInfo](classansys_1_1dpf_1_1Workflow.xhtml#aeffa8acf3f758d6889815f63cabe07fe) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [Support](classansys_1_1dpf_1_1Support.xhtml) [getOutputSupport](classansys_1_1dpf_1_1Workflow.xhtml#ac72d8c2dcd1440727a32eab2dd116de5) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) [getOutputCyclicSupport](classansys_1_1dpf_1_1Workflow.xhtml#a0f25cc380b20d458d5e89e4b65c90f2e) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [DataSources](classansys_1_1dpf_1_1DataSources.xhtml) [getOutputDataSources](classansys_1_1dpf_1_1Workflow.xhtml#a665a58c468cb73763561a72213a24105) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [Streams](classansys_1_1dpf_1_1Streams.xhtml) [getOutputStreams](classansys_1_1dpf_1_1Workflow.xhtml#a71da7d7f3e4eafd716ed3a6231f367ba) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) [getOutputPropertyField](classansys_1_1dpf_1_1Workflow.xhtml#a505757d97be1f400590993ea7afff978) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [StringField](classansys_1_1dpf_1_1StringField.xhtml) [getOutputStringField](classansys_1_1dpf_1_1Workflow.xhtml#a43caf8cf225d29a869798a9920a501e4) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) [getOutputCustomTypeField](classansys_1_1dpf_1_1Workflow.xhtml#ab1d36de322f134cd3240fb3aa138d58b) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) GenericDataContainer [getOutputGenericDataContainer](classansys_1_1dpf_1_1Workflow.xhtml#a146947a1a0e68693bbbef667e32a1ba9) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) [getOutputCustomTypeFieldsContainer](classansys_1_1dpf_1_1Workflow.xhtml#a848ccba76719484ca0fba34f3e2b2282) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [Unit](classansys_1_1dpf_1_1Unit.xhtml) [getOutputUnit](classansys_1_1dpf_1_1Workflow.xhtml#af8eb2c09487a34ec09f8166072c5ca2c) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) [getOutputWorkflow](classansys_1_1dpf_1_1Workflow.xhtml#a512f234628a9f2b95ad423907ddb25c4) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) [getOutputInt](classansys_1_1dpf_1_1Workflow.xhtml#a152f76caf982e70a1441ff18fee7ff58) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) [getOutputDouble](classansys_1_1dpf_1_1Workflow.xhtml#a2584163d1c7158faa3bcfeb5fffaeda2) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) bool [getOutputBool](classansys_1_1dpf_1_1Workflow.xhtml#ac86f5cff304ed6a263f9e915d8a8b3b7) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) std::string [getOutputString](classansys_1_1dpf_1_1Workflow.xhtml#aaa166e26a853f3619f66841f394cbb90) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; int &gt; [getOutputIntVector](classansys_1_1dpf_1_1Workflow.xhtml#ac584ff672992b102d00b63fdfda214b2) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; double &gt; [getOutputDoubleVector](classansys_1_1dpf_1_1Workflow.xhtml#a751600692296801ca04c300ed13327ce) (std::string const &amp;pin\_name, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#ab47934497d52355ac422efa57677ff75) (std::string const &amp;pin\_name, std::string const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a6ce835a6bd7213846e9f2a54c3c0a26b) (std::string const &amp;pin\_name, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a0359e496cfe9ef8b635df5ced09ee4ed) (std::string const &amp;pin\_name, bool f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a784a219175f41f4a6c7da7703f45defe) (std::string const &amp;pin\_name, [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a2bbb7a7147a954812864d12b21ded9b3) (std::string const &amp;pin\_name, std::vector&lt; int &gt; const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a667f3d115d92aab65b3220e1ab64fb28) (std::string const &amp;pin\_name, std::vector&lt; [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) &gt; const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#af22209afa4cb0826c3848bf9c99bdcd5) (std::string const &amp;pin\_name, std::vector&lt; std::string &gt; const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a8943b00849c0866751571b2e059c1f1f) (std::string const &amp;pin\_name, [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) const &amp;data) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a4b4bdbd4860a8604c9116550307f9f52) (std::string const &amp;pin\_name, [Field](classansys_1_1dpf_1_1Field.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#aa48c016c9f389323b27371756350654c) (std::string const &amp;pin\_name, [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a252c27bd350813cf0909b9577860596a) (std::string const &amp;pin\_name, [ScopingsContainer](classansys_1_1dpf_1_1ScopingsContainer.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a29916dec796fd6307c89df8c85244aa9) (std::string const &amp;pin\_name, [MeshesContainer](classansys_1_1dpf_1_1MeshesContainer.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a7e5926bff9b5aa6ee9daa21e324b538e) (std::string const &amp;pin\_name, [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a93dc6b31b164f5c4337985285fdba586) (std::string const &amp;pin\_name, [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a0974baecfc7676ccc152faab12b453b8) (std::string const &amp;pin\_name, [Support](classansys_1_1dpf_1_1Support.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a64c8c5a6f4f12237abbc87f850ca0ee9) (std::string const &amp;pin\_name, [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a7a07e03ab9fd7ec733fd0972818eef28) (std::string const &amp;pin\_name, [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#aff5f5d5fc91b7b296cb6fa5ef87c5107) (std::string const &amp;pin\_name, [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a61879be4ea94798291feddd586145c66) (std::string const &amp;pin\_name, [DataSources](classansys_1_1dpf_1_1DataSources.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a0a92f71b04c6db87cfa3a8a21e677f73) (std::string const &amp;pin\_name, [Streams](classansys_1_1dpf_1_1Streams.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#ace584af53d55760bbfef3a96cc98bfd0) (std::string const &amp;pin\_name, [DataTree](classansys_1_1dpf_1_1DataTree.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#ab1563b3745846cf98093df6185fdcaf8) (std::string const &amp;pin\_name, [StringField](classansys_1_1dpf_1_1StringField.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a4f95687c759c261e5503e71758784f67) (std::string const &amp;pin\_name, [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#ad6aa6756fd298e844d4bd319b674bf67) (std::string const &amp;pin\_name, GenericDataContainer const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a1bd6c48a52a6e33007d35ec97656a026) (std::string const &amp;pin\_name, [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#aa6ef243aa013bc7f4a1ba4fa631b5d9d) (std::string const &amp;pin\_name, [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a8474ee76056b00dc1aeaa4d88984d782) (std::string const &amp;pin\_name, [CustomContainerBase](classansys_1_1dpf_1_1CustomContainerBase.xhtml) const &amp;f) template&lt;typename DataT &gt; void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a3090ae5e11e680aeabc884d078783e25) (std::string const &amp;pin\_name, [Collection](classansys_1_1dpf_1_1Collection.xhtml)&lt; DataT &gt; const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#ad572b0f3feec3e59bfab415303a9b648) (std::string const &amp;pin\_name, [Any](classansys_1_1dpf_1_1Any.xhtml) const &amp;f) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#ac1412df4cb8570cc573ad59bdf6bd798) (std::string const &amp;pin\_name, [Operator](classansys_1_1dpf_1_1Operator.xhtml) const &amp;f, [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920) output\_pin) template&lt;typename DataT &gt; void [connectCustom](classansys_1_1dpf_1_1Workflow.xhtml#a14f12d5fc517547bda3507d1b4904cd1) (std::string const &amp;input\_pin, DataT const &amp;d) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a7a44ea576bd657745dfe605e451603b6) (std::string const &amp;pin\_name, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a6751a4d3a941a668c886d10464588f51) (std::string const &amp;pin\_name, bool f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a2e5709ac0f02efa74c1c76a93482af5f) (std::string const &amp;pin\_name, [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a4a861efbe5a6ef1e4aaf9aeffe1c0034) (std::string const &amp;pin\_name, std::string const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a66788ae625c25ec2e79381cde769dcb9) (std::string const &amp;pin\_name, std::vector&lt; int &gt; const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#ae6a0ccf692e3df243f16f631a2a3e92f) (std::string const &amp;pin\_name, std::vector&lt; [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) &gt; const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a9dec5cc81a217f554042098835c20e76) (std::string const &amp;pin\_name, std::vector&lt; std::string &gt; const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a7c3b78f070e5dd68eb6651ed3cac40dc) (std::string const &amp;pin\_name, [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a070371d847e987fc27e8a16a0be4d88e) (std::string const &amp;pin\_name, [Field](classansys_1_1dpf_1_1Field.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a0c4754aa87841da9daf4132269c2c6fa) (std::string const &amp;pin\_name, [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a50152bec5cd234c49a0d763552daf2c0) (std::string const &amp;pin\_name, [ScopingsContainer](classansys_1_1dpf_1_1ScopingsContainer.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#ad17a794af1d450de045339847fa08f9d) (std::string const &amp;pin\_name, [MeshesContainer](classansys_1_1dpf_1_1MeshesContainer.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a15ed0952fd8c9ee59a60d169c4ed9a7c) (std::string const &amp;pin\_name, [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a09030c86837fdfdaffe50d2423e39cfa) (std::string const &amp;pin\_name, [DataSources](classansys_1_1dpf_1_1DataSources.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a60314676298ac8f606b72ba8d1373938) (std::string const &amp;pin\_name, [Streams](classansys_1_1dpf_1_1Streams.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#aa7a45dd2967a76b0903648d55bd407ba) (std::string const &amp;pin\_name, [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a50ab49cc59f6eb17c84aa35a7862b44c) (std::string const &amp;pin\_name, [Support](classansys_1_1dpf_1_1Support.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a8c1fb6d6b46ad3fc35d8c385780bf797) (std::string const &amp;pin\_name, [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a54356cdba52df64f31772dc04cbff93b) (std::string const &amp;pin\_name, [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a3f0bb9caf499a7439ccc560e92636534) (std::string const &amp;pin\_name, [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a6c46ace7d641b785639d5a88dab70c8d) (std::string const &amp;pin\_name, [DataTree](classansys_1_1dpf_1_1DataTree.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#abbafe54425152568492c1e596a58aede) (std::string const &amp;pin\_name, [StringField](classansys_1_1dpf_1_1StringField.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#ae5dc73ae63ea8c4436acdb5f0cf85ded) (std::string const &amp;pin\_name, [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a3b7bf7f99abc786f14a2730ee1a10060) (std::string const &amp;pin\_name, GenericDataContainer const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#a0330735c90420e64055475071e77ac20) (std::string const &amp;pin\_name, [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#afbd38a2be7389beb2de3304e71ac8065) (std::string const &amp;pin\_name, [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#ac2989ccb8dafbb4bf150d7d774d17515) (std::string const &amp;pin\_name, [Any](classansys_1_1dpf_1_1Any.xhtml) const &amp;f, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [connect](classansys_1_1dpf_1_1Workflow.xhtml#aa1716e9cc3ecea9fd72ec6c945c66baa) (std::string const &amp;pin\_name, [Operator](classansys_1_1dpf_1_1Operator.xhtml) const &amp;f, [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920) output\_pin, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) void [discoverAllOperators](classansys_1_1dpf_1_1Workflow.xhtml#a38fb29d1a8d18b4bc08f40b657179735) () int [record](classansys_1_1dpf_1_1Workflow.xhtml#ab001bca50c1470be154a79841c43314c) (std::string const &amp;name, bool transfer\_ownership, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;error) Records the workflow in DPF's registry. [More...](classansys_1_1dpf_1_1Workflow.xhtml#ab001bca50c1470be154a79841c43314c)  
 int [record](classansys_1_1dpf_1_1Workflow.xhtml#a304ee206ac4927f7aa757c63b0ec00b5) (std::string const &amp;name, bool transfer\_ownership) Records the workflow in DPF's registry. [More...](classansys_1_1dpf_1_1Workflow.xhtml#a304ee206ac4927f7aa757c63b0ec00b5)  
 <a id="a478c1be621d4c49916771b42d4b10ba9" name="a478c1be621d4c49916771b42d4b10ba9"></a>bool **tryReplaceWorkflowInRegistry** (int id, std::string const &amp;name, bool transfer\_ownership) <a id="ae2407ad29bf6a4c815a13fa454c746e5" name="ae2407ad29bf6a4c815a13fa454c746e5"></a>bool **eraseWorkflowFromRegistry** () [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) [instantiateOnRemote](classansys_1_1dpf_1_1Workflow.xhtml#a52b68fcbd68561aa3d47a3368252a9c6) ([ansys::dpf::Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client) const [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) [instantiateOnRemote](classansys_1_1dpf_1_1Workflow.xhtml#a7371c4e5525bcf16d83a33a41d69b03c) (std::string const &amp;address, std::string const &amp;protocol) const [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) [instantiateOnRemote](classansys_1_1dpf_1_1Workflow.xhtml#a9836bf24a8037281f69e7f32285daa45) (std::string const &amp;ip, int port, std::string const &amp;protocol) const [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) [getRemoteId](classansys_1_1dpf_1_1Workflow.xhtml#a88a367b1638835774ffa7d7521b741c7) () const std::vector&lt; std::pair&lt; int, [ansys::dpf::Operator](classansys_1_1dpf_1_1Operator.xhtml) &gt; &gt; [operatorsForInput](classansys_1_1dpf_1_1Workflow.xhtml#a64cb9ef47834d2696d0b8166b6f39451) (std::string const &amp;input\_name) const std::pair&lt; int, [ansys::dpf::Operator](classansys_1_1dpf_1_1Operator.xhtml) &gt; [operatorForOutput](classansys_1_1dpf_1_1Workflow.xhtml#aeb5cac6b425e459a4261f03bae73d5f3) (std::string const &amp;output\_name) const ![-](/sites/default/files/migrate-content/dpf_cpp_client_library_2024_r2/closed.png) Public Member Functions inherited from [ansys::dpf::DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml)virtual bool [empty](classansys_1_1dpf_1_1DpfTypes.xhtml#a39cd546c42518e2332be8f287db95459) () const virtual bool [hasInternalObject](classansys_1_1dpf_1_1DpfTypes.xhtml#ae198f89868d85c7db6dc1a934a1d3c15) () const virtual std::string [describe](classansys_1_1dpf_1_1DpfTypes.xhtml#a9977945710983bc03d2940fa007847b2) () const so::API const \* [callAPI](classansys_1_1dpf_1_1DpfTypes.xhtml#aea34d37e0c080126eff70db34bf46597) () const bool [isOnCommonAPI](classansys_1_1dpf_1_1DpfTypes.xhtml#a9f9789ff61cc9d400a2a344830706b73) () const bool [getClient](classansys_1_1dpf_1_1DpfTypes.xhtml#a968afd9daa0b0f13b65a2ac61369d73a) ([Client](classansys_1_1dpf_1_1Client.xhtml) &amp;client) const bool [hasBeenMovedLocally](classansys_1_1dpf_1_1DpfTypes.xhtml#a1a5634202c15404b6b24e8f50e51cb66) () const bool [isSameObject](classansys_1_1dpf_1_1DpfTypes.xhtml#aa64d5f8fcd7d85ad6ebf708494dbefd7) ([DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml) const &amp;rhs) const ## <a id="pub-static-methods" name="pub-static-methods"></a>Static Public Member Functions

static [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) [emptyWorkflow](classansys_1_1dpf_1_1Workflow.xhtml#a304b3dba1aba101c15b08d9853111a72) () <a id="details" name="details"></a>## Detailed Description

Group a set of connected operators in order to define a whole data treatment.

Operators can be chained together to create workflows. To do so, the user only needs to connect some operator's outputs to an other operator's inputs. With workflows, lazy evaluation is performed, which means that when the last operator's outputs are asked by the user, all the connected operators will also be evaluated (and not before) to compute a given result.

The different operators contained in a workflow can be internally connected together so that the end user doesn't need to be aware of its complexity. The workflow only needs to expose the necessary inputs pin and output pins. For example, a workflow could expose a "time scoping" input pin and a "data sources" input pin and expose a "result" output pin and have very complex routines inside it.

Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#_a87).

## Constructor &amp; Destructor Documentation

<a id="a2846bb6c6a083c909cc69cdd7693e2af" name="a2846bb6c6a083c909cc69cdd7693e2af"></a>## [◆ ](#a2846bb6c6a083c909cc69cdd7693e2af)Workflow() \[1/5\]

 ansys::dpf::Workflow::Workflow  ( ) 

Create a new workflow.





<a id="a8a36b36629bde25afe03b12b0ed5a958" name="a8a36b36629bde25afe03b12b0ed5a958"></a>## [◆ ](#a8a36b36629bde25afe03b12b0ed5a958)Workflow() \[2/5\]

 ansys::dpf::Workflow::Workflow  ( std::string const &amp;  *workflow\_string*) 

Create a workflow from a string.

Parameters \[in\]workflow\_string[Workflow](classansys_1_1dpf_1_1Workflow.xhtml "Group a set of connected operators in order to define a whole data treatment.") string definition generated by [writeToString()](classansys_1_1dpf_1_1Workflow.xhtml#a6aaabec3049d60c96c32f7eb3ae38a0f). 



<a id="a9df2ce30e71299cc68d8c8b5ad6d0aab" name="a9df2ce30e71299cc68d8c8b5ad6d0aab"></a>## [◆ ](#a9df2ce30e71299cc68d8c8b5ad6d0aab)Workflow() \[3/5\]

 ansys::dpf::Workflow::Workflow  ( [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*) 

Create a new workflow on a server.





<a id="a75ca6a59b59ded54d4606acfc8f30d26" name="a75ca6a59b59ded54d4606acfc8f30d26"></a>## [◆ ](#a75ca6a59b59ded54d4606acfc8f30d26)Workflow() \[4/5\]

 ansys::dpf::Workflow::Workflow  ( std::string const &amp;  *workflow\_string*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*   ) 

Create a workflow from a string on a server.

Parameters \[in\]workflow\_string[Workflow](classansys_1_1dpf_1_1Workflow.xhtml "Group a set of connected operators in order to define a whole data treatment.") string definition generated by [writeToString()](classansys_1_1dpf_1_1Workflow.xhtml#a6aaabec3049d60c96c32f7eb3ae38a0f). 



<a id="a463fddfb0fd209fc582de029dfbcc7e6" name="a463fddfb0fd209fc582de029dfbcc7e6"></a>## [◆ ](#a463fddfb0fd209fc582de029dfbcc7e6)Workflow() \[5/5\]

 ansys::dpf::Workflow::Workflow  ( [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e)  *id*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*   ) 

Retrieve an existing instance of [Workflow](classansys_1_1dpf_1_1Workflow.xhtml "Group a set of connected operators in order to define a whole data treatment.") on a server.





## Member Function Documentation

<a id="a794c8ac3fdd9459ebfe87f3962936a81" name="a794c8ac3fdd9459ebfe87f3962936a81"></a>## [◆ ](#a794c8ac3fdd9459ebfe87f3962936a81)add()

 void ansys::dpf::Workflow::add  ( [Operator](classansys_1_1dpf_1_1Operator.xhtml) &amp;  *op*) 

Add operator to workflow.

Parameters \[in\]op[Operator](classansys_1_1dpf_1_1Operator.xhtml) to add. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a88).



<a id="a36001ca148e2ca1f6d0518d3aefad5dd" name="a36001ca148e2ca1f6d0518d3aefad5dd"></a>## [◆ ](#a36001ca148e2ca1f6d0518d3aefad5dd)chainWith() \[1/2\]

 void ansys::dpf::Workflow::chainWith  ( const [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp;  *wf*) 

Append given workflow.

Parameters \[in\]wf[Workflow](classansys_1_1dpf_1_1Workflow.xhtml) to add. 



<a id="afdb94d06a19ad7f8288a462d7e58b2aa" name="afdb94d06a19ad7f8288a462d7e58b2aa"></a>## [◆ ](#afdb94d06a19ad7f8288a462d7e58b2aa)chainWith() \[2/2\]

 void ansys::dpf::Workflow::chainWith  ( const [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp;  *wf*,    const std::pair&lt; std::string, std::string &gt; &amp;  *in\_out\_names*   ) 

Append given workflow. Output name is connected to input name of given workflow.

Parameters \[in\]wf[Workflow](classansys_1_1dpf_1_1Workflow.xhtml) to add. \[in\]in\_out\_namesPair of input/output names. 



<a id="ad572b0f3feec3e59bfab415303a9b648" name="ad572b0f3feec3e59bfab415303a9b648"></a>## [◆ ](#ad572b0f3feec3e59bfab415303a9b648)connect() \[1/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Any](classansys_1_1dpf_1_1Any.xhtml) const &amp;  *f*   ) 

Connect [Any](classansys_1_1dpf_1_1Any.xhtml) to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[Any](classansys_1_1dpf_1_1Any.xhtml) data. 



<a id="ac2989ccb8dafbb4bf150d7d774d17515" name="ac2989ccb8dafbb4bf150d7d774d17515"></a>## [◆ ](#ac2989ccb8dafbb4bf150d7d774d17515)connect() \[2/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Any](classansys_1_1dpf_1_1Any.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect [Any](classansys_1_1dpf_1_1Any.xhtml) support to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[Workflow](classansys_1_1dpf_1_1Workflow.xhtml "Group a set of connected operators in order to define a whole data treatment.") [Any](classansys_1_1dpf_1_1Any.xhtml) data. \[out\]errorStatus of call. 



<a id="a0359e496cfe9ef8b635df5ced09ee4ed" name="a0359e496cfe9ef8b635df5ced09ee4ed"></a>## [◆ ](#a0359e496cfe9ef8b635df5ced09ee4ed)connect() \[3/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    bool  *f*   ) 

Connect boolean to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fBoolean data. 



<a id="a6751a4d3a941a668c886d10464588f51" name="a6751a4d3a941a668c886d10464588f51"></a>## [◆ ](#a6751a4d3a941a668c886d10464588f51)connect() \[4/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    bool  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect boolean to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fBoolean data. \[out\]errorStatus of call. 



<a id="a3090ae5e11e680aeabc884d078783e25" name="a3090ae5e11e680aeabc884d078783e25"></a>## [◆ ](#a3090ae5e11e680aeabc884d078783e25)connect() \[5/58\]

template&lt;typename DataT &gt; 

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Collection](classansys_1_1dpf_1_1Collection.xhtml)&lt; DataT &gt; const &amp;  *f*   )   inline 

Connect [Any](classansys_1_1dpf_1_1Any.xhtml) dpf type.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[Operator](classansys_1_1dpf_1_1Operator.xhtml) from which to connect output pin. 



<a id="a8474ee76056b00dc1aeaa4d88984d782" name="a8474ee76056b00dc1aeaa4d88984d782"></a>## [◆ ](#a8474ee76056b00dc1aeaa4d88984d782)connect() \[6/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [CustomContainerBase](classansys_1_1dpf_1_1CustomContainerBase.xhtml) const &amp;  *f*   ) 

Connect [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[CustomContainerBase](classansys_1_1dpf_1_1CustomContainerBase.xhtml "Allows you to define your own containers by deriving from this class.") data. 



<a id="a4f95687c759c261e5503e71758784f67" name="a4f95687c759c261e5503e71758784f67"></a>## [◆ ](#a4f95687c759c261e5503e71758784f67)connect() \[7/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) const &amp;  *f*   ) 

Connect [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) data. 



<a id="ae5dc73ae63ea8c4436acdb5f0cf85ded" name="ae5dc73ae63ea8c4436acdb5f0cf85ded"></a>## [◆ ](#ae5dc73ae63ea8c4436acdb5f0cf85ded)connect() \[8/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) support to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) data. \[out\]errorStatus of call. 



<a id="a1bd6c48a52a6e33007d35ec97656a026" name="a1bd6c48a52a6e33007d35ec97656a026"></a>## [◆ ](#a1bd6c48a52a6e33007d35ec97656a026)connect() \[9/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) const &amp;  *f*   ) 

Connect [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) data. 



<a id="a0330735c90420e64055475071e77ac20" name="a0330735c90420e64055475071e77ac20"></a>## [◆ ](#a0330735c90420e64055475071e77ac20)connect() \[10/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) support to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) data. \[out\]errorStatus of call. 



<a id="a7a07e03ab9fd7ec733fd0972818eef28" name="a7a07e03ab9fd7ec733fd0972818eef28"></a>## [◆ ](#a7a07e03ab9fd7ec733fd0972818eef28)connect() \[11/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) const &amp;  *f*   ) 

Connect [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fTime frequency support data. 



<a id="a8c1fb6d6b46ad3fc35d8c385780bf797" name="a8c1fb6d6b46ad3fc35d8c385780bf797"></a>## [◆ ](#a8c1fb6d6b46ad3fc35d8c385780bf797)connect() \[12/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) data. \[out\]errorStatus of call. 



<a id="a61879be4ea94798291feddd586145c66" name="a61879be4ea94798291feddd586145c66"></a>## [◆ ](#a61879be4ea94798291feddd586145c66)connect() \[13/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [DataSources](classansys_1_1dpf_1_1DataSources.xhtml) const &amp;  *f*   ) 

Connect data sources to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fData sources data. 



<a id="a09030c86837fdfdaffe50d2423e39cfa" name="a09030c86837fdfdaffe50d2423e39cfa"></a>## [◆ ](#a09030c86837fdfdaffe50d2423e39cfa)connect() \[14/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [DataSources](classansys_1_1dpf_1_1DataSources.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect data sources to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fData sources data. \[out\]errorStatus of call. 



<a id="ace584af53d55760bbfef3a96cc98bfd0" name="ace584af53d55760bbfef3a96cc98bfd0"></a>## [◆ ](#ace584af53d55760bbfef3a96cc98bfd0)connect() \[15/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [DataTree](classansys_1_1dpf_1_1DataTree.xhtml) const &amp;  *f*   ) 

Connect [DataTree](classansys_1_1dpf_1_1DataTree.xhtml) to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[DataTree](classansys_1_1dpf_1_1DataTree.xhtml) data. 



<a id="a6c46ace7d641b785639d5a88dab70c8d" name="a6c46ace7d641b785639d5a88dab70c8d"></a>## [◆ ](#a6c46ace7d641b785639d5a88dab70c8d)connect() \[16/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [DataTree](classansys_1_1dpf_1_1DataTree.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect [DataTree](classansys_1_1dpf_1_1DataTree.xhtml) support to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[DataTree](classansys_1_1dpf_1_1DataTree.xhtml) support data. \[out\]errorStatus of call. 



<a id="a784a219175f41f4a6c7da7703f45defe" name="a784a219175f41f4a6c7da7703f45defe"></a>## [◆ ](#a784a219175f41f4a6c7da7703f45defe)connect() \[17/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790)  *f*   ) 

Connect double to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fDouble data. 



<a id="a2e5709ac0f02efa74c1c76a93482af5f" name="a2e5709ac0f02efa74c1c76a93482af5f"></a>## [◆ ](#a2e5709ac0f02efa74c1c76a93482af5f)connect() \[18/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790)  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect double to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fDouble data. \[out\]errorStatus of call. 



<a id="a6ce835a6bd7213846e9f2a54c3c0a26b" name="a6ce835a6bd7213846e9f2a54c3c0a26b"></a>## [◆ ](#a6ce835a6bd7213846e9f2a54c3c0a26b)connect() \[19/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *f*   ) 

Connect integer to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fInteger data. 



<a id="a7a44ea576bd657745dfe605e451603b6" name="a7a44ea576bd657745dfe605e451603b6"></a>## [◆ ](#a7a44ea576bd657745dfe605e451603b6)connect() \[20/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect integer to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fInteger data. \[out\]errorStatus of call. 



<a id="a4b4bdbd4860a8604c9116550307f9f52" name="a4b4bdbd4860a8604c9116550307f9f52"></a>## [◆ ](#a4b4bdbd4860a8604c9116550307f9f52)connect() \[21/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Field](classansys_1_1dpf_1_1Field.xhtml) const &amp;  *f*   ) 

Connect field to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[Field](classansys_1_1dpf_1_1Field.xhtml) data. 



<a id="a070371d847e987fc27e8a16a0be4d88e" name="a070371d847e987fc27e8a16a0be4d88e"></a>## [◆ ](#a070371d847e987fc27e8a16a0be4d88e)connect() \[22/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Field](classansys_1_1dpf_1_1Field.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect field to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[Field](classansys_1_1dpf_1_1Field.xhtml) data. \[out\]errorStatus of call. 



<a id="aa48c016c9f389323b27371756350654c" name="aa48c016c9f389323b27371756350654c"></a>## [◆ ](#aa48c016c9f389323b27371756350654c)connect() \[23/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) const &amp;  *f*   ) 

Connect fields container to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fFields container data. 



<a id="a0c4754aa87841da9daf4132269c2c6fa" name="a0c4754aa87841da9daf4132269c2c6fa"></a>## [◆ ](#a0c4754aa87841da9daf4132269c2c6fa)connect() \[24/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect fields container to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fFields container data. \[out\]errorStatus of call. 



<a id="ad6aa6756fd298e844d4bd319b674bf67" name="ad6aa6756fd298e844d4bd319b674bf67"></a>## [◆ ](#ad6aa6756fd298e844d4bd319b674bf67)connect() \[25/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    GenericDataContainer const &amp;  *f*   ) 

Connect GenericDataContainer to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fGenericDataContainer data. 



<a id="a3b7bf7f99abc786f14a2730ee1a10060" name="a3b7bf7f99abc786f14a2730ee1a10060"></a>## [◆ ](#a3b7bf7f99abc786f14a2730ee1a10060)connect() \[26/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    GenericDataContainer const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect GenericDataContainer support to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fGenericDataContainer data. \[out\]errorStatus of call. 



<a id="aa6ef243aa013bc7f4a1ba4fa631b5d9d" name="aa6ef243aa013bc7f4a1ba4fa631b5d9d"></a>## [◆ ](#aa6ef243aa013bc7f4a1ba4fa631b5d9d)connect() \[27/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;  *f*   ) 

Connect [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) data. 



<a id="afbd38a2be7389beb2de3304e71ac8065" name="afbd38a2be7389beb2de3304e71ac8065"></a>## [◆ ](#afbd38a2be7389beb2de3304e71ac8065)connect() \[28/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect [LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) support to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[LabelSpace](classansys_1_1dpf_1_1LabelSpace.xhtml) data. \[out\]errorStatus of call. 



<a id="a7e5926bff9b5aa6ee9daa21e324b538e" name="a7e5926bff9b5aa6ee9daa21e324b538e"></a>## [◆ ](#a7e5926bff9b5aa6ee9daa21e324b538e)connect() \[29/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) const &amp;  *f*   ) 

Connect mesed region to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fMeshed region data. 



<a id="a15ed0952fd8c9ee59a60d169c4ed9a7c" name="a15ed0952fd8c9ee59a60d169c4ed9a7c"></a>## [◆ ](#a15ed0952fd8c9ee59a60d169c4ed9a7c)connect() \[30/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect meshed region to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fMeshed region data. \[out\]errorStatus of call. 



<a id="a29916dec796fd6307c89df8c85244aa9" name="a29916dec796fd6307c89df8c85244aa9"></a>## [◆ ](#a29916dec796fd6307c89df8c85244aa9)connect() \[31/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [MeshesContainer](classansys_1_1dpf_1_1MeshesContainer.xhtml) const &amp;  *f*   ) 

Connect meshes container to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fMeshes container data. 



<a id="ad17a794af1d450de045339847fa08f9d" name="ad17a794af1d450de045339847fa08f9d"></a>## [◆ ](#ad17a794af1d450de045339847fa08f9d)connect() \[32/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [MeshesContainer](classansys_1_1dpf_1_1MeshesContainer.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect meshes container to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fMeshes container data. \[out\]errorStatus of call. 



<a id="ac1412df4cb8570cc573ad59bdf6bd798" name="ac1412df4cb8570cc573ad59bdf6bd798"></a>## [◆ ](#ac1412df4cb8570cc573ad59bdf6bd798)connect() \[33/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Operator](classansys_1_1dpf_1_1Operator.xhtml) const &amp;  *f*,    [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920)  *output\_pin*   ) 

Connect operator output pin to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[Operator](classansys_1_1dpf_1_1Operator.xhtml) from which to connect output pin. \[in\]output\_pinOutput pin. 



<a id="aa1716e9cc3ecea9fd72ec6c945c66baa" name="aa1716e9cc3ecea9fd72ec6c945c66baa"></a>## [◆ ](#aa1716e9cc3ecea9fd72ec6c945c66baa)connect() \[34/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Operator](classansys_1_1dpf_1_1Operator.xhtml) const &amp;  *f*,    [dp\_index](namespaceansys_1_1dpf.xhtml#a417548d1b705a9ba54ba9429afe68920)  *output\_pin*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect operator output pin to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[Operator](classansys_1_1dpf_1_1Operator.xhtml) from which to connect output pin. \[in\]output\_pinOutput pin. \[out\]errorStatus of call. 



<a id="a93dc6b31b164f5c4337985285fdba586" name="a93dc6b31b164f5c4337985285fdba586"></a>## [◆ ](#a93dc6b31b164f5c4337985285fdba586)connect() \[35/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) const &amp;  *f*   ) 

Connect property field to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fProperty field data. 



<a id="aa7a45dd2967a76b0903648d55bd407ba" name="aa7a45dd2967a76b0903648d55bd407ba"></a>## [◆ ](#aa7a45dd2967a76b0903648d55bd407ba)connect() \[36/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect property field to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fProperty field data. \[out\]errorStatus of call. 



<a id="a8943b00849c0866751571b2e059c1f1f" name="a8943b00849c0866751571b2e059c1f1f"></a>## [◆ ](#a8943b00849c0866751571b2e059c1f1f)connect() \[37/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) const &amp;  *data*   ) 

Connect [Scoping](classansys_1_1dpf_1_1Scoping.xhtml "Define a set of entities by ids.") data to input\_pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin. \[in\]data[Scoping](classansys_1_1dpf_1_1Scoping.xhtml "Define a set of entities by ids.") data to connect to pin. 



<a id="a7c3b78f070e5dd68eb6651ed3cac40dc" name="a7c3b78f070e5dd68eb6651ed3cac40dc"></a>## [◆ ](#a7c3b78f070e5dd68eb6651ed3cac40dc)connect() \[38/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect scoping to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[Scoping](classansys_1_1dpf_1_1Scoping.xhtml) data. \[out\]errorStatus of call. 



<a id="a252c27bd350813cf0909b9577860596a" name="a252c27bd350813cf0909b9577860596a"></a>## [◆ ](#a252c27bd350813cf0909b9577860596a)connect() \[39/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [ScopingsContainer](classansys_1_1dpf_1_1ScopingsContainer.xhtml) const &amp;  *f*   ) 

Connect scopings container to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fScopings container data. 



<a id="a50152bec5cd234c49a0d763552daf2c0" name="a50152bec5cd234c49a0d763552daf2c0"></a>## [◆ ](#a50152bec5cd234c49a0d763552daf2c0)connect() \[40/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [ScopingsContainer](classansys_1_1dpf_1_1ScopingsContainer.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect scopings container to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fScopings container data. \[out\]errorStatus of call. 



<a id="ab47934497d52355ac422efa57677ff75" name="ab47934497d52355ac422efa57677ff75"></a>## [◆ ](#ab47934497d52355ac422efa57677ff75)connect() \[41/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    std::string const &amp;  *f*   ) 

Connect string to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fString data. 



<a id="a4a861efbe5a6ef1e4aaf9aeffe1c0034" name="a4a861efbe5a6ef1e4aaf9aeffe1c0034"></a>## [◆ ](#a4a861efbe5a6ef1e4aaf9aeffe1c0034)connect() \[42/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    std::string const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect string to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fString data. \[out\]errorStatus of call. 



<a id="a667f3d115d92aab65b3220e1ab64fb28" name="a667f3d115d92aab65b3220e1ab64fb28"></a>## [◆ ](#a667f3d115d92aab65b3220e1ab64fb28)connect() \[43/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    std::vector&lt; [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) &gt; const &amp;  *f*   ) 

Connect vector of doubles to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fVector of doubles data. 



<a id="ae6a0ccf692e3df243f16f631a2a3e92f" name="ae6a0ccf692e3df243f16f631a2a3e92f"></a>## [◆ ](#ae6a0ccf692e3df243f16f631a2a3e92f)connect() \[44/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    std::vector&lt; [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) &gt; const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect vector of doubles to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fVector of double data. \[out\]errorStatus of call. 



<a id="a2bbb7a7147a954812864d12b21ded9b3" name="a2bbb7a7147a954812864d12b21ded9b3"></a>## [◆ ](#a2bbb7a7147a954812864d12b21ded9b3)connect() \[45/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    std::vector&lt; int &gt; const &amp;  *f*   ) 

Connect vector of integers to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fVector of integers data. 



<a id="a66788ae625c25ec2e79381cde769dcb9" name="a66788ae625c25ec2e79381cde769dcb9"></a>## [◆ ](#a66788ae625c25ec2e79381cde769dcb9)connect() \[46/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    std::vector&lt; int &gt; const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect vector of integers to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fVector of integer data. \[out\]errorStatus of call. 



<a id="af22209afa4cb0826c3848bf9c99bdcd5" name="af22209afa4cb0826c3848bf9c99bdcd5"></a>## [◆ ](#af22209afa4cb0826c3848bf9c99bdcd5)connect() \[47/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    std::vector&lt; std::string &gt; const &amp;  *f*   ) 

Connect vector of strings to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fVector of strings data. 



<a id="a9dec5cc81a217f554042098835c20e76" name="a9dec5cc81a217f554042098835c20e76"></a>## [◆ ](#a9dec5cc81a217f554042098835c20e76)connect() \[48/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    std::vector&lt; std::string &gt; const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect vector of strings to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fVector of string data. \[out\]errorStatus of call. 



<a id="a0a92f71b04c6db87cfa3a8a21e677f73" name="a0a92f71b04c6db87cfa3a8a21e677f73"></a>## [◆ ](#a0a92f71b04c6db87cfa3a8a21e677f73)connect() \[49/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Streams](classansys_1_1dpf_1_1Streams.xhtml) const &amp;  *f*   ) 

Connect [Streams](classansys_1_1dpf_1_1Streams.xhtml "Defines an open, ready-to-use, data sources.") to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[Streams](classansys_1_1dpf_1_1Streams.xhtml "Defines an open, ready-to-use, data sources.") data. 



<a id="a60314676298ac8f606b72ba8d1373938" name="a60314676298ac8f606b72ba8d1373938"></a>## [◆ ](#a60314676298ac8f606b72ba8d1373938)connect() \[50/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Streams](classansys_1_1dpf_1_1Streams.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect [Streams](classansys_1_1dpf_1_1Streams.xhtml "Defines an open, ready-to-use, data sources.") to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[Streams](classansys_1_1dpf_1_1Streams.xhtml "Defines an open, ready-to-use, data sources.") data. \[out\]errorStatus of call. 



<a id="ab1563b3745846cf98093df6185fdcaf8" name="ab1563b3745846cf98093df6185fdcaf8"></a>## [◆ ](#ab1563b3745846cf98093df6185fdcaf8)connect() \[51/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [StringField](classansys_1_1dpf_1_1StringField.xhtml) const &amp;  *f*   ) 

Connect [StringField](classansys_1_1dpf_1_1StringField.xhtml) to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[StringField](classansys_1_1dpf_1_1StringField.xhtml) data. 



<a id="abbafe54425152568492c1e596a58aede" name="abbafe54425152568492c1e596a58aede"></a>## [◆ ](#abbafe54425152568492c1e596a58aede)connect() \[52/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [StringField](classansys_1_1dpf_1_1StringField.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect [StringField](classansys_1_1dpf_1_1StringField.xhtml) support to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[StringField](classansys_1_1dpf_1_1StringField.xhtml) data. \[out\]errorStatus of call. 



<a id="a0974baecfc7676ccc152faab12b453b8" name="a0974baecfc7676ccc152faab12b453b8"></a>## [◆ ](#a0974baecfc7676ccc152faab12b453b8)connect() \[53/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Support](classansys_1_1dpf_1_1Support.xhtml) const &amp;  *f*   ) 

Connect support to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[Support](classansys_1_1dpf_1_1Support.xhtml) data. 



<a id="a50ab49cc59f6eb17c84aa35a7862b44c" name="a50ab49cc59f6eb17c84aa35a7862b44c"></a>## [◆ ](#a50ab49cc59f6eb17c84aa35a7862b44c)connect() \[54/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Support](classansys_1_1dpf_1_1Support.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect support to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[Support](classansys_1_1dpf_1_1Support.xhtml) data. \[out\]errorStatus of call. 



<a id="a64c8c5a6f4f12237abbc87f850ca0ee9" name="a64c8c5a6f4f12237abbc87f850ca0ee9"></a>## [◆ ](#a64c8c5a6f4f12237abbc87f850ca0ee9)connect() \[55/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) const &amp;  *f*   ) 

Connect time frequency support to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]fTime frequency support data. 



<a id="a54356cdba52df64f31772dc04cbff93b" name="a54356cdba52df64f31772dc04cbff93b"></a>## [◆ ](#a54356cdba52df64f31772dc04cbff93b)connect() \[56/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect timefrequency support to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]fTime frequency support data. \[out\]errorStatus of call. 



<a id="aff5f5d5fc91b7b296cb6fa5ef87c5107" name="aff5f5d5fc91b7b296cb6fa5ef87c5107"></a>## [◆ ](#aff5f5d5fc91b7b296cb6fa5ef87c5107)connect() \[57/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) const &amp;  *f*   ) 

Connect [Workflow](classansys_1_1dpf_1_1Workflow.xhtml "Group a set of connected operators in order to define a whole data treatment.") to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]pin\_nameInput pin name. \[in\]f[Workflow](classansys_1_1dpf_1_1Workflow.xhtml "Group a set of connected operators in order to define a whole data treatment.") data. 



<a id="a3f0bb9caf499a7439ccc560e92636534" name="a3f0bb9caf499a7439ccc560e92636534"></a>## [◆ ](#a3f0bb9caf499a7439ccc560e92636534)connect() \[58/58\]

 void ansys::dpf::Workflow::connect  ( std::string const &amp;  *pin\_name*,    [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) const &amp;  *f*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Connect [Workflow](classansys_1_1dpf_1_1Workflow.xhtml "Group a set of connected operators in order to define a whole data treatment.") support to input pin.

Parameters \[in\]pin\_nameInput pin name. \[in\]f[Workflow](classansys_1_1dpf_1_1Workflow.xhtml "Group a set of connected operators in order to define a whole data treatment.") support data. \[out\]errorStatus of call. 



<a id="a14f12d5fc517547bda3507d1b4904cd1" name="a14f12d5fc517547bda3507d1b4904cd1"></a>## [◆ ](#a14f12d5fc517547bda3507d1b4904cd1)connectCustom()

template&lt;typename DataT &gt; 

 void ansys::dpf::Workflow::connectCustom  ( std::string const &amp;  *input\_pin*,    DataT const &amp;  *d*   )   inline 

Connect typed data to input pin.

Exceptions [DpfException](classansys_1_1dpf_1_1DpfException.xhtml)Parameters \[in\]input\_pinInput pin name. d{in\] Typed data 



<a id="a4175b5645453c094e5ab3da2bc0b139e" name="a4175b5645453c094e5ab3da2bc0b139e"></a>## [◆ ](#a4175b5645453c094e5ab3da2bc0b139e)connectWith() \[1/2\]

 void ansys::dpf::Workflow::connectWith  ( [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp;  *left\_workflow*) 

connect left\_worflow to this workflow with matching input/output names.

Parameters \[in\]left\_workflow[Workflow](classansys_1_1dpf_1_1Workflow.xhtml) to add. 



<a id="a01626b04d4825b54d4a967c72c942fec" name="a01626b04d4825b54d4a967c72c942fec"></a>## [◆ ](#a01626b04d4825b54d4a967c72c942fec)connectWith() \[2/2\]

 void ansys::dpf::Workflow::connectWith  ( [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) &amp;  *left\_workflow*,    std::map&lt; std::string, std::string &gt; const &amp;  *connections*   ) 

connect left\_worflow to this workflow with specified connections (out-&gt;in).

Parameters \[in\]left\_workflow[Workflow](classansys_1_1dpf_1_1Workflow.xhtml) to add. \[in\]connectionsConnections map (out to in). 



<a id="a38fb29d1a8d18b4bc08f40b657179735" name="a38fb29d1a8d18b4bc08f40b657179735"></a>## [◆ ](#a38fb29d1a8d18b4bc08f40b657179735)discoverAllOperators()

 void ansys::dpf::Workflow::discoverAllOperators  ( ) 

Using operator's connectivity, discover all operators contained in the workflow and add them inside.





<a id="a304b3dba1aba101c15b08d9853111a72" name="a304b3dba1aba101c15b08d9853111a72"></a>## [◆ ](#a304b3dba1aba101c15b08d9853111a72)emptyWorkflow()

 static [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) ansys::dpf::Workflow::emptyWorkflow  ( )   static 

Create an empty workflow.

ReturnsEmpty [Workflow](classansys_1_1dpf_1_1Workflow.xhtml). 



<a id="a07b6c6b80c65c47282d631b9d3036289" name="a07b6c6b80c65c47282d631b9d3036289"></a>## [◆ ](#a07b6c6b80c65c47282d631b9d3036289)eraseInputPin()

 void ansys::dpf::Workflow::eraseInputPin  ( std::string const &amp;  *pin\_name*) 

Removes an exposed pin.

Parameters \[in\]pin\_namePin name. 



<a id="ae4aae9e5a3a414fa0ba10db9b219ee2d" name="ae4aae9e5a3a414fa0ba10db9b219ee2d"></a>## [◆ ](#ae4aae9e5a3a414fa0ba10db9b219ee2d)eraseOutputPin()

 void ansys::dpf::Workflow::eraseOutputPin  ( std::string const &amp;  *pin\_name*) 

Removes an exposed pin.

Parameters \[in\]pin\_namePin name. 



<a id="a240864c97ab88338e9ba6ef8c4ad9ed3" name="a240864c97ab88338e9ba6ef8c4ad9ed3"></a>## [◆ ](#a240864c97ab88338e9ba6ef8c4ad9ed3)firstOperator()

 [Operator](classansys_1_1dpf_1_1Operator.xhtml) ansys::dpf::Workflow::firstOperator  ( )  const

ReturnsFirst operator in workflow chain. 



<a id="a850d7aa707b7b9017bd679defc9d2845" name="a850d7aa707b7b9017bd679defc9d2845"></a>## [◆ ](#a850d7aa707b7b9017bd679defc9d2845)getCopy()

 [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) ansys::dpf::Workflow::getCopy  ( )  const

ReturnsCopy of workflow. 



<a id="a3d181c629d1808c570ac90e485a6c5f9" name="a3d181c629d1808c570ac90e485a6c5f9"></a>## [◆ ](#a3d181c629d1808c570ac90e485a6c5f9)getCustomOutput()

template&lt;typename DataT &gt; 

 DataT ansys::dpf::Workflow::getCustomOutput  ( std::string const &amp;  *pin\_name*)   inline 

ReturnsCustom result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a312d744b2c8174b3cd5e1d102ff6ae7b" name="a312d744b2c8174b3cd5e1d102ff6ae7b"></a>## [◆ ](#a312d744b2c8174b3cd5e1d102ff6ae7b)getOutput()

template&lt;typename DataT &gt; 

 DataT ansys::dpf::Workflow::getOutput  ( std::string const &amp;  *pin\_name*)   inline 

ReturnsTyped result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a5340e6ab9473e5615e62223509d473c2" name="a5340e6ab9473e5615e62223509d473c2"></a>## [◆ ](#a5340e6ab9473e5615e62223509d473c2)getOutputAsAny()

 [Any](classansys_1_1dpf_1_1Any.xhtml) ansys::dpf::Workflow::getOutputAsAny  ( std::string const &amp;  *pin\_name*) 

Returns[Any](classansys_1_1dpf_1_1Any.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a6156eba91101e868899f2a9401180a9e" name="a6156eba91101e868899f2a9401180a9e"></a>## [◆ ](#a6156eba91101e868899f2a9401180a9e)getOutputBool() \[1/2\]

 bool ansys::dpf::Workflow::getOutputBool  ( std::string const &amp;  *pin\_name*) 

ReturnsBoolean result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="ac86f5cff304ed6a263f9e915d8a8b3b7" name="ac86f5cff304ed6a263f9e915d8a8b3b7"></a>## [◆ ](#ac86f5cff304ed6a263f9e915d8a8b3b7)getOutputBool() \[2/2\]

 bool ansys::dpf::Workflow::getOutputBool  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsBoolean result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="ab64177b6dcf13680cf698dcdf4dc0c89" name="ab64177b6dcf13680cf698dcdf4dc0c89"></a>## [◆ ](#ab64177b6dcf13680cf698dcdf4dc0c89)getOutputCustomTypeField() \[1/2\]

 [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) ansys::dpf::Workflow::getOutputCustomTypeField  ( std::string const &amp;  *pin\_name*) 

Returns[CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="ab1d36de322f134cd3240fb3aa138d58b" name="ab1d36de322f134cd3240fb3aa138d58b"></a>## [◆ ](#ab1d36de322f134cd3240fb3aa138d58b)getOutputCustomTypeField() \[2/2\]

 [CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) ansys::dpf::Workflow::getOutputCustomTypeField  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Returns[CustomTypeField](classansys_1_1dpf_1_1CustomTypeField.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a1a190e68bcfc34d41616d008278fbdec" name="a1a190e68bcfc34d41616d008278fbdec"></a>## [◆ ](#a1a190e68bcfc34d41616d008278fbdec)getOutputCustomTypeFieldsContainer() \[1/2\]

 [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) ansys::dpf::Workflow::getOutputCustomTypeFieldsContainer  ( std::string const &amp;  *pin\_name*) 

Returns[CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a848ccba76719484ca0fba34f3e2b2282" name="a848ccba76719484ca0fba34f3e2b2282"></a>## [◆ ](#a848ccba76719484ca0fba34f3e2b2282)getOutputCustomTypeFieldsContainer() \[2/2\]

 [CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) ansys::dpf::Workflow::getOutputCustomTypeFieldsContainer  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Returns[CustomTypeFieldsContainer](classansys_1_1dpf_1_1CustomTypeFieldsContainer.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a6d1485f44ae9f6021d7abe5b624ad3dd" name="a6d1485f44ae9f6021d7abe5b624ad3dd"></a>## [◆ ](#a6d1485f44ae9f6021d7abe5b624ad3dd)getOutputCyclicSupport() \[1/2\]

 [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) ansys::dpf::Workflow::getOutputCyclicSupport  ( std::string const &amp;  *pin\_name*) 

Returns[CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a0f25cc380b20d458d5e89e4b65c90f2e" name="a0f25cc380b20d458d5e89e4b65c90f2e"></a>## [◆ ](#a0f25cc380b20d458d5e89e4b65c90f2e)getOutputCyclicSupport() \[2/2\]

 [CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) ansys::dpf::Workflow::getOutputCyclicSupport  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Returns[CyclicSupport](classansys_1_1dpf_1_1CyclicSupport.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="ab5d2dc81bc032dd62781eccc8d08dc72" name="ab5d2dc81bc032dd62781eccc8d08dc72"></a>## [◆ ](#ab5d2dc81bc032dd62781eccc8d08dc72)getOutputDataSources() \[1/2\]

 [DataSources](classansys_1_1dpf_1_1DataSources.xhtml) ansys::dpf::Workflow::getOutputDataSources  ( std::string const &amp;  *pin\_name*) 

ReturnsData sources result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a665a58c468cb73763561a72213a24105" name="a665a58c468cb73763561a72213a24105"></a>## [◆ ](#a665a58c468cb73763561a72213a24105)getOutputDataSources() \[2/2\]

 [DataSources](classansys_1_1dpf_1_1DataSources.xhtml) ansys::dpf::Workflow::getOutputDataSources  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsData sources result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="aae161a44ae32216f89da086d04cc45d2" name="aae161a44ae32216f89da086d04cc45d2"></a>## [◆ ](#aae161a44ae32216f89da086d04cc45d2)getOutputDataTree()

 [DataTree](classansys_1_1dpf_1_1DataTree.xhtml) ansys::dpf::Workflow::getOutputDataTree  ( std::string const &amp;  *pin\_name*) 

Returns[DataTree](classansys_1_1dpf_1_1DataTree.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a6fb5083841eecabdec318dd28db6e71a" name="a6fb5083841eecabdec318dd28db6e71a"></a>## [◆ ](#a6fb5083841eecabdec318dd28db6e71a)getOutputDouble() \[1/2\]

 [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) ansys::dpf::Workflow::getOutputDouble  ( std::string const &amp;  *pin\_name*) 

ReturnsDouble result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a2584163d1c7158faa3bcfeb5fffaeda2" name="a2584163d1c7158faa3bcfeb5fffaeda2"></a>## [◆ ](#a2584163d1c7158faa3bcfeb5fffaeda2)getOutputDouble() \[2/2\]

 [dp\_double](namespaceansys_1_1dpf.xhtml#acb480013bfed185b5e34a0bdcb0e3790) ansys::dpf::Workflow::getOutputDouble  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsDouble result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a4ef3ed3764263f8d09adac332209e564" name="a4ef3ed3764263f8d09adac332209e564"></a>## [◆ ](#a4ef3ed3764263f8d09adac332209e564)getOutputDoubleVector() \[1/2\]

 [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; double &gt; ansys::dpf::Workflow::getOutputDoubleVector  ( std::string const &amp;  *pin\_name*) 

ReturnsDoubles vector result as [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml "Represents a modifiable vector of data and manages its memory.") for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a751600692296801ca04c300ed13327ce" name="a751600692296801ca04c300ed13327ce"></a>## [◆ ](#a751600692296801ca04c300ed13327ce)getOutputDoubleVector() \[2/2\]

 [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; double &gt; ansys::dpf::Workflow::getOutputDoubleVector  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsDoubles vector result as [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml "Represents a modifiable vector of data and manages its memory.") for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a21d864839aa5e8df007f9596ec69a58a" name="a21d864839aa5e8df007f9596ec69a58a"></a>## [◆ ](#a21d864839aa5e8df007f9596ec69a58a)getOutputField() \[1/2\]

 [Field](classansys_1_1dpf_1_1Field.xhtml) ansys::dpf::Workflow::getOutputField  ( std::string const &amp;  *pin\_name*) 

Returns[Field](classansys_1_1dpf_1_1Field.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="ae6a68dfd55de34b0d6341187c526f555" name="ae6a68dfd55de34b0d6341187c526f555"></a>## [◆ ](#ae6a68dfd55de34b0d6341187c526f555)getOutputField() \[2/2\]

 [Field](classansys_1_1dpf_1_1Field.xhtml) ansys::dpf::Workflow::getOutputField  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Returns[Field](classansys_1_1dpf_1_1Field.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="aa3a9c25bbfb550d6692c063f9c3a9366" name="aa3a9c25bbfb550d6692c063f9c3a9366"></a>## [◆ ](#aa3a9c25bbfb550d6692c063f9c3a9366)getOutputFieldsContainer() \[1/2\]

 [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) ansys::dpf::Workflow::getOutputFieldsContainer  ( std::string const &amp;  *pin\_name*) 

ReturnsFields container result for given output pin. Parameters \[in\]pin\_nameOutput pin name. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a94).



<a id="a9ca347cc825a5222992789d272319855" name="a9ca347cc825a5222992789d272319855"></a>## [◆ ](#a9ca347cc825a5222992789d272319855)getOutputFieldsContainer() \[2/2\]

 [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) ansys::dpf::Workflow::getOutputFieldsContainer  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsFields container result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a9661afd7e92eecc870617730041cc103" name="a9661afd7e92eecc870617730041cc103"></a>## [◆ ](#a9661afd7e92eecc870617730041cc103)getOutputGenericDataContainer() \[1/2\]

 GenericDataContainer ansys::dpf::Workflow::getOutputGenericDataContainer  ( std::string const &amp;  *pin\_name*) 

ReturnsGenericDataContainer result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a146947a1a0e68693bbbef667e32a1ba9" name="a146947a1a0e68693bbbef667e32a1ba9"></a>## [◆ ](#a146947a1a0e68693bbbef667e32a1ba9)getOutputGenericDataContainer() \[2/2\]

 GenericDataContainer ansys::dpf::Workflow::getOutputGenericDataContainer  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsGenericDataContainer result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a763c0ba2b4e2184b40ab4a7a32e356c1" name="a763c0ba2b4e2184b40ab4a7a32e356c1"></a>## [◆ ](#a763c0ba2b4e2184b40ab4a7a32e356c1)getOutputInt() \[1/2\]

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::Workflow::getOutputInt  ( std::string const &amp;  *pin\_name*) 

ReturnsInteger result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a152f76caf982e70a1441ff18fee7ff58" name="a152f76caf982e70a1441ff18fee7ff58"></a>## [◆ ](#a152f76caf982e70a1441ff18fee7ff58)getOutputInt() \[2/2\]

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::Workflow::getOutputInt  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsInteger result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="ad3afdaf27db659d67365c0f76de110ef" name="ad3afdaf27db659d67365c0f76de110ef"></a>## [◆ ](#ad3afdaf27db659d67365c0f76de110ef)getOutputIntVector() \[1/2\]

 [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; int &gt; ansys::dpf::Workflow::getOutputIntVector  ( std::string const &amp;  *pin\_name*) 

ReturnsIntegers vector result as [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml "Represents a modifiable vector of data and manages its memory.") for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="ac584ff672992b102d00b63fdfda214b2" name="ac584ff672992b102d00b63fdfda214b2"></a>## [◆ ](#ac584ff672992b102d00b63fdfda214b2)getOutputIntVector() \[2/2\]

 [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml)&lt; int &gt; ansys::dpf::Workflow::getOutputIntVector  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsIntegers vector result as [DpfVector](classansys_1_1dpf_1_1DpfVector.xhtml "Represents a modifiable vector of data and manages its memory.") for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a6ea222c1a71552dce249843b94a07fa4" name="a6ea222c1a71552dce249843b94a07fa4"></a>## [◆ ](#a6ea222c1a71552dce249843b94a07fa4)getOutputMeshedRegion() \[1/2\]

 [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) ansys::dpf::Workflow::getOutputMeshedRegion  ( std::string const &amp;  *pin\_name*) 

ReturnsMeshed region result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a7e1b966c6f88bf8913a78fdd1bc9f8ec" name="a7e1b966c6f88bf8913a78fdd1bc9f8ec"></a>## [◆ ](#a7e1b966c6f88bf8913a78fdd1bc9f8ec)getOutputMeshedRegion() \[2/2\]

 [MeshedRegion](classansys_1_1dpf_1_1MeshedRegion.xhtml) ansys::dpf::Workflow::getOutputMeshedRegion  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsMeshed region result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a6c7cb7443fd062fea0ca57d48600d480" name="a6c7cb7443fd062fea0ca57d48600d480"></a>## [◆ ](#a6c7cb7443fd062fea0ca57d48600d480)getOutputMeshesContainer() \[1/2\]

 [MeshesContainer](classansys_1_1dpf_1_1MeshesContainer.xhtml) ansys::dpf::Workflow::getOutputMeshesContainer  ( std::string const &amp;  *pin\_name*) 

ReturnsMeshes container result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="aa776a964e764c7e4b48172a0058f4549" name="aa776a964e764c7e4b48172a0058f4549"></a>## [◆ ](#aa776a964e764c7e4b48172a0058f4549)getOutputMeshesContainer() \[2/2\]

 [MeshesContainer](classansys_1_1dpf_1_1MeshesContainer.xhtml) ansys::dpf::Workflow::getOutputMeshesContainer  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsMeshes container result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a505757d97be1f400590993ea7afff978" name="a505757d97be1f400590993ea7afff978"></a>## [◆ ](#a505757d97be1f400590993ea7afff978)getOutputPropertyField() \[1/2\]

 [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) ansys::dpf::Workflow::getOutputPropertyField  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsProperty field result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="acf02bf7c228fb3d944edd838022e7916" name="acf02bf7c228fb3d944edd838022e7916"></a>## [◆ ](#acf02bf7c228fb3d944edd838022e7916)getOutputPropertyField() \[2/2\]

 [PropertyField](classansys_1_1dpf_1_1PropertyField.xhtml) ansys::dpf::Workflow::getOutputPropertyField  ( std::string const &amp;  *pin\_namepin\_name*) 

ReturnsProperty field result for given output pin. Parameters \[in\]pin\_namepin\_nameOutput pin name. 



<a id="aed1256fa413f596e2adfea30249f7709" name="aed1256fa413f596e2adfea30249f7709"></a>## [◆ ](#aed1256fa413f596e2adfea30249f7709)getOutputResultInfo() \[1/2\]

 [ResultInfo](classansys_1_1dpf_1_1ResultInfo.xhtml) ansys::dpf::Workflow::getOutputResultInfo  ( std::string const &amp;  *pin\_name*) 

Returns[Result](classansys_1_1dpf_1_1Result.xhtml) information result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="aeffa8acf3f758d6889815f63cabe07fe" name="aeffa8acf3f758d6889815f63cabe07fe"></a>## [◆ ](#aeffa8acf3f758d6889815f63cabe07fe)getOutputResultInfo() \[2/2\]

 [ResultInfo](classansys_1_1dpf_1_1ResultInfo.xhtml) ansys::dpf::Workflow::getOutputResultInfo  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Returns[Result](classansys_1_1dpf_1_1Result.xhtml) information result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a74132c47f9aba3bf91929057a5765d26" name="a74132c47f9aba3bf91929057a5765d26"></a>## [◆ ](#a74132c47f9aba3bf91929057a5765d26)getOutputScoping() \[1/2\]

 [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) ansys::dpf::Workflow::getOutputScoping  ( std::string const &amp;  *pin\_name*) 

Returns[Scoping](classansys_1_1dpf_1_1Scoping.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a5c6b0a0ed35ad495a2776d9ec078fc19" name="a5c6b0a0ed35ad495a2776d9ec078fc19"></a>## [◆ ](#a5c6b0a0ed35ad495a2776d9ec078fc19)getOutputScoping() \[2/2\]

 [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) ansys::dpf::Workflow::getOutputScoping  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Returns[Scoping](classansys_1_1dpf_1_1Scoping.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a33caface659fe462e68fdbcc0970a1be" name="a33caface659fe462e68fdbcc0970a1be"></a>## [◆ ](#a33caface659fe462e68fdbcc0970a1be)getOutputScopingsContainer() \[1/2\]

 [ScopingsContainer](classansys_1_1dpf_1_1ScopingsContainer.xhtml) ansys::dpf::Workflow::getOutputScopingsContainer  ( std::string const &amp;  *pin\_name*) 

ReturnsScopings container result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a545556717c00fa45e69d5ef73db01a56" name="a545556717c00fa45e69d5ef73db01a56"></a>## [◆ ](#a545556717c00fa45e69d5ef73db01a56)getOutputScopingsContainer() \[2/2\]

 [ScopingsContainer](classansys_1_1dpf_1_1ScopingsContainer.xhtml) ansys::dpf::Workflow::getOutputScopingsContainer  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsScopings container result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="ae584dfe4b900829cd8bca00dd3200363" name="ae584dfe4b900829cd8bca00dd3200363"></a>## [◆ ](#ae584dfe4b900829cd8bca00dd3200363)getOutputStreams() \[1/2\]

 [Streams](classansys_1_1dpf_1_1Streams.xhtml) ansys::dpf::Workflow::getOutputStreams  ( std::string const &amp;  *pin\_name*) 

Returns[Streams](classansys_1_1dpf_1_1Streams.xhtml "Defines an open, ready-to-use, data sources.") result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a71da7d7f3e4eafd716ed3a6231f367ba" name="a71da7d7f3e4eafd716ed3a6231f367ba"></a>## [◆ ](#a71da7d7f3e4eafd716ed3a6231f367ba)getOutputStreams() \[2/2\]

 [Streams](classansys_1_1dpf_1_1Streams.xhtml) ansys::dpf::Workflow::getOutputStreams  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Returns[Streams](classansys_1_1dpf_1_1Streams.xhtml "Defines an open, ready-to-use, data sources.") result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a59d4b94233be7f750d0a1af78accd6ba" name="a59d4b94233be7f750d0a1af78accd6ba"></a>## [◆ ](#a59d4b94233be7f750d0a1af78accd6ba)getOutputString() \[1/2\]

 std::string ansys::dpf::Workflow::getOutputString  ( std::string const &amp;  *pin\_index*) 

ReturnsString result for given output pin. Parameters \[in\]pin\_indexOutput pin name. 



<a id="aaa166e26a853f3619f66841f394cbb90" name="aaa166e26a853f3619f66841f394cbb90"></a>## [◆ ](#aaa166e26a853f3619f66841f394cbb90)getOutputString() \[2/2\]

 std::string ansys::dpf::Workflow::getOutputString  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsString result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="add8d5ca19cf8ceba3d69cb6489ea234c" name="add8d5ca19cf8ceba3d69cb6489ea234c"></a>## [◆ ](#add8d5ca19cf8ceba3d69cb6489ea234c)getOutputStringField() \[1/2\]

 [StringField](classansys_1_1dpf_1_1StringField.xhtml) ansys::dpf::Workflow::getOutputStringField  ( std::string const &amp;  *pin\_name*) 

Returns[StringField](classansys_1_1dpf_1_1StringField.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a43caf8cf225d29a869798a9920a501e4" name="a43caf8cf225d29a869798a9920a501e4"></a>## [◆ ](#a43caf8cf225d29a869798a9920a501e4)getOutputStringField() \[2/2\]

 [StringField](classansys_1_1dpf_1_1StringField.xhtml) ansys::dpf::Workflow::getOutputStringField  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Returns[StringField](classansys_1_1dpf_1_1StringField.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="aaf5694a0c8e6c6aca9436c5c83af76b2" name="aaf5694a0c8e6c6aca9436c5c83af76b2"></a>## [◆ ](#aaf5694a0c8e6c6aca9436c5c83af76b2)getOutputSupport() \[1/2\]

 [Support](classansys_1_1dpf_1_1Support.xhtml) ansys::dpf::Workflow::getOutputSupport  ( std::string const &amp;  *pin\_name*) 

Returns[Support](classansys_1_1dpf_1_1Support.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="ac72d8c2dcd1440727a32eab2dd116de5" name="ac72d8c2dcd1440727a32eab2dd116de5"></a>## [◆ ](#ac72d8c2dcd1440727a32eab2dd116de5)getOutputSupport() \[2/2\]

 [Support](classansys_1_1dpf_1_1Support.xhtml) ansys::dpf::Workflow::getOutputSupport  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Returns[Support](classansys_1_1dpf_1_1Support.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="ac087d530db5bea30250a6110054f204a" name="ac087d530db5bea30250a6110054f204a"></a>## [◆ ](#ac087d530db5bea30250a6110054f204a)getOutputTimeFreqSupport() \[1/2\]

 [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) ansys::dpf::Workflow::getOutputTimeFreqSupport  ( std::string const &amp;  *pin\_name*) 

ReturnsTime frequency support result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="ae52042f810882873efc0ba757202e886" name="ae52042f810882873efc0ba757202e886"></a>## [◆ ](#ae52042f810882873efc0ba757202e886)getOutputTimeFreqSupport() \[2/2\]

 [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml) ansys::dpf::Workflow::getOutputTimeFreqSupport  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

ReturnsTime frequency support result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="abeff5a7ffd64f443c6da0be2e254563c" name="abeff5a7ffd64f443c6da0be2e254563c"></a>## [◆ ](#abeff5a7ffd64f443c6da0be2e254563c)getOutputUnit() \[1/2\]

 [Unit](classansys_1_1dpf_1_1Unit.xhtml) ansys::dpf::Workflow::getOutputUnit  ( std::string const &amp;  *pin\_name*) 

Returns[Unit](classansys_1_1dpf_1_1Unit.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="af8eb2c09487a34ec09f8166072c5ca2c" name="af8eb2c09487a34ec09f8166072c5ca2c"></a>## [◆ ](#af8eb2c09487a34ec09f8166072c5ca2c)getOutputUnit() \[2/2\]

 [Unit](classansys_1_1dpf_1_1Unit.xhtml) ansys::dpf::Workflow::getOutputUnit  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Returns[Unit](classansys_1_1dpf_1_1Unit.xhtml) result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a6291348781887726efc7afe9e31a5fb9" name="a6291348781887726efc7afe9e31a5fb9"></a>## [◆ ](#a6291348781887726efc7afe9e31a5fb9)getOutputWorkflow() \[1/2\]

 [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) ansys::dpf::Workflow::getOutputWorkflow  ( std::string const &amp;  *pin\_name*) 

Returns[Workflow](classansys_1_1dpf_1_1Workflow.xhtml "Group a set of connected operators in order to define a whole data treatment.") result for given output pin. Parameters \[in\]pin\_nameOutput pin name. 



<a id="a512f234628a9f2b95ad423907ddb25c4" name="a512f234628a9f2b95ad423907ddb25c4"></a>## [◆ ](#a512f234628a9f2b95ad423907ddb25c4)getOutputWorkflow() \[2/2\]

 [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) ansys::dpf::Workflow::getOutputWorkflow  ( std::string const &amp;  *pin\_name*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Returns[Workflow](classansys_1_1dpf_1_1Workflow.xhtml "Group a set of connected operators in order to define a whole data treatment.") result for given output pin. Parameters \[in\]pin\_nameOutput pin name. \[out\]errorStatus of call. 



<a id="a88a367b1638835774ffa7d7521b741c7" name="a88a367b1638835774ffa7d7521b741c7"></a>## [◆ ](#a88a367b1638835774ffa7d7521b741c7)getRemoteId()

 [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) ansys::dpf::Workflow::getRemoteId  ( )  const

If the workflow is remote, returns its Id on the server.





<a id="ad4082c537432a19c765d590a6901ab22" name="ad4082c537432a19c765d590a6901ab22"></a>## [◆ ](#ad4082c537432a19c765d590a6901ab22)hasInputPin()

 bool ansys::dpf::Workflow::hasInputPin  ( std::string const &amp;  *pin\_name*)  const

ReturnsIndication of existence of given input pin. Parameters \[in\]pin\_nameName of pin for which to check existence. 



<a id="a971acc185d66d6c1beec47af476a37b5" name="a971acc185d66d6c1beec47af476a37b5"></a>## [◆ ](#a971acc185d66d6c1beec47af476a37b5)hasOutputPin()

 bool ansys::dpf::Workflow::hasOutputPin  ( std::string const &amp;  *pin\_name*)  const

ReturnsIndication of existence of given output pin. Parameters \[in\]pin\_nameName of in for which to check existence. 



<a id="a70af322877ca5e6ee6e7b1f81012c044" name="a70af322877ca5e6ee6e7b1f81012c044"></a>## [◆ ](#a70af322877ca5e6ee6e7b1f81012c044)hasOutputWhenEvaluated()

 bool ansys::dpf::Workflow::hasOutputWhenEvaluated  ( std::string const &amp;  *pin\_name*) 

ReturnsIndication of existence of output pin when workflow evaluated. Parameters \[in\]pin\_nameName of output pin to check existence. 



<a id="a52b68fcbd68561aa3d47a3368252a9c6" name="a52b68fcbd68561aa3d47a3368252a9c6"></a>## [◆ ](#a52b68fcbd68561aa3d47a3368252a9c6)instantiateOnRemote() \[1/3\]

 [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) ansys::dpf::Workflow::instantiateOnRemote  ( [ansys::dpf::Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*)  const

Make a copy of the workflow (with writeToString) on a server.

Parameters \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) instance designating the IP, port and protocol to use. 



<a id="a7371c4e5525bcf16d83a33a41d69b03c" name="a7371c4e5525bcf16d83a33a41d69b03c"></a>## [◆ ](#a7371c4e5525bcf16d83a33a41d69b03c)instantiateOnRemote() \[2/3\]

 [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) ansys::dpf::Workflow::instantiateOnRemote  ( std::string const &amp;  *address*,    std::string const &amp;  *protocol*   )  const

Asks the server to make a copy of the workflow (with writeToString) on a server address.

Parameters \[in\]addressaddress of the server (ip:port). \[in\]protocolservers protocol (ex: 'grpc'). 



<a id="a9836bf24a8037281f69e7f32285daa45" name="a9836bf24a8037281f69e7f32285daa45"></a>## [◆ ](#a9836bf24a8037281f69e7f32285daa45)instantiateOnRemote() \[3/3\]

 [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) ansys::dpf::Workflow::instantiateOnRemote  ( std::string const &amp;  *ip*,    int  *port*,    std::string const &amp;  *protocol*   )  const

Asks the server to make a copy of the workflow (with writeToString) on a server address.

Parameters \[in\]ipip address of the server. \[in\]portport of the server. \[in\]protocolservers protocol (ex: 'grpc'). 



<a id="a7e7861cf4975e45f30bcc0e19ae55f57" name="a7e7861cf4975e45f30bcc0e19ae55f57"></a>## [◆ ](#a7e7861cf4975e45f30bcc0e19ae55f57)lastOperator()

 [Operator](classansys_1_1dpf_1_1Operator.xhtml) ansys::dpf::Workflow::lastOperator  ( )  const

Returnslast operator in workflow chain. 



<a id="a084608aa05b59222823da959778ec525" name="a084608aa05b59222823da959778ec525"></a>## [◆ ](#a084608aa05b59222823da959778ec525)listInputPins()

 std::vector&lt; std::string &gt; ansys::dpf::Workflow::listInputPins  ( )  const

ReturnsVector of input pin names. 



<a id="a6a33ca9d55b7a6f59d4fadb0e393a1eb" name="a6a33ca9d55b7a6f59d4fadb0e393a1eb"></a>## [◆ ](#a6a33ca9d55b7a6f59d4fadb0e393a1eb)listOutputPins()

 std::vector&lt; std::string &gt; ansys::dpf::Workflow::listOutputPins  ( )  const

ReturnsVector of output pin names. 



<a id="a5cb98918b3285132ff6d00f2b5905b2f" name="a5cb98918b3285132ff6d00f2b5905b2f"></a>## [◆ ](#a5cb98918b3285132ff6d00f2b5905b2f)loadFromSwf()

 void ansys::dpf::Workflow::loadFromSwf  ( std::string const &amp;  *file\_path*) 

Load workflow from given file.

Parameters \[in\]file\_pathName of file from which to read workflow. 



<a id="a71a0990995b27105d4c362ad2880e4d7" name="a71a0990995b27105d4c362ad2880e4d7"></a>## [◆ ](#a71a0990995b27105d4c362ad2880e4d7)nameInputPin()

 void ansys::dpf::Workflow::nameInputPin  ( std::string const &amp;  *pin\_name*,    int  *operator\_input\_pin*,    [Operator](classansys_1_1dpf_1_1Operator.xhtml) &amp;  *op*   ) 

Add an input name to given pin of operator.

Parameters \[in\]pin\_namePin name. \[in\]operator\_input\_pinInput pin. \[in\]op[Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") to which to add pin name. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a89).



<a id="a3a223ef1c0200cc16ac1434ef938efca" name="a3a223ef1c0200cc16ac1434ef938efca"></a>## [◆ ](#a3a223ef1c0200cc16ac1434ef938efca)nameOutputPin()

 void ansys::dpf::Workflow::nameOutputPin  ( [Operator](classansys_1_1dpf_1_1Operator.xhtml) &amp;  *op*,    int  *operator\_output\_pin*,    std::string const &amp;  *pin\_name*   ) 

Add an output name to given pin of operator.

Parameters \[in\]op[Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") to which to add pin name. \[in\]operator\_output\_pinOutput pin. \[in\]pin\_namePin name. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a90).



<a id="ab8b59d1d65ffb6df6845d98e321dfc20" name="ab8b59d1d65ffb6df6845d98e321dfc20"></a>## [◆ ](#ab8b59d1d65ffb6df6845d98e321dfc20)numberOfOperators()

 [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) ansys::dpf::Workflow::numberOfOperators  ( )  const

ReturnsNumber of operators in workflow chain. 



<a id="aeb5cac6b425e459a4261f03bae73d5f3" name="aeb5cac6b425e459a4261f03bae73d5f3"></a>## [◆ ](#aeb5cac6b425e459a4261f03bae73d5f3)operatorForOutput()

 std::pair&lt; int, [ansys::dpf::Operator](classansys_1_1dpf_1_1Operator.xhtml) &gt; ansys::dpf::Workflow::operatorForOutput  ( std::string const &amp;  *output\_name*)  const

get the [Operator](classansys_1_1dpf_1_1Operator.xhtml) and their exposed output pin number for a given exposed output pin name.

Parameters \[in\]output\_namepin\_name 



<a id="a040282982c7c01c8c0a7ac8724859d87" name="a040282982c7c01c8c0a7ac8724859d87"></a>## [◆ ](#a040282982c7c01c8c0a7ac8724859d87)operatorNameByIndex()

 std::string ansys::dpf::Workflow::operatorNameByIndex  ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0)  *index*)  const

Returns[Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") name by index in workflow chain. 



<a id="a64cb9ef47834d2696d0b8166b6f39451" name="a64cb9ef47834d2696d0b8166b6f39451"></a>## [◆ ](#a64cb9ef47834d2696d0b8166b6f39451)operatorsForInput()

 std::vector&lt; std::pair&lt; int, [ansys::dpf::Operator](classansys_1_1dpf_1_1Operator.xhtml) &gt; &gt; ansys::dpf::Workflow::operatorsForInput  ( std::string const &amp;  *input\_name*)  const

get the list of [Operator](classansys_1_1dpf_1_1Operator.xhtml) s and their exposed input pin number for a given exposed input pin name.

Parameters \[in\]input\_namepin\_name 



<a id="a6f93a5ffa10086a7f2a40291119f6e53" name="a6f93a5ffa10086a7f2a40291119f6e53"></a>## [◆ ](#a6f93a5ffa10086a7f2a40291119f6e53)readFromJson()

 void ansys::dpf::Workflow::readFromJson  ( const std::string &amp;  *jsonString*) 

load workflow from string in a json format.





<a id="a304ee206ac4927f7aa757c63b0ec00b5" name="a304ee206ac4927f7aa757c63b0ec00b5"></a>## [◆ ](#a304ee206ac4927f7aa757c63b0ec00b5)record() \[1/2\]

 int ansys::dpf::Workflow::record  ( std::string const &amp;  *name*,    bool  *transfer\_ownership*   ) 

Records the workflow in DPF's registry.

Parameters \[in\]nameName of the workflow. \[in\]transfer\_ownershipIf true the workflow will be suppressed from the registry as soon as it is returned by [ansys::dpf::core::workflowById](classansys_1_1dpf_1_1core.xhtml#a723856ec83974fcb2cc61549f3cb89dd). 



<a id="ab001bca50c1470be154a79841c43314c" name="ab001bca50c1470be154a79841c43314c"></a>## [◆ ](#ab001bca50c1470be154a79841c43314c)record() \[2/2\]

 int ansys::dpf::Workflow::record  ( std::string const &amp;  *name*,    bool  *transfer\_ownership*,    [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &amp;  *error*   ) 

Records the workflow in DPF's registry.

Parameters \[in\]nameName of the workflow. \[in\]transfer\_ownershipIf true the workflow will be suppressed from the registry as soon as it is returned by [ansys::dpf::core::workflowById](classansys_1_1dpf_1_1core.xhtml#a723856ec83974fcb2cc61549f3cb89dd). \[out\]errorName of the workflow. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a91).



<a id="a22fba3c96a8a6e9eda279fd1c4b5358f" name="a22fba3c96a8a6e9eda279fd1c4b5358f"></a>## [◆ ](#a22fba3c96a8a6e9eda279fd1c4b5358f)renameInputPin()

 void ansys::dpf::Workflow::renameInputPin  ( std::string const &amp;  *old\_pin\_name*,    std::string const &amp;  *new\_pin\_name*   ) 

Rename input pin with given name to new name.

Parameters \[in\]old\_pin\_nameName of pin to rename. \[in\]new\_pin\_nameNew pin name. 



<a id="abff62660096b06dd09667061c8e3d8a6" name="abff62660096b06dd09667061c8e3d8a6"></a>## [◆ ](#abff62660096b06dd09667061c8e3d8a6)renameOutputPin()

 void ansys::dpf::Workflow::renameOutputPin  ( std::string const &amp;  *old\_pin\_name*,    std::string const &amp;  *new\_pin\_name*   ) 

Rename output pin with given name to new name.

Parameters \[in\]old\_pin\_nameName of pin to rename. \[in\]new\_pin\_nameNew pin name. 



<a id="a65f7ba38832058e0f233ae45965ef08b" name="a65f7ba38832058e0f233ae45965ef08b"></a>## [◆ ](#a65f7ba38832058e0f233ae45965ef08b)writeToGraphViz()

 void ansys::dpf::Workflow::writeToGraphViz  ( std::string const &amp;  *file\_path*)  const

Write workflow to given file, in a graphViz format.

Parameters \[in\]file\_pathName of file to which to write workflow. 



<a id="a1ddf4b26605e2f28dd54fec4e47310d1" name="a1ddf4b26605e2f28dd54fec4e47310d1"></a>## [◆ ](#a1ddf4b26605e2f28dd54fec4e47310d1)writeToJson()

 void ansys::dpf::Workflow::writeToJson  ( std::string &amp;  *jsonString*)  const

Write workflow to string in a json format. This method is currently not supporting the serialization of data which is connected to an operator of the workflow. For example, trying to write to a JSON string a workflow that contains a forward operator with scoping connected to it, the scoping is not written.





<a id="a6aaabec3049d60c96c32f7eb3ae38a0f" name="a6aaabec3049d60c96c32f7eb3ae38a0f"></a>## [◆ ](#a6aaabec3049d60c96c32f7eb3ae38a0f)writeToString()

 std::string ansys::dpf::Workflow::writeToString  ( )  const

Write workflow to text.





<a id="ad3b00b52721f7019bd2820f93f8c0aa4" name="ad3b00b52721f7019bd2820f93f8c0aa4"></a>## [◆ ](#ad3b00b52721f7019bd2820f93f8c0aa4)writeToSwf()

 void ansys::dpf::Workflow::writeToSwf  ( std::string const &amp;  *file\_path*)  const

Write workflow to given file, in a DataProcessing format.

Parameters \[in\]file\_pathName of file to which to write workflow.