## On this page

  

 

 # ansys::dpf::core Class Reference

 Last update: 16.07.2025 

`#include <dpf_api.h>`

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

static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) [applyContext](classansys_1_1dpf_1_1core.xhtml#a5fbdf727da47ba6dd749ade51f1f2dcc) ([Context](classansys_1_1dpf_1_1Context.xhtml) const &amp;context) static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) [releaseDpf](classansys_1_1dpf_1_1core.xhtml#a1a1687a6a7403dcbdb7fdbda47e100dc) () static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) [releaseDpf](classansys_1_1dpf_1_1core.xhtml#a8dd035c5ee368c43a4bc0d25b356e28a) ([Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client) static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) [applyContext](classansys_1_1dpf_1_1core.xhtml#a768caf3bdc514ba3469584ea6da7ce78) ([Context](classansys_1_1dpf_1_1Context.xhtml) const &amp;context, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client) static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) [loadDpfPlugin](classansys_1_1dpf_1_1core.xhtml#addc032f5882185bcf940ce7adf293327) (std::string const &amp;plugin\_path, std::string const &amp;plugin\_name, std::string const &amp;symbol="LoadOperators") static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) [loadDpfPlugin](classansys_1_1dpf_1_1core.xhtml#aa9921dd047827c618f977e01ee088694) (std::string const &amp;plugin\_path, std::string const &amp;plugin\_name, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client) static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) [loadDpfPlugin](classansys_1_1dpf_1_1core.xhtml#a74f7e10fc172292bc61582304787c30f) (std::string const &amp;plugin\_path, std::string const &amp;plugin\_name, std::string const &amp;symbol, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client) static [Operator](classansys_1_1dpf_1_1Operator.xhtml) [assertInstantiate](classansys_1_1dpf_1_1core.xhtml#a90f442e446b15a9fb5171ddcdf191b16) (std::string const &amp;identifier) static [Operator](classansys_1_1dpf_1_1Operator.xhtml) [assertInstantiate](classansys_1_1dpf_1_1core.xhtml#ac729e14b3132c112e50982614be304aa) (std::string const &amp;identifier, [OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml) const &amp;config) static [OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml) [defaultOperatorConfig](classansys_1_1dpf_1_1core.xhtml#a20f37512490ec6131335f52be7f2f28d) (std::string const &amp;op\_identifier, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client=nullptr) static [OperatorSpecification](classansys_1_1dpf_1_1OperatorSpecification.xhtml) [getOperatorSpecification](classansys_1_1dpf_1_1core.xhtml#ae9c538db9a8802e9ec28e9e7b40267b5) (std::string const &amp;identifier, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client=nullptr) static void [recordOperator](classansys_1_1dpf_1_1core.xhtml#a1ba7a71221fa1426e7d692af8073c6f9) (OperatorMainFunction f, std::string const &amp;operator\_identifier, AbstractCore \*[core](classansys_1_1dpf_1_1core.xhtml)=nullptr) static void [recordOperator](classansys_1_1dpf_1_1core.xhtml#ae2e440cbaacff372ab16a894ebd58523) (OperatorMainFunction f, std::string const &amp;operator\_identifier, [OperatorSpecification](classansys_1_1dpf_1_1OperatorSpecification.xhtml) const &amp;[spec](structansys_1_1dpf_1_1spec.xhtml), AbstractCore \*=nullptr) template&lt;typename StructureT &gt; static void [recordOperator](classansys_1_1dpf_1_1core.xhtml#ab323bdae88822935579597e9057cc14b) () <a id="aeb4b908d70980261a3d1ed22d0f7e308" name="aeb4b908d70980261a3d1ed22d0f7e308"></a>template&lt;typename StructureT &gt; static void **recordOperatorAtCore** (AbstractCore \*[core](classansys_1_1dpf_1_1core.xhtml)) static void [recordOperatorWithNewName](classansys_1_1dpf_1_1core.xhtml#aee8c2e35cb45716a87ebe7770ded34ea) (std::string const &amp;exising\_identifier, std::string const &amp;new\_identifier, AbstractCore \*=nullptr) static [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) [workflowById](classansys_1_1dpf_1_1core.xhtml#a723856ec83974fcb2cc61549f3cb89dd) (int id) static [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) [workflowById](classansys_1_1dpf_1_1core.xhtml#ae3c3f567efed3342df687fac9889c878) (int id, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client) static [Operator](classansys_1_1dpf_1_1Operator.xhtml) [operatorById](classansys_1_1dpf_1_1core.xhtml#a9368b14c3950b5227a837df8d3b865e8) (int id) static [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) [workflowFromTemplate](classansys_1_1dpf_1_1core.xhtml#a0438a9c581e010038f7c40c5043a0f89) (std::string const &amp;template\_identifier) static bool [workflowTemplateExists](classansys_1_1dpf_1_1core.xhtml#a7db9305e737bd0fb2859ff145d31d350) (std::string const &amp;template\_identifier) static void [prepareServerShutdown](classansys_1_1dpf_1_1core.xhtml#ac3391e2f4d7b643efe6dcf0e934e8f45) ([Client](classansys_1_1dpf_1_1Client.xhtml) \*const client) static void [releaseServer](classansys_1_1dpf_1_1core.xhtml#a2a7492837eb46b2d3ec75cd4e3e76c9f) ([Client](classansys_1_1dpf_1_1Client.xhtml) \*const client) static std::vector&lt; std::string &gt; [availableOperators](classansys_1_1dpf_1_1core.xhtml#a4ff73d65cea2aa6f69436ec673cb8934) () static std::vector&lt; std::string &gt; [availableOperators](classansys_1_1dpf_1_1core.xhtml#aca0296747cd46c61c955b8cdaa1ed16f) ([Client](classansys_1_1dpf_1_1Client.xhtml) \*const client) <a id="a5c9ea0aa27d4bc9899d9af58e4422d60" name="a5c9ea0aa27d4bc9899d9af58e4422d60"></a>static dataIdentifierInDatabase **recordInDatabase** (databaseIdentifier const &amp;key, [DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml) &amp;data) static dataIdentifierInDatabase [recordInDatabase](classansys_1_1dpf_1_1core.xhtml#a5518f7636182e822f15a7ed40eb2c80a) ([DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml) &amp;data) static void [releaseFromDatabase](classansys_1_1dpf_1_1core.xhtml#a344424c85e16b6bb44cf7e27f021aa45) ([dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e) id, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client, bool async=false) static [RuntimeCoreConfig](classansys_1_1dpf_1_1RuntimeCoreConfig.xhtml) [getRuntimeCoreConfig](classansys_1_1dpf_1_1core.xhtml#a7e7dded7bf842c8c587bd0264b0b7452) () static [RuntimeCoreConfig](classansys_1_1dpf_1_1RuntimeCoreConfig.xhtml) [getRuntimeCoreConfig](classansys_1_1dpf_1_1core.xhtml#a26d52ede300647e78b0a538690e5ffb8) ([Client](classansys_1_1dpf_1_1Client.xhtml) \*const client) static [RuntimeClientConfig](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml) [getRuntimeClientConfig](classansys_1_1dpf_1_1core.xhtml#a4825a05c0f34be426942c0c519ee3b74) () <a id="details" name="details"></a>## Detailed Description

Groups all DataProcessingFramework core controls and utilities, like loading the core, loading libraries, protected instantiation, settings control.



## Member Function Documentation

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

 static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) ansys::dpf::core::applyContext  ( [Context](classansys_1_1dpf_1_1Context.xhtml) const &amp;  *context*)   static 

