DPF C++ Client Library 2025 R1

ansys::dpf::Any Class Reference

Last update: 16.07.2025

#include <dpf_api.h>

Inheritance diagram for ansys::dpf::Any:
ansys::dpf::DpfTypes

Public Member Functions

template<typename DataT >
 Any (const DataT &value, Client const *const client=nullptr)
 
 Any (Any const &)
 
 Any (Any &&) noexcept
 
Any & operator= (Any const &)
 
Any & operator= (Any &&) noexcept
 
std::string wrappedType ()
 
template<typename DataT >
bool testType ()
 
template<typename DataT >
DataT get () const
 
dp_int getAsInt () const
 
std::string getAsString () const
 
double getAsDouble () const
 
DpfVector< int > getAsIntVector () const
 
Field getAsField () const
 
PropertyField getAsPropertyField () const
 
Scoping getAsScoping () const
 
FieldsContainer getAsFieldsContainer () const
 
ScopingsContainer getAsScopingsContainer () const
 
MeshesContainer getAsMeshesContainer () const
 
TimeFreqSupport getAsTimeFreqSupport () const
 
MeshedRegion getAsMeshedRegion () const
 
Streams getAsStreams () const
 
ResultInfo getAsResultInfo () const
 
DataTree getAsDataTree () const
 
Workflow getAsWorkflow () const
 
Operator getAsOperator () const
 
CyclicSupport getAsCyclicSupport () const
 
DataSources getAsDataSources () const
 
StringField getAsStringField () const
 
GenericDataContainer getAsGenericDataContainer () const
 
CustomTypeFieldsContainer getAsCustomTypeFieldsContainer () const
 
CustomTypeField getAsCustomTypeField () const
 
template<typename DataT >
Collection< DataT > getAsCollection () const
 
Any deep_copy (ansys::dpf::Client const *const client) const
 
Any deep_copy () const
 
- Public Member Functions inherited from ansys::dpf::DpfTypes
virtual bool empty () const
 
virtual bool hasInternalObject () 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
 

Static Public Member Functions

static Any retrieveFromServer (int id, Client const *const client)
 
static Any emptyAny ()
 

Detailed Description

Any class holding a typed entity.

Member Function Documentation

◆ deep_copy() [1/2]

Any ansys::dpf::Any::deep_copy ( ) const

Make a deep copy locally.

◆ deep_copy() [2/2]

Any ansys::dpf::Any::deep_copy ( ansys::dpf::Client const *const  client) const

Make a deep copy on a given client.

Parameters
[in]clientRemote client

◆ get()

template<typename DataT >
DataT ansys::dpf::Any::get ( ) const
inline
Returns
specified template type held in the Any object.
Exceptions
DpfException

◆ getAsCollection()

template<typename DataT >
Collection< DataT > ansys::dpf::Any::getAsCollection ( ) const
inline
Returns
AnyCollection held in the Any object.
Exceptions
DpfException

◆ getAsCustomTypeField()

CustomTypeField ansys::dpf::Any::getAsCustomTypeField ( ) const
Returns
CustomTypeField held in the Any object.
Exceptions
DpfException

◆ getAsCustomTypeFieldsContainer()

CustomTypeFieldsContainer ansys::dpf::Any::getAsCustomTypeFieldsContainer ( ) const
Returns
CustomTypeFieldsContainer held in the Any object.
Exceptions
DpfException

◆ getAsCyclicSupport()

CyclicSupport ansys::dpf::Any::getAsCyclicSupport ( ) const
Returns
CyclicSupport held in the Any object.
Exceptions
DpfException

◆ getAsDataSources()

DataSources ansys::dpf::Any::getAsDataSources ( ) const
Returns
DataSources held in the Any object.
Exceptions
DpfException

◆ getAsDataTree()

DataTree ansys::dpf::Any::getAsDataTree ( ) const
Returns
DataTree held in the Any object.
Exceptions
DpfException

◆ getAsDouble()

double ansys::dpf::Any::getAsDouble ( ) const
Returns
Double held in the Any object.
Exceptions
DpfException

◆ getAsField()

Field ansys::dpf::Any::getAsField ( ) const
Returns
Field held in the Any object.
Exceptions
DpfException

◆ getAsFieldsContainer()

FieldsContainer ansys::dpf::Any::getAsFieldsContainer ( ) const
Returns
FieldsContainer held in the Any object.
Exceptions
DpfException

◆ getAsGenericDataContainer()

GenericDataContainer ansys::dpf::Any::getAsGenericDataContainer ( ) const
Returns
GenericDataContainer held in the Any object.
Exceptions
DpfException

◆ getAsInt()

dp_int ansys::dpf::Any::getAsInt ( ) const
Returns
Int held in the Any object.
Exceptions
DpfException

◆ getAsIntVector()

DpfVector< int > ansys::dpf::Any::getAsIntVector ( ) const
Returns
int vector held in the Any object.
Exceptions
DpfException

◆ getAsMeshedRegion()

MeshedRegion ansys::dpf::Any::getAsMeshedRegion ( ) const
Returns
MeshedRegion held in the Any object.
Exceptions
DpfException

◆ getAsMeshesContainer()

MeshesContainer ansys::dpf::Any::getAsMeshesContainer ( ) const
Returns
MeshesContainer held in the Any object.
Exceptions
DpfException

◆ getAsOperator()

Operator ansys::dpf::Any::getAsOperator ( ) const
Returns
Operator held in the Any object.
Exceptions
DpfException

◆ getAsPropertyField()

PropertyField ansys::dpf::Any::getAsPropertyField ( ) const
Returns
PropertyField held in the Any object.
Exceptions
DpfException

◆ getAsResultInfo()

ResultInfo ansys::dpf::Any::getAsResultInfo ( ) const
Returns
ResultInfo held in the Any object.
Exceptions
DpfException

◆ getAsScoping()

Scoping ansys::dpf::Any::getAsScoping ( ) const
Returns
Scoping held in the Any object.
Exceptions
DpfException

◆ getAsScopingsContainer()

ScopingsContainer ansys::dpf::Any::getAsScopingsContainer ( ) const
Returns
ScopingsContainer held in the Any object.
Exceptions
DpfException

◆ getAsStreams()

Streams ansys::dpf::Any::getAsStreams ( ) const
Returns
Streams held in the Any object.
Exceptions
DpfException

◆ getAsString()

std::string ansys::dpf::Any::getAsString ( ) const
Returns
String held in the Any object.
Exceptions
DpfException

◆ getAsStringField()

StringField ansys::dpf::Any::getAsStringField ( ) const
Returns
StringField held in the Any object.
Exceptions
DpfException

◆ getAsTimeFreqSupport()

TimeFreqSupport ansys::dpf::Any::getAsTimeFreqSupport ( ) const
Returns
TimeFreqSupport held in the Any object.
Exceptions
DpfException

◆ getAsWorkflow()

Workflow ansys::dpf::Any::getAsWorkflow ( ) const
Returns
Workflow held in the Any object.
Exceptions
DpfException

◆ retrieveFromServer()

static Any ansys::dpf::Any::retrieveFromServer ( int  id,
Client const *const  client 
)
static

Retrieve an existing instance on a server.

Parameters
[in]idId of the object on the server's database.
[in]clientClient instance designating the IP, port and protocol to use.

◆ testType()

template<typename DataT >
bool ansys::dpf::Any::testType ( )
inline
Returns
Indication that the object is of the type of data.

Connect with Ansys