## On this page

  

 

 # ansys::dpf::CustomContainerBase Class Reference

 Last update: 16.07.2025 

Allows you to define your own containers by deriving from this class. [More...](classansys_1_1dpf_1_1CustomContainerBase.xhtml#details)

`#include <dpf_api.h>`

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

 [CustomContainerBase](classansys_1_1dpf_1_1CustomContainerBase.xhtml#ab2649202d9da1730e164634a4d864f3e) (std::string const &amp;class\_name)  [CustomContainerBase](classansys_1_1dpf_1_1CustomContainerBase.xhtml#a0dbdad77df7b779da34e8fa283a6597f) (std::string const &amp;class\_name, [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const client)  [CustomContainerBase](classansys_1_1dpf_1_1CustomContainerBase.xhtml#ae7229c52821828cec4fca9dce836ee55) (std::string const &amp;class\_name, GenericDataContainer const &amp;[container](classansys_1_1dpf_1_1CustomContainerBase.xhtml#a595ca7a2057dd128a01676b24e622c08)) GenericDataContainer &amp; [container](classansys_1_1dpf_1_1CustomContainerBase.xhtml#a595ca7a2057dd128a01676b24e622c08) () virtual GenericDataContainer const &amp; [container](classansys_1_1dpf_1_1CustomContainerBase.xhtml#a43b2fea572fa3298d6405cf7f497c78b) () const std::string [describe](classansys_1_1dpf_1_1CustomContainerBase.xhtml#a65a8a6f6585ddf80c7e0dfdf9b9c50f5) () const <a id="a1ba98abe5c74497c829744f302de3cb5" name="a1ba98abe5c74497c829744f302de3cb5"></a>std::vector&lt; std::string &gt; **getAttributeNames** () const bool [getClient](classansys_1_1dpf_1_1CustomContainerBase.xhtml#ae048111b288fdbddfd3a5ab07438bc85) ([Client](classansys_1_1dpf_1_1Client.xhtml) &amp;client) const <a id="details" name="details"></a>## Detailed Description

Allows you to define your own containers by deriving from this class.

For the custom class deriving from [CustomContainerBase](classansys_1_1dpf_1_1CustomContainerBase.xhtml "Allows you to define your own containers by deriving from this class.") to be fully supported by DPF features (connection to Operator, remote access, multi languages API), all private attributes should registered into the GenericDataContainer held.



## Constructor &amp; Destructor Documentation

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

 ansys::dpf::CustomContainerBase::CustomContainerBase  ( std::string const &amp;  *class\_name*) 

Parameters \[in\]class\_nameName of the custom class in camel case format. Will be used to print the instance. 



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

 ansys::dpf::CustomContainerBase::CustomContainerBase  ( std::string const &amp;  *class\_name*,    [Client](classansys_1_1dpf_1_1Client.xhtml) const \*const  *client*   ) 

Parameters \[in\]class\_nameName of the custom class in camel case format. Will be used to print the instance. \[in\]client[Client](classansys_1_1dpf_1_1Client.xhtml) instance designating the IP, port and protocol to use. 



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

 ansys::dpf::CustomContainerBase::CustomContainerBase  ( std::string const &amp;  *class\_name*,    GenericDataContainer const &amp;  *container*   ) 

Parameters \[in\]class\_nameName of the custom class in camel case format. Will be used to print the instance. \[in\]containerInternal container holding all the attributes as properties. 



## Member Function Documentation

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

 GenericDataContainer &amp; ansys::dpf::CustomContainerBase::container  ( ) 

ReturnsThe internal container. 



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

 virtual GenericDataContainer const &amp; ansys::dpf::CustomContainerBase::container  ( )  const  virtual 

ReturnsThe internal container. 



<a id="a65a8a6f6585ddf80c7e0dfdf9b9c50f5" name="a65a8a6f6585ddf80c7e0dfdf9b9c50f5"></a>## [◆ ](#a65a8a6f6585ddf80c7e0dfdf9b9c50f5)describe()

 std::string ansys::dpf::CustomContainerBase::describe  ( )  const

ReturnsDescription of object. 



<a id="ae048111b288fdbddfd3a5ab07438bc85" name="ae048111b288fdbddfd3a5ab07438bc85"></a>## [◆ ](#ae048111b288fdbddfd3a5ab07438bc85)getClient()

 bool ansys::dpf::CustomContainerBase::getClient  ( [Client](classansys_1_1dpf_1_1Client.xhtml) &amp;  *client*)  const

ReturnsGet the [Client](classansys_1_1dpf_1_1Client.xhtml) the object is on, if it has one. Must not be used without using remote API.