Skip to content

C++ Access Layer documentation

IMAS constants

IMAS constants¶

Interpolation modes¶

CLOSEST_SAMPLE¶: Interpolation method that returns the closest time slice in the original IDS (can break causality as it can return data ahead of requested time).

See also

IdsNs::Ids::getSlice

PREVIOUS_SAMPLE¶: Interpolation method that returns the previous time slice if the requested time does not exactly exist in the original IDS.

See also

IdsNs::Ids::getSlice

INTERPOLATION¶: Interpolation method that returns a linear interpolation between the existing slices before and after the requested time.

See also

IdsNs::Ids::getSlice

Empty values¶

static const int EMPTY_INT = -999999999¶: Value representing an unset integer in an IDS.

static const double EMPTY_DOUBLE = -9.0E40¶: Value representing an unset floating point number in an IDS.

static const std::complex<double> EMPTY_COMPLEX = std::complex<double>(EMPTY_DOUBLE, EMPTY_DOUBLE)¶: Value representing an unset complex number in an IDS.

Serializer protocols¶

ASCII_SERIALIZER_PROTOCOL¶: Identifier for the ASCII serialization protocol.

FLEXBUFFERS_SERIALIZER_PROTOCOL¶: Identifier for the Flexbuffers serialization protocol. This protocol is more performant and results in a smaller buffer size than the ASCII_SERIALIZER_PROTOCOL.

DEFAULT_SERIALIZER_PROTOCOL¶: Identifier for the default serialization protocol.

Time modes¶

static const int IDS_TIME_MODE_HETEROGENEOUS = 0¶

Time mode indicating that dynamic nodes may be asynchronous.

Timebases of quantities are as indicated in the “Coordinates” column of the Data Dictionary documentation.

static const int IDS_TIME_MODE_HOMOGENEOUS = 1¶

Time mode indicating that dynamic nodes are synchronous.

Timebases of quantities are the “time” node that is the child of the nearest parent IDS.

static const int IDS_TIME_MODE_INDEPENDENT = 2¶: Time mode indicating that no dynamic nodes are filled in the IDS.

Backend identifiers¶

enum BACKEND¶

enumerator NO_BACKEND¶

enumerator ASCII_BACKEND¶: IMAS Data Entry URIs

enumerator MDSPLUS_BACKEND¶: IMAS Data Entry URIs

enumerator HDF5_BACKEND¶: IMAS Data Entry URIs

enumerator MEMORY_BACKEND¶: IMAS Data Entry URIs

enumerator UDA_BACKEND¶: IMAS Data Entry URIs

Data entry open/create modes¶

OPEN_PULSE¶: Opens the access to the data only if the Data Entry exists, returns error otherwise.

FORCE_OPEN_PULSE¶: Opens access to the data, creates the Data Entry if it does not exists yet.

CREATE_PULSE¶: Creates a new empty Data Entry (returns error if Data Entry already exists) and opens it at the same time.

FORCE_CREATE_PULSE¶: Creates an empty Data Entry (overwrites if Data Entry already exists) and opens it at the same time.

Version constants¶

const char *getALVersion()¶

Get the Access Layer low-level version.

Returns the version (C) string of the low-level component of the Access Layer, for example "5.1.0".

std::string al_cpp_version¶: Get the version string of the C++ Access Layer library, for example "5.1.0".

int al_cpp_major_version¶: Get the major version of the C++ Access Layer library, for example 5.

int al_cpp_minor_version¶: Get the minor version of the C++ Access Layer library, for example 1.

int al_cpp_patch_version¶: Get the patch version of the C++ Access Layer library, for example 0.

std::string al_dd_version¶: Get the version string of the Data Dictionary definitions that are used, for example "3.39.0".

int al_dd_major_version¶: Get the major version of the Data Dictionary definitions that are used, for example 3.

int al_dd_minor_version¶: Get the minor version of the Data Dictionary definitions that are used, for example 39.

int al_dd_patch_version¶: Get the patch version of the Data Dictionary definitions that are used, for example 0.