ncsa.hdf.hdf5lib.H5
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class H5
This class is the Java interface for the HDF5 library.
This code is the called by Java programs to access the entry points of the HDF5 library. Each routine wraps a single HDF5 entry point, generally with the arguments and return codes analogous to the C interface.
For details of the HDF5 library, see the HDF5 Documentation at: http://hdfgroup.org/HDF5/
Mapping of arguments for Java
In general, arguments to the HDF Java API are straightforward translations from the 'C' API described in the HDF Reference Manual.
| HDF-5 | Java |
| H5T_NATIVE_INT | int, Integer |
| H5T_NATIVE_SHORT | short, Short |
| H5T_NATIVE_FLOAT | float, Float |
| H5T_NATIVE_DOUBLE | double, Double |
| H5T_NATIVE_CHAR | byte, Byte |
| H5T_C_S1 | java.lang.String |
| void * (i.e., pointer to `Any') |
Special -- see HDFArray |
In general, arguments passed IN to Java are the analogous basic types, as above. The exception is for arrays, which are discussed below.
The return value of Java methods is also the analogous type, as above. A major exception to that rule is that all HDF functions that return SUCCEED/FAIL are declared boolean in the Java version, rather than int as in the C. Functions that return a value or else FAIL are declared the equivalent to the C function. However, in most cases the Java method will raise an exception instead of returning an error code. See Errors and Exceptions below.
Java does not support pass by reference of arguments, so arguments that are returned through OUT parameters must be wrapped in an object or array. The Java API for HDF consistently wraps arguments in arrays.
For instance, a function that returns two integers is declared:
h_err_t HDF5dummy( int *a1, int *a2)
For the Java interface, this would be declared:
public synchronized static native int HDF5dummy(int args[]);where a1 is args[0] and a2 is args[1], and would be invoked:
H5.HDF5dummy(a);
All the routines where this convention is used will have specific documentation of the details, given below.
HDF5 needs to read and write multi-dimensional arrays of any number type (and records). The HDF5 API describes the layout of the source and destination, and the data for the array passed as a block of bytes, for instance,
herr_t H5Dread(int fid, int filetype, int memtype, int memspace,
void * data);
where ``void *'' means that the data may be any valid numeric type, and is a contiguous block of bytes that is the data for a multi-dimensional array. The other parameters describe the dimensions, rank, and datatype of the array on disk (source) and in memory (destination).
For Java, this ``ANY'' is a problem, as the type of data must always be declared. Furthermore, multidimensional arrays are definitely not layed out contiguously in memory. It would be infeasible to declare a separate routine for every combination of number type and dimensionality. For that reason, the HDFArray class is used to discover the type, shape, and size of the data array at run time, and to convert to and from a contiguous array of bytes in synchronized static native C order.
The upshot is that any Java array of numbers (either primitive or sub-classes of type Number) can be passed as an ``Object'', and the Java API will translate to and from the appropriate packed array of bytes needed by the C library. So the function above would be declared:
public synchronized static native int H5Dread(int fid, int filetype,
int memtype, int memspace, Object data);
and the parameter data can be any multi-dimensional array of numbers,
such as float[][], or int[][][], or Double[][].
HDF-5 Constants
The HDF-5 API defines a set of constants and enumerated values. Most of these
values are available to Java programs via the class HDF5Constants. For
example, the parameters for the h5open() call include two numeric values,
HDFConstants.H5F_ACC_RDWR and
HDF5Constants.H5P_DEFAULT. As would be expected, these numbers
correspond to the C constants H5F_ACC_RDWR and
H5P_DEFAULT.
The HDF-5 API defines a set of values that describe number types and sizes,
such as "H5T_NATIVE_INT" and "hsize_t". These values are determined at run
time by the HDF-5 C library. To support these parameters, the Java class HDF5CDataTypes
looks up the values when initiated. The values can be accessed as public
variables of the Java class, such as:
Error handling and Exceptions
The HDF5 error API (H5E) manages the behavior of the error stack in the HDF-5
library. This API is omitted from the JHI5. Errors are converted into Java
exceptions. This is totally different from the C interface, but is very
natural for Java programming.
The exceptions of the JHI5 are organized as sub-classes of the class
HDF5Exception. There are two subclasses of HDF5Exception,
HDF5LibraryException and
HDF5JavaException. The sub-classes of the former represent errors
from the HDF-5 C library, while sub-classes of the latter represent errors in
the JHI5 wrapper and support code.
The super-class HDF5LibraryException implements the method
'printStackTrace()', which prints out the HDF-5 error stack, as
described in the HDF-5 C API H5Eprint(). This may be used by
Java exception handlers to print out the HDF-5 error stack.
int data_type = HDF5CDataTypes.JH5T_NATIVE_INT;
The Java application uses both types of constants the same way, the only
difference is that the HDF5CDataTypes may have different values
on different platforms.
ncsa.hdf.hdf5lib.HDF5Constants
ncsa.hdf.hdf5lib.HDF5CDataTypes
ncsa.hdf.hdf5lib.HDF5Exception
http://hdfgroup.org/HDF5"
| Field Summary | |
|---|---|
static java.lang.String |
H5_LIBRARY_NAME_PROPERTY_KEY
|
static java.lang.String |
H5PATH_PROPERTY_KEY
|
static int[] |
LIB_VERSION
The version number of the HDF5 library: LIB_VERSION[0]: The major version of the library. LIB_VERSION[1]: The minor version of the library. LIB_VERSION[2]: The release number of the library. Make sure to update the verions number when a different library is used. |
static int |
LOGGING_LEVEL
logging level: 0 -- information, 1 -- warning message, 2 -- failure |
| Constructor Summary | |
|---|---|
H5()
|
|
| Method Summary | |
|---|---|
static int |
_H5Gcreate_anon(int loc_id,
int gcpl_id,
int gapl_id)
|
static int |
_H5Gcreate2(int loc_id,
java.lang.String name,
int lcpl_id,
int gcpl_id,
int gapl_id)
|
static int |
_H5Gopen2(int loc_id,
java.lang.String name,
int gapl_id)
|
static int |
_H5Oopen(int loc_id,
java.lang.String name,
int lapl_id)
|
static int |
_H5Screate_simple(int rank,
long[] dims,
long[] maxdims)
|
static int |
getOpenID(int index)
Get the open ID at the specified index. |
static int |
getOpenIDCount()
Get number of open IDs. |
static int |
H5Aclose(int attr_id)
H5Aclose terminates access to the attribute specified by its identifier, attr_id. |
static int |
H5Acopy(int src_aid,
int dst_aid)
H5Acopy copies the content of one attribute to another. |
static int |
H5Acreate_by_name(int loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
int type_id,
int space_id,
int acpl_id,
int aapl_id,
int lapl_id)
H5Acreate_by_name creates an attribute, attr_name, which is attached to the object specified by loc_id and obj_name. |
static int |
H5Acreate(int loc_id,
java.lang.String name,
int type_id,
int space_id,
int create_plist)
Deprecated. As of HDF5 1.8, replaced by H5Acreate( int, String, int, int, int, int) |
static int |
H5Acreate(int loc_id,
java.lang.String attr_name,
int type_id,
int space_id,
int acpl_id,
int aapl_id)
H5Acreate creates an attribute, attr_name, which is attached to the object specified by the identifier loc_id. |
static void |
H5Adelete_by_idx(int loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
int lapl_id)
H5Adelete_by_idx removes an attribute, specified by its location in an index, from an object. |
static int |
H5Adelete_by_name(int loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
int lapl_id)
H5Adelete_by_name removes the attribute attr_name from an object specified by location and name, loc_id and obj_name, respectively. |
static int |
H5Adelete(int loc_id,
java.lang.String name)
H5Adelete removes the attribute specified by its name, name, from a dataset, group, or named datatype. |
static boolean |
H5Aexists_by_name(int obj_id,
java.lang.String obj_name,
java.lang.String attr_name,
int lapl_id)
H5Aexists_by_name determines whether the attribute attr_name exists on an object. |
static boolean |
H5Aexists(int obj_id,
java.lang.String attr_name)
H5Aexists determines whether the attribute attr_name exists on the object specified by obj_id. |
static H5A_info_t |
H5Aget_info_by_idx(int loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
int lapl_id)
H5Aget_info_by_idx Retrieves attribute information, by attribute index position. |
static H5A_info_t |
H5Aget_info_by_name(int loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
int lapl_id)
H5Aget_info_by_name Retrieves attribute information, by attribute name. |
static H5A_info_t |
H5Aget_info(int attr_id)
H5Aget_info retrieves attribute information, by attribute identifier. |
static java.lang.String |
H5Aget_name_by_idx(int loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
int lapl_id)
H5Aget_name_by_idx retrieves the name of an attribute that is attached to an object, which is specified by its location and name, loc_id and obj_name, respectively. |
static long |
H5Aget_name(int attr_id,
long buf_size,
java.lang.String[] name)
H5Aget_name retrieves the name of an attribute specified by the identifier, attr_id. |
static long |
H5Aget_name(int attr_id,
java.lang.String[] name)
|
static int |
H5Aget_num_attrs(int loc_id)
Deprecated. As of HDF5 1.8, replaced by H5Oget_info( int ) |
static int |
H5Aget_space(int attr_id)
H5Aget_space retrieves a copy of the dataspace for an attribute. |
static long |
H5Aget_storage_size(int attr_id)
H5Aget_storage_size returns the amount of storage that is required for the specified attribute, attr_id. |
static int |
H5Aget_type(int attr_id)
H5Aget_type retrieves a copy of the datatype for an attribute. |
static int |
H5Aopen_by_idx(int loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
int aapl_id,
int lapl_id)
H5Aopen_by_idx opens an existing attribute that is attached to an object specified by location and name, loc_id and obj_name, respectively |
static int |
H5Aopen_by_name(int loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
int aapl_id,
int lapl_id)
H5Aopen_by_name Opens an attribute for an object by object name and attribute name |
static int |
H5Aopen_idx(int loc_id,
int idx)
Deprecated. As of HDF5 1.8, replaced by H5Aopen_by_idx(int, String, int, int, long, int, int) |
static int |
H5Aopen_name(int loc_id,
java.lang.String name)
Deprecated. As of HDF5 1.8, replaced by H5Aopen_by_name(int, String, String, int, int) |
static int |
H5Aopen(int obj_id,
java.lang.String attr_name,
int aapl_id)
H5Aopen opens an existing attribute, attr_name, that is attached to an object specified an object identifier, object_id. |
static int |
H5Aread(int attr_id,
int mem_type_id,
byte[] buf)
H5Aread reads an attribute, specified with attr_id. |
static int |
H5Aread(int attr_id,
int mem_type_id,
java.lang.Object obj)
H5Aread reads an attribute, specified with attr_id. |
static int |
H5AreadVL(int attr_id,
int mem_type_id,
java.lang.String[] buf)
|
static int |
H5Arename_by_name(int loc_id,
java.lang.String obj_name,
java.lang.String old_attr_name,
java.lang.String new_attr_name,
int lapl_id)
H5Arename_by_name changes the name of attribute that is attached to the object specified by loc_id and obj_name. |
static int |
H5Awrite(int attr_id,
int mem_type_id,
byte[] buf)
H5Awrite writes an attribute, specified with attr_id. |
static int |
H5Awrite(int attr_id,
int mem_type_id,
java.lang.Object obj)
H5Awrite writes an attribute, specified with attr_id. |
static int |
H5check_version(int majnum,
int minnum,
int relnum)
H5check_version verifies that the arguments match the version numbers compiled into the library. |
static int |
H5close()
H5close flushes all data to disk, closes all file identifiers, and cleans up all memory used by the library. |
static int |
H5Dchdir_ext(java.lang.String dir_name)
|
static int |
H5Dclose(int dataset_id)
H5Dclose ends access to a dataset specified by dataset_id and releases resources used by it. |
static int |
H5Dcopy(int src_did,
int dst_did)
H5Dcopy copies the content of one dataset to another dataset. |
static int |
H5Dcreate_anon(int loc_id,
int type_id,
int space_id,
int dcpl_id,
int dapl_id)
H5Dcreate_anon creates a dataset in the file specified by loc_id. |
static int |
H5Dcreate(int loc_id,
java.lang.String name,
int type_id,
int space_id,
int create_plist_id)
Deprecated. As of HDF5 1.8, replaced by H5Dcreate(int, String, int, int, int, int, int) |
static int |
H5Dcreate(int loc_id,
java.lang.String name,
int type_id,
int space_id,
int lcpl_id,
int dcpl_id,
int dapl_id)
H5Dcreate creates a new dataset named name at the location specified by loc_id. |
static int |
H5Dextend(int dataset_id,
byte[] size)
Deprecated. As of HDF5 1.8, replaced by H5Dset_extent(int, long[]) |
static int |
H5Dextend(int dataset_id,
long[] size)
Deprecated. As of HDF5 1.8, replaced by H5Dset_extent(int, long[]) |
static void |
H5Dfill(byte[] fill,
int fill_type,
byte[] buf,
int buf_type,
int space)
H5Dfill explicitly fills the dataspace selection in memory, space_id, with the fill value specified in fill. |
static int |
H5Dget_access_plist(int dset_id)
H5Dget_access_plist returns an identifier for a copy of the dataset access property list for a dataset. |
static int |
H5Dget_create_plist(int dataset_id)
H5Dget_create_plist returns an identifier for a copy of the dataset creation property list for a dataset. |
static long |
H5Dget_offset(int dset_id)
H5Dget_offset returns the address in the file of the dataset dset_id. |
static int |
H5Dget_space_status(int dset_id)
H5Dget_space_status determines whether space has been allocated for the dataset dset_id. |
static int |
H5Dget_space_status(int dset_id,
int[] status)
H5Dget_space_status determines whether space has been allocated for the dataset dset_id. |
static int |
H5Dget_space(int dataset_id)
H5Dget_space returns an identifier for a copy of the dataspace for a dataset. |
static long |
H5Dget_storage_size(int dataset_id)
H5Dget_storage_size returns the amount of storage that is required for the dataset. |
static int |
H5Dget_type(int dataset_id)
H5Dget_type returns an identifier for a copy of the datatype for a dataset. |
static int |
H5Dgetdir_ext(java.lang.String[] dir_name,
int size)
|
static int |
H5Dopen(int loc_id,
java.lang.String name)
Deprecated. As of HDF5 1.8, replaced by H5Dopen(int, String, int) |
static int |
H5Dopen(int loc_id,
java.lang.String name,
int dapl_id)
H5Dopen opens the existing dataset specified by a location identifier and name, loc_id and name, respectively. |
static int |
H5Dread_double(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
double[] buf)
|
static int |
H5Dread_double(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
double[] buf,
boolean isCriticalPinning)
|
static int |
H5Dread_float(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
float[] buf)
|
static int |
H5Dread_float(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
float[] buf,
boolean isCriticalPinning)
|
static int |
H5Dread_int(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
int[] buf)
|
static int |
H5Dread_int(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
int[] buf,
boolean isCriticalPinning)
|
static int |
H5Dread_long(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
long[] buf)
|
static int |
H5Dread_long(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
long[] buf,
boolean isCriticalPinning)
|
static int |
H5Dread_reg_ref(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.String[] buf)
|
static int |
H5Dread_short(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
short[] buf)
|
static int |
H5Dread_short(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
short[] buf,
boolean isCriticalPinning)
|
static int |
H5Dread_string(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.String[] buf)
|
static int |
H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf)
|
static int |
H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf,
boolean isCriticalPinning)
H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application memory buffer buf. |
static int |
H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj)
|
static int |
H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj,
boolean isCriticalPinning)
H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application data object. |
static int |
H5DreadVL(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object[] buf)
|
static void |
H5Dset_extent(int dset_id,
long[] size)
H5Dset_extent sets the current dimensions of the chunked dataset dset_id to the sizes specified in size. |
static long |
H5Dvlen_get_buf_size(int dset_id,
int type_id,
int space_id)
H5Dvlen_get_buf_size determines the number of bytes required to store the VL data from the dataset, using the space_id for the selection in the dataset on disk and the type_id for the memory representation of the VL data in memory. |
static int |
H5Dvlen_get_buf_size(int dataset_id,
int type_id,
int space_id,
int[] size)
|
static int |
H5Dvlen_reclaim(int type_id,
int space_id,
int xfer_plist_id,
byte[] buf)
|
static int |
H5Dwrite_double(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
double[] buf)
|
static int |
H5Dwrite_double(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
double[] buf,
boolean isCriticalPinning)
|
static int |
H5Dwrite_float(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
float[] buf)
|
static int |
H5Dwrite_float(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
float[] buf,
boolean isCriticalPinning)
|
static int |
H5Dwrite_int(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
int[] buf)
|
static int |
H5Dwrite_int(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
int[] buf,
boolean isCriticalPinning)
|
static int |
H5Dwrite_long(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
long[] buf)
|
static int |
H5Dwrite_long(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
long[] buf,
boolean isCriticalPinning)
|
static int |
H5Dwrite_short(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
short[] buf)
|
static int |
H5Dwrite_short(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
short[] buf,
boolean isCriticalPinning)
|
static int |
H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf)
|
static int |
H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf,
boolean isCriticalPinning)
H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer buf into the file. |
static int |
H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj)
|
static int |
H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj,
boolean isCriticalPinning)
H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory data object into the file. |
static int |
H5DwriteString(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.String[] buf)
H5DwriteString writes a (partial) variable length String dataset, specified by its identifier dataset_id, from the application memory buffer buf into the file. |
static boolean |
H5Eauto_is_v2(int err_stack)
H5Eauto_is_v2 determines whether the error auto reporting function for an error stack conforms to the H5E_auto2_t typedef or the H5E_auto1_t typedef. |
static int |
H5Eclear()
H5Eclear clears the error stack for the current thread. |
static void |
H5Eclear(int err_stack)
H5Eclear clears the error stack specified by estack_id, or, if estack_id is set to H5E_DEFAULT, the error stack for the current thread. |
static void |
H5Eclear2(int err_stack)
H5Eclear2 clears the error stack specified by estack_id, or, if estack_id is set to H5E_DEFAULT, the error stack for the current thread. |
static void |
H5Eclose_msg(int err_id)
H5Eclose_msg closes an error message identifier, which can be either a major or minor message. |
static void |
H5Eclose_stack(int stack_id)
H5Eclose_stack closes the object handle for an error stack and releases its resources. |
static int |
H5Ecreate_msg(int cls_id,
int msg_type,
java.lang.String msg)
H5Ecreate_msg adds an error message to an error class defined by client library or application program. |
static int |
H5Ecreate_stack()
H5Ecreate_stack creates a new empty error stack and returns the new stack's identifier. |
static java.lang.String |
H5Eget_class_name(int class_id)
H5Eget_class_name retrieves the name of the error class specified by the class identifier. |
static int |
H5Eget_current_stack()
H5Eget_current_stack copies the current error stack and returns an error stack identifier for the new copy. |
static java.lang.String |
H5Eget_msg(int msg_id,
int[] type_list)
H5Eget_msg retrieves the error message including its length and type. |
static long |
H5Eget_num(int stack_id)
H5Eget_num retrieves the number of error records in the error stack specified by estack_id (including major, minor messages and description). |
static void |
H5Epop(int stack_id,
long count)
H5Epop deletes the number of error records specified in count from the top of the error stack specified by estack_id (including major, minor messages and description). |
static void |
H5Eprint1(java.lang.Object stream)
Deprecated. As of HDF5 1.8, replaced by H5Eprint2(int, Object) |
static void |
H5Eprint2(int err_stack,
java.lang.Object stream)
H5Eprint2 prints the error stack specified by estack_id on the specified stream, stream. |
static int |
H5Eregister_class(java.lang.String cls_name,
java.lang.String lib_name,
java.lang.String version)
H5Eregister_class registers a client library or application program to the HDF5 error API so that the client library or application program can report errors together with HDF5 library. |
static int |
H5error_off()
Turn off error handling By default, the C library prints the error stack of the HDF-5 C library on stdout. |
static void |
H5Eset_current_stack(int stack_id)
H5Eset_current_stack replaces the content of the current error stack with a copy of the content of the error stack specified by estack_id. |
static void |
H5Eunregister_class(int class_id)
H5Eunregister_class removes the error class specified by class_id. |
static int |
H5Fclose(int file_id)
H5Fclose terminates access to an HDF5 file. |
static int |
H5Fcreate(java.lang.String name,
int flags,
int create_id,
int access_id)
H5Fcreate is the primary function for creating HDF5 files. |
static int |
H5Fflush(int object_id,
int scope)
H5Fflush causes all buffers associated with a file or object to be immediately flushed (written) to disk without removing the data from the (memory) cache. |
static int |
H5Fget_access_plist(int file_id)
H5Fget_access_plist returns the file access property list identifier of the specified file. |
static int |
H5Fget_create_plist(int file_id)
H5Fget_create_plist returns a file creation property list identifier identifying the creation properties used to create this file. |
static long |
H5Fget_filesize(int file_id)
|
static long |
H5Fget_freespace(int file_id)
H5Fget_freespace returns the amount of space that is unused by any objects in the file. |
static int |
H5Fget_intent(int file_id)
H5Fget_intent retrieves the intended access mode flag passed with H5Fopen when the file was opened. |
static double |
H5Fget_mdc_hit_rate(int file_id)
H5Fget_mdc_hit_rate queries the metadata cache of the target file to obtain its hit rate (cache hits / (cache hits + cache misses)) since the last time hit rate statistics were reset. |
static int |
H5Fget_mdc_size(int file_id,
long[] metadata_cache)
H5Fget_mdc_size queries the metadata cache of the target file for the desired size information. |
static java.lang.String |
H5Fget_name(int obj_id)
H5Fget_name retrieves the name of the file to which the object obj_id belongs. |
static java.lang.String |
H5Fget_name(int obj_id,
int size)
|
static long |
H5Fget_obj_count_long(int file_id,
int types)
H5Fget_obj_count returns the number of open object identifiers for the file. |
static int |
H5Fget_obj_count(int file_id,
int types)
H5Fget_obj_count returns the number of open object identifiers for the file. |
static long |
H5Fget_obj_ids_long(int file_id,
int types,
long max_objs,
int[] obj_id_list)
H5Fget_obj_ids returns the list of identifiers for all open HDF5 objects fitting the specified criteria. |
static int |
H5Fget_obj_ids(int file_id,
int types,
int max,
int[] obj_id_list)
H5Fget_obj_ids returns the list of identifiers for all open HDF5 objects fitting the specified criteria. |
static boolean |
H5Fis_hdf5(java.lang.String name)
H5Fis_hdf5 determines whether a file is in the HDF5 format. |
static int |
H5Fmount(int loc_id,
java.lang.String name,
int child_id,
int plist_id)
H5Fmount mounts the file specified by child_id onto the group specified by loc_id and name using the mount properties plist_id. |
static int |
H5Fopen(java.lang.String name,
int flags,
int access_id)
H5Fopen opens an existing file and is the primary function for accessing existing HDF5 files. |
static int |
H5Freopen(int file_id)
H5Freopen reopens an HDF5 file. |
static void |
H5Freset_mdc_hit_rate_stats(int file_id)
H5Freset_mdc_hit_rate_stats resets the hit rate statistics counters in the metadata cache associated with the specified file. |
static int |
H5Funmount(int loc_id,
java.lang.String name)
Given a mount point, H5Funmount dissassociates the mount point's file from the file mounted there. |
static int |
H5garbage_collect()
H5garbage_collect collects on all free-lists of all types. |
static int |
H5Gclose(int group_id)
H5Gclose releases resources used by a group which was opened by a call to H5Gcreate() or H5Gopen(). |
static int |
H5Gcreate_anon(int loc_id,
int gcpl_id,
int gapl_id)
H5Gcreate_anon creates a new empty group in the file specified by loc_id. |
static int |
H5Gcreate(int loc_id,
java.lang.String name,
int lcpl_id,
int gcpl_id,
int gapl_id)
H5Gcreate creates a new group with the specified name at the specified location, loc_id. |
static int |
H5Gcreate(int loc_id,
java.lang.String name,
long size_hint)
Deprecated. As of HDF5 1.8, replaced by H5Gcreate(int, String, int, int, int) |
static int |
H5get_libversion(int[] libversion)
H5get_libversion retrieves the major, minor, and release numbers of the version of the HDF library which is linked to the application. |
static int |
H5Gget_comment(int loc_id,
java.lang.String name,
int bufsize,
java.lang.String[] comment)
Deprecated. As of HDF5 1.8, replaced by H5Oget_comment(int) |
static int |
H5Gget_create_plist(int group_id)
H5Gget_create_plist returns an identifier for the group creation property list associated with the group specified by group_id. |
static H5G_info_t |
H5Gget_info_by_idx(int group_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int lapl_id)
H5Gget_info_by_idx retrieves information about a group, according to the group's position within an index. |
static H5G_info_t |
H5Gget_info_by_name(int group_id,
java.lang.String name,
int lapl_id)
H5Gget_info_by_name retrieves information about the group group_name located in the file or group specified by loc_id. |
static H5G_info_t |
H5Gget_info(int group_id)
H5Gget_info retrieves information about the group specified by group_id. |
static int |
H5Gget_linkval(int loc_id,
java.lang.String name,
int size,
java.lang.String[] value)
Deprecated. As of HDF5 1.8, replaced by H5Lget_val(int, String, String[] , int) |
static int |
H5Gget_num_objs(int loc_id,
long[] num_obj)
Deprecated. As of HDF5 1.8, replaced by H5Gget_info(int) |
static int |
H5Gget_obj_info_all(int loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] otype,
int[] ltype,
long[] ref,
int indx_type)
|
static int |
H5Gget_obj_info_all(int loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] otype,
long[] ref)
retrieves information of all objects under the group (name) located in the file or group specified by loc_id. |
static int |
H5Gget_obj_info_idx(int loc_id,
java.lang.String name,
int idx,
java.lang.String[] oname,
int[] type)
H5Gget_obj_info_idx report the name and type of object with index 'idx' in a Group. |
static int |
H5Gget_obj_info_max(int loc_id,
java.lang.String[] objNames,
int[] objTypes,
int[] lnkTypes,
long[] ref,
int objMax)
retrieves information of all objects (recurvisely) under the group (name) located in the file or group specified by loc_id upto maximum specified by objMax. |
static int |
H5Gget_objinfo(int loc_id,
java.lang.String name,
boolean follow_link,
HDF5GroupInfo info)
Deprecated. As of HDF5 1.8 |
static int |
H5Gget_objinfo(int loc_id,
java.lang.String name,
boolean follow_link,
long[] fileno,
long[] objno,
int[] link_info,
long[] mtime)
Deprecated. As of HDF5 1.8, replaced by and #H5Oget_info(int) |
static long |
H5Gget_objname_by_idx(int group_id,
long idx,
java.lang.String[] name,
long size)
Deprecated. As of HDF5 1.8, replaced by H5Lget_name_by_idx(int, String, int, int, long, int) |
static int |
H5Gget_objtype_by_idx(int group_id,
long idx)
Deprecated. As of HDF5 1.8, replaced by H5Oget_info(int) |
static int |
H5Glink(int loc_id,
int link_type,
java.lang.String current_name,
java.lang.String new_name)
Deprecated. As of HDF5 1.8, replaced by and #H5Lcreate_soft(String, int, String, int, int) |
static int |
H5Glink2(int curr_loc_id,
java.lang.String current_name,
int link_type,
int new_loc_id,
java.lang.String new_name)
Deprecated. As of HDF5 1.8 |
static int |
H5Gmove(int loc_id,
java.lang.String src,
java.lang.String dst)
Deprecated. As of HDF5 1.8, replaced by H5Lmove(int, String, int,String, int, int) |
static long |
H5Gn_members_long(int loc_id,
java.lang.String name)
H5Gn_members report the number of objects in a Group. |
static int |
H5Gn_members(int loc_id,
java.lang.String name)
H5Gn_members report the number of objects in a Group. |
static int |
H5Gopen(int loc_id,
java.lang.String name)
Deprecated. As of HDF5 1.8, replaced by H5Gopen(int, String, int) |
static int |
H5Gopen(int loc_id,
java.lang.String name,
int gapl_id)
H5Gopen opens an existing group, name, at the location specified by loc_id. |
static int |
H5Gset_comment(int loc_id,
java.lang.String name,
java.lang.String comment)
Deprecated. As of HDF5 1.8, replaced by H5Oset_comment(int, String) |
static int |
H5Gunlink(int loc_id,
java.lang.String name)
Deprecated. As of HDF5 1.8, replaced by H5Ldelete(int, String, int) |
static int |
H5Idec_ref(int obj_id)
|
static int |
H5Iget_file_id(int obj_id)
|
static long |
H5Iget_name(int obj_id,
java.lang.String[] name,
long size)
|
static int |
H5Iget_ref(int obj_id)
|
static int |
H5Iget_type_ref(int type)
H5Iget_type_ref retrieves the reference count on an ID type. |
static int |
H5Iget_type(int obj_id)
H5Iget_type retrieves the type of the object identified by obj_id. |
static int |
H5Iinc_ref(int obj_id)
|
static int |
H5INcreate(java.lang.String grp_name,
int grp_loc_id,
int property_list,
int data_loc_id,
java.lang.String data_loc_name,
java.lang.String field_name,
long max_mem_size)
|
static int |
H5Inmembers(int type)
H5Inmembers returns the number of identifiers of the identifier type specified in type. |
static int |
H5INquery(int dset_id,
java.lang.String[] keys,
java.lang.Object ubounds,
java.lang.Object lbounds,
int nkeys)
|
static void |
H5Lcopy(int src_loc,
java.lang.String src_name,
int dst_loc,
java.lang.String dst_name,
int lcpl_id,
int lapl_id)
H5Lcopy copies a link from one location to another. |
static void |
H5Lcreate_external(java.lang.String file_name,
java.lang.String obj_name,
int link_loc_id,
java.lang.String link_name,
int lcpl_id,
int lapl_id)
H5Lcreate_external creates a new soft link to an external object, which is an object in a different HDF5 file from the location of the link. |
static void |
H5Lcreate_hard(int cur_loc,
java.lang.String cur_name,
int dst_loc,
java.lang.String dst_name,
int lcpl_id,
int lapl_id)
H5Lcreate_hard creates a new hard link to a pre-existing object in an HDF5 file. |
static void |
H5Lcreate_soft(java.lang.String link_target,
int link_loc_id,
java.lang.String link_name,
int lcpl_id,
int lapl_id)
H5Lcreate_soft creates a new soft link to an object in an HDF5 file. |
static void |
H5Ldelete_by_idx(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int lapl_id)
H5Ldelete_by_idx removes the nth link in a group according to the specified order and in the specified index. |
static void |
H5Ldelete(int loc_id,
java.lang.String name,
int lapl_id)
H5Ldelete removes the link specified from a group. |
static boolean |
H5Lexists(int loc_id,
java.lang.String name,
int lapl_id)
H5Lexists checks if a link with a particular name exists in a group. |
static H5L_info_t |
H5Lget_info_by_idx(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int lapl_id)
H5Lget_info_by_idx opens a named datatype at the location specified by loc_id and return an identifier for the datatype. |
static H5L_info_t |
H5Lget_info(int loc_id,
java.lang.String name,
int lapl_id)
H5Lget_info returns information about the specified link. |
static java.lang.String |
H5Lget_name_by_idx(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int lapl_id)
H5Lget_name_by_idx retrieves name of the nth link in a group, according to the order within a specified field or index. |
static int |
H5Lget_val_by_idx(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
java.lang.String[] link_value,
int lapl_id)
H5Lget_val_by_idx retrieves value of the nth link in a group, according to the order within an index. |
static int |
H5Lget_val(int loc_id,
java.lang.String name,
java.lang.String[] link_value,
int lapl_id)
H5Lget_val returns the link value of a symbolic link. |
static int |
H5Literate_by_name(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long idx,
H5L_iterate_cb op,
H5L_iterate_t op_data,
int lapl_id)
H5Literate_by_name iterates through links in a group. |
static int |
H5Literate(int grp_id,
int idx_type,
int order,
long idx,
H5L_iterate_cb op,
H5L_iterate_t op_data)
H5Literate iterates through links in a group. |
static void |
H5Lmove(int src_loc,
java.lang.String src_name,
int dst_loc,
java.lang.String dst_name,
int lcpl_id,
int lapl_id)
H5Lmove renames a link within an HDF5 file. |
static int |
H5Lvisit_by_name(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
H5L_iterate_cb op,
H5L_iterate_t op_data,
int lapl_id)
H5Lvisit_by_name recursively visits all links starting from a specified group. |
static int |
H5Lvisit(int grp_id,
int idx_type,
int order,
H5L_iterate_cb op,
H5L_iterate_t op_data)
H5Lvisit recursively visits all links starting from a specified group. |
static int |
H5Oclose(int object_id)
H5Oclose closes the group, dataset, or named datatype specified. |
static void |
H5Ocopy(int src_loc_id,
java.lang.String src_name,
int dst_loc_id,
java.lang.String dst_name,
int ocpypl_id,
int lcpl_id)
H5Ocopy copies the group, dataset or named datatype specified from the file or group specified by source location to the destination location. |
static java.lang.String |
H5Oget_comment_by_name(int loc_id,
java.lang.String name,
int lapl_id)
H5Oget_comment_by_name retrieves the comment for an object. |
static java.lang.String |
H5Oget_comment(int obj_id)
H5Oget_comment retrieves the comment for the specified object. |
static H5O_info_t |
H5Oget_info_by_idx(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int lapl_id)
H5Oget_info_by_idx retrieves the metadata for an object, identifying the object by an index position. |
static H5O_info_t |
H5Oget_info_by_name(int loc_id,
java.lang.String name,
int lapl_id)
H5Oget_info_by_name retrieves the metadata for an object, identifying the object by location and relative name. |
static H5O_info_t |
H5Oget_info(int loc_id)
H5Oget_info retrieves the metadata for an object specified by an identifier. |
static void |
H5Olink(int obj_id,
int new_loc_id,
java.lang.String new_name,
int lcpl_id,
int lapl_id)
H5Olink creates a new hard link to an object in an HDF5 file. |
static int |
H5Oopen(int loc_id,
java.lang.String name,
int lapl_id)
H5Oopen opens a group, dataset, or named datatype specified by a location and a path name. |
static int |
H5open()
H5open initialize the library. |
static void |
H5Oset_comment_by_name(int loc_id,
java.lang.String name,
java.lang.String comment,
int lapl_id)
H5Oset_comment_by_name sets the comment for the specified object. |
static void |
H5Oset_comment(int obj_id,
java.lang.String comment)
H5Oset_comment sets the comment for the specified object. |
static int |
H5Ovisit_by_name(int loc_id,
java.lang.String obj_name,
int idx_type,
int order,
H5O_iterate_cb op,
H5O_iterate_t op_data,
int lapl_id)
H5Ovisit_by_name recursively visits all objects starting from a specified object. |
static int |
H5Ovisit(int obj_id,
int idx_type,
int order,
H5O_iterate_cb op,
H5O_iterate_t op_data)
H5Ovisit recursively visits all objects accessible from a specified object. |
static boolean |
H5Pall_filters_avail(int dcpl_id)
|
static int |
H5Pclose_class(int plid)
Closes an existing property list class |
static int |
H5Pclose(int plist)
H5Pclose terminates access to a property list. |
static int |
H5Pcopy_prop(int dst_id,
int src_id,
java.lang.String name)
H5Pcopy_prop copies a property from one property list or class to another |
static int |
H5Pcopy(int plist)
H5Pcopy copies an existing property list to create a new property list. |
static int |
H5Pcreate(int type)
H5Pcreate creates a new property as an instance of some property list class. |
static int |
H5Pequal(int plid1,
int plid2)
H5Pequal determines if two property lists or classes are equal |
static int |
H5Pexist(int plid,
java.lang.String name)
H5Pexist determines whether a property exists within a property list or class |
static int |
H5Pfill_value_defined(int plist_id,
int[] status)
|
static int |
H5Pget_alignment(int plist,
long[] alignment)
H5Pget_alignment retrieves the current settings for alignment properties from a file access property list. |
static int |
H5Pget_alloc_time(int plist_id,
int[] alloc_time)
|
static int |
H5Pget_attr_creation_order(int ocpl_id)
H5Pget_attr_creation_order retrieves the settings for tracking and indexing attribute creation order on an object |
static int |
H5Pget_attr_phase_change(int ocpl_id,
int[] attributes)
H5Pget_attr_phase_change retrieves attribute storage phase change thresholds. |
static int |
H5Pget_btree_ratios(int plist_id,
double[] left,
double[] middle,
double[] right)
H5Pget_btree_ratio Get the B-tree split ratios for a dataset transfer property list. |
static int |
H5Pget_buffer(int plist,
byte[] tconv,
byte[] bkg)
HH5Pget_buffer gets type conversion and background buffers. |
static int |
H5Pget_cache(int plist,
int[] mdc_nelmts,
int[] rdcc_nelmts,
int[] rdcc_nbytes,
double[] rdcc_w0)
Retrieves the maximum possible number of elements in the meta data cache and the maximum possible number of bytes and the RDCC_W0 value in the raw data chunk cache. |
static int |
H5Pget_chunk(int plist,
int max_ndims,
long[] dims)
H5Pget_chunk retrieves the size of chunks for the raw data of a chunked layout dataset. |
static java.lang.String |
H5Pget_class_name(int plid)
H5Pget_class_name retrieves the name of a generic property list class |
static int |
H5Pget_class_parent(int plid)
H5Pget_class_parent retrieves an identifier for the parent class of a property class |
static int |
H5Pget_class(int plist)
H5Pget_class returns the property list class for the property list identified by the plist parameter. |
static int |
H5Pget_copy_object(int ocp_plist_id)
H5Pget_copy_object retrieves the properties to be used when an object is copied. |
static boolean |
H5Pget_create_intermediate_group(int lcpl_id)
H5Pget_create_intermediate_group determines whether property is set to enable creating missing intermediate groups. |
static long |
H5Pget_data_transform(int plist_id,
java.lang.String[] expression,
long size)
H5Pget_data_transform retrieves the data transform expression previously set in the dataset transfer property list plist_id by H5Pset_data_transform. |
static int |
H5Pget_edc_check(int plist)
|
static int |
H5Pget_elink_acc_flags(int lapl_id)
H5Pget_elink_acc_flags retrieves the external link traversal file access flag from the specified link access property list. |
static int |
H5Pget_elink_fapl(int lapl_id)
H5Pget_elink_fapl Retrieves the file access property list identifier associated with the link access property list. |
static long |
H5Pget_elink_prefix(int lapl_id,
java.lang.String[] prefix)
H5Pget_elink_prefix Retrieves prefix applied to external link paths. |
static int |
H5Pget_est_link_info(int gcpl_id,
int[] link_info)
H5Pget_est_link_info Queries data required to estimate required local heap or object header size. |
static int |
H5Pget_external_count(int plist)
H5Pget_external_count returns the number of external files for the specified dataset. |
static int |
H5Pget_external(int plist,
int idx,
int name_size,
java.lang.String[] name,
long[] size)
H5Pget_external returns information about an external file. |
static long |
H5Pget_family_offset(int fapl_id)
|
static int |
H5Pget_fapl_core(int fapl_id,
int[] increment,
boolean[] backing_store)
|
static int |
H5Pget_fapl_direct(int fapl_id,
int[] info)
H5Pget_fapl_direct Retrieve direct I/O settings. |
static int |
H5Pget_fapl_family(int fapl_id,
long[] memb_size,
int[] memb_fapl_id)
|
static int |
H5Pget_fclose_degree(int plist_id)
|
static int |
H5Pget_fill_time(int plist_id,
int[] fill_time)
|
static int |
H5Pget_fill_value(int plist_id,
int type_id,
byte[] value)
H5Pget_fill_value queries the fill value property of a dataset creation property list. |
static int |
H5Pget_fill_value(int plist_id,
int type_id,
java.lang.Object obj)
H5Pget_fill_value queries the fill value property of a dataset creation property list. |
static int |
H5Pget_filter_by_id(int plist_id,
int filter,
int[] flags,
long[] cd_nelmts,
int[] cd_values,
long namelen,
java.lang.String[] name)
|
static int |
H5Pget_filter(int plist,
int filter_number,
int[] flags,
int[] cd_nelmts,
int[] cd_values,
int namelen,
java.lang.String[] name)
Deprecated. As of HDF5 1.8, replaced by H5Pget_filter(int, int, int[], int[], int[], int, String[], int[]) |
static int |
H5Pget_filter(int plist,
int filter_number,
int[] flags,
int[] cd_nelmts,
int[] cd_values,
int namelen,
java.lang.String[] name,
int[] filter_config)
H5Pget_filter returns information about a filter, specified by its filter number, in a filter pipeline, specified by the property list with which it is associated. |
static int |
H5Pget_gc_reference(int fapl_id,
boolean[] gc_ref)
|
static int |
H5Pget_gc_references(int fapl_id,
boolean[] gc_ref)
H5Pget_gc_references Returns the current setting for the garbage collection refernces property from a file access property list. |
static int |
H5Pget_hyper_vector_size(int dxpl_id,
long[] vector_size)
|
static int |
H5Pget_istore_k(int plist,
int[] ik)
H5Pget_istore_k queries the 1/2 rank of an indexed storage B-tree. |
static int |
H5Pget_layout(int plist)
H5Pget_layout returns the layout of the raw data for a dataset. |
static int |
H5Pget_libver_bounds(int fapl_id,
int[] libver)
H5Pget_libver_bounds retrieves the lower and upper bounds on the HDF5 Library versions that indirectly determine the object formats versions used when creating objects in the file. |
static int |
H5Pget_link_creation_order(int gcpl_id)
H5Pget_link_creation_order queries the group creation property list, gcpl_id, and returns a flag indicating whether link creation order is tracked and/or indexed in a group. |
static int |
H5Pget_link_phase_change(int gcpl_id,
int[] links)
H5Pget_link_phase_change Queries the settings for conversion between compact and dense groups. |
static int |
H5Pget_local_heap_size_hint(int gcpl_id)
H5Pget_local_heap_size_hint Retrieves the anticipated size of the local heap for original-style groups. |
static int |
H5Pget_nfilters(int plist)
H5Pget_nfilters returns the number of filters defined in the filter pipeline associated with the property list plist. |
static long |
H5Pget_nlinks(int lapl_id)
H5Pget_nlinks retrieves the maximum number of soft or user-defined link traversals allowed, nlinks, before the library assumes it has found a cycle and aborts the traversal. |
static long |
H5Pget_nprops(int plid)
H5Pget_nprops retrieves the number of properties in a property list or class |
static int |
H5Pget_preserve(int plist)
H5Pget_preserve checks the status of the dataset transfer property list. |
static int |
H5Pget_shared_mesg_index(int fcpl_id,
int index_num,
int[] mesg_info)
H5Pget_shared_mesg_index Retrieves the configuration settings for a shared message index. |
static int |
H5Pget_shared_mesg_nindexes(int fcpl_id)
H5Pget_shared_mesg_nindexes retrieves number of shared object header message indexes in file creation property list. |
static int |
H5Pget_shared_mesg_phase_change(int fcpl_id,
int[] size)
H5Pget_shared_mesg_phase_change retrieves shared object header message phase change information. |
static long |
H5Pget_size(int plid,
java.lang.String name)
H5Pget_size retrieves the size of a property's value in bytes |
static int |
H5Pget_sizes(int plist,
int[] size)
H5Pget_sizes retrieves the size of the offsets and lengths used in an HDF5 file. |
static int |
H5Pget_small_data_block_size(int plist,
long[] size)
H5Pget_small_data_block_size retrieves the size of a block of small data in a file creation property list. |
static int |
H5Pget_sym_k(int plist,
int[] size)
H5Pget_sym_k retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size. |
static int |
H5Pget_userblock(int plist,
long[] size)
H5Pget_userblock retrieves the size of a user block in a file creation property list. |
static int |
H5Pget_version(int plist,
int[] version_info)
H5Pget_version retrieves the version information of various objects for a file creation property list. |
static int |
H5Pget(int plid,
java.lang.String name)
H5Pget retrieves a copy of the value for a property in a property list (support integer only) |
static int |
H5Pisa_class(int plist,
int pclass)
H5Pisa_class checks to determine whether a property list is a member of the specified class |
static int |
H5Pmodify_filter(int plist,
int filter,
int flags,
long cd_nelmts,
int[] cd_values)
|
static int |
H5Premove_filter(int obj_id,
int filter)
|
static int |
H5Premove(int plid,
java.lang.String name)
H5Premove removes a property from a property list |
static int |
H5Pset_alignment(int plist,
long threshold,
long alignment)
H5Pset_alignment sets the alignment properties of a file access property list so that any file object >= THRESHOLD bytes will be aligned on an address which is a multiple of ALIGNMENT. |
static int |
H5Pset_alloc_time(int plist_id,
int alloc_time)
|
static int |
H5Pset_attr_creation_order(int ocpl_id,
int crt_order_flags)
H5Pset_attr_creation_order sets flags specifying whether to track and index attribute creation order on an object. |
static int |
H5Pset_btree_ratios(int plist_id,
double left,
double middle,
double right)
H5Pset_btree_ratio Sets B-tree split ratios for a dataset transfer property list. |
static int |
H5Pset_buffer(int plist,
int size,
byte[] tconv,
byte[] bkg)
H5Pset_buffer sets type conversion and background buffers. |
static int |
H5Pset_cache(int plist,
int mdc_nelmts,
int rdcc_nelmts,
int rdcc_nbytes,
double rdcc_w0)
H5Pset_cache sets the number of elements (objects) in the meta data cache and the total number of bytes in the raw data chunk cache. |
static int |
H5Pset_chunk(int plist,
int ndims,
byte[] dim)
H5Pset_chunk sets the size of the chunks used to store a chunked layout dataset. |
static int |
H5Pset_chunk(int plist,
int ndims,
long[] dim)
|
static void |
H5Pset_copy_object(int ocp_plist_id,
int copy_options)
H5Pset_copy_object Sets properties to be used when an object is copied. |
static int |
H5Pset_create_intermediate_group(int lcpl_id,
boolean crt_intermed_group)
H5Pset_create_intermediate_group specifies in property list whether to create missing intermediate groups |
static int |
H5Pset_data_transform(int plist_id,
java.lang.String expression)
H5Pset_data_transform sets a data transform expression |
static int |
H5Pset_deflate(int plist,
int level)
H5Pset_deflate sets the compression method for a dataset. |
static int |
H5Pset_edc_check(int plist,
int check)
|
static int |
H5Pset_elink_acc_flags(int lapl_id,
int flags)
H5Pset_elink_acc_flags Sets the external link traversal file access flag in a link access property list. |
static int |
H5Pset_elink_fapl(int lapl_id,
int fapl_id)
H5Pset_elink_fapl Sets a file access property list for use in accessing a file pointed to by an external link. |
static int |
H5Pset_elink_prefix(int lapl_id,
java.lang.String prefix)
H5Pset_elink_prefix Sets prefix to be applied to external link paths. |
static int |
H5Pset_est_link_info(int gcpl_id,
int est_num_entries,
int est_name_len)
H5Pset_est_link_info Sets estimated number of links and length of link names in a group. |
static int |
H5Pset_external(int plist,
java.lang.String name,
long offset,
long size)
H5Pset_external adds an external file to the list of external files. |
static int |
H5Pset_family_offset(int fapl_id,
long offset)
|
static int |
H5Pset_fapl_core(int fapl_id,
int increment,
boolean backing_store)
|
static int |
H5Pset_fapl_direct(int fapl_id,
int alignment,
int block_size,
int cbuf_size)
H5Pset_fapl_direct Sets up use of the direct I/O driver. |
static int |
H5Pset_fapl_family(int fapl_id,
long memb_size,
int memb_fapl_id)
|
static int |
H5Pset_fapl_log(int fapl_id,
java.lang.String logfile,
int flags,
int buf_size)
|
static int |
H5Pset_fclose_degree(int plist,
int degree)
|
static int |
H5Pset_fill_time(int plist_id,
int fill_time)
|
static int |
H5Pset_fill_value(int plist_id,
int type_id,
byte[] value)
H5Pset_fill_value sets the fill value for a dataset creation property list. |
static int |
H5Pset_fill_value(int plist_id,
int type_id,
java.lang.Object obj)
H5Pset_fill_value sets the fill value for a dataset creation property list. |
static int |
H5Pset_filter(int plist,
int filter,
int flags,
int cd_nelmts,
int[] cd_values)
H5Pset_filter adds the specified filter and corresponding properties to the end of an output filter pipeline. |
static int |
H5Pset_fletcher32(int plist)
|
static int |
H5Pset_gc_references(int fapl_id,
boolean gc_ref)
H5Pset_gc_references Sets the flag for garbage collecting references for the file. |
static int |
H5Pset_hyper_vector_size(int dxpl_id,
long vector_size)
|
static int |
H5Pset_istore_k(int plist,
int ik)
H5Pset_istore_k sets the size of the parameter used to control the B-trees for indexing chunked datasets. |
static int |
H5Pset_layout(int plist,
int layout)
H5Pset_layout sets the type of storage used store the raw data for a dataset. |
static int |
H5Pset_libver_bounds(int fapl_id,
int low,
int high)
H5Pset_libver_bounds Sets bounds on library versions, and indirectly format versions, to be used when creating objects |
static int |
H5Pset_link_creation_order(int gcpl_id,
int crt_order_flags)
H5Pset_link_creation_order Sets flags in a group creation property list, gcpl_id, for tracking and/or indexing links on creation order. |
static int |
H5Pset_link_phase_change(int gcpl_id,
int max_compact,
int min_dense)
H5Pset_link_phase_change Sets the parameters for conversion between compact and dense groups. |
static int |
H5Pset_local_heap_size_hint(int gcpl_id,
int size_hint)
H5Pset_local_heap_size_hint Specifies the anticipated maximum size of a local heap. |
static int |
H5Pset_nbit(int plist_id)
H5Pset_nbit Sets up the use of the N-Bit filter. |
static int |
H5Pset_nlinks(int lapl_id,
long nlinks)
H5Pset_nlinks sets the maximum number of soft or user-defined link traversals allowed, nlinks, before the library assumes it has found a cycle and aborts the traversal. |
static int |
H5Pset_preserve(int plist,
boolean status)
H5Pset_preserve sets the dataset transfer property list status to TRUE or FALSE. |
static int |
H5Pset_scaleoffset(int plist_id,
int scale_type,
int scale_factor)
H5Pset_scaleoffset sets the Scale-Offset filter for a dataset. |
static int |
H5Pset_shared_mesg_index(int fcpl_id,
int index_num,
int mesg_type_flags,
int min_mesg_size)
H5Pset_shared_mesg_index Configures the specified shared object header message index |
static int |
H5Pset_shared_mesg_nindexes(int plist_id,
int nindexes)
H5Pset_shared_mesg_nindexes sets the number of shared object header message indexes in the specified file creation property list. |
static int |
H5Pset_shared_mesg_phase_change(int fcpl_id,
int max_list,
int min_btree)
H5Pset_shared_mesg_phase_change sets shared object header message storage phase change thresholds. |
static int |
H5Pset_shuffle(int plist_id)
|
static int |
H5Pset_sizes(int plist,
int sizeof_addr,
int sizeof_size)
H5Pset_sizes sets the byte size of the offsets and lengths used to address objects in an HDF5 file. |
static int |
H5Pset_small_data_block_size(int plist,
long size)
H5Pset_small_data_block_size reserves blocks of size bytes for the contiguous storage of the raw data portion of small datasets. |
static int |
H5Pset_sym_k(int plist,
int ik,
int lk)
H5Pset_sym_k sets the size of parameters used to control the symbol table nodes. |
static int |
H5Pset_szip(int plist,
int options_mask,
int pixels_per_block)
|
static int |
H5Pset_userblock(int plist,
long size)
H5Pset_userblock sets the user block size of a file creation property list. |
static int |
H5Pset(int plid,
java.lang.String name,
int value)
Sets a property list value (support integer only) |
static int |
H5Punregister(int plid,
java.lang.String name)
H5Punregister removes a property from a property list class |
static byte[] |
H5Rcreate(int loc_id,
java.lang.String name,
int ref_type,
int space_id)
H5Rcreate creates the reference, ref, of the type specified in ref_type, pointing to the object name located at loc_id. |
static int |
H5Rdereference(int dataset,
int ref_type,
byte[] ref)
Given a reference to some object, H5Rdereference opens that object and return an identifier. |
static long |
H5Rget_name(int loc_id,
int ref_type,
byte[] ref,
java.lang.String[] name,
long size)
H5Rget_name retrieves a name for the object identified by ref. |
static int |
H5Rget_obj_type(int loc_id,
int ref_type,
byte[] ref)
Deprecated. As of HDF5 1.8, replaced by H5Rget_obj_type(int, int, byte[], int[]) |
static int |
H5Rget_obj_type(int loc_id,
int ref_type,
byte[] ref,
int[] obj_type)
H5Rget_obj_type Given a reference to an object ref, H5Rget_obj_type returns the type of the object pointed to. |
static int |
H5Rget_region(int loc_id,
int ref_type,
byte[] ref)
Given a reference to an object ref, H5Rget_region creates a copy of the dataspace of the dataset pointed to and defines a selection in the copy which is the region pointed to. |
static int |
H5Sclose(int space_id)
H5Sclose releases a dataspace. |
static int |
H5Scopy(int space_id)
H5Scopy creates a new dataspace which is an exact copy of the dataspace identified by space_id. |
static int |
H5Screate_simple(int rank,
byte[] dims,
byte[] maxdims)
Deprecated. use H5Screate_simple(int rank, long[] dims, long[] maxdims) |
static int |
H5Screate_simple(int rank,
long[] dims,
long[] maxdims)
H5Screate_simple creates a new simple data space and opens it for access. |
static int |
H5Screate(int type)
H5Screate creates a new dataspace of a particular type. |
static int |
H5Sdecode(byte[] buf)
H5Sdecode reconstructs the HDF5 data space object and returns a new object handle for it. |
static byte[] |
H5Sencode(int obj_id)
H5Sencode converts a data space description into binary form in a buffer. |
static int |
H5set_free_list_limits(int reg_global_lim,
int reg_list_lim,
int arr_global_lim,
int arr_list_lim,
int blk_global_lim,
int blk_list_lim)
|
static int |
H5Sextent_copy(int dest_space_id,
int source_space_id)
H5Sextent_copy copies the extent from source_space_id to dest_space_id. |
static boolean |
H5Sextent_equal(int first_space_id,
int second_space_id)
H5Sextent_equal determines whether the dataspace extents of two dataspaces, space1_id and space2_id, are equal. |
static int |
H5Sget_select_bounds(int spaceid,
long[] start,
long[] end)
H5Sget_select_bounds retrieves the coordinates of the bounding box containing the current selection and places them into user-supplied buffers. |
static long |
H5Sget_select_elem_npoints(int spaceid)
H5Sget_select_elem_npoints returns the number of element points in the current dataspace selection. |
static int |
H5Sget_select_elem_pointlist(int spaceid,
long startpoint,
long numpoints,
long[] buf)
H5Sget_select_elem_pointlist returns an array of of element points in the current dataspace selection. |
static int |
H5Sget_select_hyper_blocklist(int spaceid,
long startblock,
long numblocks,
long[] buf)
H5Sget_select_hyper_blocklist returns an array of hyperslab blocks. |
static long |
H5Sget_select_hyper_nblocks(int spaceid)
H5Sget_select_hyper_nblocks returns the number of hyperslab blocks in the current dataspace selection. |
static long |
H5Sget_select_npoints(int space_id)
H5Sget_select_npoints determines the number of elements in the current selection of a dataspace. |
static int |
H5Sget_simple_extent_dims(int space_id,
long[] dims,
long[] maxdims)
H5Sget_simple_extent_dims returns the size and maximum sizes of each dimension of a dataspace through the dims and maxdims parameters. |
static int |
H5Sget_simple_extent_ndims(int space_id)
H5Sget_simple_extent_ndims determines the dimensionality (or rank) of a dataspace. |
static long |
H5Sget_simple_extent_npoints(int space_id)
H5Sget_simple_extent_npoints determines the number of elements in a dataspace. |
static int |
H5Sget_simple_extent_type(int space_id)
H5Sget_simple_extent_type queries a dataspace to determine the current class of a dataspace. |
static boolean |
H5Sis_simple(int space_id)
H5Sis_simple determines whether a dataspace is a simple dataspace. |
static int |
H5Soffset_simple(int space_id,
byte[] offset)
H5Soffset_simple sets the offset of a simple dataspace space_id. |
static int |
H5Soffset_simple(int space_id,
long[] offset)
|
static int |
H5Sselect_all(int space_id)
H5Sselect_all selects the entire extent of the dataspace space_id. |
static int |
H5Sselect_elements(int space_id,
int op,
int num_elements,
long[][] coord2D)
H5Sselect_elements selects array elements to be included in the selection for the space_id dataspace. |
static int |
H5Sselect_hyperslab(int space_id,
int op,
byte[] start,
byte[] stride,
byte[] count,
byte[] block)
H5Sselect_hyperslab selects a hyperslab region to add to the current selected region for the dataspace specified by space_id. |
static int |
H5Sselect_hyperslab(int space_id,
int op,
long[] start,
long[] stride,
long[] count,
long[] block)
|
static int |
H5Sselect_none(int space_id)
H5Sselect_none resets the selection region for the dataspace space_id to include no elements. |
static boolean |
H5Sselect_valid(int space_id)
H5Sselect_valid verifies that the selection for the dataspace. |
static int |
H5Sset_extent_none(int space_id)
H5Sset_extent_none removes the extent from a dataspace and sets the type to H5S_NONE. |
static int |
H5Sset_extent_simple(int space_id,
int rank,
byte[] current_size,
byte[] maximum_size)
|
static int |
H5Sset_extent_simple(int space_id,
int rank,
long[] current_size,
long[] maximum_size)
H5Sset_extent_simple sets or resets the size of an existing dataspace. |
static int |
H5Tarray_create(int base,
int rank,
int[] dims,
int[] perms)
Deprecated. As of HDF5 1.8, replaced by H5Tarray_create(int, int, long[]) |
static int |
H5Tarray_create(int base_id,
int ndims,
long[] dim)
H5Tarray_create creates a new array datatype object. |
static int |
H5Tclose(int type_id)
H5Tclose releases a datatype. |
static void |
H5Tcommit_anon(int loc_id,
int type_id,
int tcpl_id,
int tapl_id)
H5Tcommit_anon commits a transient datatype (not immutable) to a file, turning it into a named datatype with the specified creation and property lists. |
static int |
H5Tcommit(int loc_id,
java.lang.String name,
int type)
Deprecated. As of HDF5 1.8, replaced by H5Tcommit(int, String, int, int, int, int) |
static void |
H5Tcommit(int loc_id,
java.lang.String name,
int type_id,
int lcpl_id,
int tcpl_id,
int tapl_id)
H5Tcommit saves a transient datatype as an immutable named datatype in a file. |
static int |
H5Tcommit1(int loc_id,
java.lang.String name,
int type)
|
static boolean |
H5Tcommitted(int type)
H5Tcommitted queries a type to determine whether the type specified by the type identifier is a named type or a transient type. |
static void |
H5Tcompiler_conv(int src_id,
int dst_id)
H5Tcompiler_conv finds out whether the library's conversion function from type src_id to type dst_id is a compiler (hard) conversion. |
static void |
H5Tconvert(int src_id,
int dst_id,
long nelmts,
byte[] buf,
byte[] background,
int plist_id)
H5Tconvert converts nelmts elements from the type specified by the src_id identifier to type dst_id. |
static int |
H5Tcopy(int type_id)
H5Tcopy copies an existing datatype. |
static int |
H5Tcreate(int dclass,
int size)
H5Tcreate creates a new dataype of the specified class with the specified number of bytes. |
static int |
H5Tcreate(int type,
long size)
H5Tcreate creates a new dataype of the specified class with the specified number of bytes. |
static int |
H5Tdecode(byte[] buf)
H5Tdecode reconstructs the HDF5 data type object and returns a new object handle for it. |
static boolean |
H5Tdetect_class(int type_id,
int cls)
H5Tdetect_class determines whether the datatype specified in dtype_id contains any datatypes of the datatype class specified in dtype_class. |
static int |
H5Tencode(int obj_id,
byte[] buf,
long nalloc)
H5Tencode converts a data type description into binary form in a buffer. |
static int |
H5Tenum_create(int base_id)
H5Tenum_create creates a new enumeration datatype based on the specified base datatype, parent_id, which must be an integer type. |
static void |
H5Tenum_insert(int type,
java.lang.String name,
byte[] value)
H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype. |
static int |
H5Tenum_insert(int type,
java.lang.String name,
int value)
|
static int |
H5Tenum_insert(int type,
java.lang.String name,
int[] value)
H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype. |
static java.lang.String |
H5Tenum_nameof(int type,
byte[] value,
long size)
H5Tenum_nameof finds the symbol name that corresponds to the specified value of the enumeration datatype type. |
static int |
H5Tenum_nameof(int type,
int[] value,
java.lang.String[] name,
int size)
H5Tenum_nameof finds the symbol name that corresponds to the specified value of the enumeration datatype type. |
static void |
H5Tenum_valueof(int type,
java.lang.String name,
byte[] value)
H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype type. |
static int |
H5Tenum_valueof(int type,
java.lang.String name,
int[] value)
H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype type. |
static boolean |
H5Tequal(int type_id1,
int type_id2)
H5Tequal determines whether two datatype identifiers refer to the same datatype. |
static int |
H5Tget_array_dims(int dt,
int[] dims,
int[] perms)
Deprecated. As of HDF5 1.8 |
static int |
H5Tget_array_dims(int type_id,
long[] dims)
H5Tget_array_dims returns the sizes of the dimensions of the specified array datatype object. |
static int |
H5Tget_array_dims(int type_id,
long[] dims,
int[] perm)
Deprecated. As of HDF5 1.8, replaced by H5Tget_array_dims(int, long[]) |
static int |
H5Tget_array_dims2(int type_id,
long[] dims)
H5Tget_array_dims2 returns the sizes of the dimensions of the specified array datatype object. |
static int |
H5Tget_array_ndims(int type_id)
H5Tget_array_ndims returns the rank, the number of dimensions, of an array datatype object. |
static java.lang.String |
H5Tget_class_name(int class_id)
H5Tget_class_name returns the datatype class identifier. |
static int |
H5Tget_class(int type_id)
H5Tget_class returns the datatype class identifier. |
static int |
H5Tget_create_plist(int type_id)
H5Tget_create_plist returns a property list identifier for the datatype creation property list associated with the datatype specified by type_id. |
static int |
H5Tget_cset(int type_id)
H5Tget_cset retrieves the character set type of a string datatype. |
static long |
H5Tget_ebias_long(int type_id)
H5Tget_ebias retrieves the exponent bias of a floating-point type. |
static int |
H5Tget_ebias(int type_id)
H5Tget_ebias retrieves the exponent bias of a floating-point type. |
static int |
H5Tget_fields(int type_id,
int[] fields)
H5Tget_fields retrieves information about the locations of the various bit fields of a floating point datatype. |
static void |
H5Tget_fields(int type_id,
long[] fields)
H5Tget_fields retrieves information about the locations of the various bit fields of a floating point datatype. |
static int |
H5Tget_inpad(int type_id)
H5Tget_inpad retrieves the internal padding type for unused bits in floating-point datatypes. |
static int |
H5Tget_member_class(int type_id,
int membno)
H5Tget_member_class returns the datatype of the specified member. |
static int |
H5Tget_member_index(int type_id,
java.lang.String field_name)
H5Tget_member_index retrieves the index of a field of a compound datatype. |
static java.lang.String |
H5Tget_member_name(int type_id,
int field_idx)
H5Tget_member_name retrieves the name of a field of a compound datatype or an element of an enumeration datatype. |
static long |
H5Tget_member_offset(int type_id,
int membno)
H5Tget_member_offset returns the byte offset of the specified member of the compound datatype. |
static int |
H5Tget_member_type(int type_id,
int field_idx)
H5Tget_member_type returns the datatype of the specified member. |
static void |
H5Tget_member_value(int type_id,
int membno,
byte[] value)
H5Tget_member_value returns the value of the enumeration datatype member memb_no. |
static int |
H5Tget_member_value(int type_id,
int membno,
int[] value)
H5Tget_member_value returns the value of the enumeration datatype member memb_no. |
static int |
H5Tget_native_type(int tid)
H5Tget_native_type returns the equivalent native datatype for the datatype specified in type_id. |
static int |
H5Tget_native_type(int tid,
int direction)
H5Tget_native_type returns the equivalent native datatype for the datatype specified in type_id. |
static int |
H5Tget_nmembers(int type_id)
H5Tget_nmembers retrieves the number of fields a compound datatype has. |
static int |
H5Tget_norm(int type_id)
H5Tget_norm retrieves the mantissa normalization of a floating-point datatype. |
static int |
H5Tget_offset(int type_id)
H5Tget_offset retrieves the bit offset of the first significant bit. |
static int |
H5Tget_order(int type_id)
H5Tget_order returns the byte order of an atomic datatype. |
static int |
H5Tget_pad(int type_id,
int[] pad)
H5Tget_pad retrieves the padding type of the least and most-significant bit padding. |
static long |
H5Tget_precision_long(int type_id)
H5Tget_precision returns the precision of an atomic datatype. |
static int |
H5Tget_precision(int type_id)
H5Tget_precision returns the precision of an atomic datatype. |
static int |
H5Tget_sign(int type_id)
H5Tget_sign retrieves the sign type for an integer type. |
static long |
H5Tget_size_long(int type_id)
H5Tget_size returns the size of a datatype in bytes. |
static int |
H5Tget_size(int type_id)
H5Tget_size returns the size of a datatype in bytes. |
static int |
H5Tget_strpad(int type_id)
H5Tget_strpad retrieves the string padding method for a string datatype. |
static int |
H5Tget_super(int type)
H5Tget_super returns the type from which TYPE is derived. |
static java.lang.String |
H5Tget_tag(int type)
H5Tget_tag returns the tag associated with datatype type_id. |
static int |
H5Tinsert(int type_id,
java.lang.String name,
long offset,
int field_id)
H5Tinsert adds another member to the compound datatype type_id. |
static boolean |
H5Tis_variable_str(int type_id)
H5Tis_variable_str determines whether the datatype identified in type_id is a variable-length string. |
static int |
H5Tlock(int type_id)
H5Tlock locks the datatype specified by the type_id identifier, making it read-only and non-destrucible. |
static int |
H5Topen(int loc_id,
java.lang.String name)
Deprecated. As of HDF5 1.8, replaced by H5Topen(int, String, int) |
static int |
H5Topen(int loc_id,
java.lang.String name,
int tapl_id)
H5Topen opens a named datatype at the location specified by loc_id and return an identifier for the datatype. |
static int |
H5Tpack(int type_id)
H5Tpack recursively removes padding from within a compound datatype to make it more efficient (space-wise) to store that data. |
static int |
H5Tset_cset(int type_id,
int cset)
H5Tset_cset the character set to be used. |
static int |
H5Tset_ebias(int type_id,
int ebias)
H5Tset_ebias sets the exponent bias of a floating-point type. |
static void |
H5Tset_ebias(int type_id,
long ebias)
H5Tset_ebias sets the exponent bias of a floating-point type. |
static int |
H5Tset_fields(int type_id,
int spos,
int epos,
int esize,
int mpos,
int msize)
H5Tset_fields sets the locations and sizes of the various floating point bit fields. |
static void |
H5Tset_fields(int type_id,
long spos,
long epos,
long esize,
long mpos,
long msize)
H5Tset_fields sets the locations and sizes of the various floating point bit fields. |
static int |
H5Tset_inpad(int type_id,
int inpad)
If any internal bits of a floating point type are unused (that is, those significant bits which are not part of the sign, exponent, or mantissa), then H5Tset_inpad will be filled according to the value of the padding value property inpad. |
static int |
H5Tset_norm(int type_id,
int norm)
H5Tset_norm sets the mantissa normalization of a floating-point datatype. |
static int |
H5Tset_offset(int type_id,
int offset)
H5Tset_offset sets the bit offset of the first significant bit. |
static void |
H5Tset_offset(int type_id,
long offset)
H5Tset_offset sets the bit offset of the first significant bit. |
static int |
H5Tset_order(int type_id,
int order)
H5Tset_order sets the byte ordering of an atomic datatype. |
static int |
H5Tset_pad(int type_id,
int lsb,
int msb)
H5Tset_pad sets the least and most-significant bits padding types. |
static int |
H5Tset_precision(int type_id,
int precision)
H5Tset_precision sets the precision of an atomic datatype. |
static void |
H5Tset_precision(int type_id,
long precision)
H5Tset_precision sets the precision of an atomic datatype. |
static int |
H5Tset_sign(int type_id,
int sign)
H5Tset_sign sets the sign proprety for an integer type. |
static int |
H5Tset_size(int type_id,
int size)
H5Tset_size sets the total size in bytes, size, for an atomic datatype (this operation is not permitted on compound datatypes). |
static void |
H5Tset_size(int type_id,
long size)
H5Tset_size sets the total size in bytes, size, for an atomic datatype (this operation is not permitted on compound datatypes). |
static int |
H5Tset_strpad(int type_id,
int strpad)
H5Tset_strpad defines the storage mechanism for the string. |
static int |
H5Tset_tag(int type,
java.lang.String tag)
H5Tset_tag tags an opaque datatype type_id with a unique ASCII identifier tag. |
static int |
H5Tvlen_create(int base_id)
H5Tvlen_create creates a new variable-length (VL) dataype. |
static int |
H5Zfilter_avail(int filter)
|
static int |
H5Zget_filter_info(int filter)
|
static int |
H5Zunregister(int filter)
|
static void |
loadH5Lib()
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int[] LIB_VERSION
public static final java.lang.String H5PATH_PROPERTY_KEY
public static final java.lang.String H5_LIBRARY_NAME_PROPERTY_KEY
public static int LOGGING_LEVEL
| Constructor Detail |
|---|
public H5()
| Method Detail |
|---|
public static void loadH5Lib()
public static int H5error_off()
public static final int getOpenIDCount()
public static final int getOpenID(int index)
index - -- an index of the open ID.
public static int H5open()
throws HDF5LibraryException
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5close()
throws HDF5LibraryException
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5get_libversion(int[] libversion)
throws HDF5LibraryException
libversion - The version information of the HDF library.
libversion[0] = The major version of the library.
libversion[1] = The minor version of the library.
libversion[2] = The release number of the library.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5check_version(int majnum,
int minnum,
int relnum)
majnum - The major version of the library.minnum - The minor version of the library.relnum - The release number of the library.
public static int H5garbage_collect()
throws HDF5LibraryException
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Eclear()
throws HDF5LibraryException
This may be used by exception handlers to assure that the error condition in the HDF-5 library has been reset.
HDF5LibraryException - - Error from the HDF-5 Library.
@Deprecated
public static int H5Acreate(int loc_id,
java.lang.String name,
int type_id,
int space_id,
int create_plist)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Acreate( int, String, int, int, int, int)
loc_id - IN: Object (dataset, group, or named datatype) to be attached
to.name - IN: Name of attribute to create.type_id - IN: Identifier of datatype for attribute.space_id - IN: Identifier of dataspace for attribute.create_plist - IN: Identifier of creation property list (currently not used).
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
@Deprecated
public static int H5Aopen_name(int loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Aopen_by_name(int, String, String, int, int)
loc_id - IN: Identifier of a group, dataset, or named datatype
atttributename - IN: Attribute name.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
@Deprecated
public static int H5Aopen_idx(int loc_id,
int idx)
throws HDF5LibraryException
H5Aopen_by_idx(int, String, int, int, long, int, int)
loc_id - IN: Identifier of the group, dataset, or named datatype
attributeidx - IN: Index of the attribute to open.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Awrite(int attr_id,
int mem_type_id,
byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
attr_id - IN: Identifier of an attribute to write.mem_type_id - IN: Identifier of the attribute datatype (in memory).buf - IN: Data to be written.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - data is null.
public static int H5Awrite(int attr_id,
int mem_type_id,
java.lang.Object obj)
throws HDF5Exception,
java.lang.NullPointerException
attr_id - IN: Identifier of an attribute to write.mem_type_id - IN: Identifier of the attribute datatype (in memory).obj - IN: Data object to be written.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - data object is null. See public synchronized static
native int H5Awrite(int attr_id, int mem_type_id, byte[]
buf);
HDF5Exception
public static int H5Acopy(int src_aid,
int dst_aid)
throws HDF5LibraryException
src_aid - the identifier of the source attributedst_aid - the identifier of the destinaiton attribute
HDF5LibraryException
public static int H5Aread(int attr_id,
int mem_type_id,
byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
attr_id - IN: Identifier of an attribute to read.mem_type_id - IN: Identifier of the attribute datatype (in memory).buf - IN: Buffer for data to be read.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - data buffer is null.
public static int H5Aread(int attr_id,
int mem_type_id,
java.lang.Object obj)
throws HDF5Exception,
java.lang.NullPointerException
attr_id - IN: Identifier of an attribute to read.mem_type_id - IN: Identifier of the attribute datatype (in memory).obj - IN: Object for data to be read.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - data buffer is null. See public synchronized static
native int H5Aread( )
HDF5Exception
public static int H5AreadVL(int attr_id,
int mem_type_id,
java.lang.String[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Aget_space(int attr_id)
throws HDF5LibraryException
attr_id - IN: Identifier of an attribute.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Aget_type(int attr_id)
throws HDF5LibraryException
attr_id - IN: Identifier of an attribute.
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Aget_name(int attr_id,
long buf_size,
java.lang.String[] name)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.ArrayStoreException,
HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
attr_id - IN: Identifier of the attribute.buf_size - IN: The size of the buffer to store the name in.name - OUT: Buffer to store name in.
java.lang.ArrayIndexOutOfBoundsException - JNI error writing back array
java.lang.ArrayStoreException - JNI error writing back array
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
java.lang.IllegalArgumentException - - bub_size <= 0.
public static long H5Aget_name(int attr_id,
java.lang.String[] name)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.ArrayStoreException,
HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
java.lang.ArrayIndexOutOfBoundsException
java.lang.ArrayStoreException
HDF5LibraryException
java.lang.NullPointerException
java.lang.IllegalArgumentException
@Deprecated
public static int H5Aget_num_attrs(int loc_id)
throws HDF5LibraryException
H5Oget_info( int )
loc_id - IN: Identifier of a group, dataset, or named datatype.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Adelete(int loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Identifier of the dataset, group, or named datatype.name - IN: Name of the attribute to delete.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Aclose(int attr_id)
throws HDF5LibraryException
attr_id - IN: Attribute to release access to.
HDF5LibraryException - - Error from the HDF-5 Library.
@Deprecated
public static int H5Dcreate(int loc_id,
java.lang.String name,
int type_id,
int space_id,
int create_plist_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Dcreate(int, String, int, int, int, int, int)
loc_id - Identifier of the file or group to create the dataset within.name - The name of the dataset to create.type_id - Identifier of the datatype to use when creating the dataset.space_id - Identifier of the dataspace to use when creating the dataset.create_plist_id - Identifier of the set creation property list.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
@Deprecated
public static int H5Dopen(int loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Dopen(int, String, int)
loc_id - IN: Location identifiername - IN: Dataset name
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Dchdir_ext(java.lang.String dir_name)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dgetdir_ext(java.lang.String[] dir_name,
int size)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dget_space(int dataset_id)
throws HDF5LibraryException
dataset_id - Identifier of the dataset to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Dget_type(int dataset_id)
throws HDF5LibraryException
dataset_id - Identifier of the dataset to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Dget_create_plist(int dataset_id)
throws HDF5LibraryException
dataset_id - Identifier of the dataset to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
dataset_id - Identifier of the dataset read from.mem_type_id - Identifier of the memory datatype.mem_space_id - Identifier of the memory dataspace.file_space_id - Identifier of the dataset's dataspace in the file.xfer_plist_id - Identifier of a transfer property list for this I/O operation.buf - Buffer to store data read from the file.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - data buffer is null.
public static int H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5DreadVL(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj,
boolean isCriticalPinning)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
dataset_id - Identifier of the dataset read from.mem_type_id - Identifier of the memory datatype.mem_space_id - Identifier of the memory dataspace.file_space_id - Identifier of the dataset's dataspace in the file.xfer_plist_id - Identifier of a transfer property list for this I/O operation.obj - Object to store data read from the file.
HDF5Exception - - Failure in the data conversion.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - data object is null.
public static int H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
HDF5Exception
HDF5LibraryException
java.lang.NullPointerException
public static int H5DwriteString(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.String[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
dataset_id - Identifier of the dataset read from.mem_type_id - Identifier of the memory datatype.mem_space_id - Identifier of the memory dataspace.file_space_id - Identifier of the dataset's dataspace in the file.xfer_plist_id - Identifier of a transfer property list for this I/O operation.buf - Buffer with data to be written to the file.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
dataset_id - Identifier of the dataset read from.mem_type_id - Identifier of the memory datatype.mem_space_id - Identifier of the memory dataspace.file_space_id - Identifier of the dataset's dataspace in the file.xfer_plist_id - Identifier of a transfer property list for this I/O operation.buf - Buffer with data to be written to the file.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj,
boolean isCriticalPinning)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
dataset_id - Identifier of the dataset read from.mem_type_id - Identifier of the memory datatype.mem_space_id - Identifier of the memory dataspace.file_space_id - Identifier of the dataset's dataspace in the file.xfer_plist_id - Identifier of a transfer property list for this I/O operation.obj - Object with data to be written to the file.
HDF5Exception - - Failure in the data conversion.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - data object is null.
public static int H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
HDF5Exception
HDF5LibraryException
java.lang.NullPointerException
@Deprecated
public static int H5Dextend(int dataset_id,
byte[] size)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Dset_extent(int, long[])
dataset_id - IN: Identifier of the dataset.size - IN: Array containing the new magnitude of each dimension.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size array is null.
@Deprecated
public static int H5Dextend(int dataset_id,
long[] size)
throws HDF5Exception,
java.lang.NullPointerException
H5Dset_extent(int, long[])
dataset_id - IN: Identifier of the dataset.size - IN: Array containing the new magnitude of each dimension.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size array is null.
HDF5Exception
public static int H5Dclose(int dataset_id)
throws HDF5LibraryException
dataset_id - Identifier of the dataset to finish access to.
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Dget_storage_size(int dataset_id)
throws HDF5LibraryException
dataset_id - Identifier of the dataset in question
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Dcopy(int src_did,
int dst_did)
throws HDF5LibraryException
src_did - the identifier of the source datasetdst_did - the identifier of the destinaiton dataset
HDF5LibraryException
public static int H5Dvlen_get_buf_size(int dataset_id,
int type_id,
int space_id,
int[] size)
throws HDF5LibraryException
HDF5LibraryException
public static int H5Dvlen_reclaim(int type_id,
int space_id,
int xfer_plist_id,
byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - buf is null.
public static int H5Fopen(java.lang.String name,
int flags,
int access_id)
throws HDF5LibraryException,
java.lang.NullPointerException
name - Name of the file to access.flags - File access flags.access_id - Identifier for the file access properties list.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Fcreate(java.lang.String name,
int flags,
int create_id,
int access_id)
throws HDF5LibraryException,
java.lang.NullPointerException
name - Name of the file to access.flags - File access flags. Possible values include:
create_id - File creation property list identifier, used when modifying
default file meta-data. Use H5P_DEFAULT for default access
properties.access_id - File access property list identifier. If parallel file access
is desired, this is a collective call according to the
communicator stored in the access_id (not supported in Java).
Use H5P_DEFAULT for default access properties.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Fflush(int object_id,
int scope)
throws HDF5LibraryException
After this call completes, the file (or object) is in a consistent state and all data written to date is assured to be permanent.
object_id - Identifier of object used to identify the file.
object_id can be any object associated with the file,
including the file itself, a dataset, a group, an attribute,
or a named data type.scope - specifies the scope of the flushing action, in the case that
the HDF-5 file is not a single physical file.
Valid values are:
HDF5LibraryException - - Error from the HDF-5 Library.
public static boolean H5Fis_hdf5(java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
name - File name to check format.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Fget_create_plist(int file_id)
throws HDF5LibraryException
file_id - Identifier of the file to get creation property list
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Fget_access_plist(int file_id)
throws HDF5LibraryException
file_id - Identifier of file to get access property list of
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Fclose(int file_id)
throws HDF5LibraryException
file_id - Identifier of a file to terminate access to.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Fmount(int loc_id,
java.lang.String name,
int child_id,
int plist_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - The identifier for the group onto which the file specified by
child_id is to be mounted.name - The name of the group onto which the file specified by
child_id is to be mounted.child_id - The identifier of the file to be mounted.plist_id - The identifier of the property list to be used.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Funmount(int loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - The identifier for the location at which the specified file is
to be unmounted.name - The name of the file to be unmounted.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Freopen(int file_id)
throws HDF5LibraryException
file_id - Identifier of a file to terminate and reopen access to.
HDF5LibraryException - - Error from the HDF-5 Library.
@Deprecated
public static int H5Gcreate(int loc_id,
java.lang.String name,
long size_hint)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Gcreate(int, String, int, int, int)
loc_id - The file or group identifier.name - The absolute or relative name of the new group.size_hint - An optional parameter indicating the number of bytes to
reserve for the names that will appear in the group.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
@Deprecated
public static int H5Gopen(int loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Gopen(int, String, int)
loc_id - File or group identifier within which group is to be open.name - Name of group to open.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Gclose(int group_id)
throws HDF5LibraryException
group_id - Group identifier to release.
HDF5LibraryException - - Error from the HDF-5 Library.
@Deprecated
public static int H5Glink(int loc_id,
int link_type,
java.lang.String current_name,
java.lang.String new_name)
throws HDF5LibraryException,
java.lang.NullPointerException
and #H5Lcreate_soft(String, int, String, int, int)
loc_id - File, group, dataset, or datatype identifier.link_type - Link type. Possible values are:
current_name - A name of the existing object if link is a hard link. Can be
anything for the soft link.new_name - New name for the object.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - current_name or name is null.
@Deprecated
public static int H5Glink2(int curr_loc_id,
java.lang.String current_name,
int link_type,
int new_loc_id,
java.lang.String new_name)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
@Deprecated
public static int H5Gunlink(int loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Ldelete(int, String, int)
loc_id - Identifier of the file containing the object.name - Name of the object to unlink.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
@Deprecated
public static int H5Gmove(int loc_id,
java.lang.String src,
java.lang.String dst)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lmove(int, String, int,String, int, int)
loc_id - File or group identifier.src - Object's original name.dst - Object's new name.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - src or dst is null.
@Deprecated
public static int H5Gget_linkval(int loc_id,
java.lang.String name,
int size,
java.lang.String[] value)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.ArrayStoreException,
HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Lget_val(int, String, String[] , int)
loc_id - IN: Identifier of the file, group, dataset, or datatype.name - IN: Name of the object whose link value is to be checked.size - IN: Maximum number of characters of value to be returned.value - OUT: Link value.
java.lang.ArrayIndexOutOfBoundsException - Copy back failed
java.lang.ArrayStoreException - Copy back failed
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
java.lang.IllegalArgumentException - - size is invalid
@Deprecated
public static int H5Gset_comment(int loc_id,
java.lang.String name,
java.lang.String comment)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Oset_comment(int, String)
loc_id - IN: Identifier of the file, group, dataset, or datatype.name - IN: Name of the object whose comment is to be set or reset.comment - IN: The new comment.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name or comment is null.
@Deprecated
public static int H5Gget_comment(int loc_id,
java.lang.String name,
int bufsize,
java.lang.String[] comment)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.ArrayStoreException,
HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Oget_comment(int)
loc_id - IN: Identifier of the file, group, dataset, or datatype.name - IN: Name of the object whose comment is to be set or reset.bufsize - IN: Anticipated size of the buffer required to hold comment.comment - OUT: The comment.
java.lang.ArrayIndexOutOfBoundsException - - JNI error writing back data
java.lang.ArrayStoreException - - JNI error writing back data
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
java.lang.IllegalArgumentException - - size < 1, comment is invalid.
public static int H5Iget_type(int obj_id)
throws HDF5LibraryException
obj_id - IN: Object identifier whose type is to be determined.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pcreate(int type)
throws HDF5LibraryException
type - IN: The type of property list to create.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pclose(int plist)
throws HDF5LibraryException
plist - IN: Identifier of the property list to terminate access to.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_class(int plist)
throws HDF5LibraryException
plist - IN: Identifier of property list to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pcopy(int plist)
throws HDF5LibraryException
plist - IN: Identifier of property list to duplicate.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_version(int plist,
int[] version_info)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
plist - IN: Identifier of the file creation property list.version_info - OUT: version information.
version_info[0] = boot // boot block version number
version_info[1] = freelist // global freelist version
version_info[2] = stab // symbol tabl version number
version_info[3] = shhdr // hared object header version
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - version_info is null.
java.lang.IllegalArgumentException - - version_info is illegal.
public static int H5Pset_userblock(int plist,
long size)
throws HDF5LibraryException
plist - IN: Identifier of property list to modify.size - IN: Size of the user-block in bytes.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_userblock(int plist,
long[] size)
throws HDF5LibraryException,
java.lang.NullPointerException
plist - IN: Identifier for property list to query.size - OUT: Pointer to location to return user-block size.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size is null.
public static int H5Pset_small_data_block_size(int plist,
long size)
throws HDF5LibraryException
plist - IN: Identifier of property list to modify.size - IN: Size of the blocks in bytes.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_small_data_block_size(int plist,
long[] size)
throws HDF5LibraryException,
java.lang.NullPointerException
plist - IN: Identifier for property list to query.size - OUT: Pointer to location to return block size.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size is null.
public static int H5Pset_sizes(int plist,
int sizeof_addr,
int sizeof_size)
throws HDF5LibraryException
plist - IN: Identifier of property list to modify.sizeof_addr - IN: Size of an object offset in bytes.sizeof_size - IN: Size of an object length in bytes.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_sizes(int plist,
int[] size)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
plist - IN: Identifier of property list to query.size - OUT: the size of the offsets and length.
size[0] = sizeof_addr // offset size in bytes
size[1] = sizeof_size // length size in bytes
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size is null.
java.lang.IllegalArgumentException - - size is invalid.
public static int H5Pset_sym_k(int plist,
int ik,
int lk)
throws HDF5LibraryException
plist - IN: Identifier for property list to query.ik - IN: Symbol table tree rank.lk - IN: Symbol table node size.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_sym_k(int plist,
int[] size)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
plist - IN: Property list to query.size - OUT: the symbol table's B-tree 1/2 rank and leaf node 1/2
size.
size[0] = ik // the symbol table's B-tree 1/2 rank
size[1] = lk // leaf node 1/2 size
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size is null.
java.lang.IllegalArgumentException - - size is invalid.
public static int H5Pset_istore_k(int plist,
int ik)
throws HDF5LibraryException
plist - IN: Identifier of property list to query.ik - IN: 1/2 rank of chunked storage B-tree.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_istore_k(int plist,
int[] ik)
throws HDF5LibraryException,
java.lang.NullPointerException
plist - IN: Identifier of property list to query.ik - OUT: Pointer to location to return the chunked storage B-tree
1/2 rank.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - ik array is null.
public static int H5Pset_layout(int plist,
int layout)
throws HDF5LibraryException
plist - IN: Identifier of property list to query.layout - IN: Type of storage layout for raw data.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_layout(int plist)
throws HDF5LibraryException
plist - IN: Identifier for property list to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_chunk(int plist,
int ndims,
byte[] dim)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
plist - IN: Identifier for property list to query.ndims - IN: The number of dimensions of each chunk.dim - IN: An array containing the size of each chunk.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - dims array is null.
java.lang.IllegalArgumentException - - dims <=0
public static int H5Pset_chunk(int plist,
int ndims,
long[] dim)
throws HDF5Exception,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
HDF5Exception
java.lang.NullPointerException
java.lang.IllegalArgumentException
public static int H5Pget_chunk(int plist,
int max_ndims,
long[] dims)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
plist - IN: Identifier of property list to query.max_ndims - IN: Size of the dims array.dims - OUT: Array to store the chunk dimensions.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - dims array is null.
java.lang.IllegalArgumentException - - max_ndims <=0
public static int H5Pset_alignment(int plist,
long threshold,
long alignment)
throws HDF5LibraryException
plist - IN: Identifier for a file access property list.threshold - IN: Threshold value.alignment - IN: Alignment value.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_alignment(int plist,
long[] alignment)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
plist - IN: Identifier of a file access property list.alignment - OUT: threshold value and alignment value.
alignment[0] = threshold // threshold value
alignment[1] = alignment // alignment value
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - aligment array is null.
java.lang.IllegalArgumentException - - aligment array is invalid.
public static int H5Pset_external(int plist,
java.lang.String name,
long offset,
long size)
throws HDF5LibraryException,
java.lang.NullPointerException
plist - IN: Identifier of a dataset creation property list.name - IN: Name of an external file.offset - IN: Offset, in bytes, from the beginning of the file to the
location in the file where the data starts.size - IN: Number of bytes reserved in the file for the data.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Pget_external_count(int plist)
throws HDF5LibraryException
plist - IN: Identifier of a dataset creation property list.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_external(int plist,
int idx,
int name_size,
java.lang.String[] name,
long[] size)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.ArrayStoreException,
HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
plist - IN: Identifier of a dataset creation property list.idx - IN: External file index.name_size - IN: Maximum length of name array.name - OUT: Name of the external file.size - OUT: the offset value and the size of the external file data.
size[0] = offset // a location to return an offset value
size[1] = size // a location to return the size of
// the external file data.
java.lang.ArrayIndexOutOfBoundsException - Fatal error on Copyback
java.lang.ArrayStoreException - Fatal error on Copyback
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name or size is null.
java.lang.IllegalArgumentException - - name_size <= 0 .
public static int H5Pset_fill_value(int plist_id,
int type_id,
byte[] value)
throws HDF5Exception
plist_id - IN: Property list identifier.type_id - IN: The datatype identifier of value.value - IN: The fill value.
HDF5Exception - - Error converting data array
public static int H5Pset_fill_value(int plist_id,
int type_id,
java.lang.Object obj)
throws HDF5Exception
plist_id - IN: Property list identifier.type_id - IN: The datatype identifier of value.obj - IN: The fill value.
HDF5Exception - - Error converting data array
public static int H5Pget_fill_value(int plist_id,
int type_id,
byte[] value)
throws HDF5Exception
plist_id - IN: Property list identifier.type_id - IN: The datatype identifier of value.value - IN: The fill value.
HDF5Exception
public static int H5Pget_fill_value(int plist_id,
int type_id,
java.lang.Object obj)
throws HDF5Exception
plist_id - IN: Property list identifier.type_id - IN: The datatype identifier of value.obj - IN: The fill value.
HDF5Exception
public static int H5Pset_filter(int plist,
int filter,
int flags,
int cd_nelmts,
int[] cd_values)
throws HDF5LibraryException
plist - IN: Property list identifier.filter - IN: Filter to be added to the pipeline.flags - IN: Bit vector specifying certain general properties of the
filter.cd_nelmts - IN: Number of elements in cd_valuescd_values - IN: Auxiliary data for the filter.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_nfilters(int plist)
throws HDF5LibraryException
plist - IN: Property list identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
@Deprecated
public static int H5Pget_filter(int plist,
int filter_number,
int[] flags,
int[] cd_nelmts,
int[] cd_values,
int namelen,
java.lang.String[] name)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.ArrayStoreException,
HDF5LibraryException,
java.lang.NullPointerException
H5Pget_filter(int, int, int[], int[], int[], int, String[], int[])
plist - IN: Property list identifier.filter_number - IN: Sequence number within the filter pipeline of the filter
for which information is sought.flags - OUT: Bit vector specifying certain general properties of the
filter.cd_nelmts - IN/OUT: Number of elements in cd_valuescd_values - OUT: Auxiliary data for the filter.namelen - IN: Anticipated number of characters in name.name - OUT: Name of the filter.
java.lang.ArrayIndexOutOfBoundsException - Fatal error on Copyback
java.lang.ArrayStoreException - Fatal error on Copyback
java.lang.NullPointerException - - name or an array is null.
HDF5LibraryException
public static int H5Pset_cache(int plist,
int mdc_nelmts,
int rdcc_nelmts,
int rdcc_nbytes,
double rdcc_w0)
throws HDF5LibraryException
plist - IN: Identifier of the file access property list.mdc_nelmts - IN: Number of elements (objects) in the meta data cache.rdcc_nbytes - IN: Total size of the raw data chunk cache, in bytes.rdcc_w0 - IN: Preemption policy.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_cache(int plist,
int[] mdc_nelmts,
int[] rdcc_nelmts,
int[] rdcc_nbytes,
double[] rdcc_w0)
throws HDF5LibraryException,
java.lang.NullPointerException
plist - IN: Identifier of the file access property list.mdc_nelmts - IN/OUT: Number of elements (objects) in the meta data cache.rdcc_nbytes - IN/OUT: Total size of the raw data chunk cache, in bytes.rdcc_w0 - IN/OUT: Preemption policy.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - an array is null.
public static int H5Pset_buffer(int plist,
int size,
byte[] tconv,
byte[] bkg)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
plist - Identifier for the dataset transfer property list.size - Size, in bytes, of the type conversion and background buffers.tconv - byte array of application-allocated type conversion buffer.bkg - byte array of application-allocated background buffer.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - plist is invalid.
public static int H5Pget_buffer(int plist,
byte[] tconv,
byte[] bkg)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
plist - Identifier for the dataset transfer property list.tconv - byte array of application-allocated type conversion buffer.bkg - byte array of application-allocated background buffer.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - plist is invalid.
public static int H5Pset_preserve(int plist,
boolean status)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
plist - IN: Identifier for the dataset transfer property list.status - IN: Status of for the dataset transfer property list.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - plist is invalid.
public static int H5Pget_preserve(int plist)
throws HDF5LibraryException
plist - IN: Identifier for the dataset transfer property list.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_deflate(int plist,
int level)
throws HDF5LibraryException
plist - IN: Identifier for the dataset creation property list.level - IN: Compression level.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_gc_references(int fapl_id,
boolean gc_ref)
throws HDF5LibraryException
fapl_id - IN File access property listgc_ref - IN set GC on (true) or off (false)
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_gc_references(int fapl_id,
boolean[] gc_ref)
throws HDF5LibraryException,
java.lang.NullPointerException
Note: this routine changed name with HDF5.1.2.2. If using an earlier version, use 'configure --enable-hdf5_1_2_1' so this routine will link to the old name.
fapl_id - IN File access property listgc_ref - OUT GC is on (true) or off (false)
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - array is null.
public static int H5Pget_gc_reference(int fapl_id,
boolean[] gc_ref)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_btree_ratios(int plist_id,
double left,
double middle,
double right)
throws HDF5LibraryException
plist_id - IN Dataset transfer property listleft - IN split ratio for leftmost nodesright - IN split ratio for righttmost nodesmiddle - IN split ratio for all other nodes
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_btree_ratios(int plist_id,
double[] left,
double[] middle,
double[] right)
throws HDF5LibraryException,
java.lang.NullPointerException
plist_id - IN Dataset transfer property listleft - OUT split ratio for leftmost nodesright - OUT split ratio for righttmost nodesmiddle - OUT split ratio for all other nodes
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - an input array is null.
public static byte[] H5Rcreate(int loc_id,
java.lang.String name,
int ref_type,
int space_id)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
loc_id - IN: Location identifier used to locate the object being
pointed to.name - IN: Name of object at location loc_id.ref_type - IN: Type of reference.space_id - IN: Dataspace identifier with selection.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - an input array is null.
java.lang.IllegalArgumentException - - an input array is invalid.
public static int H5Rdereference(int dataset,
int ref_type,
byte[] ref)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
dataset - IN: Dataset containing reference object.ref_type - IN: The reference type of ref.ref - IN: reference to an object
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - output array is null.
java.lang.IllegalArgumentException - - output array is invalid.
public static int H5Rget_region(int loc_id,
int ref_type,
byte[] ref)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
loc_id - IN: loc_id of the reference object.ref_type - IN: The reference type of ref.ref - OUT: the reference to the object and region
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - output array is null.
java.lang.IllegalArgumentException - - output array is invalid.
@Deprecated
public static int H5Rget_obj_type(int loc_id,
int ref_type,
byte[] ref)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Rget_obj_type(int, int, byte[], int[])
loc_id - IN: loc_id of the reference object.ref_type - IN: Type of reference to query. *ref - IN: the reference
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - array is null.
java.lang.IllegalArgumentException - - array is invalid.
public static int H5Screate(int type)
throws HDF5LibraryException
type - IN: The type of dataspace to be created.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Screate_simple(int rank,
long[] dims,
long[] maxdims)
throws HDF5Exception,
java.lang.NullPointerException
rank - IN: Number of dimensions of dataspace.dims - IN: An array of the size of each dimension.maxdims - IN: An array of the maximum size of each dimension.
HDF5Exception - - Error from the HDF-5 Library.
java.lang.NullPointerException - - dims or maxdims is null.
public static int _H5Screate_simple(int rank,
long[] dims,
long[] maxdims)
throws HDF5Exception,
java.lang.NullPointerException
HDF5Exception
java.lang.NullPointerException
@Deprecated
public static int H5Screate_simple(int rank,
byte[] dims,
byte[] maxdims)
throws HDF5Exception,
java.lang.NullPointerException
HDF5Exception
java.lang.NullPointerException
public static int H5Scopy(int space_id)
throws HDF5LibraryException
space_id - Identifier of dataspace to copy.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Sselect_elements(int space_id,
int op,
int num_elements,
long[][] coord2D)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
space_id - Identifier of the dataspace.op - operator specifying how the new selection is combined.num_elements - Number of elements to be selected.coord2D - A 2-dimensional array specifying the coordinates of the
elements.
HDF5Exception - - Error in the data conversion
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - cord array is
public static int H5Sselect_all(int space_id)
throws HDF5LibraryException
space_id - IN: The identifier of the dataspace to be selected.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Sselect_none(int space_id)
throws HDF5LibraryException
space_id - IN: The identifier of the dataspace to be reset.
HDF5LibraryException - - Error from the HDF-5 Library.
public static boolean H5Sselect_valid(int space_id)
throws HDF5LibraryException
space_id - The identifier for the dataspace in which the selection is
being reset.
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Sget_simple_extent_npoints(int space_id)
throws HDF5LibraryException
space_id - ID of the dataspace object to query
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Sget_select_npoints(int space_id)
throws HDF5LibraryException
space_id - IN: Identifier of the dataspace object to query
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Sget_simple_extent_ndims(int space_id)
throws HDF5LibraryException
space_id - IN: Identifier of the dataspace
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Sget_simple_extent_dims(int space_id,
long[] dims,
long[] maxdims)
throws HDF5LibraryException,
java.lang.NullPointerException
space_id - IN: Identifier of the dataspace object to querydims - OUT: Pointer to array to store the size of each dimension.maxdims - OUT: Pointer to array to store the maximum size of each
dimension.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - dims or maxdims is null.
public static int H5Sget_simple_extent_type(int space_id)
throws HDF5LibraryException
space_id - Dataspace identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Sset_extent_simple(int space_id,
int rank,
long[] current_size,
long[] maximum_size)
throws HDF5LibraryException,
java.lang.NullPointerException
space_id - Dataspace identifier.rank - Rank, or dimensionality, of the dataspace.current_size - Array containing current size of dataspace.maximum_size - Array containing maximum size of dataspace.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException
public static int H5Sset_extent_simple(int space_id,
int rank,
byte[] current_size,
byte[] maximum_size)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static boolean H5Sis_simple(int space_id)
throws HDF5LibraryException
space_id - Identifier of the dataspace to query
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Soffset_simple(int space_id,
byte[] offset)
throws HDF5LibraryException,
java.lang.NullPointerException
space_id - IN: The identifier for the dataspace object to reset.offset - IN: The offset at which to position the selection.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - offset array is null.
public static int H5Soffset_simple(int space_id,
long[] offset)
throws HDF5Exception,
java.lang.NullPointerException
HDF5Exception
java.lang.NullPointerException
public static int H5Sextent_copy(int dest_space_id,
int source_space_id)
throws HDF5LibraryException
dest_space_id - IN: The identifier for the dataspace from which the extent is
copied.source_space_id - IN: The identifier for the dataspace to which the extent is
copied.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Sset_extent_none(int space_id)
throws HDF5LibraryException
space_id - The identifier for the dataspace from which the extent is to
be removed.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Sselect_hyperslab(int space_id,
int op,
byte[] start,
byte[] stride,
byte[] count,
byte[] block)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
space_id - IN: Identifier of dataspace selection to modifyop - IN: Operation to perform on current selection.start - IN: Offset of start of hyperslabstride - IN: Hyperslab stride.count - IN: Number of blocks included in hyperslab.block - IN: Size of block in hyperslab.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - an input array is null.
java.lang.NullPointerException - - an input array is invalid.
java.lang.IllegalArgumentException
public static int H5Sselect_hyperslab(int space_id,
int op,
long[] start,
long[] stride,
long[] count,
long[] block)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
HDF5LibraryException
java.lang.NullPointerException
java.lang.IllegalArgumentException
public static int H5Sclose(int space_id)
throws HDF5LibraryException
space_id - Identifier of dataspace to release.
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Sget_select_hyper_nblocks(int spaceid)
throws HDF5LibraryException
spaceid - Identifier of dataspace to release.
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Sget_select_elem_npoints(int spaceid)
throws HDF5LibraryException
spaceid - Identifier of dataspace to release.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Sget_select_hyper_blocklist(int spaceid,
long startblock,
long numblocks,
long[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
<"start" coordinate>, immediately followed by
<"opposite" corner coordinate>, followed by
the next "start" and "opposite" coordinates,
etc.
until all of the selected blocks have been listed.
spaceid - Identifier of dataspace to release.startblock - first block to retrievenumblocks - number of blocks to retrievebuf - returns blocks startblock to startblock+num-1, each block is
rank * 2 (corners) longs.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - buf is null.
public static int H5Sget_select_elem_pointlist(int spaceid,
long startpoint,
long numpoints,
long[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
spaceid - Identifier of dataspace to release.startpoint - first point to retrievenumpoints - number of points to retrievebuf - returns points startblock to startblock+num-1, each points is
rank longs.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - buf is null.
public static int H5Sget_select_bounds(int spaceid,
long[] start,
long[] end)
throws HDF5LibraryException,
java.lang.NullPointerException
The start and end buffers must be large enough to hold the dataspace rank number of coordinates.
spaceid - Identifier of dataspace to release.start - coordinates of lowest corner of bounding box.end - coordinates of highest corner of bounding box.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - start or end is null.
@Deprecated
public static int H5Topen(int loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Topen(int, String, int)
loc_id - IN: A file, group, or datatype identifier.name - IN: A datatype name, defined within the file or group identified by loc_id.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
@Deprecated
public static int H5Tcommit(int loc_id,
java.lang.String name,
int type)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tcommit(int, String, int, int, int, int)
loc_id - IN: Location identifier.name - IN: Name given to committed datatype.type_id - IN: Identifier of datatype to be committed.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Tcommit1(int loc_id,
java.lang.String name,
int type)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static boolean H5Tcommitted(int type)
throws HDF5LibraryException
type_id - IN: Identifier of datatype.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tcreate(int dclass,
int size)
throws HDF5LibraryException
type - IN: Class of datatype to create.size - IN: The number of bytes in the datatype to create.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tcopy(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to copy. Can be a datatype
identifier, a predefined datatype (defined in
H5Tpublic.h), or a dataset Identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
public static boolean H5Tequal(int type_id1,
int type_id2)
throws HDF5LibraryException
type_id1 - IN: Identifier of datatype to compare.type_id2 - IN: Identifier of datatype to compare.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tlock(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to lock.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_class(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.public static java.lang.String H5Tget_class_name(int class_id)
class_id - IN: Identifier of class from H5Tget_class.
public static int H5Tget_size(int type_id)
throws HDF5LibraryException
type_id - Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tset_size(int type_id,
int size)
throws HDF5LibraryException
type_id - Identifier of datatype to change size.size - Size in bytes to modify datatype.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_order(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tset_order(int type_id,
int order)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to set.order - IN: Byte ordering constant.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_precision(int type_id)
throws HDF5LibraryException
type_id - Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tset_precision(int type_id,
int precision)
throws HDF5LibraryException
type_id - Identifier of datatype to set.precision - Number of bits of precision for datatype.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_offset(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tset_offset(int type_id,
int offset)
throws HDF5LibraryException
type_id - Identifier of datatype to set.offset - Offset of first significant bit.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_pad(int type_id,
int[] pad)
throws HDF5LibraryException,
java.lang.NullPointerException
type_id - IN: Identifier of datatype to query.pad - OUT: locations to return least-significant and
most-significant bit padding type.
pad[0] = lsb // least-significant bit padding type
pad[1] = msb // most-significant bit padding type
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - pad is null.
public static int H5Tset_pad(int type_id,
int lsb,
int msb)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to set.lsb - IN: Padding type for least-significant bits.msb - IN: Padding type for most-significant bits.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_sign(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tset_sign(int type_id,
int sign)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to set.sign - IN: Sign type.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_fields(int type_id,
int[] fields)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
type_id - IN: Identifier of datatype to query.fields - OUT: location of size and bit-position.
fields[0] = spos OUT: location to return size of in bits.
fields[1] = epos OUT: location to return exponent bit-position.
fields[2] = esize OUT: location to return size of exponent in bits.
fields[3] = mpos OUT: location to return mantissa bit-position.
fields[4] = msize OUT: location to return size of mantissa in bits.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - fields is null.
java.lang.IllegalArgumentException - - fields array is invalid.
public static int H5Tset_fields(int type_id,
int spos,
int epos,
int esize,
int mpos,
int msize)
throws HDF5LibraryException
type_id - Identifier of datatype to set.spos - Size position.epos - Exponent bit position.esize - Size of exponent in bits.mpos - Mantissa bit position.msize - Size of mantissa in bits.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_ebias(int type_id)
throws HDF5LibraryException
type_id - Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tset_ebias(int type_id,
int ebias)
throws HDF5LibraryException
type_id - Identifier of datatype to set.ebias - Exponent bias value.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_norm(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tset_norm(int type_id,
int norm)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to set.norm - IN: Mantissa normalization type.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_inpad(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tset_inpad(int type_id,
int inpad)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to modify.inpad - IN: Padding type.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_cset(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tset_cset(int type_id,
int cset)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to modify.cset - IN: Character set type.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_strpad(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tset_strpad(int type_id,
int strpad)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to modify.strpad - IN: String padding type.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_nmembers(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static java.lang.String H5Tget_member_name(int type_id,
int field_idx)
type_id - IN: Identifier of datatype to query.field_idx - IN: Field index (0-based) of the field name to retrieve.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_member_index(int type_id,
java.lang.String field_name)
type_id - IN: Identifier of datatype to query.field_name - IN: Field name of the field index to retrieve.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_member_class(int type_id,
int membno)
throws HDF5LibraryException
type_id - IN: Datatype identifier of compound object.membno - IN: Compound object member number.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_member_type(int type_id,
int field_idx)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.field_idx - IN: Field index (0-based) of the field type to retrieve.
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Tget_member_offset(int type_id,
int membno)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.membno - IN: Field index (0-based) of the field type to retrieve.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tinsert(int type_id,
java.lang.String name,
long offset,
int field_id)
throws HDF5LibraryException,
java.lang.NullPointerException
type_id - IN: Identifier of compound datatype to modify.name - IN: Name of the field to insert.offset - IN: Offset in memory structure of the field to insert.field_id - IN: Datatype identifier of the field to insert.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Tpack(int type_id)
throws HDF5LibraryException
WARNING: This call only affects the C-data, even if it succeeds, there may be no visible effect on Java objects.
type_id - IN: Identifier of datatype to modify.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tclose(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to release.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tenum_create(int base_id)
throws HDF5LibraryException
base_id - IN: Identifier of the parent datatype to release.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tenum_insert(int type,
java.lang.String name,
int[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
type - IN: Identifier of datatype.name - IN: The name of the membervalue - IN: The value of the member, data of the correct type
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Tenum_insert(int type,
java.lang.String name,
int value)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Tenum_nameof(int type,
int[] value,
java.lang.String[] name,
int size)
throws HDF5LibraryException,
java.lang.NullPointerException
type - IN: Identifier of datatype.value - IN: The value of the member, data of the correctname - OUT: The name of the membersize - IN: The max length of the name
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Tenum_valueof(int type,
java.lang.String name,
int[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
type - IN: Identifier of datatype.name - IN: The name of the membervalue - OUT: The value of the member
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Tvlen_create(int base_id)
throws HDF5LibraryException
base_id - IN: Identifier of parent datatype.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tset_tag(int type,
java.lang.String tag)
throws HDF5LibraryException
type - IN: Datatype identifier for the opaque datatype to be tagged.tag - IN: Descriptive ASCII string with which the opaque datatype is to be tagged.
HDF5LibraryException - - Error from the HDF-5 Library.
public static java.lang.String H5Tget_tag(int type)
throws HDF5LibraryException
type - IN: Identifier of datatype.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_super(int type)
throws HDF5LibraryException
type - IN: Identifier of datatype.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_member_value(int type_id,
int membno,
int[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
type_id - IN: Identifier of datatype.membno - IN: The name of the membervalue - OUT: The value of the member
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - value is null.
@Deprecated
public static int H5Tarray_create(int base,
int rank,
int[] dims,
int[] perms)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tarray_create(int, int, long[])
base - IN: Datatype identifier for the array base datatype.rank - IN: Rank of the array.dims - IN: Size of each array dimension.perms - IN: Dimension permutation. (Currently not implemented.)
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - dims is null.
public static int H5Tget_array_ndims(int type_id)
throws HDF5LibraryException
type_id - IN: Datatype identifier of array object.
HDF5LibraryException - - Error from the HDF-5 Library.
@Deprecated
public static int H5Tget_array_dims(int dt,
int[] dims,
int[] perms)
throws HDF5LibraryException,
java.lang.NullPointerException
type_id - IN: Datatype identifier of array object.dims - OUT: Sizes of array dimensions.perm[] - OUT: Dimension permutations. (This parameter is not used.)
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - dims is null.
@Deprecated
public static int H5Gget_num_objs(int loc_id,
long[] num_obj)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Gget_info(int)
loc_id - Identifier of the group or the filenum_obj - Number of objects in the group
HDF5LibraryException
java.lang.NullPointerException
@Deprecated
public static long H5Gget_objname_by_idx(int group_id,
long idx,
java.lang.String[] name,
long size)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lget_name_by_idx(int, String, int, int, long, int)
group_id - Group or file identifieridx - Transient index identifying objectname - the object namesize - Name length
HDF5LibraryException
java.lang.NullPointerException
@Deprecated
public static int H5Gget_objtype_by_idx(int group_id,
long idx)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Oget_info(int)
group_id - Group or file identifier.idx - Transient index identifying object.
HDF5LibraryException
java.lang.NullPointerException
public static int H5Tget_native_type(int tid,
int direction)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.direction - IN: Direction of search.
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Gn_members_long(int loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - file or group ID.name - name of the group to iterate, relative to the loc_id
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Gn_members(int loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - file or group ID.name - name of the group to iterate, relative to the loc_id
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Gget_obj_info_idx(int loc_id,
java.lang.String name,
int idx,
java.lang.String[] oname,
int[] type)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: file or group ID.name - IN: name of the group to iterate, relative to the loc_ididx - IN: the index of the object to iterate.oname - the name of the object [OUT]type - the type of the object [OUT]
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Gget_obj_info_all(int loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] otype,
long[] ref)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File or group identifiername - IN: Name of group for which information is to be retrievedobjNames - OUT: Names of all objects under the group, name.objTypes - OUT: Types of all objects under the group, name.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Gget_obj_info_all(int loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] otype,
int[] ltype,
long[] ref,
int indx_type)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
@Deprecated
public static int H5Gget_objinfo(int loc_id,
java.lang.String name,
boolean follow_link,
long[] fileno,
long[] objno,
int[] link_info,
long[] mtime)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
and #H5Oget_info(int)
loc_id - IN: File, group, dataset, or datatype identifier.name - IN: Name of the object for which status is being sought.follow_link - IN: Link flag.fileno - OUT: file id numbers.objno - OUT: object id numbers.link_info - OUT: link information.
link_info[0] = nlink
link_info[1] = type
link_info[2] = linklen
mtime - OUT: modification time
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name or array is null.
java.lang.IllegalArgumentException - - bad argument.
@Deprecated
public static int H5Gget_objinfo(int loc_id,
java.lang.String name,
boolean follow_link,
HDF5GroupInfo info)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File, group, dataset, or datatype identifier.name - IN: Name of the object for which status is being sought.follow_link - IN: Link flag.info - OUT: the HDF5GroupInfo object to store the object infomation
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.See public synchronized static native
int H5Gget_objinfo();
public static int H5Tget_native_type(int tid)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
Direction of search is assumed to be in ascending order.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_alloc_time(int plist_id,
int alloc_time)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pget_alloc_time(int plist_id,
int[] alloc_time)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_fill_time(int plist_id,
int fill_time)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pget_fill_time(int plist_id,
int[] fill_time)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pfill_value_defined(int plist_id,
int[] status)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_fletcher32(int plist)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_edc_check(int plist,
int check)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pget_edc_check(int plist)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_shuffle(int plist_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_szip(int plist,
int options_mask,
int pixels_per_block)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dget_space_status(int dset_id,
int[] status)
throws HDF5LibraryException,
java.lang.NullPointerException
dset_id - IN: Identifier of the dataset to query.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException
public static long H5Iget_name(int obj_id,
java.lang.String[] name,
long size)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5set_free_list_limits(int reg_global_lim,
int reg_list_lim,
int arr_global_lim,
int arr_list_lim,
int blk_global_lim,
int blk_list_lim)
throws HDF5LibraryException
HDF5LibraryException
public static int H5Fget_obj_ids(int file_id,
int types,
int max,
int[] obj_id_list)
throws HDF5LibraryException,
java.lang.NullPointerException
file_id - IN: File identifier for a currently-open HDF5 filetypes - IN: Type of object for which identifiers are to be returned.max_objs - IN: Maximum number of object identifiers to place into
obj_id_list.obj_id_list - OUT: Pointer to the returned list of open object identifiers.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - obj_id_list is null.
public static int H5Fget_obj_count(int file_id,
int types)
throws HDF5LibraryException
file_id - IN: File identifier for a currently-open HDF5 filetypes - IN: Type of object for which identifiers are to be returned.
HDF5LibraryException - - Error from the HDF-5 Library.
public static boolean H5Tis_variable_str(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Zfilter_avail(int filter)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Zunregister(int filter)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pmodify_filter(int plist,
int filter,
int flags,
long cd_nelmts,
int[] cd_values)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pget_filter_by_id(int plist_id,
int filter,
int[] flags,
long[] cd_nelmts,
int[] cd_values,
long namelen,
java.lang.String[] name)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static boolean H5Pall_filters_avail(int dcpl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_hyper_vector_size(int dxpl_id,
long vector_size)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pget_hyper_vector_size(int dxpl_id,
long[] vector_size)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static boolean H5Tdetect_class(int type_id,
int cls)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.cls - IN: Identifier of datatype cls.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Dread_short(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
short[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread_short(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
short[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread_int(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
int[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread_int(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
int[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread_long(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
long[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread_long(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
long[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread_float(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
float[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread_float(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
float[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread_double(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
double[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread_double(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
double[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread_string(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.String[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dread_reg_ref(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.String[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dwrite_short(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
short[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dwrite_short(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
short[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dwrite_int(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
int[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dwrite_int(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
int[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dwrite_long(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
long[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dwrite_long(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
long[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dwrite_float(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
float[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dwrite_float(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
float[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dwrite_double(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
double[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Dwrite_double(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
double[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_fclose_degree(int plist,
int degree)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pget_fclose_degree(int plist_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Iget_ref(int obj_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Iinc_ref(int obj_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Idec_ref(int obj_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_fapl_family(int fapl_id,
long memb_size,
int memb_fapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pget_fapl_family(int fapl_id,
long[] memb_size,
int[] memb_fapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_fapl_core(int fapl_id,
int increment,
boolean backing_store)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pget_fapl_core(int fapl_id,
int[] increment,
boolean[] backing_store)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_family_offset(int fapl_id,
long offset)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static long H5Pget_family_offset(int fapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Pset_fapl_log(int fapl_id,
java.lang.String logfile,
int flags,
int buf_size)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static java.lang.String H5Fget_name(int obj_id,
int size)
throws HDF5LibraryException
HDF5LibraryException
public static long H5Fget_filesize(int file_id)
throws HDF5LibraryException
HDF5LibraryException
public static int H5Iget_file_id(int obj_id)
throws HDF5LibraryException
HDF5LibraryException
public static int H5Premove_filter(int obj_id,
int filter)
throws HDF5LibraryException
HDF5LibraryException
public static int H5Zget_filter_info(int filter)
throws HDF5LibraryException
HDF5LibraryException
public static int H5INcreate(java.lang.String grp_name,
int grp_loc_id,
int property_list,
int data_loc_id,
java.lang.String data_loc_name,
java.lang.String field_name,
long max_mem_size)
public static int H5INquery(int dset_id,
java.lang.String[] keys,
java.lang.Object ubounds,
java.lang.Object lbounds,
int nkeys)
public static int H5Pset(int plid,
java.lang.String name,
int value)
throws HDF5LibraryException
plid - IN: Property list identifier to modifyname - IN: Name of property to modifyvalue - IN: value to set the property to
HDF5LibraryException
public static int H5Pexist(int plid,
java.lang.String name)
throws HDF5LibraryException
plid - IN: Identifier for the property to queryname - IN: Name of property to check for
HDF5LibraryException
public static long H5Pget_size(int plid,
java.lang.String name)
throws HDF5LibraryException
plid - IN: Identifier of property object to queryname - IN: Name of property to query
HDF5LibraryException
public static long H5Pget_nprops(int plid)
throws HDF5LibraryException
plid - IN: Identifier of property object to query
HDF5LibraryException
public static java.lang.String H5Pget_class_name(int plid)
throws HDF5LibraryException
plid - IN: Identifier of property object to query
HDF5LibraryException
public static int H5Pget_class_parent(int plid)
throws HDF5LibraryException
plid - IN: Identifier of the property class to query
HDF5LibraryException
public static int H5Pisa_class(int plist,
int pclass)
throws HDF5LibraryException
plist - IN: Identifier of the property listpclass - IN: Identifier of the property class
HDF5LibraryException
public static int H5Pget(int plid,
java.lang.String name)
throws HDF5LibraryException
plid - IN: Identifier of property object to queryname - IN: Name of property to query
HDF5LibraryException
public static int H5Pequal(int plid1,
int plid2)
throws HDF5LibraryException
plid1 - IN: First property object to be comparedplid2 - IN: Second property object to be compared
HDF5LibraryException
public static int H5Pcopy_prop(int dst_id,
int src_id,
java.lang.String name)
throws HDF5LibraryException
dst_id - IN: Identifier of the destination property list or classsrc_id - IN: Identifier of the source property list or classname - IN: Name of the property to copy
HDF5LibraryException
public static int H5Premove(int plid,
java.lang.String name)
throws HDF5LibraryException
plid - IN: Identifier of the property list to modifyname - IN: Name of property to remove
HDF5LibraryException
public static int H5Punregister(int plid,
java.lang.String name)
throws HDF5LibraryException
plid - IN: Property list class from which to remove permanent
propertyname - IN: Name of property to remove
HDF5LibraryException
public static int H5Pclose_class(int plid)
throws HDF5LibraryException
plid - IN: Property list class to close
HDF5LibraryException
public static int H5Eregister_class(java.lang.String cls_name,
java.lang.String lib_name,
java.lang.String version)
throws HDF5LibraryException,
java.lang.NullPointerException
cls_name - IN: Name of the error class.lib_name - IN: Name of the client library or application to which the
error class belongs.version - IN: Version of the client library or application to which the
error class belongs.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static void H5Eunregister_class(int class_id)
throws HDF5LibraryException
class_id - IN: Error class identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Eclose_msg(int err_id)
throws HDF5LibraryException
err_id - IN: Error message identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Ecreate_msg(int cls_id,
int msg_type,
java.lang.String msg)
throws HDF5LibraryException,
java.lang.NullPointerException
cls_id - IN: Error class identifier.msg_type - IN: The type of the error message.msg - IN: The error message.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - msg is null.
public static int H5Ecreate_stack()
throws HDF5LibraryException
none -
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Eget_current_stack()
throws HDF5LibraryException
none -
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Eclose_stack(int stack_id)
throws HDF5LibraryException
stack_id - IN: Error stack identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
public static java.lang.String H5Eget_class_name(int class_id)
throws HDF5LibraryException,
java.lang.NullPointerException
class_id - IN: Error class identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException
public static void H5Eset_current_stack(int stack_id)
throws HDF5LibraryException
stack_id - IN: Error stack identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Epop(int stack_id,
long count)
throws HDF5LibraryException
stack_id - IN: Error stack identifier.count - IN: Version of the client library or application to which the
error class belongs.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Eprint2(int err_stack,
java.lang.Object stream)
throws HDF5LibraryException
stack_id - IN: Error stack identifier.If the identifier is H5E_DEFAULT,
the current error stack will be printed.stream - IN: File pointer, or stderr if null.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Eclear(int err_stack)
throws HDF5LibraryException
stack_id - IN: Error stack identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Eclear2(int err_stack)
throws HDF5LibraryException
HDF5LibraryExceptionstatic void H5Eclear(int err_stack)
public static boolean H5Eauto_is_v2(int err_stack)
throws HDF5LibraryException
stack_id - IN: Error stack identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
public static java.lang.String H5Eget_msg(int msg_id,
int[] type_list)
throws HDF5LibraryException
msg_id - IN: Name of the error class.type - OUT: The type of the error message. Valid values are H5E_MAJOR
and H5E_MINOR.
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Eget_num(int stack_id)
throws HDF5LibraryException,
java.lang.NullPointerException
stack_id - IN: Error stack identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException
@Deprecated
public static void H5Eprint1(java.lang.Object stream)
throws HDF5LibraryException
H5Eprint2(int, Object)
stream - IN: File pointer, or stderr if null.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Fget_intent(int file_id)
throws HDF5LibraryException
file_id - IN: File identifier for a currently-open HDF5 file
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Fget_obj_count_long(int file_id,
int types)
throws HDF5LibraryException
file_id - IN: File identifier for a currently-open HDF5 filetypes - IN: Type of object for which identifiers are to be returned.
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Fget_obj_ids_long(int file_id,
int types,
long max_objs,
int[] obj_id_list)
throws HDF5LibraryException,
java.lang.NullPointerException
file_id - IN: File identifier for a currently-open HDF5 filetypes - IN: Type of object for which identifiers are to be returned.max_objs - IN: Maximum number of object identifiers to place into
obj_id_list.obj_id_list - OUT: Pointer to the returned list of open object identifiers.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - obj_id_list is null.
public static long H5Fget_freespace(int file_id)
throws HDF5LibraryException
file_id - IN: File identifier for a currently-open HDF5 file
HDF5LibraryException - - Error from the HDF-5 Library.
public static double H5Fget_mdc_hit_rate(int file_id)
throws HDF5LibraryException
file_id - IN: Identifier of the target file.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Fget_mdc_size(int file_id,
long[] metadata_cache)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
file_id - IN: Identifier of the target file.metadata_cache - OUT: Current metadata cache information
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - metadata_cache is null.
java.lang.IllegalArgumentException
public static void H5Freset_mdc_hit_rate_stats(int file_id)
throws HDF5LibraryException
file_id - IN: Identifier of the target file.
HDF5LibraryException - - Error from the HDF-5 Library.
public static java.lang.String H5Fget_name(int obj_id)
throws HDF5LibraryException
obj_id - IN: Identifier of the object for which the associated filename
is sought.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Gcreate(int loc_id,
java.lang.String name,
int lcpl_id,
int gcpl_id,
int gapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: The file or group identifier.name - IN: The absolute or relative name of the new group.lcpl_id - IN: Identifier of link creation property list.gcpl_id - IN: Identifier of group creation property list.gapl_id - IN: Identifier of group access property list. (No group access
properties have been implemented at this time; use
H5P_DEFAULT.)
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int _H5Gcreate2(int loc_id,
java.lang.String name,
int lcpl_id,
int gcpl_id,
int gapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Gcreate_anon(int loc_id,
int gcpl_id,
int gapl_id)
throws HDF5LibraryException
loc_id - IN: File or group identifier specifying the file in which the
new group is to be created.gcpl_id - IN: Identifier of group creation property list.gapl_id - IN: Identifier of group access property list. (No group access
properties have been implemented at this time; use
H5P_DEFAULT.)
HDF5LibraryException - - Error from the HDF-5 Library.
public static int _H5Gcreate_anon(int loc_id,
int gcpl_id,
int gapl_id)
throws HDF5LibraryException
HDF5LibraryException
public static int H5Gopen(int loc_id,
java.lang.String name,
int gapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File or group identifier specifying the location of the
group to be opened.name - IN: Name of group to open.gapl_id - IN: Identifier of group access property list. (No group access
properties have been implemented at this time; use
H5P_DEFAULT.)
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int _H5Gopen2(int loc_id,
java.lang.String name,
int gapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static int H5Gget_create_plist(int group_id)
throws HDF5LibraryException
group_id - IN: Identifier of the group.
HDF5LibraryException - - Error from the HDF-5 Library.
public static H5G_info_t H5Gget_info(int group_id)
throws HDF5LibraryException
group_id - IN: Identifier of the group.
HDF5LibraryException - - Error from the HDF-5 Library.
public static H5G_info_t H5Gget_info_by_name(int group_id,
java.lang.String name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
group_id - IN: File or group identifier.name - IN: Name of group for which information is to be retrieved.lapl_id - IN: Link access property list.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static H5G_info_t H5Gget_info_by_idx(int group_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
group_id - IN: File or group identifier.group_name - IN: Name of group for which information is to be retrieved.idx_type - IN: Type of index by which objects are orderedorder - IN: Order of iteration within indexn - IN: Attribute's position in indexlapl_id - IN: Link access property list.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Gget_obj_info_max(int loc_id,
java.lang.String[] objNames,
int[] objTypes,
int[] lnkTypes,
long[] ref,
int objMax)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File or group identifiername - IN: Name of group for which information is to be retrievedobjNames - OUT: Names of all objects under the group, name.objTypes - OUT: Types of all objects under the group, name.objMax - IN: Maximum number of all objects under the group, name.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static void H5Lcopy(int src_loc,
java.lang.String src_name,
int dst_loc,
java.lang.String dst_name,
int lcpl_id,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
src_loc - IN: Location identifier of the source linksrc_name - IN: Name of the link to be copieddst_loc - IN: Location identifier specifying the destination of the copydst_name - IN: Name to be assigned to the new copylcpl_id - IN: Link creation property list identifierlapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static void H5Lcreate_external(java.lang.String file_name,
java.lang.String obj_name,
int link_loc_id,
java.lang.String link_name,
int lcpl_id,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
file_name - IN: Name of the target file containing the target object.obj_name - IN: Path within the target file to the target object.link_loc_id - IN: The file or group identifier for the new link.link_name - IN: The name of the new link.lcpl_id - IN: Link creation property list identifierlapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static void H5Lcreate_hard(int cur_loc,
java.lang.String cur_name,
int dst_loc,
java.lang.String dst_name,
int lcpl_id,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
cur_loc - IN: The file or group identifier for the target object.cur_name - IN: Name of the target object, which must already exist.dst_loc - IN: The file or group identifier for the new link.dst_name - IN: The name of the new link.lcpl_id - IN: Link creation property list identifierlapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - cur_name or dst_name is null.
public static void H5Lcreate_soft(java.lang.String link_target,
int link_loc_id,
java.lang.String link_name,
int lcpl_id,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
link_target - IN: Path to the target object, which is not required to exist.link_loc_id - IN: The file or group identifier for the new link.link_name - IN: The name of the new link.lcpl_id - IN: Link creation property list identifierlapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - link_name is null.
public static void H5Ldelete(int loc_id,
java.lang.String name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Identifier of the file or group containing the object.name - IN: Name of the link to delete.lapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static void H5Ldelete_by_idx(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File or group identifier specifying location of subject groupgroup_name - IN: Name of subject groupidx_type - IN: Index or field which determines the orderorder - IN: Order within field or indexn - IN: Link for which to retrieve informationlapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - group_name is null.
public static boolean H5Lexists(int loc_id,
java.lang.String name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Identifier of the file or group to query.name - IN: The name of the link to check.lapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static H5L_info_t H5Lget_info(int loc_id,
java.lang.String name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Identifier of the file or group.name - IN: Name of the link for which information is being sought.lapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static H5L_info_t H5Lget_info_by_idx(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File or group identifier specifying location of subject groupgroup_name - IN: Name of subject groupidx_type - IN: Type of indexorder - IN: Order within field or indexn - IN: Link for which to retrieve informationlapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - group_name is null.
public static java.lang.String H5Lget_name_by_idx(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File or group identifier specifying location of subject groupgroup_name - IN: Name of subject groupidx_type - IN: Type of indexorder - IN: Order within field or indexn - IN: Link for which to retrieve informationlapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - group_name is null.
public static int H5Lget_val(int loc_id,
java.lang.String name,
java.lang.String[] link_value,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Identifier of the file or group containing the object.name - IN: Name of the symbolic link.link_value - OUT: Path of the symbolic link, or the file_name and path of an external file.lapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Lget_val_by_idx(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
java.lang.String[] link_value,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File or group identifier specifying location of subject groupgroup_name - IN: Name of subject groupidx_type - IN: Type of indexorder - IN: Order within field or indexn - IN: Link for which to retrieve informationlink_value - OUT: Path of the symbolic link, or the file_name and path of an external file.lapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - group_name is null.
public static void H5Lmove(int src_loc,
java.lang.String src_name,
int dst_loc,
java.lang.String dst_name,
int lcpl_id,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
src_loc - IN: Original file or group identifier.src_name - IN: Original link name.dst_loc - IN: Destination file or group identifier.dst_name - IN: New link name.lcpl_id - IN: Link creation property list identifier to be associated with the new link.lapl_id - IN: Link access property list identifier to be associated with the new link.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Lvisit(int grp_id,
int idx_type,
int order,
H5L_iterate_cb op,
H5L_iterate_t op_data)
throws HDF5LibraryException
grp_id - IN: Identifier specifying subject groupidx_type - IN: Type of indexorder - IN: Order of iteration within indexop - IN: Callback function passing data regarding the link to the calling applicationop_data - IN: User-defined pointer to data required by the application for its processing of the link
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Lvisit_by_name(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
H5L_iterate_cb op,
H5L_iterate_t op_data,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Identifier specifying subject groupgroup_name - IN: Name of subject groupidx_type - IN: Type of indexorder - IN: Order of iteration within indexop - IN: Callback function passing data regarding the link to the calling applicationop_data - IN: User-defined pointer to data required by the application for its processing of the link
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - group_name is null.
public static int H5Literate(int grp_id,
int idx_type,
int order,
long idx,
H5L_iterate_cb op,
H5L_iterate_t op_data)
throws HDF5LibraryException
grp_id - IN: Identifier specifying subject groupidx_type - IN: Type of indexorder - IN: Order of iteration within indexidx - IN: Iteration position at which to startop - IN: Callback function passing data regarding the link to the calling applicationop_data - IN: User-defined pointer to data required by the application for its processing of the link
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Literate_by_name(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long idx,
H5L_iterate_cb op,
H5L_iterate_t op_data,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
grp_id - IN: Identifier specifying subject groupgroup_name - IN: Name of subject groupidx_type - IN: Type of indexorder - IN: Order of iteration within indexidx - IN: Iteration position at which to startop - IN: Callback function passing data regarding the link to the calling applicationop_data - IN: User-defined pointer to data required by the application for its processing of the linklapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - group_name is null.
public static boolean H5Sextent_equal(int first_space_id,
int second_space_id)
throws HDF5LibraryException
first_space_id - IN: The identifier for the first dataspace.second_space_id - IN: The identifier for the seconddataspace.
HDF5LibraryException - - Error from the HDF-5 Library.
public static byte[] H5Sencode(int obj_id)
throws HDF5LibraryException,
java.lang.NullPointerException
obj_id - IN: Identifier of the object to be encoded.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException
public static int H5Sdecode(byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
buf - IN: Buffer for the data space object to be decoded.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - buf is null.
public static int H5Tcreate(int type,
long size)
throws HDF5LibraryException
type - IN: Class of datatype to create.size - IN: The number of bytes in the datatype to create.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Tcommit(int loc_id,
java.lang.String name,
int type_id,
int lcpl_id,
int tcpl_id,
int tapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location identifier.name - IN: Name given to committed datatype.type_id - IN: Identifier of datatype to be committed.lcpl_id - IN: Link creation property list.tcpl_id - IN: Datatype creation property list.tapl_id - IN: Datatype access property list.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Topen(int loc_id,
java.lang.String name,
int tapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: A file, group, or datatype identifier.name - IN: A datatype name, defined within the file or group identified by loc_id.tapl_id - IN: Datatype access property list.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static void H5Tcommit_anon(int loc_id,
int type_id,
int tcpl_id,
int tapl_id)
throws HDF5LibraryException
loc_id - IN: Location identifier.type_id - IN: Identifier of datatype to be committed.tcpl_id - IN: Datatype creation property list.tapl_id - IN: Datatype access property list.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tget_create_plist(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Tencode(int obj_id,
byte[] buf,
long nalloc)
throws HDF5LibraryException,
java.lang.NullPointerException
obj_id - IN: Identifier of the object to be encoded.buf - OUT: Buffer for the object to be encoded into.
If the provided buffer is NULL, only the
size of buffer needed is returned.nalloc - IN: The size of the allocated buffer.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - buf is null.
public static int H5Tdecode(byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
buf - IN: Buffer for the data type object to be decoded.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - buf is null.
public static void H5Tenum_insert(int type,
java.lang.String name,
byte[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
type - IN: Identifier of datatype.name - IN: The name of the membervalue - IN: The value of the member, data of the correct type
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static java.lang.String H5Tenum_nameof(int type,
byte[] value,
long size)
throws HDF5LibraryException,
java.lang.NullPointerException
type - IN: Identifier of datatype.value - IN: The value of the member, data of the correctsize - IN: The probable length of the name
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - value is null.
public static void H5Tenum_valueof(int type,
java.lang.String name,
byte[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
type - IN: Identifier of datatype.name - IN: The name of the membervalue - OUT: The value of the member
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException
public static int H5Tarray_create(int base_id,
int ndims,
long[] dim)
throws HDF5LibraryException,
java.lang.NullPointerException
base_id - IN: Datatype identifier for the array base datatype.ndims - IN: Rank of the array.dim - IN: Size of each array dimension.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - dim is null.
public static int H5Tget_array_dims(int type_id,
long[] dims)
throws HDF5LibraryException,
java.lang.NullPointerException
type_id - IN: Datatype identifier of array object.dims - OUT: Sizes of array dimensions.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - dims is null.
public static int H5Tget_array_dims2(int type_id,
long[] dims)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerExceptionstatic int H5Tget_array_dims(int type_id, long[] dims)
public static long H5Tget_size_long(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Tget_precision_long(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Tget_fields(int type_id,
long[] fields)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
type_id - IN: Identifier of datatype to query.fields - OUT: location of size and bit-position.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - fields is null.
java.lang.IllegalArgumentException - - fields array is invalid.
public static long H5Tget_ebias_long(int type_id)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Tget_member_value(int type_id,
int membno,
byte[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
type_id - IN: Datatype identifier for the enumeration datatype.membno - IN: Number of the enumeration datatype member.value - OUT: The value of the member
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - value is null.
public static void H5Tset_size(int type_id,
long size)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to change size.size - IN: Size in bytes to modify datatype.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Tset_precision(int type_id,
long precision)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to set.precision - IN: Number of bits of precision for datatype.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Tset_offset(int type_id,
long offset)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to set.offset - IN: Offset of first significant bit.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Tset_fields(int type_id,
long spos,
long epos,
long esize,
long mpos,
long msize)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to set.spos - IN: Size position.epos - IN: Exponent bit position.esize - IN: Size of exponent in bits.mpos - IN: Mantissa bit position.msize - IN: Size of mantissa in bits.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Tset_ebias(int type_id,
long ebias)
throws HDF5LibraryException
type_id - IN: Identifier of datatype to set.ebias - IN: Exponent bias value.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Tcompiler_conv(int src_id,
int dst_id)
throws HDF5LibraryException
src_id - IN: Identifier of source datatype.dst_id - IN: Identifier of destination datatype.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Tconvert(int src_id,
int dst_id,
long nelmts,
byte[] buf,
byte[] background,
int plist_id)
throws HDF5LibraryException,
java.lang.NullPointerException
src_id - IN: Identifier of source datatype.dst_id - IN: Identifier of destination datatype.nelmts - IN: Size of array buf.buf - IN: Array containing pre- and post-conversion values.background - IN: Optional background buffer.plist_id - IN: Dataset transfer property list identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - buf is null.
@Deprecated
public static int H5Tget_array_dims(int type_id,
long[] dims,
int[] perm)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tget_array_dims(int, long[])
type_id - IN: Datatype identifier of array object.dims - OUT: Sizes of array dimensions.perm - OUT: Dimension permutation. (Currently not implemented.)
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException
public static int H5Dcreate(int loc_id,
java.lang.String name,
int type_id,
int space_id,
int lcpl_id,
int dcpl_id,
int dapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location identifiername - IN: Dataset nametype_id - IN: Datatype identifierspace_id - IN: Dataspace identifierlcpl_id - IN: Identifier of link creation property list.dcpl_id - IN: Identifier of dataset creation property list.dapl_id - IN: Identifier of dataset access property list.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Dcreate_anon(int loc_id,
int type_id,
int space_id,
int dcpl_id,
int dapl_id)
throws HDF5LibraryException
loc_id - IN: Location identifiertype_id - IN: Datatype identifierspace_id - IN: Dataspace identifierlcpl_id - IN: Identifier of link creation property list.dcpl_id - IN: Identifier of dataset creation property list.dapl_id - IN: Identifier of dataset access property list.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Dopen(int loc_id,
java.lang.String name,
int dapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location identifiername - IN: Dataset namedapl_id - IN: Identifier of dataset access property list.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Dget_space_status(int dset_id)
throws HDF5LibraryException
dset_id - IN: Identifier of the dataset to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Dget_access_plist(int dset_id)
throws HDF5LibraryException
dset_id - IN: Identifier of the dataset to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Dget_offset(int dset_id)
throws HDF5LibraryException
dset_id - IN: Identifier of the dataset in question
HDF5LibraryException - - Error from the HDF-5 Library.
public static long H5Dvlen_get_buf_size(int dset_id,
int type_id,
int space_id)
throws HDF5LibraryException
dset_id - IN: Identifier of the dataset read from.type_id - IN: Identifier of the datatype.space_id - IN: Identifier of the dataspace.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - buf is null.
public static void H5Dfill(byte[] fill,
int fill_type,
byte[] buf,
int buf_type,
int space)
throws HDF5LibraryException,
java.lang.NullPointerException
fill - IN: Pointer to the fill value to be used.fill_type - IN: Fill value datatype identifier.buf - IN/OUT: Pointer to the memory buffer containing the selection to be filled.buf_type - IN: Datatype of dataspace elements to be filled.space - IN: Dataspace describing memory buffer and containing the selection to be filled.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - buf is null.
public static void H5Dset_extent(int dset_id,
long[] size)
throws HDF5LibraryException,
java.lang.NullPointerException
dset_id - IN: Chunked dataset identifier.size - IN: Array containing the new magnitude of each dimension of the dataset.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size is null.
public static long H5Rget_name(int loc_id,
int ref_type,
byte[] ref,
java.lang.String[] name,
long size)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
loc_id - IN: Identifier for the dataset containing the reference or for the group that dataset is in.ref_type - IN: Type of reference.ref - IN: An object or dataset region reference.name - OUT: A name associated with the referenced object or dataset region.size - IN: The size of the name buffer.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size is null.
java.lang.IllegalArgumentException - - Argument is illegal.
public static int H5Rget_obj_type(int loc_id,
int ref_type,
byte[] ref,
int[] obj_type)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
loc_id - IN: loc_id of the reference object.ref_type - IN: Type of reference to query.ref - IN: the referenceobj_type - OUT:Type of referenced object
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - array is null.
java.lang.IllegalArgumentException - - array is invalid.
public static long H5Pget_nlinks(int lapl_id)
throws HDF5LibraryException
lapl_id - IN: File access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_nlinks(int lapl_id,
long nlinks)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
fapl_id - IN: File access property list identifiernlinks - IN: Maximum number of links to traverse
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - Argument is Illegal
public static int H5Pget_libver_bounds(int fapl_id,
int[] libver)
throws HDF5LibraryException,
java.lang.NullPointerException
fapl_id - IN: File access property list identifierlibver - The earliest/latest version of the library that will be used for writing objects.
libver[0] = The earliest version of the library that will be used for writing objects
libver[1] = The latest version of the library that will be used for writing objects.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size is null.
public static int H5Pset_libver_bounds(int fapl_id,
int low,
int high)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
fapl_id - IN: File access property list identifierlow - IN: The earliest version of the library that will be used for writing objectshigh - IN: The latest version of the library that will be used for writing objects.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - Argument is Illegal
public static int H5Pget_link_creation_order(int gcpl_id)
throws HDF5LibraryException
gcpl_id - IN: Group creation property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_link_creation_order(int gcpl_id,
int crt_order_flags)
throws HDF5LibraryException
gcpl_id - IN: Group creation property list identifiercrt_order_flags - IN: Creation order flag(s)
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_attr_creation_order(int ocpl_id)
throws HDF5LibraryException
ocpl_id - IN: Object (group or dataset) creation property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_attr_creation_order(int ocpl_id,
int crt_order_flags)
throws HDF5LibraryException
ocpl_id - IN: Object creation property list identifiercrt_order_flags - IN: Flags specifying whether to track and index attribute creation order
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Pset_copy_object(int ocp_plist_id,
int copy_options)
throws HDF5LibraryException
ocp_plist_id - IN: Object copy property list identifiercopy_options - IN: Copy option(s) to be set
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_copy_object(int ocp_plist_id)
throws HDF5LibraryException
ocp_plist_id - IN: Object copy property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_create_intermediate_group(int lcpl_id,
boolean crt_intermed_group)
throws HDF5LibraryException
lcpl_id - IN: Link creation property list identifiercrt_intermed_group - IN: Flag specifying whether to create intermediate groups upon the creation of an object
HDF5LibraryException - - Error from the HDF-5 Library.
public static boolean H5Pget_create_intermediate_group(int lcpl_id)
throws HDF5LibraryException
lcpl_id - IN: Link creation property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_data_transform(int plist_id,
java.lang.String expression)
throws HDF5LibraryException,
java.lang.NullPointerException
plist_id - IN: Identifier of the property list or classexpression - IN: Pointer to the null-terminated data transform expression
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - expression is null.
public static long H5Pget_data_transform(int plist_id,
java.lang.String[] expression,
long size)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
plist_id - IN: Identifier of the property list or classsize - IN: Number of bytes of the transform expression to copy toexpression - OUT: A data transform expression
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - Size is <= 0.
public static int H5Pget_elink_acc_flags(int lapl_id)
throws HDF5LibraryException
lapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_elink_acc_flags(int lapl_id,
int flags)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
lapl_id - IN: Link access property list identifierflags - IN: The access flag for external link traversal.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - Invalid Flag values.
public static int H5Pset_link_phase_change(int gcpl_id,
int max_compact,
int min_dense)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
gcpl_id - IN: Group creation property list identifiermax_compact - IN: Maximum number of links for compact storage(Default: 8)min_dense - IN: Minimum number of links for dense storage(Default: 6)
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - Invalid values of max_compact and min_dense.
public static int H5Pget_link_phase_change(int gcpl_id,
int[] links)
throws HDF5LibraryException,
java.lang.NullPointerException
gcpl_id - IN: Group creation property list identifierlinks - The max. no. of compact links & the min. no. of dense
links, which are used for storing groups
links[0] = The maximum number of links for compact storage
links[1] = The minimum number of links for dense storage
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size is null.
public static int H5Pget_attr_phase_change(int ocpl_id,
int[] attributes)
throws HDF5LibraryException,
java.lang.NullPointerException
ocpl_id - IN: : Object (dataset or group) creation property list identifierattributes - The maximun and minimum no. of attributes
to be stored.
attributes[0] = The maximum number of attributes to be stored in compact storage
attributes[1] = The minimum number of attributes to be stored in dense storage
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size is null.
public static int H5Pget_shared_mesg_phase_change(int fcpl_id,
int[] size)
throws HDF5LibraryException,
java.lang.NullPointerException
fcpl_id - IN: : File creation property list identifiersize - The threshold values for storage of shared object header
message indexes in a file.
size[0] = Threshold above which storage of a shared object header message index shifts from list to B-tree
size[1] = Threshold below which storage of a shared object header message index reverts to list format
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - size is null.
public static int H5Pset_shared_mesg_phase_change(int fcpl_id,
int max_list,
int min_btree)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
fcpl_id - IN: File creation property list identifiermax_list - IN: Threshold above which storage of a shared object header message index shifts from list to B-treemin_btree - IN: Threshold below which storage of a shared object header message index reverts to list format
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - Invalid values of max_list and min_btree.
public static int H5Pget_shared_mesg_nindexes(int fcpl_id)
throws HDF5LibraryException
fcpl_id - IN: : File creation property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_shared_mesg_nindexes(int plist_id,
int nindexes)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
plist_id - IN: File creation property listnindexes - IN: Number of shared object header message indexes to be available in files created with this property list
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - Invalid value of nindexes
public static int H5Pset_shared_mesg_index(int fcpl_id,
int index_num,
int mesg_type_flags,
int min_mesg_size)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
fcpl_id - IN: File creation property list identifier.index_num - IN: Index being configured.mesg_type_flags - IN: Types of messages that should be stored in this index.min_mesg_size - IN: Minimum message size.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - Invalid value of nindexes
public static int H5Pget_shared_mesg_index(int fcpl_id,
int index_num,
int[] mesg_info)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
fcpl_id - IN: File creation property list identifierindex_num - IN: Index being configured.mesg_info - The message type and minimum message size
mesg_info[0] = Types of messages that may be stored in this index.
mesg_info[1] = Minimum message size.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - mesg_info is null.
java.lang.IllegalArgumentException - - Invalid value of nindexes
public static int H5Pset_local_heap_size_hint(int gcpl_id,
int size_hint)
throws HDF5LibraryException
gcpl_id - IN: Group creation property list identifiersize_hint - IN: Anticipated maximum size in bytes of local heap
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_local_heap_size_hint(int gcpl_id)
throws HDF5LibraryException
gcpl_id - IN: Group creation property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_nbit(int plist_id)
throws HDF5LibraryException
plist_id - IN: Dataset creation property list identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_scaleoffset(int plist_id,
int scale_type,
int scale_factor)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
plist_id - IN: Dataset creation property list identifier.scale_type - IN: Flag indicating compression method.scale_factor - IN: Parameter related to scale.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - Invalid arguments
public static int H5Pset_est_link_info(int gcpl_id,
int est_num_entries,
int est_name_len)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
gcpl_id - IN: Group creation property list identifierest_num_entries - IN: Estimated number of links to be inserted into groupest_name_len - IN: Estimated average length of link names
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.IllegalArgumentException - - Invalid values to est_num_entries and est_name_len.
public static int H5Pget_est_link_info(int gcpl_id,
int[] link_info)
throws HDF5LibraryException,
java.lang.NullPointerException
gcpl_id - IN: Group creation property list identifierlink_info - Estimated number of links to be inserted into group
And the estimated average length of link names
link_info[0] = Estimated number of links to be inserted into group
link_info[1] = Estimated average length of link names
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - link_info is null.
public static int H5Pset_elink_fapl(int lapl_id,
int fapl_id)
throws HDF5LibraryException
lapl_id - IN: Link access property list identifierfapl_id - IN: File access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_elink_fapl(int lapl_id)
throws HDF5LibraryException
lapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pset_elink_prefix(int lapl_id,
java.lang.String prefix)
throws HDF5LibraryException,
java.lang.NullPointerException
lapl_id - IN: Link access property list identifierprefix - IN: Prefix to be applied to external link paths
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - prefix is null.
public static long H5Pget_elink_prefix(int lapl_id,
java.lang.String[] prefix)
throws HDF5LibraryException,
java.lang.NullPointerException
lapl_id - IN: Link access property list identifierprefix - OUT: Prefix applied to external link paths
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - prefix is null.
public static int H5Pset_fapl_direct(int fapl_id,
int alignment,
int block_size,
int cbuf_size)
throws HDF5LibraryException
fapl_id - IN: File access property list identifieralignment - IN: Required memory alignment boundaryblock_size - IN: File system block sizecbuf_size - IN: Copy buffer size
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_fapl_direct(int fapl_id,
int[] info)
throws HDF5LibraryException
fapl_id - IN: File access property list identifierinfo[0] - = alignment OUT: Required memory alignment boundaryinfo[1] - = block_size OUT: File system block sizeinfo[2] - = cbuf_size OUT: Copy buffer size
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Pget_filter(int plist,
int filter_number,
int[] flags,
int[] cd_nelmts,
int[] cd_values,
int namelen,
java.lang.String[] name,
int[] filter_config)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.ArrayStoreException,
HDF5LibraryException,
java.lang.NullPointerException
plist - IN: Property list identifier.filter_number - IN: Sequence number within the filter pipeline of the filter
for which information is sought.flags - OUT: Bit vector specifying certain general properties of the
filter.cd_nelmts - IN/OUT: Number of elements in cd_valuescd_values - OUT: Auxiliary data for the filter.namelen - IN: Anticipated number of characters in name.name - OUT: Name of the filter.filter_config - OUT:A bit field encoding the returned filter information
java.lang.ArrayIndexOutOfBoundsException - Fatal error on Copyback
java.lang.ArrayStoreException - Fatal error on Copyback
java.lang.NullPointerException - - name or an array is null.
HDF5LibraryException
public static int H5Iget_type_ref(int type)
throws HDF5LibraryException
type - IN: The identifier of the type whose reference count is to be retrieved
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Inmembers(int type)
throws HDF5LibraryException
type - IN: Identifier for the identifier type whose member count will be retrieved
HDF5LibraryException - - Error from the HDF-5 Library.
public static int H5Acreate(int loc_id,
java.lang.String attr_name,
int type_id,
int space_id,
int acpl_id,
int aapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location or object identifier; may be dataset or groupattr_name - IN: Attribute nametype_id - IN: Attribute datatype identifierspace_id - IN: Attribute dataspace identifieracpl_id - IN: Attribute creation property list identifieraapl_id - IN: Attribute access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - Name is null.
public static int H5Aopen(int obj_id,
java.lang.String attr_name,
int aapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
obj_id - IN: Identifer for object to which attribute is attachedattr_name - IN: Name of attribute to openaapl_id - IN: Attribute access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - Name is null.
public static int H5Aopen_by_idx(int loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
int aapl_id,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location of object to which attribute is attachedobj_name - IN: Name of object to which attribute is attached, relative to locationidx_type - IN: Type of indexorder - IN: Index traversal ordern - IN: Attribute's position in indexaapl_id - IN: Attribute access property listlapl_id - IN: Link access property list
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - Name is null.
public static int H5Acreate_by_name(int loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
int type_id,
int space_id,
int acpl_id,
int aapl_id,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location or object identifier; may be dataset or groupobj_name - IN: Name, relative to loc_id, of object that attribute is to be attached toattr_name - IN: Attribute nametype_id - IN: Attribute datatype identifierspace_id - IN: Attribute dataspace identifieracpl_id - IN: Attribute creation property list identifier (currently not used).aapl_id - IN: Attribute access property list identifier (currently not used).lapl_id - IN: Link access property list
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static boolean H5Aexists_by_name(int obj_id,
java.lang.String obj_name,
java.lang.String attr_name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location of object to which attribute is attached .obj_name - IN: Name, relative to loc_id, of object that attribute is attached to.attr_name - IN: Name of attribute.lapl_id - IN: Link access property list identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Arename_by_name(int loc_id,
java.lang.String obj_name,
java.lang.String old_attr_name,
java.lang.String new_attr_name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location or object identifier; may be dataset or groupobj_name - IN: Name of object, relative to location, whose attribute is to be renamedold_attr_name - IN: Prior attribute namenew_attr_name - IN: New attribute namelapl_id - IN: Link access property list
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - Name is null.
public static java.lang.String H5Aget_name_by_idx(int loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
attr_id - IN: Attribute identifierobj_name - IN: Name of object to which attribute is attached, relative to locationidx_type - IN: Type of indexorder - IN: Index traversal ordern - IN: Attribute's position in indexlapl_id - IN: Link access property list
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - obj_name is null.
public static long H5Aget_storage_size(int attr_id)
throws HDF5LibraryException
attr_id - IN: Identifier of the attribute to query.
HDF5LibraryException - - Error from the HDF-5 Library.
public static H5A_info_t H5Aget_info(int attr_id)
throws HDF5LibraryException
attr_id - IN: Attribute identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static H5A_info_t H5Aget_info_by_idx(int loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location of object to which attribute is attachedobj_name - IN: Name of object to which attribute is attached, relative to locationidx_type - IN: Type of indexorder - IN: Index traversal ordern - IN: Attribute's position in indexlapl_id - IN: Link access property list
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - obj_name is null.
public static H5A_info_t H5Aget_info_by_name(int loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location of object to which attribute is attachedobj_name - IN: Name of object to which attribute is attached, relative to locationattr_name - IN: Attribute namelapl_id - IN: Link access property list
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - obj_name is null.
public static int H5Adelete_by_name(int loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location or object identifier; may be dataset or groupobj_name - IN: Name of object, relative to location, from which attribute is to be removedattr_name - IN: Name of attribute to deletelapl_id - IN: Link access property list identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static boolean H5Aexists(int obj_id,
java.lang.String attr_name)
throws HDF5LibraryException,
java.lang.NullPointerException
obj_id - IN: Object identifier.attr_name - IN: Name of the attribute.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - attr_name is null.
public static void H5Adelete_by_idx(int loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location or object identifier; may be dataset or groupobj_name - IN: Name of object, relative to location, from which attribute is to be removedidx_type - IN: Type of indexorder - IN: Order in which to iterate over indexn - IN: Offset within indexlapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - obj_name is null.
public static int H5Aopen_by_name(int loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
int aapl_id,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Location from which to find object to which attribute is attachedobj_name - IN: Name of object to which attribute is attached, relative to loc_idattr_name - IN: Name of attribute to openaapl_id - IN: Attribute access property listlapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - obj_name is null.
public static int H5Oopen(int loc_id,
java.lang.String name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File or group identifiername - IN: Relative path to the objectlapl_id - IN: Access property list identifier for the link pointing to the object
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int _H5Oopen(int loc_id,
java.lang.String name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
HDF5LibraryException
java.lang.NullPointerException
public static void H5Ocopy(int src_loc_id,
java.lang.String src_name,
int dst_loc_id,
java.lang.String dst_name,
int ocpypl_id,
int lcpl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
src_loc_id - IN: Object identifier indicating the location of the source object to be copiedsrc_name - IN: Name of the source object to be copieddst_loc_id - IN: Location identifier specifying the destinationdst_name - IN: Name to be assigned to the new copyocpypl_id - IN: Object copy property listlcpl_id - IN: Link creation property list for the new hard link
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static H5O_info_t H5Oget_info(int loc_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Identifier for target object
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static H5O_info_t H5Oget_info_by_name(int loc_id,
java.lang.String name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File or group identifier specifying location of group in which object is locatedname - IN: Relative name of grouplapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static H5O_info_t H5Oget_info_by_idx(int loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File or group identifiergroup_name - IN: Name of group, relative to loc_id, in which object is locatedidx_type - IN: Type of index by which objects are orderedorder - IN: Order of iteration within indexn - IN: Object to openlapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static void H5Olink(int obj_id,
int new_loc_id,
java.lang.String new_name,
int lcpl_id,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
obj_id - IN: Object to be linked.new_loc_id - IN: File or group identifier specifying location at which object is to be linked.name - IN: Relative name of link to be created.lcpl_id - IN: Link creation property list identifier.lapl_id - IN: Access property list identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static void H5Oset_comment(int obj_id,
java.lang.String comment)
throws HDF5LibraryException
obj_id - IN: Identifier of the target objectcomment - IN: The new comment.
HDF5LibraryException - - Error from the HDF-5 Library.
public static void H5Oset_comment_by_name(int loc_id,
java.lang.String name,
java.lang.String comment,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Identifier of a file, group, dataset, or named datatype.name - IN: Relative name of the object whose comment is to be set or reset.comment - IN: The new comment.lapl_id - IN: Link access property list identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static java.lang.String H5Oget_comment(int obj_id)
throws HDF5LibraryException
obj_id - IN: File or group identifier
HDF5LibraryException - - Error from the HDF-5 Library.
public static java.lang.String H5Oget_comment_by_name(int loc_id,
java.lang.String name,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: Identifier of a file, group, dataset, or named datatype.name - IN: Relative name of the object whose comment is to be set or reset.lapl_id - IN: Link access property list identifier.
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Ovisit(int obj_id,
int idx_type,
int order,
H5O_iterate_cb op,
H5O_iterate_t op_data)
throws HDF5LibraryException,
java.lang.NullPointerException
obj_id - IN: Identifier of the object at which the recursive iteration begins.idx_type - IN: Type of indexorder - IN: Order of iteration within indexop - IN: Callback function passing data regarding the object to the calling applicationop_data - IN: User-defined pointer to data required by the application for its processing of the object
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Ovisit_by_name(int loc_id,
java.lang.String obj_name,
int idx_type,
int order,
H5O_iterate_cb op,
H5O_iterate_t op_data,
int lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
loc_id - IN: File or group identifierobj_name - IN: Relative path to the objectidx_type - IN: Type of indexorder - IN: Order of iteration within indexop - IN: Callback function passing data regarding the object to the calling applicationop_data - IN: User-defined pointer to data required by the application for its processing of the objectlapl_id - IN: Link access property list identifier
HDF5LibraryException - - Error from the HDF-5 Library.
java.lang.NullPointerException - - name is null.
public static int H5Oclose(int object_id)
throws HDF5LibraryException
object_id - IN: Object identifier
HDF5LibraryException - - Error from the HDF-5 Library.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||