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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 48 additions & 14 deletions 2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-any.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
* [getAsField](classansys-dpf-any.md#classansys-dpf-any-1a8bb8b9c5c9b8caccff78ff66a16780cb)
* [getAsFieldsContainer](classansys-dpf-any.md#classansys-dpf-any-1af48a4b58d4d52dd107e75fdb6db2cdea)
* [getAsGenericDataContainer](classansys-dpf-any.md#classansys-dpf-any-1a8a4ae829c4e5142a390158b7f1842cfb)
* [getAsGenericSupport](classansys-dpf-any.md#classansys-dpf-any-1a31d1d3ef7e7043252be52ab9a75ac926)
* [getAsInt](classansys-dpf-any.md#classansys-dpf-any-1a00cce5475752905812ab028e4c1ca97b)
* [getAsIntVector](classansys-dpf-any.md#classansys-dpf-any-1a9b3531295f844610cc131f78c96ef04d)
* [getAsLabelSpace](classansys-dpf-any.md#classansys-dpf-any-1a53dda1baccbaa272f72df5195f30591b)
Expand Down Expand Up @@ -167,7 +168,7 @@ ansys::dpf::Any::Any(Any const &)

**Parameters**:

* Any const &
* [Any](classansys-dpf-any.md#classansys-dpf-any) const &

**Return type**:

Expand Down Expand Up @@ -196,7 +197,7 @@ ansys::dpf::Any::Any(Any &&) noexcept

**Parameters**:

* Any &&
* [Any](classansys-dpf-any.md#classansys-dpf-any) &&

**Return type**:

Expand Down Expand Up @@ -225,9 +226,9 @@ Any & ansys::dpf::Any::operator=(Any const &)

**Parameters**:

* Any const &
* [Any](classansys-dpf-any.md#classansys-dpf-any) const &

**Return type**: Any &
**Return type**: [Any](classansys-dpf-any.md#classansys-dpf-any) &

<!--
**TODO**:
Expand All @@ -254,9 +255,9 @@ Any & ansys::dpf::Any::operator=(Any &&) noexcept

**Parameters**:

* Any &&
* [Any](classansys-dpf-any.md#classansys-dpf-any) &&

**Return type**: Any &
**Return type**: [Any](classansys-dpf-any.md#classansys-dpf-any) &

<!--
**TODO**:
Expand Down Expand Up @@ -476,7 +477,7 @@ int vector held in the [Any](classansys-dpf-any.md#classansys-dpf-any) object.



**Return type**: DpfVector< int >
**Return type**: [DpfVector](classansys-dpf-dpfvector.md#classansys-dpf-dpfvector)< int >

<!--
**TODO**:
Expand Down Expand Up @@ -905,7 +906,7 @@ Operator ansys::dpf::Any::getAsOperator() const



**Return type**: Operator
**Return type**: [Operator](classansys-dpf-operator.md#classansys-dpf-operator)

<!--
**TODO**:
Expand Down Expand Up @@ -946,6 +947,39 @@ CyclicSupport ansys::dpf::Any::getAsCyclicSupport() const
* `qualifiedname {"type":"element","name":"qualifiedname","attributes":{},"children":[{"type":"text","text":"ansys::dpf::Any::getAsCyclicSupport"}]}`
-->

<a id="classansys-dpf-any-1a31d1d3ef7e7043252be52ab9a75ac926"></a>
### Function getAsGenericSupport

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


```cpp
GenericSupport ansys::dpf::Any::getAsGenericSupport() const
```




**Returns**:

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


**Exceptions**:

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



**Return type**: [GenericSupport](classansys-dpf-genericsupport.md#classansys-dpf-genericsupport)

<!--
**TODO**:

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

<a id="classansys-dpf-any-1a52850e5eb23e6cba70ccd0c0713e3452"></a>
### Function getAsDataSources

Expand Down Expand Up @@ -1233,7 +1267,7 @@ Make a deep copy on a given client.

* [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) const *const **client** = nullptr : [in] Remote client

**Return type**: Any
**Return type**: [Any](classansys-dpf-any.md#classansys-dpf-any)

<!--
**TODO**:
Expand Down Expand Up @@ -1269,7 +1303,7 @@ static Any ansys::dpf::Any::createFromFbsReference(const opaque::FbsChannel *cha
* size_t **req_offset**
* const [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) * **client** = nullptr

**Return type**: Any
**Return type**: [Any](classansys-dpf-any.md#classansys-dpf-any)

<!--
**TODO**:
Expand Down Expand Up @@ -1297,11 +1331,11 @@ static Any ansys::dpf::Any::createFromFbsReference(FbsClient const &fbs_client,

**Parameters**:

* FbsClient const & **fbs_client**
* [FbsClient](classansys-dpf-any.md#classansys-dpf-any) const & **fbs_client**
* const opaque::FbsSlice * **req_slice**
* const [ansys::dpf::Client](classansys-dpf-client.md#classansys-dpf-client) * **client** = nullptr

**Return type**: Any
**Return type**: [Any](classansys-dpf-any.md#classansys-dpf-any)

<!--
**TODO**:
Expand Down Expand Up @@ -1332,7 +1366,7 @@ Retrieve an existing instance on a server.
* int **id**: [in] Id of the object on the server's database.
* [Client](classansys-dpf-client.md#classansys-dpf-client) const *const **client**: [in] [Client](classansys-dpf-client.md#classansys-dpf-client) instance designating the IP, port and protocol to use.

**Return type**: Any
**Return type**: [Any](classansys-dpf-any.md#classansys-dpf-any)

<!--
**TODO**:
Expand All @@ -1358,7 +1392,7 @@ static Any ansys::dpf::Any::emptyAny()



**Return type**: Any
**Return type**: [Any](classansys-dpf-any.md#classansys-dpf-any)

<!--
**TODO**:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Changelog & ansys::dpf::Changelog::patchBump(const std::string changes)

* const std::string **changes**

**Return type**: Changelog &
**Return type**: [Changelog](classansys-dpf-changelog.md#classansys-dpf-changelog) &

<!--
**TODO**:
Expand Down Expand Up @@ -171,7 +171,7 @@ Changelog & ansys::dpf::Changelog::minorBump(const std::string changes)

* const std::string **changes**

**Return type**: Changelog &
**Return type**: [Changelog](classansys-dpf-changelog.md#classansys-dpf-changelog) &

<!--
**TODO**:
Expand Down Expand Up @@ -200,7 +200,7 @@ Changelog & ansys::dpf::Changelog::majorBump(const std::string changes)

* const std::string **changes**

**Return type**: Changelog &
**Return type**: [Changelog](classansys-dpf-changelog.md#classansys-dpf-changelog) &

<!--
**TODO**:
Expand Down Expand Up @@ -229,7 +229,7 @@ Changelog & ansys::dpf::Changelog::expectVersion(const SemanticVersion &version)

* const [SemanticVersion](classansys-dpf-semanticversion.md#classansys-dpf-semanticversion) & **version**

**Return type**: Changelog &
**Return type**: [Changelog](classansys-dpf-changelog.md#classansys-dpf-changelog) &

<!--
**TODO**:
Expand Down
18 changes: 9 additions & 9 deletions 2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Create [Client](classansys-dpf-client.md#classansys-dpf-client) from known ip, p

* std::string const & **ip**: [in] server ip
* std::string const & **port**: [in] server port
* LibraryHandle const & **library_handle**: [in] the library_handle API will be used
* [LibraryHandle](classansys-dpf-libraryhandle.md#classansys-dpf-libraryhandle) const & **library_handle**: [in] the library_handle API will be used

**Return type**:

Expand Down Expand Up @@ -153,7 +153,7 @@ Create [Client](classansys-dpf-client.md#classansys-dpf-client) from known addre
**Parameters**:

* std::string const & **address**: [in] string with 'ip::port' format.
* LibraryHandle const & **library_handle**: [in] the library_handle API will be used
* [LibraryHandle](classansys-dpf-libraryhandle.md#classansys-dpf-libraryhandle) const & **library_handle**: [in] the library_handle API will be used

**Return type**:

Expand Down Expand Up @@ -182,7 +182,7 @@ ansys::dpf::Client::Client(Client const &)

**Parameters**:

* Client const &
* [Client](classansys-dpf-client.md#classansys-dpf-client) const &

**Return type**:

Expand Down Expand Up @@ -211,7 +211,7 @@ ansys::dpf::Client::Client(Client &&) noexcept

**Parameters**:

* Client &&
* [Client](classansys-dpf-client.md#classansys-dpf-client) &&

**Return type**:

Expand Down Expand Up @@ -240,9 +240,9 @@ Client & ansys::dpf::Client::operator=(Client const &)

**Parameters**:

* Client const &
* [Client](classansys-dpf-client.md#classansys-dpf-client) const &

**Return type**: Client &
**Return type**: [Client](classansys-dpf-client.md#classansys-dpf-client) &

<!--
**TODO**:
Expand All @@ -269,9 +269,9 @@ Client & ansys::dpf::Client::operator=(Client &&) noexcept

**Parameters**:

* Client &&
* [Client](classansys-dpf-client.md#classansys-dpf-client) &&

**Return type**: Client &
**Return type**: [Client](classansys-dpf-client.md#classansys-dpf-client) &

<!--
**TODO**:
Expand Down Expand Up @@ -467,7 +467,7 @@ Empty [Client](classansys-dpf-client.md#classansys-dpf-client)



**Return type**: Client
**Return type**: [Client](classansys-dpf-client.md#classansys-dpf-client)

<!--
**TODO**:
Expand Down
18 changes: 9 additions & 9 deletions 2027R1/dpf-cpp-27-r1/api-reference/classansys-dpf-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ ansys::dpf::Collection< DataT >::Collection(Collection< DataT > const &)

**Parameters**:

* rhsCollection< DataT > const &
* rhs[Collection](classansys-dpf-collection.md#classansys-dpf-collection)< DataT > const &

**Return type**:

Expand Down Expand Up @@ -174,7 +174,7 @@ ansys::dpf::Collection< DataT >::Collection(Collection< DataT > &&) noexcept

**Parameters**:

* rhsCollection< DataT > &&
* rhs[Collection](classansys-dpf-collection.md#classansys-dpf-collection)< DataT > &&

**Return type**:

Expand Down Expand Up @@ -285,7 +285,7 @@ ansys::dpf::Collection< DataT >::Collection(int id, Client const *const client)



Retrieve an existing instance of [Collection](classansys-dpf-collection.md#classansys-dpf-collection) on a server.
Retrieve an existing instance of [Collection](classansys-dpf-collection.md#classansys-dpf-collection) on a server. <br/>



Expand Down Expand Up @@ -321,9 +321,9 @@ Collection< DataT > & ansys::dpf::Collection< DataT >::operator=(Collection< Dat

**Parameters**:

* rhsCollection< DataT > const &
* rhs[Collection](classansys-dpf-collection.md#classansys-dpf-collection)< DataT > const &

**Return type**: Collection &
**Return type**: [Collection](classansys-dpf-collection.md#classansys-dpf-collection) &

<!--
**TODO**:
Expand All @@ -350,9 +350,9 @@ Collection< DataT > & ansys::dpf::Collection< DataT >::operator=(Collection< Dat

**Parameters**:

* rhsCollection< DataT > &&
* rhs[Collection](classansys-dpf-collection.md#classansys-dpf-collection)< DataT > &&

**Return type**: Collection &
**Return type**: [Collection](classansys-dpf-collection.md#classansys-dpf-collection) &

<!--
**TODO**:
Expand Down Expand Up @@ -695,7 +695,7 @@ create a [Collection](classansys-dpf-collection.md#classansys-dpf-collection) wi

* [LabelSpace](classansys-dpf-labelspace.md#classansys-dpf-labelspace) const & **lab_space**

**Return type**: Collection< DataT >
**Return type**: [Collection](classansys-dpf-collection.md#classansys-dpf-collection)< DataT >

<!--
**TODO**:
Expand Down Expand Up @@ -726,7 +726,7 @@ Empty container.



**Return type**: Collection< DataT >
**Return type**: [Collection](classansys-dpf-collection.md#classansys-dpf-collection)< DataT >

<!--
**TODO**:
Expand Down
Loading