Defines the settings that will be used to load DPF's plugins. A DPF xml file can be used.

ReturnsStatus of call. 



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

 static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) ansys::dpf::core::applyContext  ( [Context](classansys_1_1dpf_1_1Context.xhtml) const &amp;  *context*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*   )   static 

Defines the settings that will be used to load DPF's plugins. A DPF xml file can be used.

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



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

 static [Operator](classansys_1_1dpf_1_1Operator.xhtml) ansys::dpf::core::assertInstantiate  ( std::string const &amp;  *identifier*)   static 

Returns[Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") given by identifier. Parameters \[in\]identifier[Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") to instantiate. 



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

 static [Operator](classansys_1_1dpf_1_1Operator.xhtml) ansys::dpf::core::assertInstantiate  ( std::string const &amp;  *identifier*,    [OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml) const &amp;  *config*   )   static 

Parameters \[in\]identifier[Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") to instantiate. \[in\]configAdditional configuration information. 



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

 static std::vector&lt; std::string &gt; ansys::dpf::core::availableOperators  ( )   static 

Returns all the availbale operators names.





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

 static std::vector&lt; std::string &gt; ansys::dpf::core::availableOperators  ( [Client](classansys_1_1dpf_1_1Client.xhtml) \*const  *client*)   static 

Returns all the availbale operators names for a given client.

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



<a id="a20f37512490ec6131335f52be7f2f28d" name="a20f37512490ec6131335f52be7f2f28d"></a>## [◆ ](#a20f37512490ec6131335f52be7f2f28d)defaultOperatorConfig()

 static [OperatorConfig](classansys_1_1dpf_1_1OperatorConfig.xhtml) ansys::dpf::core::defaultOperatorConfig  ( std::string const &amp;  *op\_identifier*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client* = `nullptr`   )   static 

ReturnsDefault configuration of given operator. Parameters \[in\]op\_identifier[Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") for which to get configuration. \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) on which to get the operator's config from. Default is nullptr. Examples[OperatorsApis.cpp](OperatorsApis_8cpp-example.xhtml#a17).



<a id="ae9c538db9a8802e9ec28e9e7b40267b5" name="ae9c538db9a8802e9ec28e9e7b40267b5"></a>## [◆ ](#ae9c538db9a8802e9ec28e9e7b40267b5)getOperatorSpecification()

 static [OperatorSpecification](classansys_1_1dpf_1_1OperatorSpecification.xhtml) ansys::dpf::core::getOperatorSpecification  ( std::string const &amp;  *identifier*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client* = `nullptr`   )   static 

ReturnsSpecification of given operator. Parameters \[in\]identifier[Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") for which to get specification. \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) on which to get the operator's config from. Default is nullptr. 



<a id="a4825a05c0f34be426942c0c519ee3b74" name="a4825a05c0f34be426942c0c519ee3b74"></a>## [◆ ](#a4825a05c0f34be426942c0c519ee3b74)getRuntimeClientConfig()

 static [RuntimeClientConfig](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml) ansys::dpf::core::getRuntimeClientConfig  ( )   static 

Returnsthe [RuntimeClientConfig](classansys_1_1dpf_1_1RuntimeClientConfig.xhtml) used to set [Client](classansys_1_1dpf_1_1Client.xhtml) runtime configuration options 



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

 static [RuntimeCoreConfig](classansys_1_1dpf_1_1RuntimeCoreConfig.xhtml) ansys::dpf::core::getRuntimeCoreConfig  ( )   static 

Returnsthe [RuntimeCoreConfig](classansys_1_1dpf_1_1RuntimeCoreConfig.xhtml) used to set DataProcessingCore runtime configuration options 



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

 static [RuntimeCoreConfig](classansys_1_1dpf_1_1RuntimeCoreConfig.xhtml) ansys::dpf::core::getRuntimeCoreConfig  ( [Client](classansys_1_1dpf_1_1Client.xhtml) \*const  *client*)   static 

Returnsthe [RuntimeCoreConfig](classansys_1_1dpf_1_1RuntimeCoreConfig.xhtml) used to set DataProcessingCore runtime configuration options Parameters \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) instance designating the IP, port and protocol to use. 



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

 static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) ansys::dpf::core::loadDpfPlugin  ( std::string const &amp;  *plugin\_path*,    std::string const &amp;  *plugin\_name*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*   )   static 

Loads specified DPF plugin.

ReturnsStatus of call. Parameters \[in\]plugin\_pathFull path to plugin. \[in\]plugin\_nameIdentifying name for plugin. \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) instance designating the IP, port and protocol to use. 



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

 static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) ansys::dpf::core::loadDpfPlugin  ( std::string const &amp;  *plugin\_path*,    std::string const &amp;  *plugin\_name*,    std::string const &amp;  *symbol*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*   )   static 

