ansys::dpf::CustomContainerBase Class Reference
Last update: 16.07.2025Allows you to define your own containers by deriving from this class. More...
#include <dpf_api.h>
Public Member Functions | |
| CustomContainerBase (std::string const &class_name) | |
| CustomContainerBase (std::string const &class_name, Client const *const client) | |
| CustomContainerBase (std::string const &class_name, GenericDataContainer const &container) | |
| GenericDataContainer & | container () |
| GenericDataContainer const & | container () const |
| std::string | describe () const |
| std::vector< std::string > | getAttributeNames () const |
| bool | getClient (Client &client) const |
Detailed Description
Allows you to define your own containers by deriving from this class.
For the custom class deriving from CustomContainerBase 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 & Destructor Documentation
◆ CustomContainerBase() [1/3]
| ansys::dpf::CustomContainerBase::CustomContainerBase | ( | std::string const & | class_name | ) |
- Parameters
-
[in] class_name Name of the custom class in camel case format. Will be used to print the instance.
◆ CustomContainerBase() [2/3]
| ansys::dpf::CustomContainerBase::CustomContainerBase | ( | std::string const & | class_name, |
| Client const *const | client | ||
| ) |
- Parameters
-
[in] class_name Name of the custom class in camel case format. Will be used to print the instance. [in] client Client instance designating the IP, port and protocol to use.
◆ CustomContainerBase() [3/3]
| ansys::dpf::CustomContainerBase::CustomContainerBase | ( | std::string const & | class_name, |
| GenericDataContainer const & | container | ||
| ) |
- Parameters
-
[in] class_name Name of the custom class in camel case format. Will be used to print the instance. [in] container Internal container holding all the attributes as properties.
Member Function Documentation
◆ container() [1/2]
| GenericDataContainer & ansys::dpf::CustomContainerBase::container | ( | ) |
- Returns
- The internal container.
◆ container() [2/2]
| GenericDataContainer const & ansys::dpf::CustomContainerBase::container | ( | ) | const |
- Returns
- The internal container.
◆ describe()
| std::string ansys::dpf::CustomContainerBase::describe | ( | ) | const |
- Returns
- Description of object.
