Skip to main content

DPF Cpp Client Library 2026 R1

Class ansys::dpf::core

Last update: 25.03.2026

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

Inner classes

Members

Friends

Public functions

Function core

ansys::dpf::core::core()=delete

Return type:

Public static functions

Function applyContext

static DpfError ansys::dpf::core::applyContext(Context const &context)

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

Status of call.

Parameters:

Return type: DpfError

Function releaseDpf

static DpfError ansys::dpf::core::releaseDpf()

Clears the available Operators and Releases licenses when necessary. Returns:

Status of call.

Return type: DpfError

Function releaseDpf

static DpfError ansys::dpf::core::releaseDpf(Client const *const client)

Clears the available Operators and Releases licenses when necessary. Returns:

Status of call.

Parameters:

  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: DpfError

Function applyContext

static DpfError ansys::dpf::core::applyContext(Context const &context, Client const *const client)

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

Status of call.

Parameters:

  • Context const & context
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: DpfError

Function loadDpfPlugin

static DpfError ansys::dpf::core::loadDpfPlugin(std::string const &plugin_path, std::string const &plugin_name, std::string const &symbol="LoadOperators")

Loads specified DPF plugin. Returns:

Status of call.

Parameters:

  • std::string const & plugin_path: [in] Full path to plugin.
  • std::string const & plugin_name: [in] Identifying name for plugin.
  • std::string const & symbol = "LoadOperators" : [in] Type of load.

Return type: DpfError

Function loadDpfPlugin

static DpfError ansys::dpf::core::loadDpfPlugin(std::string const &plugin_path, std::string const &plugin_name, Client const *const client)

Loads specified DPF plugin. Returns:

Status of call.

Parameters:

  • std::string const & plugin_path: [in] Full path to plugin.
  • std::string const & plugin_name: [in] Identifying name for plugin.
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: DpfError

Function loadDpfPlugin

static DpfError ansys::dpf::core::loadDpfPlugin(std::string const &plugin_path, std::string const &plugin_name, std::string const &symbol, Client const *const client)

Loads specified DPF plugin. Returns:

Status of call.

Parameters:

  • std::string const & plugin_path: [in] Full path to plugin.
  • std::string const & plugin_name: [in] Identifying name for plugin.
  • std::string const & symbol: [in] Type of load.
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: DpfError

Function assertInstantiate

static Operator ansys::dpf::core::assertInstantiate(std::string const &identifier)

Returns:

Operator given by identifier.

Parameters:

  • std::string const & identifier: [in] Operator to instantiate.

Return type: Operator

Function assertInstantiate

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

Returns:

Operator given by identifier.

Parameters:

  • std::string const & identifier: [in] Operator to instantiate.
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: Operator

Function assertInstantiate

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

Parameters:

  • std::string const & identifier: [in] Operator to instantiate.
  • OperatorConfig const & config: [in] Additional configuration information.
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: Operator

Function assertInstantiate

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

Parameters:

  • std::string const & identifier: [in] Operator to instantiate.
  • OperatorConfig const & config: [in] Additional configuration information.

Return type: Operator

Function defaultOperatorConfig

static OperatorConfig ansys::dpf::core::defaultOperatorConfig(std::string const &op_identifier, Client const *const client=nullptr)

Returns:

Default configuration of given operator.

Parameters:

  • std::string const & op_identifier: [in] Operator for which to get configuration.
  • Client const *const client = nullptr : [in] Client on which to get the operator's config from. Default is nullptr.

Return type: OperatorConfig

Function getOperatorSpecification

static OperatorSpecification ansys::dpf::core::getOperatorSpecification(std::string const &identifier, Client const *const client=nullptr)

Returns:

Specification of given operator.

Parameters:

  • std::string const & identifier: [in] Operator for which to get specification.
  • Client const *const client = nullptr : [in] Client on which to get the operator's config from. Default is nullptr.

Return type: OperatorSpecification

