imasjava.imas API¶

public class imas¶

public static int open(String uri, int mode)¶

Open or create the Data Entry at the provided URI.

Parameters:

• uri (String) – Data entry URI

• mode (int) – One of OPEN_PULSE, FORCE_OPEN_PULSE, CREATE_PULSE, FORCE_CREATE_PULSE

Returns:

Opened data entry context

Example:

See Open an existing IMAS Database Entry.

public static int openEnv(int pulse, int run, String user, String tokamak, String version)¶

public static int openEnv(int pulse, int run, String user, String tokamak, String version, String options)¶

public static int openEnv(int pulse, int run, String user, String tokamak, String version, int backendType)¶

public static int openEnv(int pulse, int run, String user, String tokamak, String version, int backendType, String options)¶

Open the Data Entry defined by the provided parameters.

Parameters:

• pulse (int) – Pulse number

• run (int) – Run number

• user (String) – User name

• tokamak (String) – Tokamak name, also known as Database name

• version (String) – Major version of the data dictionary, e.g. "3"

• backendType (int) – Backend ID to use: ASCII_BACKEND, MDSPLUS_BACKEND, HDF5_BACKEND, MEMORY_BACKEND or UDA_BACKEND.

• options (String) – Backend specific options

Returns:

Opened data entry context

public static int createEnv(int pulse, int run, String user, String tokamak, String version)¶

public static int createEnv(int pulse, int run, String user, String tokamak, String version, String options)¶

public static int createEnv(int pulse, int run, String user, String tokamak, String version, int backendType)¶

public static int createEnv(int pulse, int run, String user, String tokamak, String version, int backendType, String options)¶

Create the Data Entry defined by the provided parameters.

Parameters:

• pulse (int) – Pulse number

• run (int) – Run number

• user (String) – User name

• tokamak (String) – Tokamak name, also known as Database name

• version (String) – Major version of the data dictionary, e.g. "3"

• backendType (int) – Backend ID to use: ASCII_BACKEND, MDSPLUS_BACKEND, HDF5_BACKEND, MEMORY_BACKEND or UDA_BACKEND.

• options (String) – Backend specific options

Returns:

Opened data entry context

public static HashMap<Integer, String> listAllOccurrences(int idx, String idsName, String nodePath)¶

Return a hashmap of the occurrence index and the node content of the IDS in the provided db entry.

Parameters:

• idx (int) – Pulse number

• idsName (String) – IDS name

• nodePath (String) – Node path

Returns:

The HashMap <ids index, node contents> or null.

imasjava.wrapper.Wrapper API¶

public class Wrapper¶

public static native String al_build_uri_from_legacy_parameters(int backendID, int pulse, int run, String user, String tokamak, String version, String options)¶

Parameters:

• backendID (int) – Backend id

• pulse (int) – Pulse number

• run (int) – Run number

• user (String) – User name

• tokamak (String) – Tokamak name, also known as Database name

• version (String) – Major version of the data dictionary, e.g. "3"

• options (String) – Options