Skip to content

Java Access Layer documentation

IMAS constants

IMAS constants¶

public class LowLevel¶

Interpolation modes¶

public static final int CLOSEST_INTERP = 1¶: 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

getSlice

public static final int PREVIOUS_INTERP = 2¶: Interpolation method that returns the previous time slice if the requested time does not exactly exist in the original IDS.

See also

getSlice

public static final int LINEAR_INTERP = 3¶: Interpolation method that returns a linear interpolation between the existing slices before and after the requested time.

See also

getSlice

Empty values¶

public static final int EMPTY_INT = 999999999¶: Value representing an unset integer in an IDS.

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

public static final Complex EMPTY_COMPLEX¶: Value representing an unset complex number in an IDS.

Serializer protocols¶

public static final int ASCII_SERIALIZER_PROTOCOL = 60¶: Identifier for the ASCII serialization protocol.

public static final int FLEXBUFFERS_SERIALIZER_PROTOCOL = 61¶: Identifier for the Flexbuffers serialization protocol. This protocol is more performant and results in a smaller buffer size than the ASCII_SERIALIZER_PROTOCOL.

public static final int DEFAULT_SERIALIZER_PROTOCOL¶: Identifier for the default serialization protocol.

Time modes¶

public static final 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.

public static final 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.

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

Backend identifiers¶

public static final int ASCII_BACKEND = 11¶: Identifier for the ASCII backend. See IMAS-Core documentation for backend details.

public static final int MDSPLUS_BACKEND = 12¶: Identifier for the MDSplus backend. See IMAS-Core documentation for backend details.

public static final int HDF5_BACKEND = 13¶: Identifier for the HDF5 backend. See IMAS-Core documentation for backend details.

public static final int MEMORY_BACKEND = 14¶: Identifier for the Memory backend. See IMAS-Core documentation for backend details.

public static final int UDA_BACKEND = 15¶: Identifier for the UDA backend. See IMAS-Core documentation for backend details.

Data entry open/create modes¶

public static final int OPEN_PULSE = 40¶: Opens the access to the data only if the Data Entry exists, returns error otherwise.

public static final int FORCE_OPEN_PULSE = 41¶: Opens access to the data, creates the Data Entry if it does not exists yet.

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

public static final int FORCE_CREATE_PULSE = 43¶: Creates an empty Data Entry (overwrites if Data Entry already exists) and opens it at the same time.

Version constants¶

public class imas

public static String get_al_version()¶

Get the Access Layer low-level version.

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

public static final String al_java_version¶: Get the version string of the Java Access Layer library, for example '5.1.0'.

public static final int al_java_major_version¶: Get the major version of the Java Access Layer library, for example 5.

public static final int al_java_minor_version¶: Get the minor version of the Java Access Layer library, for example 1.

public static final int al_java_patch_version¶: Get the patch version of the Java Access Layer library, for example 0.

public static final String al_dd_version¶: Get the version string of the Data Dictionary definitions that are used, for example '3.39.0'.

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

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

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