Loads specified DPF plugin.

ReturnsStatus of call. Parameters \[in\]plugin\_pathFull path to plugin. \[in\]plugin\_nameIdentifying name for plugin. \[in\]symbolType of load. \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) instance designating the IP, port and protocol to use. 



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

 static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) ansys::dpf::core::loadDpfPlugin  ( std::string const &amp;  *plugin\_path*,    std::string const &amp;  *plugin\_name*,    std::string const &amp;  *symbol* = `"LoadOperators"`   )   static 

Loads specified DPF plugin.

ReturnsStatus of call. Parameters \[in\]plugin\_pathFull path to plugin. \[in\]plugin\_nameIdentifying name for plugin. \[in\]symbolType of load. Examples[Example.cpp](Example_8cpp-example.xhtml#a1).



<a id="a9368b14c3950b5227a837df8d3b865e8" name="a9368b14c3950b5227a837df8d3b865e8"></a>## [◆ ](#a9368b14c3950b5227a837df8d3b865e8)operatorById()

 static [Operator](classansys_1_1dpf_1_1Operator.xhtml) ansys::dpf::core::operatorById  ( int  *id*)   static 

Returns[Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") given by id. Parameters \[in\]id[Operator](classansys_1_1dpf_1_1Operator.xhtml) id. 



<a id="ac3391e2f4d7b643efe6dcf0e934e8f45" name="ac3391e2f4d7b643efe6dcf0e934e8f45"></a>## [◆ ](#ac3391e2f4d7b643efe6dcf0e934e8f45)prepareServerShutdown()

 static void ansys::dpf::core::prepareServerShutdown  ( [Client](classansys_1_1dpf_1_1Client.xhtml) \*const  *client*)   static 

Send a prepare shutdown request (cleanup process) to a specified server.

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



<a id="a5518f7636182e822f15a7ed40eb2c80a" name="a5518f7636182e822f15a7ed40eb2c80a"></a>## [◆ ](#a5518f7636182e822f15a7ed40eb2c80a)recordInDatabase()

 static dataIdentifierInDatabase ansys::dpf::core::recordInDatabase  ( [DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml) &amp;  *data*)   static 

Parameters \[in\]dataRemote Data to record 



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

template&lt;typename StructureT &gt; 

 static void ansys::dpf::core::recordOperator  ( )   inlinestatic 

Record a new operator based on defined type.





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

 static void ansys::dpf::core::recordOperator  ( OperatorMainFunction  *f*,    std::string const &amp;  *operator\_identifier*,    AbstractCore \*  *core* = `nullptr`   )   static 

Record a new operator.

Parameters \[in\]fFunction to perform operator. \[in\]operator\_identifierUnique identifier for operator. 



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

 static void ansys::dpf::core::recordOperator  ( OperatorMainFunction  *f*,    std::string const &amp;  *operator\_identifier*,    [OperatorSpecification](classansys_1_1dpf_1_1OperatorSpecification.xhtml) const &amp;  *spec*,    AbstractCore \*   = `nullptr`   )   static 

Record a new operator.

Parameters \[in\]fFunction to perform operator. \[in\]operator\_identifierUnique identifier for operator. \[in\]specDefinition of inputs and outputs. 



<a id="aee8c2e35cb45716a87ebe7770ded34ea" name="aee8c2e35cb45716a87ebe7770ded34ea"></a>## [◆ ](#aee8c2e35cb45716a87ebe7770ded34ea)recordOperatorWithNewName()

 static void ansys::dpf::core::recordOperatorWithNewName  ( std::string const &amp;  *exising\_identifier*,    std::string const &amp;  *new\_identifier*,    AbstractCore \*   = `nullptr`   )   static 

Duplicates the record of the [Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") identified by its name in the registry. The [Operator](classansys_1_1dpf_1_1Operator.xhtml "Wrap an elementary operation.") will be added as private and won't appear in the documentation

Parameters \[in\]exising\_identifierexisting unique identifier for operator. \[in\]new\_identifierUnique identifier for operator. 



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

 static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) ansys::dpf::core::releaseDpf  ( )   static 

Clears the available Operators and Releases licenses when necessary.

ReturnsStatus of call. 



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

 static [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) ansys::dpf::core::releaseDpf  ( [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*)   static 

Clears the available Operators and Releases licenses when necessary.

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



<a id="a344424c85e16b6bb44cf7e27f021aa45" name="a344424c85e16b6bb44cf7e27f021aa45"></a>## [◆ ](#a344424c85e16b6bb44cf7e27f021aa45)releaseFromDatabase()

 static void ansys::dpf::core::releaseFromDatabase  ( [dp\_id](namespaceansys_1_1dpf.xhtml#ab4574c9af3f2bb8011da7d1f4c8da20e)  *id*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*,    bool  *async* = `false`   )   static 

suppress the entity from the server's database.

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



<a id="a2a7492837eb46b2d3ec75cd4e3e76c9f" name="a2a7492837eb46b2d3ec75cd4e3e76c9f"></a>## [◆ ](#a2a7492837eb46b2d3ec75cd4e3e76c9f)releaseServer()

 static void ansys::dpf::core::releaseServer  ( [Client](classansys_1_1dpf_1_1Client.xhtml) \*const  *client*)   static 

@detailsremoves the handle on the server should be used only if the server was started by this client instance

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



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

 static [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) ansys::dpf::core::workflowById  ( int  *id*)   static 

ReturnsWorflow registered in the registry (with Workflow::record) with its id. Parameters \[in\]id[Workflow](classansys_1_1dpf_1_1Workflow.xhtml) id created by Workflow::record. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a93).



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

 static [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) ansys::dpf::core::workflowById  ( int  *id*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*   )   static 

ReturnsWorflow registered in a server's registry (with Workflow::record) with its id. Parameters \[in\]id[Workflow](classansys_1_1dpf_1_1Workflow.xhtml) id created by Workflow::record. \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) instance designating the IP, port and protocol to use. 



<a id="a0438a9c581e010038f7c40c5043a0f89" name="a0438a9c581e010038f7c40c5043a0f89"></a>## [◆ ](#a0438a9c581e010038f7c40c5043a0f89)workflowFromTemplate()

 static [Workflow](classansys_1_1dpf_1_1Workflow.xhtml) ansys::dpf::core::workflowFromTemplate  ( std::string const &amp;  *template\_identifier*)   static 

Returns[Workflow](classansys_1_1dpf_1_1Workflow.xhtml "Group a set of connected operators in order to define a whole data treatment.") given by template identifier. Parameters \[in\]template\_identifier[Workflow](classansys_1_1dpf_1_1Workflow.xhtml) template identifier. 



<a id="a7db9305e737bd0fb2859ff145d31d350" name="a7db9305e737bd0fb2859ff145d31d350"></a>## [◆ ](#a7db9305e737bd0fb2859ff145d31d350)workflowTemplateExists()

 static bool ansys::dpf::core::workflowTemplateExists  ( std::string const &amp;  *template\_identifier*)   static 

Returnstrue if template identifier exists Parameters \[in\]template\_identifier[Workflow](classansys_1_1dpf_1_1Workflow.xhtml) template identifier.