## On this page

  

 

 # ansys::dpf::DpfTypes Class Reference

 Last update: 16.07.2025 

`#include <dpf_api_base.h>`

Inheritance diagram for ansys::dpf::DpfTypes:

 ![](/sites/default/files/migrate-content/dpf_cpp_client_library_2024_r1/classansys_1_1dpf_1_1DpfTypes.png)



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

virtual bool [empty](classansys_1_1dpf_1_1DpfTypes.xhtml#a39cd546c42518e2332be8f287db95459) () const virtual bool [hasInternalObject](classansys_1_1dpf_1_1DpfTypes.xhtml#ae198f89868d85c7db6dc1a934a1d3c15) () const virtual std::string [describe](classansys_1_1dpf_1_1DpfTypes.xhtml#a9977945710983bc03d2940fa007847b2) () const so::API const \* [callAPI](classansys_1_1dpf_1_1DpfTypes.xhtml#aea34d37e0c080126eff70db34bf46597) () const bool [isOnCommonAPI](classansys_1_1dpf_1_1DpfTypes.xhtml#a9f9789ff61cc9d400a2a344830706b73) () const bool [getClient](classansys_1_1dpf_1_1DpfTypes.xhtml#a968afd9daa0b0f13b65a2ac61369d73a) ([Client](classansys_1_1dpf_1_1Client.xhtml) &amp;client) const bool [hasBeenMovedLocally](classansys_1_1dpf_1_1DpfTypes.xhtml#a1a5634202c15404b6b24e8f50e51cb66) () const bool [isSameObject](classansys_1_1dpf_1_1DpfTypes.xhtml#aa64d5f8fcd7d85ad6ebf708494dbefd7) ([DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml) const &amp;rhs) const <a id="details" name="details"></a>## Detailed Description

Base class for many DPF classes



## Member Function Documentation

<a id="aea34d37e0c080126eff70db34bf46597" name="aea34d37e0c080126eff70db34bf46597"></a>## [◆ ](#aea34d37e0c080126eff70db34bf46597)callAPI()

 so::API const \* ansys::dpf::DpfTypes::callAPI  ( )  const

ReturnsAPI of object. 



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

 virtual std::string ansys::dpf::DpfTypes::describe  ( )  const  virtual 

ReturnsDescription of object. 



<a id="a39cd546c42518e2332be8f287db95459" name="a39cd546c42518e2332be8f287db95459"></a>## [◆ ](#a39cd546c42518e2332be8f287db95459)empty()

 virtual bool ansys::dpf::DpfTypes::empty  ( )  const  virtual 

ReturnsIndicates if object is empty. Examples[AveragingTest.cpp](AveragingTest_8cpp-example.xhtml#a3), and [CompleteRST.cpp](CompleteRST_8cpp-example.xhtml#a4).



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

 bool ansys::dpf::DpfTypes::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. 



<a id="a1a5634202c15404b6b24e8f50e51cb66" name="a1a5634202c15404b6b24e8f50e51cb66"></a>## [◆ ](#a1a5634202c15404b6b24e8f50e51cb66)hasBeenMovedLocally()

 bool ansys::dpf::DpfTypes::hasBeenMovedLocally  ( )  const

ReturnsWether the object has been fully moved on the local server, in case it was defined first on another server. 



<a id="ae198f89868d85c7db6dc1a934a1d3c15" name="ae198f89868d85c7db6dc1a934a1d3c15"></a>## [◆ ](#ae198f89868d85c7db6dc1a934a1d3c15)hasInternalObject()

 virtual bool ansys::dpf::DpfTypes::hasInternalObject  ( )  const  virtual 

ReturnsIndicates if the internal implementation object has been instantiated. 



<a id="a9f9789ff61cc9d400a2a344830706b73" name="a9f9789ff61cc9d400a2a344830706b73"></a>## [◆ ](#a9f9789ff61cc9d400a2a344830706b73)isOnCommonAPI()

 bool ansys::dpf::DpfTypes::isOnCommonAPI  ( )  const

ReturnsWether the common API is used by the object or not. 



<a id="aa64d5f8fcd7d85ad6ebf708494dbefd7" name="aa64d5f8fcd7d85ad6ebf708494dbefd7"></a>## [◆ ](#aa64d5f8fcd7d85ad6ebf708494dbefd7)isSameObject()

 bool ansys::dpf::DpfTypes::isSameObject  ( [DpfTypes](classansys_1_1dpf_1_1DpfTypes.xhtml) const &amp;  *rhs*)  const

ReturnsIndicate if the current object reference the same underlying DPF object than the provided DpfType.