Skip to main content

DPF Cpp Client Library 2026 R1

Class ansys::dpf::CustomContainerBase

Last update: 25.03.2026

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.

Inherited by:

Members

Friends

Public functions

Function CustomContainerBase

ansys::dpf::CustomContainerBase::CustomContainerBase(std::string const &class_name)

Parameters:

  • std::string const & class_name: [in] Name of the custom class in camel case format. Will be used to print the instance.

Return type:

Function CustomContainerBase

ansys::dpf::CustomContainerBase::CustomContainerBase(std::string const &class_name, Client const *const client)

Parameters:

  • std::string const & class_name: [in] Name of the custom class in camel case format. Will be used to print the instance.
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type:

Function CustomContainerBase

ansys::dpf::CustomContainerBase::CustomContainerBase(std::string const &class_name, GenericDataContainer const &container)

Parameters:

  • std::string const & class_name: [in] Name of the custom class in camel case format. Will be used to print the instance.
  • GenericDataContainer const & container: [in] Internal container holding all the attributes as properties.

Return type:

Function ~CustomContainerBase

virtual ansys::dpf::CustomContainerBase::~CustomContainerBase()

Return type:

Function container

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

Returns:

The internal container.

Return type: GenericDataContainer &

Function container

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

Returns:

The internal container.

Return type: GenericDataContainer const &

Function describe

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

Returns:

Description of object.

Return type: std::string

Function getAttributeNames

std::vector< std::string > ansys::dpf::CustomContainerBase::getAttributeNames() const

Return type: std::vector< std::string >

Function getClient

bool ansys::dpf::CustomContainerBase::getClient(Client &client) const

Returns:

Get the Client the object is on, if it has one. Must not be used without using remote API.

Parameters:

Return type: bool

Connect with Ansys