DPF C++ client library 2023 R2

ansys::dpf::DpfTypes Class Reference

Last update: 10.07.2023

#include <dpf_api_base.h>

Inheritance diagram for ansys::dpf::DpfTypes:
ansys::dpf::Anyansys::dpf::Clientansys::dpf::CustomTypeFieldansys::dpf::CyclicSupportansys::dpf::DataSourcesansys::dpf::DataTreeansys::dpf::Fieldansys::dpf::FieldDefinitionansys::dpf::FieldsContaineransys::dpf::LabelSpaceansys::dpf::Mappingansys::dpf::MeshedRegionansys::dpf::MeshesContaineransys::dpf::Operatoransys::dpf::OperatorConfigansys::dpf::OperatorSpecificationansys::dpf::PropertyFieldansys::dpf::ResultInfoansys::dpf::Scopingansys::dpf::ScopingsContaineransys::dpf::Sessionansys::dpf::Streamsansys::dpf::StringFieldansys::dpf::Supportansys::dpf::TimeFreqSupportansys::dpf::Workflow

Public Member Functions

virtual bool empty () const
 
virtual std::string describe () const
 
so::API const * callAPI () const
 
bool isOnCommonAPI () const
 
bool getClient (Client &client) const
 
bool hasBeenMovedLocally () const
 
bool isSameObject (DpfTypes const &rhs) const
 

Detailed Description

Base class for many DPF classes

Member Function Documentation

◆ callAPI()

so::API const * ansys::dpf::DpfTypes::callAPI ( ) const
inline
Returns
API of object.

◆ describe()

virtual std::string ansys::dpf::DpfTypes::describe ( ) const
virtual
Returns
Description of object.

◆ empty()

virtual bool ansys::dpf::DpfTypes::empty ( ) const
virtual
Returns
Indicates if object defined.
Examples
AveragingTest.cpp, and CompleteRST.cpp.

◆ getClient()

bool ansys::dpf::DpfTypes::getClient ( Client &  client) const
Returns
Get the Client the object is on, if it has one. Must not be used without using remote API.

◆ hasBeenMovedLocally()

bool ansys::dpf::DpfTypes::hasBeenMovedLocally ( ) const
Returns
Wether the object has been fully moved on the local server, in case it was defined first on another server.

◆ isOnCommonAPI()

bool ansys::dpf::DpfTypes::isOnCommonAPI ( ) const
Returns
Wether the common API is used by the object or not.

◆ isSameObject()

bool ansys::dpf::DpfTypes::isSameObject ( DpfTypes const &  rhs) const
Returns
Indicate if the current object reference the same underlying DPF object than the provided DpfType.

Connect with Ansys