Skip to main content

DPF Cpp Client Library 2026 R1

Class ansys::dpf::GenericDataContainer

Last update: 25.03.2026

Inherits from:

Members

Friends

Friend internal::set_prop

Public functions

Function ~GenericDataContainer

virtual ansys::dpf::GenericDataContainer::~GenericDataContainer()=default

Return type:

Function GenericDataContainer

ansys::dpf::GenericDataContainer::GenericDataContainer()

Return type:

Function GenericDataContainer

ansys::dpf::GenericDataContainer::GenericDataContainer(int id, Client const *const client)

Retrieve an existing instance of GenericDataContainer on a server.

Parameters:

  • int id: [in] Id of the GenericDataContainer object on the server's database.
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type:

Function GenericDataContainer

ansys::dpf::GenericDataContainer::GenericDataContainer(Client const *const client)

Parameters:

  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type:

Function GenericDataContainer

ansys::dpf::GenericDataContainer::GenericDataContainer(GenericDataContainer const &)

Parameters:

  • GenericDataContainer const &

Return type:

Function GenericDataContainer

ansys::dpf::GenericDataContainer::GenericDataContainer(GenericDataContainer &&) noexcept

Parameters:

  • GenericDataContainer &&

Return type:

Function operator=

GenericDataContainer & ansys::dpf::GenericDataContainer::operator=(GenericDataContainer const &)

Parameters:

  • GenericDataContainer const &

Return type: GenericDataContainer &

Function operator=

GenericDataContainer & ansys::dpf::GenericDataContainer::operator=(GenericDataContainer &&) noexcept

Parameters:

  • GenericDataContainer &&

Return type: GenericDataContainer &

Function getPropertyNames

std::vector< std::string > ansys::dpf::GenericDataContainer::getPropertyNames() const

Returns:

property names as a vector of string considering the properties set in the file

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

Function getProperty

T ansys::dpf::GenericDataContainer::getProperty(const std::string &property_name) const

Returns:

property associated to given property name

Exceptions:

  • if: the property doesn't exist.

Parameters:

  • const std::string & property_name

Return type: T

Function getCustomContainerProperty

CustomContainerT ansys::dpf::GenericDataContainer::getCustomContainerProperty(const std::string &property_name) const

Returns:

property of type deriving from CustomContainerBase associated to given property name

Parameters:

  • const std::string & property_name

Return type: CustomContainerT

Function container

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

Return type: GenericDataContainer const &

Function setProperty

void ansys::dpf::GenericDataContainer::setProperty(const std::string &property_name, const T &property)

set property with given property name

Parameters:

  • const std::string & property_name
  • const T & property

Return type: void

Function getPropertyAny

Any ansys::dpf::GenericDataContainer::getPropertyAny(const std::string &property_name) const

Parameters:

  • const std::string & property_name

Return type: Any

Function setPropertyAny

void ansys::dpf::GenericDataContainer::setPropertyAny(const std::string &property_name, const Any &property)

Parameters:

  • const std::string & property_name
  • const Any & property

Return type: void

Public static functions

Function emptyGenericDataContainer

static GenericDataContainer ansys::dpf::GenericDataContainer::emptyGenericDataContainer()

Creates an empty GenericDataContainer. Returns:

Empty GenericDataContainer.

Return type: GenericDataContainer

Connect with Ansys