Function recordOperator

static void ansys::dpf::core::recordOperator(OperatorMainFunction f, std::string const &operator_identifier, AbstractCore *core=nullptr)

Record a new operator.

Parameters:

  • OperatorMainFunction f: [in] Function to perform operator.
  • std::string const & operator_identifier: [in] Unique identifier for operator.
  • AbstractCore * core = nullptr

Return type: void

Function recordOperator

static void ansys::dpf::core::recordOperator(OperatorMainFunction f, std::string const &operator_identifier, OperatorSpecification const &spec, AbstractCore *=nullptr)

Record a new operator.

Parameters:

  • OperatorMainFunction f: [in] Function to perform operator.
  • std::string const & operator_identifier: [in] Unique identifier for operator.
  • OperatorSpecification const & spec: [in] Definition of inputs and outputs.
  • AbstractCore * = nullptr

Return type: void

Function recordOperator

static void ansys::dpf::core::recordOperator(OperatorMainFunction f, OperatorDerivateFunction deriv, std::string const &operator_identifier, OperatorSpecification const &spec, AbstractCore *=nullptr)

Record a new operator.

Parameters:

  • OperatorMainFunction f: [in] Function to perform operator.
  • OperatorDerivateFunction deriv
  • std::string const & operator_identifier: < [in] Function to derivate operator [in] Unique identifier for operator.
  • OperatorSpecification const & spec: [in] Definition of inputs and outputs.
  • AbstractCore * = nullptr

Return type: void

Function recordOperator

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

Record a new operator based on defined type.

Return type: void

Function recordOperatorWithDerivative

static void ansys::dpf::core::recordOperatorWithDerivative()

Record a new operator based on defined type, with a derivative

Return type: void

Function recordOperatorAtCore

static void ansys::dpf::core::recordOperatorAtCore(AbstractCore *core)

Parameters:

  • AbstractCore * core

Return type: void

Function recordOperatorAtCoreWithDerivative

static void ansys::dpf::core::recordOperatorAtCoreWithDerivative(AbstractCore *core)

Record a new operator based on defined type, with a derivative

Parameters:

  • AbstractCore * core

Return type: void

Function recordOperatorWithNewName

static void ansys::dpf::core::recordOperatorWithNewName(std::string const &exising_identifier, std::string const &new_identifier, AbstractCore *=nullptr)

Duplicates the record of the Operator identified by its name in the registry. The Operator will be added as private and won't appear in the documentation

Parameters:

  • std::string const & exising_identifier: [in] existing unique identifier for operator.
  • std::string const & new_identifier: [in] Unique identifier for operator.
  • AbstractCore * = nullptr

Return type: void

Function workflowById

static Workflow ansys::dpf::core::workflowById(int id)

Returns:

Worflow registered in the registry (with Workflow::record) with its id.

Parameters:

  • int id: [in] Workflow id created by Workflow::record.

Return type: Workflow

Function workflowById

static Workflow ansys::dpf::core::workflowById(int id, Client const *const client)

Returns:

Worflow registered in a server's registry (with Workflow::record) with its id.

Parameters:

  • int id: [in] Workflow id created by Workflow::record.
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: Workflow

Function operatorById

static Operator ansys::dpf::core::operatorById(int id)

Returns:

Operator given by id.

Parameters:

Return type: Operator

Function workflowFromTemplate

static Workflow ansys::dpf::core::workflowFromTemplate(std::string const &template_identifier)

Returns:

Workflow given by template identifier.

Parameters:

  • std::string const & template_identifier: [in] Workflow template identifier.

Return type: Workflow

Function workflowTemplateExists

static bool ansys::dpf::core::workflowTemplateExists(std::string const &template_identifier)

Returns:

true if template identifier exists

Parameters:

  • std::string const & template_identifier: [in] Workflow template identifier.

Return type: bool

Function prepareServerShutdown

