diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-any.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-any.md index 54975ef0da..47f4291e41 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-any.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-any.md @@ -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) @@ -1112,6 +1113,39 @@ CustomTypeFieldsContainer ansys::dpf::Any::getAsCustomTypeFieldsContainer() cons * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Any::getAsCustomTypeFieldsContainer"}]}` --> + +### 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) + + + ### Function getAsCustomTypeField diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-collectionbase.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-collectionbase.md index a0f3dbf272..093aa23170 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-collectionbase.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-collectionbase.md @@ -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 diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-core.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-core.md index 704cdedf10..713b2e70da 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-core.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-core.md @@ -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) @@ -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) @@ -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"}]}` --> - -### 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 - - - - -### 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 - - - - -### Function clearStepIndex - -![][public] -![][static] - - -```cpp -static void ansys::dpf::core::clearStepIndex() -``` - - -Clears all entries from the workflow step index. - - - - - -**Return type**: void - - - ### Function copyTo diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-customtypefield.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-customtypefield.md index 08ab2d8fe7..8a563c0d4b 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-customtypefield.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-customtypefield.md @@ -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) @@ -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"}]}` --> + +### Function typeName + +![][public] +![][const] + + +```cpp +std::string ansys::dpf::CustomTypeField::typeName() const +``` + + + + +**Returns**: + +Type of the data. + + + +**Return type**: std::string + + + + +### 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) + + + ### Function cloneToCustomTypeField diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-defaulterrorformatter.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-defaulterrorformatter.md new file mode 100644 index 0000000000..ea4436ba48 --- /dev/null +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-defaulterrorformatter.md @@ -0,0 +1,82 @@ +# Class ansys::dpf::DefaultErrorFormatter + + + +![][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 + + +### Function ~DefaultErrorFormatter + +![][public] + + +```cpp +virtual ansys::dpf::DefaultErrorFormatter::~DefaultErrorFormatter()=default +``` + + + + + + + + +**Return type**: + + + + +### 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 + + + +[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) \ No newline at end of file diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-dpferror.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-dpferror.md index 191a585bdf..7f845439c1 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-dpferror.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-dpferror.md @@ -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) @@ -59,7 +60,8 @@ enum ErrorNature { eUnimplemented, eUserInterrupted, eLicensingFailure, - eUnimplementedAPI + eUnimplementedAPI, + eJsonError } ``` @@ -161,6 +163,13 @@ Licensing checks failed. Functionality not implemented. + +#### Enumerator eJsonError + + + +Structured error, json parseable. + + + +### Function format + +![][public] + + +```cpp +virtual std::string ansys::dpf::ErrorFormatter::format(const ansys::dpf::DpfError::ErrorNature &nature, const std::string &msg)=0 +``` + + + + + + + + +**Parameters**: + +* const [ansys::dpf::DpfError::ErrorNature](classansys-dpf-dpferror.md#classansys-dpf-dpferror-1a9a3fe202cc2e46746462fdb1ce44c47f) & **nature** +* const std::string & **msg** + +**Return type**: std::string + + + +[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) \ No newline at end of file diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-hgpdpfexception.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-hgpdpfexception.md new file mode 100644 index 0000000000..616329a8c3 --- /dev/null +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-hgpdpfexception.md @@ -0,0 +1,137 @@ +# Class ansys::dpf::HgpDpfException + + + +![][C++] +![][public] + + + + + +**Inherits from**: + +* std::exception + +## Members + +* [HgpDpfException](classansys-dpf-hgpdpfexception.md#classansys-dpf-hgpdpfexception-1a277677e718b9c0644b258c631345f53c) +* [kvals](classansys-dpf-hgpdpfexception.md#classansys-dpf-hgpdpfexception-1a5a4f71981a8a09abbef160bedca11449) +* [type](classansys-dpf-hgpdpfexception.md#classansys-dpf-hgpdpfexception-1a3a7d37008efda652aa2df1ccdd5249a1) +* [what](classansys-dpf-hgpdpfexception.md#classansys-dpf-hgpdpfexception-1ac279dc3a00e542fef44ea89381d7207f) + +## Public functions + + +### Function HgpDpfException + +![][public] + + +```cpp +ansys::dpf::HgpDpfException::HgpDpfException(const std::string &type, const std::string &what, std::initializer_list< kv_t > kvals) +``` + + + + + + + + +**Parameters**: + +* const std::string & **type** +* const std::string & **what** +* std::initializer_list< kv_t > **kvals** + +**Return type**: + + + + +### Function what + +![][public] +![][const] + + +```cpp +const char * ansys::dpf::HgpDpfException::what() const noexcept override +``` + + + + + + + + +**Return type**: const char * + + + + +### Function type + +![][public] +![][const] + + +```cpp +const char * ansys::dpf::HgpDpfException::type() const +``` + + + + + + + + +**Return type**: const char * + + + + +### Function kvals + +![][public] +![][const] + + +```cpp +const std::unordered_map< std::string, std::string > ansys::dpf::HgpDpfException::kvals() const +``` + + + + + + + + +**Return type**: const std::unordered_map< std::string, std::string > + + + +[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) \ No newline at end of file diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-operator.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-operator.md index 18ec6df11f..cf1fae2fda 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-operator.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-operator.md @@ -32,6 +32,7 @@ The [Operator](classansys-dpf-operator.md#classansys-dpf-operator) is the main o * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a6f9e628bf2429fc5a805871c61c69a17) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1aad1b060bfb2886c3b3dd75f1385f6222) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a5add81029b92a785398586268a0112a9) +* [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a03a8e31439cd8d397b84c70b3d6ac638) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a5e5cbe01690fca3a27bbf8cd4a21f530) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1af13e07e9f51973d31c33dd4c80930c0f) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a9006d2db6a9e078acc0b293ec1439863) @@ -50,6 +51,7 @@ The [Operator](classansys-dpf-operator.md#classansys-dpf-operator) is the main o * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ae76c6c18901c49692e9d15d59b784d79) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a21dfe41f3f388752fa35bd28b7cb82a7) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1af9629fd0bf6f14054969bd1a17a3c01a) +* [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a218d7f8cea0d8382f70d2f1c329b85d2) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ae5bd39532c17864b402d36cbf299e0a6) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a5c1afb9023b4dcede90cbb689d44235b) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1af0cc66b849378593d484d64fd884f534) @@ -69,6 +71,7 @@ The [Operator](classansys-dpf-operator.md#classansys-dpf-operator) is the main o * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a7fc609c2f4538038c30ec8034f22ddb8) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ab0a16ba648b2e088b1b1bbb6c6d57bf1) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a8e9cb2e84276a62ecbfac15fc34eb987) +* [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a196fecf93c582c710a8c2c8c9c5f0ed8) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a055daebf6e09e2f8cadbd71218de629e) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a6a6d0fca683a19dded250760f9f67b4b) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a72c6e272e3a18c77d170ae638943e6a5) @@ -81,6 +84,7 @@ The [Operator](classansys-dpf-operator.md#classansys-dpf-operator) is the main o * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ae2825474b8c81df35899c9f4f2d99564) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1acfd6ae4496cac17382d290385b016b46) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a35815dd63725ce35d51b791dea1713e3) +* [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ad5bfefab97939ef5afd96f51e42ed3d7) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ac9f70f22925540444a489da7c389cd2c) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a0dccc56a240f176d4406901fa3779ae8) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ab319e553b676692001a5fd6ea54a791c) @@ -142,6 +146,8 @@ The [Operator](classansys-dpf-operator.md#classansys-dpf-operator) is the main o * [getOutputOperator](classansys-dpf-operator.md#classansys-dpf-operator-1a255fa07a2e0a12152f915ee8f5b5a524) * [getOutputPropertyField](classansys-dpf-operator.md#classansys-dpf-operator-1a58ea7f5128ab677787afb696b0293267) * [getOutputPropertyField](classansys-dpf-operator.md#classansys-dpf-operator-1ae726557dc3c40abd7afe411fc2ce278c) +* [getOutputPropertyFieldsContainer](classansys-dpf-operator.md#classansys-dpf-operator-1a5572ba10829cb4f482c5265df5c2be55) +* [getOutputPropertyFieldsContainer](classansys-dpf-operator.md#classansys-dpf-operator-1a85531ed5d40a0230ca9eaeb1431b3f31) * [getOutputResultInfo](classansys-dpf-operator.md#classansys-dpf-operator-1aeb719093c2406e06455423370eed3cd8) * [getOutputResultInfo](classansys-dpf-operator.md#classansys-dpf-operator-1acea4c808d2f4d01adea5539b3da95d33) * [getOutputScoping](classansys-dpf-operator.md#classansys-dpf-operator-1a08ab4421b7cc47bb6c5baeafdebe641f) @@ -158,6 +164,8 @@ The [Operator](classansys-dpf-operator.md#classansys-dpf-operator) is the main o * [getOutputSupport](classansys-dpf-operator.md#classansys-dpf-operator-1aa818d55166583977ae4e4ecbd709b56e) * [getOutputTimeFreqSupport](classansys-dpf-operator.md#classansys-dpf-operator-1ad2bfffac019485c51c8d3cc88c94ebd0) * [getOutputTimeFreqSupport](classansys-dpf-operator.md#classansys-dpf-operator-1ab6015d4542961222e37a107e699dfc2e) +* [getOutputUInt](classansys-dpf-operator.md#classansys-dpf-operator-1a74c3403cdcd79a4fc262bd91a2a4d231) +* [getOutputUInt](classansys-dpf-operator.md#classansys-dpf-operator-1a87689e72739ab2b4533f6eb4728b7691) * [getOutputWorkflow](classansys-dpf-operator.md#classansys-dpf-operator-1ab43c2d56664e3db3bfb386bb6895fc9c) * [getOutputWorkflow](classansys-dpf-operator.md#classansys-dpf-operator-1a0875bb76f8121ba69f3e5e001deb7ea2) * [getRemoteId](classansys-dpf-operator.md#classansys-dpf-operator-1a3450f744e8f833a2862686431855c990) @@ -1071,6 +1079,36 @@ Connect [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyf * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Operator::connect"}]}` --> + +### Function connect + +![][public] + + +```cpp +void ansys::dpf::Operator::connect(dp_index input_pin, PropertyFieldsContainer const &data) +``` + + + + +Connect [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) data to input_pin. + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **input_pin**: [in] Input pin. +* [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) const & **data**: [in] [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) data to connect to pin. + +**Return type**: void + + + ### Function connect @@ -1665,6 +1703,39 @@ Connect double data to input_pin. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Operator::connect"}]}` --> + +### Function connect + +![][public] + + +```cpp +void ansys::dpf::Operator::connect(dp_index input_pin, uint64_t data) +``` + + + + +Connect unsigned 64-bit integer data to input_pin. +**Exceptions**: + +* **[DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception)**: + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **input_pin**: [in] Input pin. +* uint64_t **data**: [in] Unsigned 64-bit integer data to connect to pin. + +**Return type**: void + + + ### Function connect @@ -2338,6 +2409,37 @@ Connect [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyf * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Operator::connect"}]}` --> + +### Function connect + +![][public] + + +```cpp +void ansys::dpf::Operator::connect(dp_index input_pin, PropertyFieldsContainer const &data, DpfError &error) +``` + + + + +Connect [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) data to input_pin. + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **input_pin**: [in] Input pin. +* [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) const & **data**: [in] [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) data to connect to pin. +* [DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror) & **error**: [out] Status of call. + +**Return type**: void + + + ### Function connect @@ -2710,6 +2812,37 @@ Connect double data to input_pin. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Operator::connect"}]}` --> + +### Function connect + +![][public] + + +```cpp +void ansys::dpf::Operator::connect(dp_index input_pin, uint64_t data, DpfError &error) +``` + + + + +Connect unsigned 64-bit integer data to input_pin. + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **input_pin**: [in] Input pin. +* uint64_t **data**: [in] Unsigned 64-bit integer data to connect to pin. +* [DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror) & **error**: [out] Status of call. + +**Return type**: void + + + ### Function connect @@ -3813,6 +3946,42 @@ CustomTypeFieldsContainer ansys::dpf::Operator::getOutputCustomTypeFieldsContain * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Operator::getOutputCustomTypeFieldsContainer"}]}` --> + +### Function getOutputPropertyFieldsContainer + +![][public] + + +```cpp +PropertyFieldsContainer ansys::dpf::Operator::getOutputPropertyFieldsContainer(dp_index pin_index) +``` + + + + +**Returns**: + +[PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) output on pin_index. + + +**Exceptions**: + +* **[DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception)**: + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **pin_index**: [in] Pin from which to get output. + +**Return type**: [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) + + + ### Function getOutputCustomContainer @@ -3994,6 +4163,42 @@ Boolean output on pin_index. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Operator::getOutputBool"}]}` --> + +### Function getOutputUInt + +![][public] + + +```cpp +uint64_t ansys::dpf::Operator::getOutputUInt(dp_index pin_index) +``` + + + + +**Returns**: + +Unsigned 64-bit integer output on pin_index. + + +**Exceptions**: + +* **[DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception)**: + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **pin_index**: [in] Pin from which to get output. + +**Return type**: uint64_t + + + ### Function getOutputIntVector @@ -4828,6 +5033,38 @@ CustomTypeFieldsContainer ansys::dpf::Operator::getOutputCustomTypeFieldsContain * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Operator::getOutputCustomTypeFieldsContainer"}]}` --> + +### Function getOutputPropertyFieldsContainer + +![][public] + + +```cpp +PropertyFieldsContainer ansys::dpf::Operator::getOutputPropertyFieldsContainer(dp_index pin_index, DpfError &error) +``` + + + + +**Returns**: + +[PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) output on pin_index. + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **pin_index**: [in] Pin from which to get output. +* [DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror) & **error**: [out] Status of call. + +**Return type**: [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) + + + ### Function getOutputString @@ -4956,6 +5193,38 @@ int output on pin_index. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Operator::getOutputInt"}]}` --> + +### Function getOutputUInt + +![][public] + + +```cpp +uint64_t ansys::dpf::Operator::getOutputUInt(dp_index pin_index, DpfError &error) +``` + + + + +**Returns**: + +Unsigned 64-bit integer output on pin_index. + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **pin_index**: [in] Pin from which to get output. +* [DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror) & **error**: [out] Status of call. + +**Return type**: uint64_t + + + ### Function getOutputIntVector diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-operatormain.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-operatormain.md index e50eba7340..a5ed3990ab 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-operatormain.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-operatormain.md @@ -29,9 +29,9 @@ * [getInputField](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a064e47615a3d7beb23ee8ab9f589844e) * [getInputFieldsContainer](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1ae3a8077aa63c688e42dbe707a5bbe320) * [getInputGenericDataContainer](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a6c877ce71b260e6a540a8cff6bec8acd) +* [getInputInt64](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1abc8f1a12dda42ce3762b414f79acddec) * [getInputInteger](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1ab313f7215443f3bd16dac73d5bbea480) * [getInputLabelSpace](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a86ba9637ed2ad87246690b2407ce8033) -* [getInputLongLong](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1ad227f6658d46455cc795c0e8e2e26c22) * [getInputMeshedRegion](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1abf3941daef165cb449d4159b106a23fd) * [getInputMeshesContainer](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a33d2b9d8e6408e42547340f056fdecee) * [getInputOperator](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a0fb8663005dd50e7aff666a463d7064c) @@ -45,9 +45,11 @@ * [getInputStringField](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a16741789fff23ceca3d49d71a2c5e9d4) * [getInputSupport](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1abd71f83c649a04e7f2f7813384255f29) * [getInputTimeFreqSupport](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a772955b40f867d944a2420934a969e92) +* [getInputUInt64](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1adcf7e063620b6613db3b565820e2831e) * [getInputVecDouble](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1accaaa7cf0b5753e3ac603e833df5f79c) * [getInputVecInt](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a1f0a8b9bfdb1068237ea65e9ced21b4d) * [getInputVecString](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a0655fe1b44a5385e2dbc8ddc4fca8e35) +* [getInputVecUInt64](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a9b32fd8b72604b9f74aa4e19d24520ac) * [getInputWorkflow](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1ab7c167dbd3257b0683906edc2cc27a65) * [getNumInputs](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a041b07a72607c574cd81a878f9e16e41) * [getNumThreads](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a5c2957fff4ff41671e98489faf5530ee) @@ -84,7 +86,9 @@ * [setOutput](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a604b24756c0ee9f63941e1943ce029ad) * [setOutput](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a0c74f0785a142a82c33796feaced4542) * [setOutput](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1ad6d1c029bc239f8b47f7ae34d011a4ad) -* [setOutput](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a9ddd1af34ae1cc9b0274203471cfadc6) +* [setOutput](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1ac3179d72d416414c8187981e6cf99be3) +* [setOutput](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a37e9b49b12293fc27e47a6193e633a13) +* [setOutput](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1acb9a49a02246ae0e7557b8db67fd936d) * [setOutput](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a13cd3ab170883dae7943255b33078cba) * [setOutput](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1a08c3ec2a45807e4f9e7ca10d7fee867b) * [setOutput](classansys-dpf-operatormain.md#classansys-dpf-operatormain-1ade2fb9f881cb1a54fb9e916faceb0c93) @@ -2028,14 +2032,14 @@ Set double value for given output pin. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::OperatorMain::setOutput"}]}` --> - -### Function getInputLongLong + +### Function getInputInt64 ![][public] ```cpp -long long int ansys::dpf::OperatorMain::getInputLongLong(dp_index pin_index) +int64_t ansys::dpf::OperatorMain::getInputInt64(dp_index pin_index) ``` @@ -2043,7 +2047,7 @@ long long int ansys::dpf::OperatorMain::getInputLongLong(dp_index pin_index) **Returns**: -Long long int value for given input pin. +Int64 value for given input pin. @@ -2051,35 +2055,96 @@ Long long int value for given input pin. * [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **pin_index**: [in] Input pin for which to get value. -**Return type**: long long int +**Return type**: int64_t - + ### Function setOutput ![][public] ```cpp -void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, long long int f) +void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, int64_t f) ``` -Set long long int value for given output pin. +Set int64 value for given output pin. **Parameters**: * [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **pin_index**: [in] Output pin for which to set value. -* long long int **f**: [in] Long long int value to assign to output pin. +* int64_t **f**: [in] Int64 value to assign to output pin. + +**Return type**: void + + + + +### Function getInputUInt64 + +![][public] + + +```cpp +uint64_t ansys::dpf::OperatorMain::getInputUInt64(dp_index pin_index) +``` + + + + +**Returns**: + +UInt64 value for given input pin. + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **pin_index**: [in] Input pin for which to get value. + +**Return type**: uint64_t + + + + +### Function setOutput + +![][public] + + +```cpp +void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, uint64_t f) +``` + + + + +Set uint64 value for given output pin. + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **pin_index**: [in] Output pin for which to set value. +* uint64_t **f**: [in] UInt64 value to assign to output pin. **Return type**: void @@ -2182,6 +2247,67 @@ Vector of strings for given input pin. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::OperatorMain::getInputVecString"}]}` --> + +### Function getInputVecUInt64 + +![][public] + + +```cpp +std::vector< uint64_t > ansys::dpf::OperatorMain::getInputVecUInt64(dp_index pin_index) +``` + + + + +**Returns**: + +Vector of uint64_t for given input pin. + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **pin_index**: [in] Input pin for which to get value. + +**Return type**: std::vector< uint64_t > + + + + +### Function setOutput + +![][public] + + +```cpp +void ansys::dpf::OperatorMain::setOutput(dp_index pin_index, std::vector< uint64_t > const &out) +``` + + + + +Set vector of uint64_t for given output pin. + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **pin_index**: [in] Output pin for which to set value. +* std::vector< uint64_t > const & **out**: [in] Vector of uint64_t to assign to output pin. + +**Return type**: void + + + ### Function setOutput diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-propertyfieldscontainer.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-propertyfieldscontainer.md new file mode 100644 index 0000000000..d7d0f19555 --- /dev/null +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-propertyfieldscontainer.md @@ -0,0 +1,619 @@ +# Class ansys::dpf::PropertyFieldsContainer + + + +![][C++] +![][public] + + + +Contains a group of property fields. The [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) is a set of property fields ordered through labels and ids. It is the external-API equivalent of the internal CPropertyFieldsContainer. + +**See also**: [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) + +**Inherits from**: + +* ansys::dpf::CollectionBase + +## Members + +* [add](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1a516027968af62af231e6a8328a5206ef) +* [addLabel](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a623a0b168512a4621fb7af8084f9872b) +* [addLabel](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ac6ce7bc876d6a94a97996d5febba5116) +* [addLabels](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ae97480559c14c59e830559582c1f2cd5) +* [at](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1a1c4b5909f25eba964ce77213847f229e) +* [at](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1a02a35c2ef55e1cf084c01fe41ceb1a99) +* [callAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aea34d37e0c080126eff70db34bf46597) +* [describe](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9977945710983bc03d2940fa007847b2) +* [empty](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a39cd546c42518e2332be8f287db95459) +* [emptyPropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1a97acb600355d03ca1182fcc9c22d2a42) +* [getClient](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a968afd9daa0b0f13b65a2ac61369d73a) +* [getLabelSpace](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a66d62492d07889a95a5d10f9d827cd11) +* [getMatchingPropertyField](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1ad8e7513de92e250580d327866edd69eb) +* [getMatchingPropertyFieldIndices](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1a3098d8c43a36f300f2eb04201ae428c8) +* [getPropertyField](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1a25d4e79f68ed5c12c3ebb502552d0fda) +* [getPropertyFields](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1abea305375bca0a24a90d3c2947de2c34) +* [getPropertyFieldsIndices](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1aeb10e343fe980616f9da1e5f542c780f) +* [getSizeFor](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1aab65999d65acb4eab6aa7375266e5456) +* [hasBeenMovedLocally](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a1a5634202c15404b6b24e8f50e51cb66) +* [hasInternalObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ae198f89868d85c7db6dc1a934a1d3c15) +* [hasLabel](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a82ac9433fd3963b37b07989ef05de331) +* [id](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a5e8d2dd8b9b6cf273985ce3ead392830) +* [isOnCommonAPI](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1a9f9789ff61cc9d400a2a344830706b73) +* [isSameObject](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1aa64d5f8fcd7d85ad6ebf708494dbefd7) +* [labels](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a2c1bb3718e1a96d3f40b64794eb25f91) +* [labelScoping](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ac61aef82ffe249c95dd10cf40de7c910) +* [name](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a691450ab7c89db80f39d6bb2d10eace4) +* [operator=](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1abee80077e5413de6f252547c6ff37e9d) +* [operator=](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1afe0aec13a6ea9b365e0c4a5fc497119f) +* [operator[]](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1aa2bcaa573b44f264d5e4afbb72bcb121) +* [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1a9e08e771d93d635ead012bbd337664a4) +* [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1ab898b6efd3a27fd7a8ea904d7d7489d1) +* [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1ae9b8e3fd95b504b154ef3d770bdb38aa) +* [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1acd849dbe9da1be093ab43b137de3fcab) +* [reserve](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a98ab98c9a6b91b886fd600ed7d9e633b) +* [resize](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ac88664d3e1d22abb74a95c8223b1e771) +* [setId](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a93ebbfe9396dd1c4f447e799db6cbf3b) +* [setName](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a44394f964c6130dcbaed446cec3b0197) +* [setSupport](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ae6f7683496d153ed944856d42b97dc82) +* [setSupport](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1ada2a037068417557fd7d410577a7fbb9) +* [size](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a69e6878d2d691807f8a45ddfbda42f9e) +* [support](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a9830a03b992af391bf03acad90eac372) +* [update](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1a8ec93e502fb755c1ddbb8552a2e40b25) +* [~CollectionBase](classansys-dpf-collectionbase.md#classansys-dpf-collectionbase-1a99e04439d35f26b89f4d66813d74035b) +* [~DpfTypes](classansys-dpf-dpftypes.md#classansys-dpf-dpftypes-1ab7c83b6ea160c2b115e056f6c312112f) +* [~PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer-1a49d4bed7313dff96bec9793daff05962) + +## Friends + +## Public functions + + +### Function PropertyFieldsContainer + +![][public] + + +```cpp +ansys::dpf::PropertyFieldsContainer::PropertyFieldsContainer() +``` + + + + + + + + +**Return type**: + + + + +### Function ~PropertyFieldsContainer + +![][public] + + +```cpp +virtual ansys::dpf::PropertyFieldsContainer::~PropertyFieldsContainer() +``` + + + + + + + + +**Return type**: + + + + +### Function PropertyFieldsContainer + +![][public] + + +```cpp +ansys::dpf::PropertyFieldsContainer::PropertyFieldsContainer(PropertyFieldsContainer const &rhs) +``` + + + + + + + + +**Parameters**: + +* [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) const & **rhs** + +**Return type**: + + + + +### Function PropertyFieldsContainer + +![][public] + + +```cpp +ansys::dpf::PropertyFieldsContainer::PropertyFieldsContainer(PropertyFieldsContainer &&) noexcept +``` + + + + + + + + +**Parameters**: + +* [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) && + +**Return type**: + + + + +### Function PropertyFieldsContainer + +![][public] + + +```cpp +ansys::dpf::PropertyFieldsContainer::PropertyFieldsContainer(std::vector< std::string > const &labels) +``` + + + + +Create container for a group of PropertyFields with the given labels. + + + +**Parameters**: + +* std::vector< std::string > const & **labels**: [in] Labels for group of PropertyFields. + +**Return type**: + + + + +### Function operator= + +![][public] + + +```cpp +PropertyFieldsContainer & ansys::dpf::PropertyFieldsContainer::operator=(PropertyFieldsContainer const &) +``` + + + + + + + + +**Parameters**: + +* [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) const & + +**Return type**: [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) & + + + + +### Function operator= + +![][public] + + +```cpp +PropertyFieldsContainer & ansys::dpf::PropertyFieldsContainer::operator=(PropertyFieldsContainer &&) noexcept +``` + + + + + + + + +**Parameters**: + +* [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) && + +**Return type**: [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) & + + + + +### Function operator[] + +![][public] + + +```cpp +PropertyField ansys::dpf::PropertyFieldsContainer::operator[](dp_int index) +``` + + + + +**Returns**: + +[PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) for given index. + + + +**Parameters**: + +* [dp_int](namespaceansys-dpf.md#namespaceansys-dpf-1a60d181a1f9d29cc7cc38b25dac4401f0) **index**: [in] Index of [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) within container. + +**Return type**: [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) + + + + +### Function at + +![][public] + + +```cpp +PropertyField ansys::dpf::PropertyFieldsContainer::at(dp_index index) +``` + + + + +**Returns**: + +[PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) for given index. + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **index**: [in] Index of [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) to get. + +**Return type**: [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) + + + + +### Function at + +![][public] +![][const] + + +```cpp +const PropertyField ansys::dpf::PropertyFieldsContainer::at(dp_index index) const +``` + + + + +**Returns**: + +[PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) for given index. + + + +**Parameters**: + +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **index**: [in] Index of [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) to get. + +**Return type**: const [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) + + + + +### Function update + +![][public] + + +```cpp +void ansys::dpf::PropertyFieldsContainer::update(PropertyField &f, dp_index index) +``` + + + + +Update a [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) at index. + + + +**Parameters**: + +* [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) & **f**: [in] New [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield). +* [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) **index**: [in] Index of [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) to update. + +**Return type**: void + + + + +### Function add + +![][public] + + +```cpp +void ansys::dpf::PropertyFieldsContainer::add(LabelSpace const &labels, PropertyField const &f, bool can_replace=true) +``` + + + + +Add [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) with given label space. + + + +**Parameters**: + +* [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const & **labels**: [in] [Label](structansys-dpf-label.md#structansys-dpf-label) space for [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield). +* [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) const & **f**: [in] [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) to add. +* bool **can_replace** = true : [in] if can_replace is false, then, the entity is pushed back without checking if the label space already exists. + +**Return type**: void + + + + +### Function getPropertyFields + +![][public] +![][const] + + +```cpp +std::vector< PropertyField > ansys::dpf::PropertyFieldsContainer::getPropertyFields(LabelSpace const &label_space) const +``` + + + + +**Returns**: + +Vector of PropertyFields for given label space. + + + +**Parameters**: + +* [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const & **label_space**: [in] [Label](structansys-dpf-label.md#structansys-dpf-label) space for which to get PropertyFields. + +**Return type**: std::vector< [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) > + + + + +### Function getPropertyField + +![][public] +![][const] + + +```cpp +PropertyField ansys::dpf::PropertyFieldsContainer::getPropertyField(LabelSpace const &label_space) const +``` + + + + +**Returns**: + +First [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) for given label space. + + + +**Parameters**: + +* [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const & **label_space**: [in] [Label](structansys-dpf-label.md#structansys-dpf-label) space for which to get [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield). + +**Return type**: [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) + + + + +### Function getPropertyFieldsIndices + +![][public] +![][const] + + +```cpp +std::vector< int > ansys::dpf::PropertyFieldsContainer::getPropertyFieldsIndices(LabelSpace const &lab_space) const +``` + + + + + + + + +**Parameters**: + +* [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const & **lab_space** + +**Return type**: std::vector< int > + + + + +### Function getMatchingPropertyField + +![][public] +![][const] + + +```cpp +PropertyField ansys::dpf::PropertyFieldsContainer::getMatchingPropertyField(LabelSpace const &label_space) const +``` + + + + +**Returns**: + +First matching [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) for given label space. + + + +**Parameters**: + +* [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const & **label_space**: [in] [Label](structansys-dpf-label.md#structansys-dpf-label) space for which to get [Any](classansys-dpf-any.md#classansys-dpf-any). + +**Return type**: [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) + + + + +### Function getMatchingPropertyFieldIndices + +![][public] +![][const] + + +```cpp +DpfVector< dp_index > ansys::dpf::PropertyFieldsContainer::getMatchingPropertyFieldIndices(LabelSpace const &label_space) const +``` + + + + +**Returns**: + +Vector of matching [PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) to the given label space. + + + +**Parameters**: + +* [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const & **label_space**: [in] [Label](structansys-dpf-label.md#structansys-dpf-label) space for which to get entries. + +**Return type**: [DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector)< [dp_index](namespaceansys-dpf.md#namespaceansys-dpf-1a417548d1b705a9ba54ba9429afe68920) > + + + +## Public static functions + + +### Function emptyPropertyFieldsContainer + +![][public] +![][static] + + +```cpp +static PropertyFieldsContainer ansys::dpf::PropertyFieldsContainer::emptyPropertyFieldsContainer() +``` + + + + +Create an empty container. +**Returns**: + +Empty [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer). + + + +**Return type**: [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) + + + + + +[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) \ No newline at end of file diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-remoteoperator.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-remoteoperator.md index 0ac9236038..5dcbdcf4e7 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-remoteoperator.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-remoteoperator.md @@ -28,6 +28,7 @@ * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a6f9e628bf2429fc5a805871c61c69a17) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1aad1b060bfb2886c3b3dd75f1385f6222) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a5add81029b92a785398586268a0112a9) +* [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a03a8e31439cd8d397b84c70b3d6ac638) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a5e5cbe01690fca3a27bbf8cd4a21f530) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1af13e07e9f51973d31c33dd4c80930c0f) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a9006d2db6a9e078acc0b293ec1439863) @@ -46,6 +47,7 @@ * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ae76c6c18901c49692e9d15d59b784d79) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a21dfe41f3f388752fa35bd28b7cb82a7) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1af9629fd0bf6f14054969bd1a17a3c01a) +* [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a218d7f8cea0d8382f70d2f1c329b85d2) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ae5bd39532c17864b402d36cbf299e0a6) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a5c1afb9023b4dcede90cbb689d44235b) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1af0cc66b849378593d484d64fd884f534) @@ -65,6 +67,7 @@ * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a7fc609c2f4538038c30ec8034f22ddb8) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ab0a16ba648b2e088b1b1bbb6c6d57bf1) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a8e9cb2e84276a62ecbfac15fc34eb987) +* [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a196fecf93c582c710a8c2c8c9c5f0ed8) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a055daebf6e09e2f8cadbd71218de629e) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a6a6d0fca683a19dded250760f9f67b4b) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a72c6e272e3a18c77d170ae638943e6a5) @@ -77,6 +80,7 @@ * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ae2825474b8c81df35899c9f4f2d99564) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1acfd6ae4496cac17382d290385b016b46) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a35815dd63725ce35d51b791dea1713e3) +* [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ad5bfefab97939ef5afd96f51e42ed3d7) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ac9f70f22925540444a489da7c389cd2c) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1a0dccc56a240f176d4406901fa3779ae8) * [connect](classansys-dpf-operator.md#classansys-dpf-operator-1ab319e553b676692001a5fd6ea54a791c) @@ -138,6 +142,8 @@ * [getOutputOperator](classansys-dpf-operator.md#classansys-dpf-operator-1a255fa07a2e0a12152f915ee8f5b5a524) * [getOutputPropertyField](classansys-dpf-operator.md#classansys-dpf-operator-1a58ea7f5128ab677787afb696b0293267) * [getOutputPropertyField](classansys-dpf-operator.md#classansys-dpf-operator-1ae726557dc3c40abd7afe411fc2ce278c) +* [getOutputPropertyFieldsContainer](classansys-dpf-operator.md#classansys-dpf-operator-1a5572ba10829cb4f482c5265df5c2be55) +* [getOutputPropertyFieldsContainer](classansys-dpf-operator.md#classansys-dpf-operator-1a85531ed5d40a0230ca9eaeb1431b3f31) * [getOutputResultInfo](classansys-dpf-operator.md#classansys-dpf-operator-1aeb719093c2406e06455423370eed3cd8) * [getOutputResultInfo](classansys-dpf-operator.md#classansys-dpf-operator-1acea4c808d2f4d01adea5539b3da95d33) * [getOutputScoping](classansys-dpf-operator.md#classansys-dpf-operator-1a08ab4421b7cc47bb6c5baeafdebe641f) @@ -154,6 +160,8 @@ * [getOutputSupport](classansys-dpf-operator.md#classansys-dpf-operator-1aa818d55166583977ae4e4ecbd709b56e) * [getOutputTimeFreqSupport](classansys-dpf-operator.md#classansys-dpf-operator-1ad2bfffac019485c51c8d3cc88c94ebd0) * [getOutputTimeFreqSupport](classansys-dpf-operator.md#classansys-dpf-operator-1ab6015d4542961222e37a107e699dfc2e) +* [getOutputUInt](classansys-dpf-operator.md#classansys-dpf-operator-1a74c3403cdcd79a4fc262bd91a2a4d231) +* [getOutputUInt](classansys-dpf-operator.md#classansys-dpf-operator-1a87689e72739ab2b4533f6eb4728b7691) * [getOutputWorkflow](classansys-dpf-operator.md#classansys-dpf-operator-1ab43c2d56664e3db3bfb386bb6895fc9c) * [getOutputWorkflow](classansys-dpf-operator.md#classansys-dpf-operator-1a0875bb76f8121ba69f3e5e001deb7ea2) * [getRemoteId](classansys-dpf-operator.md#classansys-dpf-operator-1a3450f744e8f833a2862686431855c990) diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-remoteworkflow.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-remoteworkflow.md index 6e31e77db2..de8e6c4e65 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-remoteworkflow.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-remoteworkflow.md @@ -24,6 +24,7 @@ * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a6ce835a6bd7213846e9f2a54c3c0a26b) * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a0359e496cfe9ef8b635df5ced09ee4ed) * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a784a219175f41f4a6c7da7703f45defe) +* [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a84c7e95e6ce6f0ef58b52bc0633ce109) * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a2bbb7a7147a954812864d12b21ded9b3) * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a667f3d115d92aab65b3220e1ab64fb28) * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1af22209afa4cb0826c3848bf9c99bdcd5) @@ -147,6 +148,8 @@ * [getOutputSupport](classansys-dpf-workflow.md#classansys-dpf-workflow-1ac72d8c2dcd1440727a32eab2dd116de5) * [getOutputTimeFreqSupport](classansys-dpf-workflow.md#classansys-dpf-workflow-1ac087d530db5bea30250a6110054f204a) * [getOutputTimeFreqSupport](classansys-dpf-workflow.md#classansys-dpf-workflow-1ae52042f810882873efc0ba757202e886) +* [getOutputUInt](classansys-dpf-workflow.md#classansys-dpf-workflow-1af358c6fd7d0c089aab1e2251bdd2d012) +* [getOutputUInt](classansys-dpf-workflow.md#classansys-dpf-workflow-1ae51613d555b44ca05ff4ae8c8b427668) * [getOutputUnit](classansys-dpf-workflow.md#classansys-dpf-workflow-1abeff5a7ffd64f443c6da0be2e254563c) * [getOutputUnit](classansys-dpf-workflow.md#classansys-dpf-workflow-1af8eb2c09487a34ec09f8166072c5ca2c) * [getOutputWorkflow](classansys-dpf-workflow.md#classansys-dpf-workflow-1a6291348781887726efc7afe9e31a5fb9) @@ -188,6 +191,10 @@ * [RemoteWorkflow](classansys-dpf-remoteworkflow.md#classansys-dpf-remoteworkflow-1a7fe3018d374672149e4568929736729f) * [renameInputPin](classansys-dpf-workflow.md#classansys-dpf-workflow-1a22fba3c96a8a6e9eda279fd1c4b5358f) * [renameOutputPin](classansys-dpf-workflow.md#classansys-dpf-workflow-1abff62660096b06dd09667061c8e3d8a6) +* [setStepIndexMaxMemoryMB](classansys-dpf-workflow.md#classansys-dpf-workflow-1a6c3700bdf7cf0fb38a12c15cf8213205) +* [shareStepIndexWith](classansys-dpf-workflow.md#classansys-dpf-workflow-1acfeb4ac138a1ec9e4b6e0d7fae14abb5) +* [stepIndexCurrentMemoryMB](classansys-dpf-workflow.md#classansys-dpf-workflow-1a7cc02b047d1d37c1bb92440f4fade050) +* [stepIndexOperatorStatuses](classansys-dpf-workflow.md#classansys-dpf-workflow-1a5a24c6e5128c940559d976e236c58ec5) * [tryReplaceWorkflowInRegistry](classansys-dpf-workflow.md#classansys-dpf-workflow-1a478c1be621d4c49916771b42d4b10ba9) * [Workflow](classansys-dpf-workflow.md#classansys-dpf-workflow-1a808195b2d92b18f8f3a362e4bd701f39) * [Workflow](classansys-dpf-workflow.md#classansys-dpf-workflow-1a8a36b36629bde25afe03b12b0ed5a958) diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-workflow.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-workflow.md index 6b51186ede..501ff72b20 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-workflow.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classansys-dpf-workflow.md @@ -28,6 +28,7 @@ * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a6ce835a6bd7213846e9f2a54c3c0a26b) * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a0359e496cfe9ef8b635df5ced09ee4ed) * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a784a219175f41f4a6c7da7703f45defe) +* [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a84c7e95e6ce6f0ef58b52bc0633ce109) * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a2bbb7a7147a954812864d12b21ded9b3) * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1a667f3d115d92aab65b3220e1ab64fb28) * [connect](classansys-dpf-workflow.md#classansys-dpf-workflow-1af22209afa4cb0826c3848bf9c99bdcd5) @@ -150,6 +151,8 @@ * [getOutputSupport](classansys-dpf-workflow.md#classansys-dpf-workflow-1ac72d8c2dcd1440727a32eab2dd116de5) * [getOutputTimeFreqSupport](classansys-dpf-workflow.md#classansys-dpf-workflow-1ac087d530db5bea30250a6110054f204a) * [getOutputTimeFreqSupport](classansys-dpf-workflow.md#classansys-dpf-workflow-1ae52042f810882873efc0ba757202e886) +* [getOutputUInt](classansys-dpf-workflow.md#classansys-dpf-workflow-1af358c6fd7d0c089aab1e2251bdd2d012) +* [getOutputUInt](classansys-dpf-workflow.md#classansys-dpf-workflow-1ae51613d555b44ca05ff4ae8c8b427668) * [getOutputUnit](classansys-dpf-workflow.md#classansys-dpf-workflow-1abeff5a7ffd64f443c6da0be2e254563c) * [getOutputUnit](classansys-dpf-workflow.md#classansys-dpf-workflow-1af8eb2c09487a34ec09f8166072c5ca2c) * [getOutputWorkflow](classansys-dpf-workflow.md#classansys-dpf-workflow-1a6291348781887726efc7afe9e31a5fb9) @@ -183,6 +186,10 @@ * [record](classansys-dpf-workflow.md#classansys-dpf-workflow-1a304ee206ac4927f7aa757c63b0ec00b5) * [renameInputPin](classansys-dpf-workflow.md#classansys-dpf-workflow-1a22fba3c96a8a6e9eda279fd1c4b5358f) * [renameOutputPin](classansys-dpf-workflow.md#classansys-dpf-workflow-1abff62660096b06dd09667061c8e3d8a6) +* [setStepIndexMaxMemoryMB](classansys-dpf-workflow.md#classansys-dpf-workflow-1a6c3700bdf7cf0fb38a12c15cf8213205) +* [shareStepIndexWith](classansys-dpf-workflow.md#classansys-dpf-workflow-1acfeb4ac138a1ec9e4b6e0d7fae14abb5) +* [stepIndexCurrentMemoryMB](classansys-dpf-workflow.md#classansys-dpf-workflow-1a7cc02b047d1d37c1bb92440f4fade050) +* [stepIndexOperatorStatuses](classansys-dpf-workflow.md#classansys-dpf-workflow-1a5a24c6e5128c940559d976e236c58ec5) * [tryReplaceWorkflowInRegistry](classansys-dpf-workflow.md#classansys-dpf-workflow-1a478c1be621d4c49916771b42d4b10ba9) * [Workflow](classansys-dpf-workflow.md#classansys-dpf-workflow-1a808195b2d92b18f8f3a362e4bd701f39) * [Workflow](classansys-dpf-workflow.md#classansys-dpf-workflow-1a8a36b36629bde25afe03b12b0ed5a958) @@ -1591,6 +1598,91 @@ GenericDataContainer with active operators info (name_id -> status). * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::getActiveOperators"}]}` --> + +### Function stepIndexCurrentMemoryMB + +![][public] +![][const] + + +```cpp +int ansys::dpf::Workflow::stepIndexCurrentMemoryMB() const +``` + + + + +**Returns**: + +Current heap memory (in MB) held by this workflow's step index. + + + +**Return type**: int + + + + +### Function setStepIndexMaxMemoryMB + +![][public] + + +```cpp +void ansys::dpf::Workflow::setStepIndexMaxMemoryMB(double megaBytes) +``` + + + + +Sets an upper bound (in MB) on the memory held by this workflow's step index. A value <= 0 disables the limit. + + + +**Parameters**: + +* double **megaBytes** + +**Return type**: void + + + + +### Function stepIndexOperatorStatuses + +![][public] +![][const] + + +```cpp +GenericDataContainer ansys::dpf::Workflow::stepIndexOperatorStatuses() const +``` + + + + +**Returns**: + +GenericDataContainer with step-index operator statuses (name_id -> int E_OperatorState). + + + +**Return type**: GenericDataContainer + + + ### Function getOutputField @@ -2304,6 +2396,37 @@ Boolean result for given output pin. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::getOutputBool"}]}` --> + +### Function getOutputUInt + +![][public] + + +```cpp +uint64_t ansys::dpf::Workflow::getOutputUInt(std::string const &pin_name) +``` + + + + +**Returns**: + +Unsigned 64-bit integer result for given output pin. + + + +**Parameters**: + +* std::string const & **pin_name**: [in] Output pin name. + +**Return type**: uint64_t + + + ### Function getOutputString @@ -3196,6 +3319,38 @@ Boolean result for given output pin. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::getOutputBool"}]}` --> + +### Function getOutputUInt + +![][public] + + +```cpp +uint64_t ansys::dpf::Workflow::getOutputUInt(std::string const &pin_name, DpfError &error) +``` + + + + +**Returns**: + +Unsigned 64-bit integer result for given output pin. + + + +**Parameters**: + +* std::string const & **pin_name**: [in] Output pin name. +* [DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror) & **error**: [out] Status of call. + +**Return type**: uint64_t + + + ### Function getOutputString @@ -3424,6 +3579,39 @@ Connect double to input pin. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::connect"}]}` --> + +### Function connect + +![][public] + + +```cpp +void ansys::dpf::Workflow::connect(std::string const &pin_name, uint64_t f) +``` + + + + +Connect unsigned 64-bit integer to input pin. +**Exceptions**: + +* **[DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception)**: + + + +**Parameters**: + +* std::string const & **pin_name**: [in] Input pin name. +* uint64_t **f**: [in] Unsigned 64-bit integer data. + +**Return type**: void + + + ### Function connect @@ -5544,6 +5732,35 @@ void ansys::dpf::Workflow::enableCache(bool b) * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Workflow::enableCache"}]}` --> + +### Function shareStepIndexWith + +![][public] + + +```cpp +void ansys::dpf::Workflow::shareStepIndexWith(Workflow const &other) +``` + + + + +Attach this workflow to the same step index as other, so both share the step cache. + + + +**Parameters**: + +* Workflow const & **other** + +**Return type**: void + + + ### Function getHash diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classes.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classes.md index 9001d02c24..9c0ec5f9c4 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classes.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/classes.md @@ -20,6 +20,7 @@ List of Classes: - [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md) - [ansys::dpf::DataSources](classansys-dpf-datasources.md) - [ansys::dpf::DataTree](classansys-dpf-datatree.md) +- [ansys::dpf::DefaultErrorFormatter](classansys-dpf-defaulterrorformatter.md) - [ansys::dpf::Dimensionality](structansys-dpf-dimensionality.md) - [ansys::dpf::DpfError](classansys-dpf-dpferror.md) - [ansys::dpf::DpfException](classansys-dpf-dpfexception.md) @@ -30,6 +31,7 @@ List of Classes: - [ansys::dpf::DpfVectorDataHelper](structansys-dpf-dpfvectordatahelper.md) - [ansys::dpf::ElementCursor](classansys-dpf-elementcursor.md) - [ansys::dpf::ElementDescriptor](structansys-dpf-elementdescriptor.md) +- [ansys::dpf::ErrorFormatter](classansys-dpf-errorformatter.md) - [ansys::dpf::EventHandler](classansys-dpf-eventhandler.md) - [ansys::dpf::ExternalData](classansys-dpf-externaldata.md) - [ansys::dpf::ExternalDataT](classansys-dpf-externaldatat.md) @@ -40,6 +42,7 @@ List of Classes: - [ansys::dpf::FieldsContainer](classansys-dpf-fieldscontainer.md) - [ansys::dpf::GenericDataContainer](classansys-dpf-genericdatacontainer.md) - [ansys::dpf::GenericSupport](classansys-dpf-genericsupport.md) +- [ansys::dpf::HgpDpfException](classansys-dpf-hgpdpfexception.md) - [ansys::dpf::Homogeneity](classansys-dpf-homogeneity.md) - [ansys::dpf::Interface](classansys-dpf-interface.md) - [ansys::dpf::Label](structansys-dpf-label.md) @@ -63,6 +66,7 @@ List of Classes: - [ansys::dpf::PinDefinition](structansys-dpf-pindefinition.md) - [ansys::dpf::PropFieldCursor](classansys-dpf-propfieldcursor.md) - [ansys::dpf::PropertyField](classansys-dpf-propertyfield.md) +- [ansys::dpf::PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md) - [ansys::dpf::PropertyType](structansys-dpf-propertytype.md) - [ansys::dpf::QuantityType](structansys-dpf-quantitytype.md) - [ansys::dpf::RemoteOperator](classansys-dpf-remoteoperator.md) @@ -119,6 +123,7 @@ List of Classes: - [ansys::dpf::reflect< MeshesContainer >](structansys-dpf-reflect-meshescontainer.md) - [ansys::dpf::reflect< Operator >](structansys-dpf-reflect-operator.md) - [ansys::dpf::reflect< PropertyField >](structansys-dpf-reflect-propertyfield.md) +- [ansys::dpf::reflect< PropertyFieldsContainer >](structansys-dpf-reflect-propertyfieldscontainer.md) - [ansys::dpf::reflect< RemoteOperator >](structansys-dpf-reflect-remoteoperator.md) - [ansys::dpf::reflect< RemoteWorkflow >](structansys-dpf-reflect-remoteworkflow.md) - [ansys::dpf::reflect< ResultInfo >](structansys-dpf-reflect-resultinfo.md) @@ -136,7 +141,7 @@ List of Classes: - [ansys::dpf::reflect< int64_t >](structansys-dpf-reflect-int64-t.md) - [ansys::dpf::reflect< int8_t >](structansys-dpf-reflect-int8-t.md) - [ansys::dpf::reflect< short >](structansys-dpf-reflect-short.md) -- [ansys::dpf::reflect< size_t >](structansys-dpf-reflect-size-t.md) +- [ansys::dpf::reflect< uint64_t >](structansys-dpf-reflect-uint64-t.md) - [ansys::dpf::reflect< unsigned int >](structansys-dpf-reflect-unsigned-int.md) - [ansys::dpf::reflect< unsigned short >](structansys-dpf-reflect-unsigned-short.md) - [ansys::dpf::reflect< wchar_t >](structansys-dpf-reflect-wchar-t.md) diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dir-dd83be0cfbcc27aa9f.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dir-dd83be0cfbcc27aa9f.md index 9fe398cdab..a0f76f984f 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dir-dd83be0cfbcc27aa9f.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dir-dd83be0cfbcc27aa9f.md @@ -1,4 +1,4 @@ -# Directory C:/agent/installer/_work/12/s/DPF/Ans.Dpf.Hgp +# Directory C:/agent/installer/_work/7/s/DPF/Ans.Dpf.Hgp @@ -8,7 +8,7 @@ ## Subdirectories -* [C:/agent/installer/_work/12/s/DPF/Ans.Dpf.Hgp/helpers](dir-fca9ddd4acaabdc476476.md#dir-fca9ddd4acaabdc476476) +* [C:/agent/installer/_work/7/s/DPF/Ans.Dpf.Hgp/helpers](dir-fca9ddd4acaabdc476476.md#dir-fca9ddd4acaabdc476476) ## Files diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dir-fca9ddd4acaabdc476476.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dir-fca9ddd4acaabdc476476.md index 4876da5629..3c646e7186 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dir-fca9ddd4acaabdc476476.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dir-fca9ddd4acaabdc476476.md @@ -1,4 +1,4 @@ -# Directory C:/agent/installer/_work/12/s/DPF/Ans.Dpf.Hgp/helpers +# Directory C:/agent/installer/_work/7/s/DPF/Ans.Dpf.Hgp/helpers diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dpf-api-base-h.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dpf-api-base-h.md index 9ad4525e99..a17856d4f4 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dpf-api-base-h.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dpf-api-base-h.md @@ -38,6 +38,9 @@ * [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) * [ansys::dpf::DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror) * [ansys::dpf::DpfException](classansys-dpf-dpfexception.md#classansys-dpf-dpfexception) +* [ansys::dpf::HgpDpfException](classansys-dpf-hgpdpfexception.md#classansys-dpf-hgpdpfexception) +* [ansys::dpf::ErrorFormatter](classansys-dpf-errorformatter.md#classansys-dpf-errorformatter) +* [ansys::dpf::DefaultErrorFormatter](classansys-dpf-defaulterrorformatter.md#classansys-dpf-defaulterrorformatter) * [ansys::dpf::DpfVectorDataHelper](structansys-dpf-dpfvectordatahelper.md#structansys-dpf-dpfvectordatahelper) * [ansys::dpf::DpfVectorData](classansys-dpf-dpfvectordata.md#classansys-dpf-dpfvectordata) * [ansys::dpf::DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector) @@ -49,7 +52,7 @@ * [ansys::dpf::reflect\< int \>](structansys-dpf-reflect-int.md#structansys-dpf-reflect-int-4) * [ansys::dpf::reflect\< double \>](structansys-dpf-reflect-double.md#structansys-dpf-reflect-double-4) * [ansys::dpf::reflect\< bool \>](structansys-dpf-reflect-bool.md#structansys-dpf-reflect-bool-4) -* [ansys::dpf::reflect\< size_t \>](structansys-dpf-reflect-size-t.md#structansys-dpf-reflect-size-t-4) +* [ansys::dpf::reflect\< uint64_t \>](structansys-dpf-reflect-uint64-t.md#structansys-dpf-reflect-uint64-t-4) * [ansys::dpf::reflect\< int64_t \>](structansys-dpf-reflect-int64-t.md#structansys-dpf-reflect-int64-t-4) * [ansys::dpf::reflect\< char \>](structansys-dpf-reflect-char.md#structansys-dpf-reflect-char-4) * [ansys::dpf::reflect\< wchar_t \>](structansys-dpf-reflect-wchar-t.md#structansys-dpf-reflect-wchar-t-4) @@ -68,6 +71,9 @@ * * +* +* +* * * * @@ -91,26 +97,35 @@ click 1 "dpf__api__base_8h.md#dpf__api__base_8h" 1 --> 9 1 --> 10 1 --> 11 +1 --> 12 +1 --> 13 +1 --> 14 2["array"] -10["complex"] +13["complex"] -9["cstring"] +12["cstring"] 3["exception"] -8["iostream"] +4["initializer_list"] -6["map"] +11["iostream"] -7["set"] +9["map"] -4["string"] +10["set"] -11["tchar.h"] +6["stdexcept"] -5["vector"] +7["string"] + +14["tchar.h"] + +5["unordered_map"] + +8["vector"] ``` diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dpf-api-h.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dpf-api-h.md index 056093319d..1ec89079d8 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dpf-api-h.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/dpf-api-h.md @@ -41,6 +41,7 @@ * [ansys::dpf::ScopingsContainer](classansys-dpf-scopingscontainer.md#classansys-dpf-scopingscontainer) * [ansys::dpf::MeshesContainer](classansys-dpf-meshescontainer.md#classansys-dpf-meshescontainer) * [ansys::dpf::CustomTypeFieldsContainer](classansys-dpf-customtypefieldscontainer.md#classansys-dpf-customtypefieldscontainer) +* [ansys::dpf::PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) * [ansys::dpf::Collection](classansys-dpf-collection.md#classansys-dpf-collection) * [ansys::dpf::DataSources](classansys-dpf-datasources.md#classansys-dpf-datasources) * [ansys::dpf::ExternalStream](classansys-dpf-externalstream.md#classansys-dpf-externalstream) @@ -99,6 +100,7 @@ * [ansys::dpf::reflect\< LabelSpace \>](structansys-dpf-reflect-labelspace.md#structansys-dpf-reflect-labelspace-4) * [ansys::dpf::reflect\< GenericDataContainer \>](structansys-dpf-reflect-genericdatacontainer.md#structansys-dpf-reflect-genericdatacontainer-4) * [ansys::dpf::reflect\< CustomTypeFieldsContainer \>](structansys-dpf-reflect-customtypefieldscontainer.md#structansys-dpf-reflect-customtypefieldscontainer-4) +* [ansys::dpf::reflect\< PropertyFieldsContainer \>](structansys-dpf-reflect-propertyfieldscontainer.md#structansys-dpf-reflect-propertyfieldscontainer-4) * [ansys::dpf::LicenseContextManager](classansys-dpf-licensecontextmanager.md#classansys-dpf-licensecontextmanager) ## Namespaces diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/namespaceansys-dpf.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/namespaceansys-dpf.md index be31685e93..c9f343a41d 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/namespaceansys-dpf.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/namespaceansys-dpf.md @@ -28,6 +28,7 @@ This namespace encapsulates all of the HGP functionality. * [ansys::dpf::CyclicSupport](classansys-dpf-cyclicsupport.md#classansys-dpf-cyclicsupport) * [ansys::dpf::DataSources](classansys-dpf-datasources.md#classansys-dpf-datasources) * [ansys::dpf::DataTree](classansys-dpf-datatree.md#classansys-dpf-datatree) +* [ansys::dpf::DefaultErrorFormatter](classansys-dpf-defaulterrorformatter.md#classansys-dpf-defaulterrorformatter) * [ansys::dpf::dimensionalities](structansys-dpf-dimensionalities.md#structansys-dpf-dimensionalities) * [ansys::dpf::Dimensionality](structansys-dpf-dimensionality.md#structansys-dpf-dimensionality) * [ansys::dpf::DpfError](classansys-dpf-dpferror.md#classansys-dpf-dpferror) @@ -39,6 +40,7 @@ This namespace encapsulates all of the HGP functionality. * [ansys::dpf::ElementCursor](classansys-dpf-elementcursor.md#classansys-dpf-elementcursor) * [ansys::dpf::ElementDescriptor](structansys-dpf-elementdescriptor.md#structansys-dpf-elementdescriptor) * [ansys::dpf::elements](structansys-dpf-elements.md#structansys-dpf-elements) +* [ansys::dpf::ErrorFormatter](classansys-dpf-errorformatter.md#classansys-dpf-errorformatter) * [ansys::dpf::EventHandler](classansys-dpf-eventhandler.md#classansys-dpf-eventhandler) * [ansys::dpf::ExternalData](classansys-dpf-externaldata.md#classansys-dpf-externaldata) * [ansys::dpf::ExternalDataT](classansys-dpf-externaldatat.md#classansys-dpf-externaldatat) @@ -49,6 +51,7 @@ This namespace encapsulates all of the HGP functionality. * [ansys::dpf::FieldsContainer](classansys-dpf-fieldscontainer.md#classansys-dpf-fieldscontainer) * [ansys::dpf::GenericDataContainer](classansys-dpf-genericdatacontainer.md#classansys-dpf-genericdatacontainer) * [ansys::dpf::GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport) +* [ansys::dpf::HgpDpfException](classansys-dpf-hgpdpfexception.md#classansys-dpf-hgpdpfexception) * [ansys::dpf::homogeneities](structansys-dpf-homogeneities.md#structansys-dpf-homogeneities) * [ansys::dpf::Homogeneity](classansys-dpf-homogeneity.md#classansys-dpf-homogeneity) * [ansys::dpf::Interface](classansys-dpf-interface.md#classansys-dpf-interface) @@ -75,6 +78,7 @@ This namespace encapsulates all of the HGP functionality. * [ansys::dpf::PinDefinition](structansys-dpf-pindefinition.md#structansys-dpf-pindefinition) * [ansys::dpf::property_types](structansys-dpf-property-types.md#structansys-dpf-property-types) * [ansys::dpf::PropertyField](classansys-dpf-propertyfield.md#classansys-dpf-propertyfield) +* [ansys::dpf::PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) * [ansys::dpf::PropertyType](structansys-dpf-propertytype.md#structansys-dpf-propertytype) * [ansys::dpf::PropFieldCursor](classansys-dpf-propfieldcursor.md#classansys-dpf-propfieldcursor) * [ansys::dpf::quantity_types](structansys-dpf-quantity-types.md#structansys-dpf-quantity-types) @@ -99,16 +103,17 @@ This namespace encapsulates all of the HGP functionality. * [ansys::dpf::reflect\< MeshesContainer \>](structansys-dpf-reflect-meshescontainer.md#structansys-dpf-reflect-meshescontainer-4) * [ansys::dpf::reflect\< Operator \>](structansys-dpf-reflect-operator.md#structansys-dpf-reflect-operator-4) * [ansys::dpf::reflect\< PropertyField \>](structansys-dpf-reflect-propertyfield.md#structansys-dpf-reflect-propertyfield-4) +* [ansys::dpf::reflect\< PropertyFieldsContainer \>](structansys-dpf-reflect-propertyfieldscontainer.md#structansys-dpf-reflect-propertyfieldscontainer-4) * [ansys::dpf::reflect\< RemoteOperator \>](structansys-dpf-reflect-remoteoperator.md#structansys-dpf-reflect-remoteoperator-4) * [ansys::dpf::reflect\< RemoteWorkflow \>](structansys-dpf-reflect-remoteworkflow.md#structansys-dpf-reflect-remoteworkflow-4) * [ansys::dpf::reflect\< ResultInfo \>](structansys-dpf-reflect-resultinfo.md#structansys-dpf-reflect-resultinfo-4) * [ansys::dpf::reflect\< Scoping \>](structansys-dpf-reflect-scoping.md#structansys-dpf-reflect-scoping-4) * [ansys::dpf::reflect\< ScopingsContainer \>](structansys-dpf-reflect-scopingscontainer.md#structansys-dpf-reflect-scopingscontainer-4) * [ansys::dpf::reflect\< short \>](structansys-dpf-reflect-short.md#structansys-dpf-reflect-short-4) -* [ansys::dpf::reflect\< size_t \>](structansys-dpf-reflect-size-t.md#structansys-dpf-reflect-size-t-4) * [ansys::dpf::reflect\< Streams \>](structansys-dpf-reflect-streams.md#structansys-dpf-reflect-streams-4) * [ansys::dpf::reflect\< StringField \>](structansys-dpf-reflect-stringfield.md#structansys-dpf-reflect-stringfield-4) * [ansys::dpf::reflect\< TimeFreqSupport \>](structansys-dpf-reflect-timefreqsupport.md#structansys-dpf-reflect-timefreqsupport-4) +* [ansys::dpf::reflect\< uint64_t \>](structansys-dpf-reflect-uint64-t.md#structansys-dpf-reflect-uint64-t-4) * [ansys::dpf::reflect\< unsigned int \>](structansys-dpf-reflect-unsigned-int.md#structansys-dpf-reflect-unsigned-int-4) * [ansys::dpf::reflect\< unsigned short \>](structansys-dpf-reflect-unsigned-short.md#structansys-dpf-reflect-unsigned-short-4) * [ansys::dpf::reflect\< wchar_t \>](structansys-dpf-reflect-wchar-t.md#structansys-dpf-reflect-wchar-t-4) diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-reflect-propertyfieldscontainer.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-reflect-propertyfieldscontainer.md new file mode 100644 index 0000000000..2b7b77b8e9 --- /dev/null +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-reflect-propertyfieldscontainer.md @@ -0,0 +1,49 @@ +# Structure ansys::dpf::reflect\< PropertyFieldsContainer \> + + + +![][C++] +![][public] + + + + + + + +## Members + +* [type_name](structansys-dpf-reflect-propertyfieldscontainer.md#structansys-dpf-reflect-propertyfieldscontainer-4-1ac3fcca7c3232096c93a0331a61ed1df8) + +## Public static functions + + +### Function type_name + +![][public] +![][static] + + +```cpp +static std::string ansys::dpf::reflect< PropertyFieldsContainer >::type_name() +``` + + + + + + + + +**Return type**: std::string + + + +[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) \ No newline at end of file diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-reflect-size-t.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-reflect-uint64-t.md similarity index 59% rename from docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-reflect-size-t.md rename to docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-reflect-uint64-t.md index 76ef475525..ae9a57e45b 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-reflect-size-t.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-reflect-uint64-t.md @@ -1,6 +1,6 @@ -# Structure ansys::dpf::reflect\< size_t \> +# Structure ansys::dpf::reflect\< uint64_t \> - + ![][C++] ![][public] @@ -13,11 +13,11 @@ ## Members -* [type_name](structansys-dpf-reflect-size-t.md#structansys-dpf-reflect-size-t-4-1a93a3eb7ab21c60a9571c17c5cbc13569) +* [type_name](structansys-dpf-reflect-uint64-t.md#structansys-dpf-reflect-uint64-t-4-1aa3b65813878fe6618df36329ff646f0f) ## Public static functions - + ### Function type_name ![][public] @@ -25,7 +25,7 @@ ```cpp -static std::string ansys::dpf::reflect< size_t >::type_name() +static std::string ansys::dpf::reflect< uint64_t >::type_name() ``` @@ -40,7 +40,7 @@ static std::string ansys::dpf::reflect< size_t >::type_name() [C++]: https://img.shields.io/badge/language-C%2B%2B-blue (C++) diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-types.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-types.md index c91dad7e16..de471cbb1b 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-types.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/api-reference/structansys-dpf-types.md @@ -33,6 +33,7 @@ Predefined TypeDescriptors. * [meshes_container](structansys-dpf-types.md#structansys-dpf-types-1aa5aef8db0de66f13c7d824cc7fc3deaa) * [operators](structansys-dpf-types.md#structansys-dpf-types-1aa6514ce8d3c27091d3b4a510f8a3260c) * [property_field](structansys-dpf-types.md#structansys-dpf-types-1a64e3b69e41834d5713e61cb6a032d71b) +* [property_fields_container](structansys-dpf-types.md#structansys-dpf-types-1a66518d1b7aee68278c8e87a61b25ce7f) * [result_info](structansys-dpf-types.md#structansys-dpf-types-1af809418d3ce134e74935fb71f67309f1) * [scoping](structansys-dpf-types.md#structansys-dpf-types-1a70eb3fbf8f74e6582f60e6530001ea61) * [scopings_container](structansys-dpf-types.md#structansys-dpf-types-1a599190c382fbb28272d0cc561e83fbfd) @@ -42,6 +43,8 @@ Predefined TypeDescriptors. * [stringVector](structansys-dpf-types.md#structansys-dpf-types-1af817abd6d08d95f7750a18197db74fed) * [support](structansys-dpf-types.md#structansys-dpf-types-1a2dd4f30d4bd8a24632ac9acd77e4e453) * [time_freq_support](structansys-dpf-types.md#structansys-dpf-types-1a47aee41447edf07259b66ec6d420239a) +* [uint64](structansys-dpf-types.md#structansys-dpf-types-1aa30ee96d193a92ca9dd34f730c51b81b) +* [uint64Vector](structansys-dpf-types.md#structansys-dpf-types-1af9a8bd5f9f05368dce689efdc3258be8) * [unit_system](structansys-dpf-types.md#structansys-dpf-types-1a800614ddcefefba1d683e616632a0688) * [workflow](structansys-dpf-types.md#structansys-dpf-types-1acf75ebca42a0a125d9947ba26b362228) @@ -579,6 +582,34 @@ const TypeDescriptor ansys::dpf::types::custom_type_fields_container * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::types::custom_type_fields_container"}]}` --> + +### Variable property_fields_container + +![][public] +![][static] + + +```cpp +const TypeDescriptor ansys::dpf::types::property_fields_container +``` + + + + +[PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) type. + +**See also**: [PropertyFieldsContainer](classansys-dpf-propertyfieldscontainer.md#classansys-dpf-propertyfieldscontainer) + + + +**Type**: const [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) + + + ### Variable any @@ -659,6 +690,32 @@ Integer type. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::types::integer"}]}` --> + +### Variable uint64 + +![][public] +![][static] + + +```cpp +const TypeDescriptor ansys::dpf::types::uint64 +``` + + + + +Unsigned integer type. + + + +**Type**: const [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) + + + ### Variable doubleValue @@ -763,6 +820,32 @@ Vector of integers type. * `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::types::intVector"}]}` --> + +### Variable uint64Vector + +![][public] +![][static] + + +```cpp +const TypeDescriptor ansys::dpf::types::uint64Vector +``` + + + + +Vector of unsigned integers type. + + + +**Type**: const [TypeDescriptor](structansys-dpf-typedescriptor.md#structansys-dpf-typedescriptor) + + + ### Variable doubleVector diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/docfx.json b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/docfx.json index 26a91e39db..003e640f92 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/docfx.json +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/docfx.json @@ -7,7 +7,8 @@ "product": "DPF", "programming language": "C++", "product collection": "Structures", - "physics": "Multiphysics, Structures, Fluids" + "physics": "Multiphysics, Structures, Fluids", + "is dpf context": true } } } \ No newline at end of file diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/examples/averagingtest-cpp-example.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/examples/averagingtest-cpp-example.md index d3bcad4b78..7ce61c0a69 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/examples/averagingtest-cpp-example.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/examples/averagingtest-cpp-example.md @@ -106,7 +106,7 @@ TEST(AveragingPerBody, Nodal) scoping_op.connect(13, std::string("mat")); // split per body with mat attribute ansys::dpf::ScopingsContainer scopings_per_body = scoping_op.getOutputScopingsContainer(0); - EXPECT_EQ(scopings_per_body.size(), 4); + EXPECT_EQ(scopings_per_body.size(), 5); // Get split result // ---------------- @@ -127,7 +127,7 @@ TEST(AveragingPerBody, Nodal) // Compute output FieldsContainer ansys::dpf::FieldsContainer result_fc = stress_op.getOutputFieldsContainer(0); - EXPECT_EQ(result_fc.size(), 4); + EXPECT_EQ(result_fc.size(), 5); } ``` diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/examples/modeltest-cpp-example.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/examples/modeltest-cpp-example.md index 1eb6198efe..53a0b6c546 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/examples/modeltest-cpp-example.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/examples/modeltest-cpp-example.md @@ -24,14 +24,14 @@ TEST(Model, readMetaData) ansys::dpf::MeshedRegion mesh = model.getMesh(); auto numEle = mesh.numberOfElements(); - EXPECT_TRUE(numEle == 165); + EXPECT_TRUE(numEle == 169); auto numNodes = mesh.numberOfNodes(); EXPECT_TRUE(numNodes == 344); ansys::dpf::Field fieldCoord = mesh.nodesCoordinates(); EXPECT_EQ(fieldCoord.dataSize(), 344 * 3); ansys::dpf::PropertyField elementsConnectivity = mesh.connectivity(); - EXPECT_EQ(elementsConnectivity.dataSize(), 1562); + EXPECT_EQ(elementsConnectivity.dataSize(), 1594); ansys::dpf::TimeFreqSupport timeSupport = model.getTimeFreqSupport(); @@ -198,7 +198,7 @@ TEST(Model, ReleaseHandles) ansys::dpf::MeshedRegion mesh = model.getMesh(); auto numEle = mesh.numberOfElements(); - EXPECT_TRUE(numEle == 165); + EXPECT_TRUE(numEle == 169); auto numNodes = mesh.numberOfNodes(); EXPECT_TRUE(numNodes == 344); diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/toc.yml b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/toc.yml index 0bf00c39d3..db44af5fa4 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/toc.yml +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/toc.yml @@ -86,6 +86,8 @@ href: api-reference/classansys-dpf-datasources.md - name: ansys::dpf::DataTree href: api-reference/classansys-dpf-datatree.md + - name: ansys::dpf::DefaultErrorFormatter + href: api-reference/classansys-dpf-defaulterrorformatter.md - name: ansys::dpf::Dimensionality href: api-reference/structansys-dpf-dimensionality.md - name: ansys::dpf::DpfError @@ -106,6 +108,8 @@ href: api-reference/classansys-dpf-elementcursor.md - name: ansys::dpf::ElementDescriptor href: api-reference/structansys-dpf-elementdescriptor.md + - name: ansys::dpf::ErrorFormatter + href: api-reference/classansys-dpf-errorformatter.md - name: ansys::dpf::EventHandler href: api-reference/classansys-dpf-eventhandler.md - name: ansys::dpf::ExternalData @@ -126,6 +130,8 @@ href: api-reference/classansys-dpf-genericdatacontainer.md - name: ansys::dpf::GenericSupport href: api-reference/classansys-dpf-genericsupport.md + - name: ansys::dpf::HgpDpfException + href: api-reference/classansys-dpf-hgpdpfexception.md - name: ansys::dpf::Homogeneity href: api-reference/classansys-dpf-homogeneity.md - name: ansys::dpf::Interface @@ -172,6 +178,8 @@ href: api-reference/classansys-dpf-propfieldcursor.md - name: ansys::dpf::PropertyField href: api-reference/classansys-dpf-propertyfield.md + - name: ansys::dpf::PropertyFieldsContainer + href: api-reference/classansys-dpf-propertyfieldscontainer.md - name: ansys::dpf::PropertyType href: api-reference/structansys-dpf-propertytype.md - name: ansys::dpf::QuantityType @@ -284,6 +292,8 @@ href: api-reference/structansys-dpf-reflect-operator.md - name: ansys::dpf::reflect< PropertyField > href: api-reference/structansys-dpf-reflect-propertyfield.md + - name: ansys::dpf::reflect< PropertyFieldsContainer > + href: api-reference/structansys-dpf-reflect-propertyfieldscontainer.md - name: ansys::dpf::reflect< RemoteOperator > href: api-reference/structansys-dpf-reflect-remoteoperator.md - name: ansys::dpf::reflect< RemoteWorkflow > @@ -318,8 +328,8 @@ href: api-reference/structansys-dpf-reflect-int8-t.md - name: ansys::dpf::reflect< short > href: api-reference/structansys-dpf-reflect-short.md - - name: ansys::dpf::reflect< size_t > - href: api-reference/structansys-dpf-reflect-size-t.md + - name: ansys::dpf::reflect< uint64_t > + href: api-reference/structansys-dpf-reflect-uint64-t.md - name: ansys::dpf::reflect< unsigned int > href: api-reference/structansys-dpf-reflect-unsigned-int.md - name: ansys::dpf::reflect< unsigned short > diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/create-cpp-plugin.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/create-cpp-plugin.md index 163630d993..9293cda6c1 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/create-cpp-plugin.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/create-cpp-plugin.md @@ -23,7 +23,6 @@ being an environment variable defining the root of the Ansys Inc or [DPF Server] **DPF_HGP_ROOT environment variable** must be set to define the location of those files and **must be set to follow this tutorial**. Here is the command for Windows: - ```bat set DPF_HGP_ROOT=%AWP_ROOT271%/dpf/include ``` @@ -31,7 +30,6 @@ set DPF_HGP_ROOT=%AWP_ROOT271%/dpf/include It can also be set by editing the environment variables in Windows settings. Here is the command for Linux: - ```bash export DPF_HGP_ROOT=${AWP_ROOT271}/dpf/include ``` diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/debugging-dpf.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/debugging-dpf.md index 3f46b163a4..976ca4ad56 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/debugging-dpf.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/debugging-dpf.md @@ -52,7 +52,7 @@ Many tools are available to render Graphviz diagrams in useful formats such as S When you use a Graphviz diagram in combination with a Natvis view, you can see the content of each operator of a workflow (using their IDs). -![Graph combo](../images/graph-combo.png) +![](../images/graph-combo.png) ## Usages for the CodeDV Property Sheet diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/error-handling.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/error-handling.md new file mode 100644 index 0000000000..1c23cf8af0 --- /dev/null +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/error-handling.md @@ -0,0 +1,207 @@ +# Handling errors in DPF HGP operators and plugins + +This page explains how to raise and catch errors using the public DPF C++ HGP API. + +Use this page when writing an operator that must signal a failure, or when writing client code that must diagnose why an operator failed. + +For runtime observability that is unrelated to failures, see [Logging in DPF operators and plugins](logging-in-dpf.md). + +## API overview + +The error API is available in `ansys::dpf` and declared in `dpf_api_base.h`. + +- Client-side exception type caught around DPF calls: `DpfException`. +- Nature of the error, as a stable enum: `DpfException::nature()` returning `DpfError::ErrorNature`. +- Human-readable message: `DpfException::what()`. +- Structured message with the full nested cause chain, as JSON: `DpfException::message()`. +- Base class to raise typed errors from an operator ``run()``: `HgpDpfException`. + +All errors raised on the server side surface to client code as `ansys::dpf::DpfException`, whether they originated in the framework, in an operator, or in the C Layer. The structured chain in `message()` preserves the layer where the error occurred and any typed data attached at the throw site. + +## Catching errors around DPF calls + +Wrap any call that can trigger operator or workflow execution in a `try/catch` block on `ansys::dpf::DpfException`: + +```cpp +#include "dpf_api.h" +#include "dpf_api_base.h" + +ansys::dpf::Operator op("add"); + +try { + op.run(); +} catch (const ansys::dpf::DpfException& e) { + std::cerr << e.what() << std::endl; +} +``` + +- `e.what()` returns a short human-readable string suitable for display to an end user. +- `e.nature()` returns a stable `DpfError::ErrorNature` enum (for example `eFileNotFound`, `eRuntimeError`, `eUnimplemented`) that client code can branch on. +- `e.origin()` returns the API entry point where the exception was raised. + +## Inspecting the structured error chain + +`DpfException::message()` returns a JSON document that encodes every layer the error passed through, from the innermost cause to the outermost frame. Use the standard DPF `json_to_data_tree` operator to parse it: + +```cpp +try { + op.run(); +} catch (const ansys::dpf::DpfException& e) { + ansys::dpf::Operator json2dt("json_to_data_tree"); + json2dt.connect(0, std::string(e.message())); + + auto dt = json2dt.getOutputDataTree(0); + auto frames = dt.getSubByName("frames"); + + // Frames are indexed as strings from "0" (innermost cause) upwards. + auto root_cause = frames.getSubByName("0"); + std::cout << root_cause.getStringAttribute("what") << std::endl; +} +``` + +Each frame carries at least: + +- `type` - a stable string identifying the error category (for example `opframe`, `kernel_clayer`, or the custom type of an `HgpDpfException` subclass). +- `what` - the frame-level message. + +Higher-level frames may add typed attributes. For example the operator frame carries `operator_name` and `operator_id`, allowing client code to identify which operator inside a workflow failed: + +```cpp +auto op_frame = frames.getSubByName("1"); +std::string failing_op = op_frame.getStringAttribute("operator_name"); +``` + +## Raising errors from an operator + +Inside an operator ``run()`` method, throw an `ansys::dpf::HgpDpfException`. The framework catches it, tags it with the current operator frame, forwards it through the C Layer, and re-raises it on the client side as a `DpfException`. + +The `HgpDpfException` constructor takes: + +1. A `type` string - a short, stable identifier for the error category. +2. A `what` string - the human-readable message. +3. An initializer list of key/value pairs - typed attributes preserved end-to-end. + +```cpp +#include "dpf_api.h" +#include "dpf_api_base.h" + +struct MyOperator +{ + static std::string name() { return "my_operator"; } + + static void run(ansys::dpf::OperatorMain& main) + { + if (!main.testInput(0)) { + throw ansys::dpf::HgpDpfException( + "missing_input", + "Missing boolean on pin 0.", + { { "pin_index", "0" }, { "expected_type", "bool" } }); + } + // ... + } + + static ansys::dpf::OperatorSpecification specification() { return {}; } +}; +``` + +Do not raise raw `std::exception` or `std::runtime_error` to signal domain errors. Those types are still forwarded and end up as a generic `DpfException` on the client side, but with no `type` and no structured attributes, which forces client code to fall back to string parsing. + +## Defining a custom exception type + +For error categories that recur across operators, define a subclass of `HgpDpfException` and set the `type` string once. Callers can then filter on `type` or read the typed attributes directly. + +```cpp +class MissingInputException : public ansys::dpf::HgpDpfException +{ +public: + MissingInputException(const std::string& what, const std::string& advice) + : ansys::dpf::HgpDpfException( + "missing_input", + what, + { { "advice", advice } }) {} + + std::string advice() const { return kvals().at("advice"); } +}; +``` + +Throw it from `run()`: + +```cpp +throw MissingInputException( + "Missing boolean on pin 0 of my_operator.", + "Connect a boolean value to input pin 0."); +``` + +Client code recognizes it by its `type`: + +```cpp +try { + op.run(); +} catch (const ansys::dpf::DpfException& e) { + ansys::dpf::Operator json2dt("json_to_data_tree"); + json2dt.connect(0, std::string(e.message())); + auto frames = json2dt.getOutputDataTree(0).getSubByName("frames"); + + auto op_frame = frames.getSubByName("1"); + if (op_frame.getStringAttribute("type") == "missing_input") { + std::cerr << "advice: " << op_frame.getStringAttribute("advice") << std::endl; + } +} +``` + +## Selectively absorbing an expected error from a child operator + +When your operator composes other operators and one of them can raise an error that is **not** a real failure in your context (for example, a distributed data source where a given partition legitimately holds no data), inspect the child error's `type` before re-throwing. + +The pattern in a `run()` that iterates over chunks: + +```cpp +for (const auto& chunk : chunks) { + ansys::dpf::Operator child("read_from_chunk"); + child.connect(0, chunk); + try { + auto data = child.getOutputField(0); + merge(data); + } catch (const ansys::dpf::DpfException& e) { + ansys::dpf::Operator json2dt("json_to_data_tree"); + json2dt.connect(0, std::string(e.message())); + auto frames = json2dt.getOutputDataTree(0).getSubByName("frames"); + + // The innermost frame carries the child operator's exception type. + auto root_cause = frames.getSubByName("0"); + if (root_cause.getStringAttribute("type") == "result_not_found") { + continue; // expected: this chunk simply has nothing to contribute + } + throw; // any other type is a real failure - propagate + } +} +``` + +Do: + +- **Match on the child's stable `type` string**, never on a substring of `what()` or `message()`. +- Read the innermost frame (`frames["0"]`) - that is the actual child error, before any wrapping frame the framework may have added. +- Keep the `try/catch` scoped to the smallest region where the absorbable error can legitimately be raised. + +Do not: + +- Swallow `DpfException` without inspecting its `type`. A blanket `catch` hides genuine failures. +- Rely on the human-readable `what()` string to decide - it is not part of the API contract. + +Consider this a last-resort pattern. If the child operator can distinguish "no data" from "failure" via a boolean query or an explicit output pin, use that path instead of the exception path. + +## Guidelines for operator authors + +- Prefer a `type` string that is stable across releases. Client code branches on it. +- Keep the `what` string user-facing: describe **what** failed and, when possible, **why**. +- Put remediation hints in a dedicated attribute (for example `advice` or `suggestion`) rather than concatenating them into `what`. +- Attach typed attributes for anything a caller may want to filter on or display separately (pin index, expected type, file path). Values are strings. +- Do not embed the operator name or ID in the message. The framework attaches them automatically to the operator frame. +- Do not swallow lower-level exceptions silently. If you need to translate one, catch it and throw an `HgpDpfException` from the catch block so the original cause is preserved in the frame chain. If you need to intentionally absorb one, follow the pattern above and match on the child's `type`. + +## Guidelines for client code + +- Always catch `ansys::dpf::DpfException` around calls that trigger operator or workflow execution. +- Use `what()` for logging or display, and `nature()` for coarse branching. +- Use `message()` with `json_to_data_tree` when you need to identify the failing operator inside a chained workflow, or when you need the typed attributes carried by a custom exception type. +- Frame `"0"` is the innermost cause. The highest-indexed frame is the outermost boundary the error crossed. diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/how-tos.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/how-tos.md index 965a7c6a14..106b40bed2 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/how-tos.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/how-tos.md @@ -14,6 +14,8 @@ This section gathers pages related to DPF tutorials. [Logging in DPF operators and plugins](logging-in-dpf.md) +[Handling errors in DPF operators and plugins](error-handling.md) + > **_NOTE:_** > This documentation focuses on the C++ API for DPF. > diff --git a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/write-an-operator.md b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/write-an-operator.md index 582977fc31..f621a72b8e 100644 --- a/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/write-an-operator.md +++ b/docs/dpf/dpf-client-cpp/versions/2027.R1.SP00/user-guide/write-an-operator.md @@ -138,6 +138,29 @@ static void run(ansys::dpf::OperatorMain& main) } ``` +### Raise errors from operator runtime + +When `run()` cannot produce a valid output, signal the failure by throwing an `ansys::dpf::HgpDpfException`. The framework catches it, tags it with the current operator frame, forwards it through the C Layer, and re-raises it on the client side as a `DpfException`. + +```cpp +static void run(ansys::dpf::OperatorMain& main) +{ + if (!main.testInput(0)) { + throw ansys::dpf::HgpDpfException( + "missing_input", + "Missing field on pin 0 of custom_sort.", + { { "pin_index", "0" }, { "expected_type", "field" } }); + } + // ... normal processing +} +``` + +For recurring error categories, define a subclass of `HgpDpfException` and set the `type` string once so callers can filter on it. + +Do not raise raw `std::exception` or `std::runtime_error` to signal domain errors. They are still forwarded, but the client loses the `type` string and the structured attributes. + +For the full pattern - catching errors on the client side, inspecting the nested cause chain with `json_to_data_tree`, defining custom exception types - see [Handling errors in DPF operators and plugins](error-handling.md). + ### Record the operator The following code enables the operator to be accessible and must be run before any instantiation of this operator.