DPF C++ client library 2023 R2

ansys::dpf::Any Class Reference

Last update: 10.07.2023

#include <dpf_api.h>

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

Public Member Functions

template<typename DataT >
 Any (const DataT &value)
 
 Any (Any const &)
 
 Any (Any &&)
 
Any & operator= (Any const &)
 
Any & operator= (Any &&)
 
std::string wrappedType ()
 
template<typename DataT >
bool testType ()
 
template<typename DataT >
DataT get ()
 
dp_int getAsInt ()
 
std::string getAsString ()
 
double getAsDouble ()
 
Field getAsField ()
 
PropertyField getAsPropertyField ()
 
Scoping getAsScoping ()
 
FieldsContainer getAsFieldsContainer ()
 
ScopingsContainer getAsScopingsContainer ()
 
MeshesContainer getAsMeshesContainer ()
 
TimeFreqSupport getAsTimeFreqSupport ()
 
MeshedRegion getAsMeshedRegion ()
 
Streams getAsStreams ()
 
ResultInfo getAsResultInfo ()
 
DataTree getAsDataTree ()
 
Workflow getAsWorkflow ()
 
Operator getAsOperator ()
 
CyclicSupport getAsCyclicSupport ()
 
DataSources getAsDataSources ()
 
StringField getAsStringField ()
 
GenericDataContainer getAsGenericDataContainer ()
 
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 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 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 ( )
Returns
specified template type held in the Any object.
Exceptions
DpfException

◆ getAsCyclicSupport()

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

◆ getAsDataSources()

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

◆ getAsDataTree()

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

◆ getAsDouble()

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

◆ getAsField()

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

◆ getAsFieldsContainer()

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

◆ getAsGenericDataContainer()

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

◆ getAsInt()

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

◆ getAsMeshedRegion()

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

◆ getAsMeshesContainer()

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

◆ getAsOperator()

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

◆ getAsPropertyField()

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

◆ getAsResultInfo()

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

◆ getAsScoping()

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

◆ getAsScopingsContainer()

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

◆ getAsStreams()

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

◆ getAsString()

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

◆ getAsStringField()

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

◆ getAsTimeFreqSupport()

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

◆ getAsWorkflow()

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

◆ testType()

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

Connect with Ansys