Skip to main content

DPF Cpp Client Library 2026 R1

Class ansys::dpf::Any

Last update: 25.03.2026

Any class holding a typed entity.

Inherits from:

Members

Friends

Friend ConstructHelpers::construct_trait

Public functions

Function ~Any

virtual ansys::dpf::Any::~Any()

Return type:

Function Any

ansys::dpf::Any::Any(const DataT &value, Client const *const client=nullptr)

Parameters:

  • const DataT & value
  • Client const *const client = nullptr

Return type:

Function Any

ansys::dpf::Any::Any(Any const &)

Parameters:

  • Any const &

Return type:

Function Any

ansys::dpf::Any::Any(Any &&) noexcept

Parameters:

  • Any &&

Return type:

Function operator=

Any & ansys::dpf::Any::operator=(Any const &)

Parameters:

  • Any const &

Return type: Any &

Function operator=

Any & ansys::dpf::Any::operator=(Any &&) noexcept

Parameters:

  • Any &&

Return type: Any &

Function wrappedType

std::string ansys::dpf::Any::wrappedType()

Return type: std::string

Function testType

bool ansys::dpf::Any::testType() const

Returns:

Indication that the object is of the type of data.

Return type: bool

Function get

DataT ansys::dpf::Any::get() const

Returns:

specified template type held in the Any object.

Exceptions:

Return type: DataT

Function getAsInt

dp_int ansys::dpf::Any::getAsInt() const

Returns:

Int held in the Any object.

Exceptions:

Return type: dp_int

Function getAsString

std::string ansys::dpf::Any::getAsString() const

Returns:

String held in the Any object.

Exceptions:

Return type: std::string

Function getAsDouble

double ansys::dpf::Any::getAsDouble() const

Returns:

Double held in the Any object.

Exceptions:

Return type: double

Function getAsIntVector

DpfVector< int > ansys::dpf::Any::getAsIntVector() const

Returns:

int vector held in the Any object.

Exceptions:

Return type: DpfVector< int >

Function getAsField

Field ansys::dpf::Any::getAsField() const

Returns:

Field held in the Any object.

Exceptions:

Return type: Field

Function getAsPropertyField

PropertyField ansys::dpf::Any::getAsPropertyField() const

Returns:

PropertyField held in the Any object.

Exceptions:

Return type: PropertyField

Function getAsScoping

Scoping ansys::dpf::Any::getAsScoping() const

Returns:

Scoping held in the Any object.

Exceptions:

Return type: Scoping

Function getAsFieldsContainer

FieldsContainer ansys::dpf::Any::getAsFieldsContainer() const

Returns:

FieldsContainer held in the Any object.

Exceptions:

Return type: FieldsContainer

Function getAsScopingsContainer

ScopingsContainer ansys::dpf::Any::getAsScopingsContainer() const

Returns:

ScopingsContainer held in the Any object.

Exceptions:

Return type: ScopingsContainer

Function getAsMeshesContainer

MeshesContainer ansys::dpf::Any::getAsMeshesContainer() const

Returns:

MeshesContainer held in the Any object.

Exceptions:

Return type: MeshesContainer

Function getAsTimeFreqSupport

TimeFreqSupport ansys::dpf::Any::getAsTimeFreqSupport() const

Returns:

TimeFreqSupport held in the Any object.

Exceptions:

Return type: TimeFreqSupport

Function getAsMeshedRegion

MeshedRegion ansys::dpf::Any::getAsMeshedRegion() const

Returns:

MeshedRegion held in the Any object.

Exceptions:

Return type: MeshedRegion

Function getAsStreams

Streams ansys::dpf::Any::getAsStreams() const

Returns:

Streams held in the Any object.

Exceptions:

Return type: Streams

Function getAsResultInfo

ResultInfo ansys::dpf::Any::getAsResultInfo() const

Returns:

ResultInfo held in the Any object.

Exceptions:

Return type: ResultInfo

Function getAsDataTree

DataTree ansys::dpf::Any::getAsDataTree() const

Returns:

DataTree held in the Any object.

Exceptions:

Return type: DataTree

Function getAsWorkflow

Workflow ansys::dpf::Any::getAsWorkflow() const

Returns:

Workflow held in the Any object.

Exceptions:

Return type: Workflow

Function getAsOperator

Operator ansys::dpf::Any::getAsOperator() const

Returns:

Operator held in the Any object.

Exceptions:

Return type: Operator

Function getAsCyclicSupport

CyclicSupport ansys::dpf::Any::getAsCyclicSupport() const

Returns:

CyclicSupport held in the Any object.

Exceptions:

Return type: CyclicSupport

Function getAsDataSources

DataSources ansys::dpf::Any::getAsDataSources() const

Returns:

DataSources held in the Any object.

Exceptions:

Return type: DataSources

Function getAsStringField

StringField ansys::dpf::Any::getAsStringField() const

Returns:

StringField held in the Any object.

Exceptions:

Return type: StringField

Function getAsGenericDataContainer

GenericDataContainer ansys::dpf::Any::getAsGenericDataContainer() const

Returns:

GenericDataContainer held in the Any object.

Exceptions:

Return type: GenericDataContainer

Function getAsCustomTypeFieldsContainer

CustomTypeFieldsContainer ansys::dpf::Any::getAsCustomTypeFieldsContainer() const

Returns:

CustomTypeFieldsContainer held in the Any object.

Exceptions:

Return type: CustomTypeFieldsContainer

Function getAsCustomTypeField

CustomTypeField ansys::dpf::Any::getAsCustomTypeField() const

Returns:

CustomTypeField held in the Any object.

Exceptions:

Return type: CustomTypeField

Function getAsLabelSpace

LabelSpace ansys::dpf::Any::getAsLabelSpace() const

Returns:

LabelSpace held in the Any object.

Exceptions:

Return type: LabelSpace

Function getAsCollection

Collection< DataT > ansys::dpf::Any::getAsCollection() const

Returns:

AnyCollection held in the Any object.

Exceptions:

Return type: Collection< DataT >

Function getAsFbsReference

void ansys::dpf::Any::getAsFbsReference(opaque::FbsChannel *&client, std::string &address, opaque::FbsSlice *&req_slice, size_t &req_offset) const

Parameters:

  • opaque::FbsChannel *& client
  • std::string & address
  • opaque::FbsSlice *& req_slice
  • size_t & req_offset

Return type: void

Function deep_copy

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

Make a deep copy on a given client.

Parameters:

Return type: Any

Public static functions

Function createFromFbsReference

static Any ansys::dpf::Any::createFromFbsReference(const opaque::FbsChannel *channel, std::string const &address, const opaque::FbsSlice *req_slice, size_t req_offset, const ansys::dpf::Client *client=nullptr)

Parameters:

  • const opaque::FbsChannel * channel
  • std::string const & address
  • const opaque::FbsSlice * req_slice
  • size_t req_offset
  • const ansys::dpf::Client * client = nullptr

Return type: Any

Function retrieveFromServer

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

Retrieve an existing instance on a server.

Parameters:

  • int id: [in] Id of the object on the server's database.
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type: Any

Function emptyAny

static Any ansys::dpf::Any::emptyAny()

Return type: Any

Connect with Ansys