Class ansys::dpf::DpfTypes
Last update: 25.03.2026
Base class for many DPF classes
Inherited by:
- ansys::dpf::Any
- ansys::dpf::Client
- ansys::dpf::CollectionBase
- ansys::dpf::CustomTypeField
- ansys::dpf::CyclicSupport
- ansys::dpf::DataSources
- ansys::dpf::DataTree
- ansys::dpf::Field
- ansys::dpf::FieldDefinition
- ansys::dpf::GenericDataContainer
- ansys::dpf::LabelSpace
- ansys::dpf::Mapping
- ansys::dpf::MeshedRegion
- ansys::dpf::Operator
- ansys::dpf::OperatorConfig
- ansys::dpf::OperatorSpecification
- ansys::dpf::PropertyField
- ansys::dpf::ResultInfo
- ansys::dpf::Scoping
- ansys::dpf::Session
- ansys::dpf::Streams
- ansys::dpf::StringField
- ansys::dpf::Support
- ansys::dpf::TimeFreqSupport
- ansys::dpf::Workflow
Members
- callAPI
- describe
- empty
- getClient
- hasBeenMovedLocally
- hasInternalObject
- isOnCommonAPI
- isSameObject
- ~DpfTypes
Friends
Public functions
Function ~DpfTypes
virtual ansys::dpf::DpfTypes::~DpfTypes()
Return type:
Function empty
virtual bool ansys::dpf::DpfTypes::empty() const
Returns:
Indicates if object is empty.
Return type: bool
Function hasInternalObject
virtual bool ansys::dpf::DpfTypes::hasInternalObject() const
Returns:
Indicates if the internal implementation object has been instantiated.
Return type: bool
Function describe
virtual std::string ansys::dpf::DpfTypes::describe() const
Returns:
Description of object.
Return type: std::string
Function callAPI
so::API const * ansys::dpf::DpfTypes::callAPI() const
Returns:
API of object.
Return type: so::API const *
Function isOnCommonAPI
bool ansys::dpf::DpfTypes::isOnCommonAPI() const
Returns:
Wether the common API is used by the object or not.
Return type: bool
Function 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.
Parameters:
- Client & client
Return type: bool
Function 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.
Return type: bool
Function 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.
Parameters:
- DpfTypes const & rhs
Return type: bool