static void ansys::dpf::core::prepareServerShutdown(Client *const client)

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

Parameters:

  • Client *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: void

Function releaseServer

static void ansys::dpf::core::releaseServer(Client *const client)

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

Parameters:

  • Client *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: void

Function availableOperators

static std::vector< std::string > ansys::dpf::core::availableOperators()

Returns all the availbale operators names.

Return type: std::vector< std::string >

Function availableOperators

static std::vector< std::string > ansys::dpf::core::availableOperators(Client *const client)

Returns all the availbale operators names for a given client.

Parameters:

  • Client *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: std::vector< std::string >

Function recordInDatabase

static dataIdentifierInDatabase ansys::dpf::core::recordInDatabase(databaseIdentifier const &key, DpfTypes &data)

Parameters:

  • databaseIdentifier const & key
  • DpfTypes & data

Return type: dataIdentifierInDatabase

Function recordInDatabase

static dataIdentifierInDatabase ansys::dpf::core::recordInDatabase(DpfTypes &data)

Parameters:

  • DpfTypes & data: [in] Remote Data to record

Return type: dataIdentifierInDatabase

Function releaseFromDatabase

static void ansys::dpf::core::releaseFromDatabase(dp_id id, Client const *const client, bool async=false)

suppress the entity from the server's database.

Parameters:

  • dp_id id: [in] its Id on the server.
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.
  • bool async = false

Return type: void

Function getAndReleaseFromDatabase

static ansys::dpf::Any ansys::dpf::core::getAndReleaseFromDatabase(dp_id id, databaseIdentifier db_id)

Retrieves the object from the database, deletes it from the database and returns it. if nothing is found, the return Any is empty, see ansys::dpf::Any::empty.

Parameters:

  • dp_id id: [in] Id of the object on the server's database.
  • databaseIdentifier db_id

Return type: ansys::dpf::Any

Function getRuntimeCoreConfig

static RuntimeCoreConfig ansys::dpf::core::getRuntimeCoreConfig()

Returns:

the RuntimeCoreConfig used to set DataProcessingCore runtime configuration options

Return type: RuntimeCoreConfig

Function getRuntimeCoreConfig

static RuntimeCoreConfig ansys::dpf::core::getRuntimeCoreConfig(Client *const client)

Returns:

the RuntimeCoreConfig used to set DataProcessingCore runtime configuration options

Parameters:

  • Client *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: RuntimeCoreConfig

Function getRuntimeClientConfig

static RuntimeClientConfig ansys::dpf::core::getRuntimeClientConfig()

Returns:

the RuntimeClientConfig used to set Client runtime configuration options

Return type: RuntimeClientConfig

Function startFbsServer

static FbsServerData ansys::dpf::core::startFbsServer(std::string const &ip="", int port=0, const Client *client=nullptr)

Starts a fbs server in this process or in the process targeted by "client".

Parameters:

  • std::string const & ip = ""
  • int port = 0
  • const Client * client = nullptr

Return type: FbsServerData

Function getOrStartFbsServer

static FbsServerData ansys::dpf::core::getOrStartFbsServer(std::string const &ip="", int port=0, const Client *client=nullptr)

Starts a fbs server in this process or in the process targeted by "client". If a server was already started with this functions, the existing server is returned.

Parameters:

  • std::string const & ip = ""
  • int port = 0
  • const Client * client = nullptr

Return type: FbsServerData

Function getServerVersion

static void ansys::dpf::core::getServerVersion(int &major_version, int &minor_version)

Fills the major and minor versions of the In-Process server

Parameters:

  • int & major_version: [in] major version of the server
  • int & minor_version: [in] minor version of the server

Return type: void

Function copyTo

static DpfType ansys::dpf::core::copyTo(DpfType const &to_copy, const Client *client)

Parameters:

  • DpfType const & to_copy
  • const Client * client: [in] Client instance designating the IP, port and protocol to use.

Return type: DpfType

Connect with Ansys