Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
* [getAsMeshesContainer](classansys-dpf-any.md#classansys-dpf-any-1aee25715543d8396d96a2826cf1d84a98)
* [getAsOperator](classansys-dpf-any.md#classansys-dpf-any-1a5c1f49a671fa9d9d53b5b98fefdbd33b)
* [getAsPropertyField](classansys-dpf-any.md#classansys-dpf-any-1a91f7cbddb5ec5ce949a7a9f692d1d113)
* [getAsPropertyFieldsContainer](classansys-dpf-any.md#classansys-dpf-any-1ad305863576e44ad632de6acde30d9caf)
* [getAsResultInfo](classansys-dpf-any.md#classansys-dpf-any-1ab65ba60185b1136c36b4ed181521bfb1)
* [getAsScoping](classansys-dpf-any.md#classansys-dpf-any-1a1fede102c77bed4303bc8aa9210863b2)
* [getAsScopingsContainer](classansys-dpf-any.md#classansys-dpf-any-1abcc1dc4052f9679abd3f13538ada623e)
Expand Down Expand Up @@ -1112,6 +1113,39 @@ CustomTypeFieldsContainer ansys::dpf::Any::getAsCustomTypeFieldsContainer() cons
* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Any::getAsCustomTypeFieldsContainer"}]}`
-->

<a id="classansys-dpf-any-1ad305863576e44ad632de6acde30d9caf"></a>
### Function getAsPropertyFieldsContainer

![][public]
![][const]


```cpp
PropertyFieldsContainer ansys::dpf::Any::getAsPropertyFieldsContainer() const
```




**Returns**:

[PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) held in the [Any](classansys-dpf-any.md#classansys-dpf-any) object.


**Exceptions**:

* **[DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception)**:



**Return type**: [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer)

<!--
**TODO**:

* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Any::getAsPropertyFieldsContainer"}]}`
-->

<a id="classansys-dpf-any-1a971efc6d276a05d1e2e047878cdfb56a"></a>
### Function getAsCustomTypeField

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
* [ansys::dpf::CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer)
* [ansys::dpf::FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldscontainer)
* [ansys::dpf::MeshesContainer](classansys-dpf-meshescontainer.md#classansys-dpf-meshescontainer)
* [ansys::dpf::PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer)
* [ansys::dpf::ScopingsContainer](classansys-dpf-scopingscontainer.md#classansys-dpf-scopingscontainer)

## Members
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Groups all DataProcessingFramework core controls and utilities, like loading the
* [assertInstantiate](classansys-dpf-core.md#classansys-dpf-core-1ac729e14b3132c112e50982614be304aa)
* [availableOperators](classansys-dpf-core.md#classansys-dpf-core-1a4ff73d65cea2aa6f69436ec673cb8934)
* [availableOperators](classansys-dpf-core.md#classansys-dpf-core-1aca0296747cd46c61c955b8cdaa1ed16f)
* [clearStepIndex](classansys-dpf-core.md#classansys-dpf-core-1a03d79f5bc63307fe5e39ba2d135dc7e7)
* [connectToFbsServer](classansys-dpf-core.md#classansys-dpf-core-1a8db49a31a767102e225f9b0de89aabc1)
* [connectToFbsServer](classansys-dpf-core.md#classansys-dpf-core-1af59369ee9906684fed5f2deab51d6c78)
* [copyTo](classansys-dpf-core.md#classansys-dpf-core-1af26687fad53552d2263864bc46f935c8)
Expand All @@ -41,8 +40,6 @@ Groups all DataProcessingFramework core controls and utilities, like loading the
* [getRuntimeCoreConfig](classansys-dpf-core.md#classansys-dpf-core-1a26d52ede300647e78b0a538690e5ffb8)
* [getServerVersion](classansys-dpf-core.md#classansys-dpf-core-1ae3472a9ced3aff887f623d3a46943d5d)
* [getServerVersionFull](classansys-dpf-core.md#classansys-dpf-core-1a816f74283747eb9906949dfe61af99d8)
* [getStepIndexCurrentMemory](classansys-dpf-core.md#classansys-dpf-core-1a1f019bb156aafda8b39610dfabaf6495)
* [getStepIndexOperatorStatuses](classansys-dpf-core.md#classansys-dpf-core-1a433263d40e0819e0c93009abe04184ca)
* [loadDpfPlugin](classansys-dpf-core.md#classansys-dpf-core-1addc032f5882185bcf940ce7adf293327)
* [loadDpfPlugin](classansys-dpf-core.md#classansys-dpf-core-1aa9921dd047827c618f977e01ee088694)
* [loadDpfPlugin](classansys-dpf-core.md#classansys-dpf-core-1a74f7e10fc172292bc61582304787c30f)
Expand Down Expand Up @@ -1522,88 +1519,6 @@ Fills all version components of the In-Process server.
* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::core::getServerVersionFull"}]}`
-->

<a id="classansys-dpf-core-1a1f019bb156aafda8b39610dfabaf6495"></a>
### Function getStepIndexCurrentMemory

![][public]
![][static]


```cpp
static int ansys::dpf::core::getStepIndexCurrentMemory()
```




**Returns**:

Current heap memory (in MB) held by the workflow step index.



**Return type**: int

<!--
**TODO**:

* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::core::getStepIndexCurrentMemory"}]}`
-->

<a id="classansys-dpf-core-1a433263d40e0819e0c93009abe04184ca"></a>
### Function getStepIndexOperatorStatuses

![][public]
![][static]


```cpp
static GenericDataContainer ansys::dpf::core::getStepIndexOperatorStatuses()
```




**Returns**:

A GenericDataContainer with operator statuses from the workflow step index. Keys are "opName_opId", values are int (E_OperatorState).



**Return type**: GenericDataContainer

<!--
**TODO**:

* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::core::getStepIndexOperatorStatuses"}]}`
-->

<a id="classansys-dpf-core-1a03d79f5bc63307fe5e39ba2d135dc7e7"></a>
### Function clearStepIndex

![][public]
![][static]


```cpp
static void ansys::dpf::core::clearStepIndex()
```


Clears all entries from the workflow step index.





**Return type**: void

<!--
**TODO**:

* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::core::clearStepIndex"}]}`
-->

<a id="classansys-dpf-core-1af26687fad53552d2263864bc46f935c8"></a>
### Function copyTo

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ Holds data located on given entities (the [Field](classansys-dpf-field.md#classa
* [setSupport](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a42a4865d6dd7101dd937d4a5eaab5dfc)
* [setSupport](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a3e2d48d20c6b045faab0618e89e004c3)
* [support](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1ac395281a74f1a78df961f443a32648a1)
* [typeName](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1abbdf64fde6abac6ded4815f89c5e17eb)
* [unitarySize](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a8fc4cb48cf78f7ebfc2ca3ddb6da4c81)
* [~CustomTypeField](classansys-dpf-customtypefield.md#classansys-dpf-customtypefield-1a07dba2c5b6fccedaa06182c3b2749b22)
* [~DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ab7c83b6ea160c2b115e056f6c312112f)

Expand Down Expand Up @@ -1388,6 +1390,62 @@ tests the type of the [Field](classansys-dpf-field.md#classansys-dpf-field).
* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::CustomTypeField::isOfUnitaryType"}]}`
-->

<a id="classansys-dpf-customtypefield-1abbdf64fde6abac6ded4815f89c5e17eb"></a>
### Function typeName

![][public]
![][const]


```cpp
std::string ansys::dpf::CustomTypeField::typeName() const
```




**Returns**:

Type of the data.



**Return type**: std::string

<!--
**TODO**:

* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::CustomTypeField::typeName"}]}`
-->

<a id="classansys-dpf-customtypefield-1a8fc4cb48cf78f7ebfc2ca3ddb6da4c81"></a>
### Function unitarySize

![][public]
![][const]


```cpp
dp_int ansys::dpf::CustomTypeField::unitarySize() const
```




**Returns**:

Byte size of the data type.



**Return type**: [dp_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0)

<!--
**TODO**:

* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::CustomTypeField::unitarySize"}]}`
-->

<a id="classansys-dpf-customtypefield-1ab2a21d596a016b4c26ca7c473bdeacbb"></a>
### Function cloneToCustomTypeField

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Class ansys::dpf::DefaultErrorFormatter

<a id="classansys-dpf-defaulterrorformatter"></a>

![][C++]
![][public]





**Inherits from**:

* ansys::dpf::ErrorFormatter

## Members

* [format](classansys-dpf-defaulterrorformatter.md#classansys-dpf-defaulterrorformatter-1af83491e11bea69055a9daa1121c6abc4)
* [~DefaultErrorFormatter](classansys-dpf-defaulterrorformatter.md#classansys-dpf-defaulterrorformatter-1a1ffc82ad84dd982319e368cf633d293b)
* [~ErrorFormatter](classansys-dpf-errorformatter.md#classansys-dpf-errorformatter-1a0a0369394d69af3bb1a7ebd7990fde6e)

## Public functions

<a id="classansys-dpf-defaulterrorformatter-1a1ffc82ad84dd982319e368cf633d293b"></a>
### Function ~DefaultErrorFormatter

![][public]


```cpp
virtual ansys::dpf::DefaultErrorFormatter::~DefaultErrorFormatter()=default
```








**Return type**:

<!--
**TODO**:

* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::DefaultErrorFormatter::~DefaultErrorFormatter"}]}`
-->

<a id="classansys-dpf-defaulterrorformatter-1af83491e11bea69055a9daa1121c6abc4"></a>
### Function format

![][public]


```cpp
std::string ansys::dpf::DefaultErrorFormatter::format(const ansys::dpf::DpfError::ErrorNature &nature, const std::string &msg) override
```








**Parameters**:

* const [ansys::dpf::DpfError::ErrorNature](classansys-dpf-dpferror.md#classansys-dpf-dpferror-1a9a3fe202cc2e46746462fdb1ce44c47f) & **nature**
* const std::string & **msg**

**Return type**: std::string

<!--
**TODO**:

* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::DefaultErrorFormatter::format"}]}`
-->

[C++]: https://img.shields.io/badge/language-C%2B%2B-blue (C++)
[const]: https://img.shields.io/badge/-const-lightblue (const)
[public]: https://img.shields.io/badge/-public-brightgreen (public)
[static]: https://img.shields.io/badge/-static-lightgrey (static)
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Error from DPF call.
* [eComponentLoading](classansys-dpf-dpferror.md#classansys-dpf-dpferror-1a9a3fe202cc2e46746462fdb1ce44c47fa63cc3ff6720228860f33c24e18a81abf)
* [eFailure](classansys-dpf-dpferror.md#classansys-dpf-dpferror-1a9a3fe202cc2e46746462fdb1ce44c47faf8acd9de5506b8d9fd2acd4aaa0d2341)
* [eFileNotFound](classansys-dpf-dpferror.md#classansys-dpf-dpferror-1a9a3fe202cc2e46746462fdb1ce44c47fa6173cc22576234d0f2ff8e731269f12b)
* [eJsonError](classansys-dpf-dpferror.md#classansys-dpf-dpferror-1a9a3fe202cc2e46746462fdb1ce44c47fa8bce473fe3a5c9733bd7a8d6ad2a8e7e)
* [eLicensingFailure](classansys-dpf-dpferror.md#classansys-dpf-dpferror-1a9a3fe202cc2e46746462fdb1ce44c47fa7e497c9bbbed6bc9974b24a48c589cba)
* [eOk](classansys-dpf-dpferror.md#classansys-dpf-dpferror-1a9a3fe202cc2e46746462fdb1ce44c47fafbbb18218f01ff212fea92a133b88e21)
* [ErrorNature](classansys-dpf-dpferror.md#classansys-dpf-dpferror-1a9a3fe202cc2e46746462fdb1ce44c47f)
Expand Down Expand Up @@ -59,7 +60,8 @@ enum ErrorNature {
eUnimplemented,
eUserInterrupted,
eLicensingFailure,
eUnimplementedAPI
eUnimplementedAPI,
eJsonError
}
```

Expand Down Expand Up @@ -161,6 +163,13 @@ Licensing checks failed.

Functionality not implemented.

<a id="classansys-dpf-dpferror-1a9a3fe202cc2e46746462fdb1ce44c47fa8bce473fe3a5c9733bd7a8d6ad2a8e7e"></a>
#### Enumerator eJsonError



Structured error, json parseable.

<!--
**TODO**:

Expand Down
Loading