generated.docs.javadoc.hdf.hdf5lib.H5.html Maven / Gradle / Ivy
H5 (h5jan API)
hdf.hdf5lib
Class H5
- java.lang.Object
-
- hdf.hdf5lib.H5
-
- All Implemented Interfaces:
- java.io.Serializable
public class H5
extends java.lang.Object
implements java.io.Serializable
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 C types to Java types
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
General Rules for Passing Arguments and Results
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.
Arrays
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(long fid, long filetype, long memtype, long 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(long fid, long filetype, long memtype, long memspace, Object data);
OPEN_IDS.addElement(id);
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:
long 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.
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.
- See Also:
- Serialized Form
-
-
Field Summary
Fields
Modifier and Type
Field and Description
static java.lang.StringH5_LIBRARY_NAME_PROPERTY_KEY
static java.lang.StringH5PATH_PROPERTY_KEY
static int[]LIB_VERSION
The version number of the HDF5 library:
LIB_VERSION[0]: The major version of the library.
-
Constructor Summary
Constructors
Constructor and Description
H5()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type
Method and Description
static long_H5Oopen_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
static int_H5Pclose_class(long plid)
static voidaddLibraryPath(java.lang.String pathToAdd)
static intgetOpenIDCount()
Get number of open IDs.
static java.util.Collection<java.lang.Long>getOpenIDs()
Get the open IDs
static intH5Aclose(long attr_id)
H5Aclose terminates access to the attribute specified by its identifier, attr_id.
static intH5Acopy(long src_aid,
long dst_aid)
H5Acopy copies the content of one attribute to another.
static longH5Acreate_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
long type_id,
long space_id,
long acpl_id,
long aapl_id,
long lapl_id)
H5Acreate_by_name creates an attribute, attr_name, which is attached to the object specified by loc_id and
obj_name.
static longH5Acreate(long loc_id,
java.lang.String attr_name,
long type_id,
long space_id,
long acpl_id,
long aapl_id)
H5Acreate creates an attribute, attr_name, which is attached to the object specified by the identifier loc_id.
static voidH5Adelete_by_idx(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
long lapl_id)
H5Adelete_by_idx removes an attribute, specified by its location in an index, from an object.
static intH5Adelete_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
long 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 intH5Adelete(long loc_id,
java.lang.String name)
H5Adelete removes the attribute specified by its name, name, from a dataset, group, or named datatype.
static booleanH5Aexists_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
long lapl_id)
H5Aexists_by_name determines whether the attribute attr_name exists on an object.
static booleanH5Aexists(long obj_id,
java.lang.String attr_name)
H5Aexists determines whether the attribute attr_name exists on the object specified by obj_id.
static longH5Aget_create_plist(long attr_id)
H5Aget_create_plist retrieves a copy of the attribute creation property list identifier.
static H5A_info_tH5Aget_info_by_idx(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
long lapl_id)
H5Aget_info_by_idx Retrieves attribute information, by attribute index position.
static H5A_info_tH5Aget_info_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
long lapl_id)
H5Aget_info_by_name Retrieves attribute information, by attribute name.
static H5A_info_tH5Aget_info(long attr_id)
H5Aget_info retrieves attribute information, by attribute identifier.
static java.lang.StringH5Aget_name_by_idx(long attr_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
long 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 java.lang.StringH5Aget_name(long attr_id)
H5Aget_name retrieves the name of an attribute specified by the identifier, attr_id.
static longH5Aget_space(long attr_id)
H5Aget_space retrieves a copy of the dataspace for an attribute.
static longH5Aget_storage_size(long attr_id)
H5Aget_storage_size returns the amount of storage that is required for the specified attribute, attr_id.
static longH5Aget_type(long attr_id)
H5Aget_type retrieves a copy of the datatype for an attribute.
static intH5Aiterate_by_name(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long idx,
H5A_iterate_cb op,
H5A_iterate_t op_data,
long lapl_id)
H5Aiterate_by_name iterates over the attributes attached to the dataset or group specified with loc_id
and obj_name.
static intH5Aiterate(long loc_id,
int idx_type,
int order,
long idx,
H5A_iterate_cb op,
H5A_iterate_t op_data)
H5Aiterate2 iterates over the attributes attached to a dataset, named datatype, or group, as
specified by obj_id.
static longH5Aopen_by_idx(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
long aapl_id,
long 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 longH5Aopen_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
long aapl_id,
long lapl_id)
H5Aopen_by_name Opens an attribute for an object by object name and attribute name
static longH5Aopen(long obj_id,
java.lang.String attr_name,
long aapl_id)
H5Aopen opens an existing attribute, attr_name, that is attached to an object specified an object identifier,
object_id.
static intH5Aread_double(long attr_id,
long mem_type_id,
double[] buf)
static intH5Aread_double(long attr_id,
long mem_type_id,
double[] buf,
boolean isCriticalPinning)
static intH5Aread_float(long attr_id,
long mem_type_id,
float[] buf)
static intH5Aread_float(long attr_id,
long mem_type_id,
float[] buf,
boolean isCriticalPinning)
static intH5Aread_int(long attr_id,
long mem_type_id,
int[] buf)
static intH5Aread_int(long attr_id,
long mem_type_id,
int[] buf,
boolean isCriticalPinning)
static intH5Aread_long(long attr_id,
long mem_type_id,
long[] buf)
static intH5Aread_long(long attr_id,
long mem_type_id,
long[] buf,
boolean isCriticalPinning)
static intH5Aread_reg_ref(long attr_id,
long mem_type_id,
java.lang.String[] buf)
static intH5Aread_short(long attr_id,
long mem_type_id,
short[] buf)
static intH5Aread_short(long attr_id,
long mem_type_id,
short[] buf,
boolean isCriticalPinning)
static intH5Aread_string(long attr_id,
long mem_type_id,
java.lang.String[] buf)
static intH5Aread_VLStrings(long attr_id,
long mem_type_id,
java.lang.Object[] buf)
static intH5Aread(long attr_id,
long mem_type_id,
byte[] buf)
static intH5Aread(long attr_id,
long mem_type_id,
byte[] obj,
boolean isCriticalPinning)
H5Aread reads an attribute, specified with attr_id.
static intH5Aread(long attr_id,
long mem_type_id,
java.lang.Object obj)
static intH5Aread(long attr_id,
long mem_type_id,
java.lang.Object obj,
boolean isCriticalPinning)
H5Aread reads an attribute, specified with attr_id.
static intH5AreadComplex(long attr_id,
long mem_type_id,
java.lang.String[] buf)
static intH5AreadVL(long attr_id,
long mem_type_id,
java.lang.Object[] buf)
static intH5Arename_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String old_attr_name,
java.lang.String new_attr_name,
long lapl_id)
H5Arename_by_name changes the name of attribute that is attached to the object specified by loc_id and obj_name.
static intH5Arename(long loc_id,
java.lang.String old_attr_name,
java.lang.String new_attr_name)
H5Arename changes the name of attribute that is attached to the object specified by loc_id.
static intH5Awrite_double(long attr_id,
long mem_type_id,
double[] buf)
static intH5Awrite_double(long attr_id,
long mem_type_id,
double[] buf,
boolean isCriticalPinning)
static intH5Awrite_float(long attr_id,
long mem_type_id,
float[] buf)
static intH5Awrite_float(long attr_id,
long mem_type_id,
float[] buf,
boolean isCriticalPinning)
static intH5Awrite_int(long attr_id,
long mem_type_id,
int[] buf)
static intH5Awrite_int(long attr_id,
long mem_type_id,
int[] buf,
boolean isCriticalPinning)
static intH5Awrite_long(long attr_id,
long mem_type_id,
long[] buf)
static intH5Awrite_long(long attr_id,
long mem_type_id,
long[] buf,
boolean isCriticalPinning)
static intH5Awrite_short(long attr_id,
long mem_type_id,
short[] buf)
static intH5Awrite_short(long attr_id,
long mem_type_id,
short[] buf,
boolean isCriticalPinning)
static intH5Awrite_string(long attr_id,
long mem_type_id,
java.lang.String[] buf)
static intH5Awrite_VLStrings(long attr_id,
long mem_type_id,
java.lang.Object[] buf)
H5Awrite_VLStrings writes a variable length String dataset, specified by its identifier attr_id, from
the application memory buffer buf into the file.
static intH5Awrite(long attr_id,
long mem_type_id,
byte[] buf)
static intH5Awrite(long attr_id,
long mem_type_id,
byte[] buf,
boolean isCriticalPinning)
H5Awrite writes an attribute, specified with attr_id.
static intH5Awrite(long attr_id,
long mem_type_id,
java.lang.Object obj)
static intH5Awrite(long attr_id,
long mem_type_id,
java.lang.Object obj,
boolean isCriticalPinning)
H5Awrite writes an attribute, specified with attr_id.
static intH5AwriteVL(long attr_id,
long mem_type_id,
java.lang.Object[] buf)
static intH5check_version(int majnum,
int minnum,
int relnum)
H5check_version verifies that the arguments match the version numbers compiled into the library.
static intH5close()
H5close flushes all data to disk, closes all file identifiers, and cleans up all memory used by the library.
static intH5Dclose(long dataset_id)
H5Dclose ends access to a dataset specified by dataset_id and releases resources used by it.
static intH5Dcopy(long src_did,
long dst_did)
H5Dcopy copies the content of one dataset to another dataset.
static longH5Dcreate_anon(long loc_id,
long type_id,
long space_id,
long dcpl_id,
long dapl_id)
H5Dcreate_anon creates a dataset in the file specified by loc_id.
static longH5Dcreate(long loc_id,
java.lang.String name,
long type_id,
long space_id,
long lcpl_id,
long dcpl_id,
long dapl_id)
H5Dcreate creates a new dataset named name at the location specified by loc_id.
static voidH5Dfill(byte[] fill,
long fill_type,
byte[] buf,
long buf_type,
long space_id)
H5Dfill explicitly fills the dataspace selection in memory, space_id, with the fill value specified in fill.
static voidH5Dflush(long dset_id)
H5Dflush causes all buffers associated with a dataset to be immediately flushed to disk without removing the
data from the cache.
static longH5Dget_access_plist(long dset_id)
H5Dget_access_plist returns an identifier for a copy of the dataset access property list for a dataset.
static longH5Dget_create_plist(long dataset_id)
H5Dget_create_plist returns an identifier for a copy of the dataset creation property list for a dataset.
static longH5Dget_offset(long dset_id)
H5Dget_offset returns the address in the file of the dataset dset_id.
static intH5Dget_space_status(long dset_id)
H5Dget_space_status determines whether space has been allocated for the dataset dset_id.
static longH5Dget_space(long dataset_id)
H5Dget_space returns an identifier for a copy of the dataspace for a dataset.
static longH5Dget_storage_size(long dataset_id)
H5Dget_storage_size returns the amount of storage that is required for the dataset.
static longH5Dget_type(long dataset_id)
H5Dget_type returns an identifier for a copy of the datatype for a dataset.
static intH5Diterate(byte[] buf,
long buf_type,
long space_id,
H5D_iterate_cb op,
H5D_iterate_t op_data)
H5Diterate iterates over all the data elements in the memory buffer buf, executing the callback function operator
once for each such data element.
static longH5Dopen(long loc_id,
java.lang.String name,
long dapl_id)
H5Dopen opens the existing dataset specified by a location identifier and name, loc_id and name, respectively.
static intH5Dread_double(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
double[] buf)
static intH5Dread_double(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
double[] buf,
boolean isCriticalPinning)
static intH5Dread_float(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
float[] buf)
static intH5Dread_float(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
float[] buf,
boolean isCriticalPinning)
static intH5Dread_int(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
int[] buf)
static intH5Dread_int(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
int[] buf,
boolean isCriticalPinning)
static intH5Dread_long(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
long[] buf)
static intH5Dread_long(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
long[] buf,
boolean isCriticalPinning)
static intH5Dread_reg_ref(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.String[] buf)
static intH5Dread_short(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
short[] buf)
static intH5Dread_short(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
short[] buf,
boolean isCriticalPinning)
static intH5Dread_string(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.String[] buf)
static intH5Dread_VLStrings(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object[] buf)
static intH5Dread(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
byte[] buf)
static intH5Dread(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
byte[] obj,
boolean isCriticalPinning)
H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
memory buffer buf.
static intH5Dread(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object obj)
static intH5Dread(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long 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 intH5DreadVL(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object[] buf)
static voidH5Drefresh(long dset_id)
H5Drefresh causes all buffers associated with a dataset to be cleared and immediately re-loaded with updated
contents from disk.
static voidH5Dset_extent(long dset_id,
long[] size)
H5Dset_extent sets the current dimensions of the chunked dataset dset_id to the sizes specified in size.
static longH5Dvlen_get_buf_size(long dset_id,
long type_id,
long 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 intH5Dvlen_reclaim(long type_id,
long space_id,
long xfer_plist_id,
byte[] buf)
H5Dvlen_reclaim reclaims buffer used for VL data.
static intH5Dwrite_double(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
double[] buf)
static intH5Dwrite_double(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
double[] buf,
boolean isCriticalPinning)
static intH5Dwrite_float(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
float[] buf)
static intH5Dwrite_float(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
float[] buf,
boolean isCriticalPinning)
static intH5Dwrite_int(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
int[] buf)
static intH5Dwrite_int(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
int[] buf,
boolean isCriticalPinning)
static intH5Dwrite_long(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
long[] buf)
static intH5Dwrite_long(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
long[] buf,
boolean isCriticalPinning)
static intH5Dwrite_short(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
short[] buf)
static intH5Dwrite_short(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
short[] buf,
boolean isCriticalPinning)
static intH5Dwrite_string(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.String[] buf)
static intH5Dwrite_VLStrings(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object[] buf)
H5Dwrite_VLStrings writes a (partial) variable length String dataset, specified by its identifier dataset_id, from
the application memory buffer buf into the file.
static intH5Dwrite(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
byte[] buf)
static intH5Dwrite(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long 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 intH5Dwrite(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object obj)
static intH5Dwrite(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long 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 intH5DwriteVL(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object[] buf)
static booleanH5Eauto_is_v2(long stack_id)
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 intH5Eclear()
H5Eclear clears the error stack for the current thread.
static voidH5Eclear(long stack_id)
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 voidH5Eclear2(long stack_id)
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 voidH5Eclose_msg(long err_id)
H5Eclose_msg closes an error message identifier, which can be either a major or minor message.
static voidH5Eclose_stack(long stack_id)
H5Eclose_stack closes the object handle for an error stack and releases its resources.
static longH5Ecreate_msg(long 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 longH5Ecreate_stack()
H5Ecreate_stack creates a new empty error stack and returns the new stack's identifier.
static java.lang.StringH5Eget_class_name(long class_id)
H5Eget_class_name retrieves the name of the error class specified by the class identifier.
static longH5Eget_current_stack()
H5Eget_current_stack copies the current error stack and returns an error stack identifier for the new copy.
static java.lang.StringH5Eget_msg(long msg_id,
int[] type_list)
H5Eget_msg retrieves the error message including its length and type.
static longH5Eget_num(long 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 voidH5Epop(long 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 voidH5Eprint2(long stack_id,
java.lang.Object stream)
H5Eprint2 prints the error stack specified by estack_id on the specified stream, stream.
static voidH5Epush(long stack_id,
java.lang.String file,
java.lang.String func,
int line,
long cls_id,
long maj_id,
long min_id,
java.lang.String msg)
H5Epush2 pushes a new error record onto the error stack specified by estack_id.
static voidH5Epush2(long stack_id,
java.lang.String file,
java.lang.String func,
int line,
long cls_id,
long maj_id,
long min_id,
java.lang.String msg)
static longH5Eregister_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 intH5error_off()
Turn off error handling.
static voidH5error_on()
Turn on error handling.
static voidH5Eset_current_stack(long 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 voidH5Eunregister_class(long class_id)
H5Eunregister_class removes the error class specified by class_id.
static voidH5Ewalk(long stack_id,
long direction,
H5E_walk_cb func,
H5E_walk_t client_data)
H5Ewalk walks the error stack specified by estack_id for the current thread and calls the
function specified in func for each error along the way.
static voidH5Ewalk2(long stack_id,
long direction,
H5E_walk_cb func,
H5E_walk_t client_data)
static voidH5export_dataset(java.lang.String file_export_name,
java.lang.String file_name,
java.lang.String object_path,
int binary_order)
H5export_dataset is a utility function to save data in a file.
static voidH5Fclear_elink_file_cache(long file_id)
H5Fclear_elink_file_cache evicts all the cached child files in the specified file's external file
cache, causing them to be closed if there is nothing else holding them open.
static intH5Fclose(long file_id)
H5Fclose terminates access to an HDF5 file.
static longH5Fcreate(java.lang.String name,
int flags,
long create_id,
long access_id)
H5Fcreate is the primary function for creating HDF5 files.
static intH5Fflush(long 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 longH5Fget_access_plist(long file_id)
H5Fget_access_plist returns the file access property list identifier of the specified file.
static longH5Fget_create_plist(long file_id)
H5Fget_create_plist returns a file creation property list identifier identifying the creation properties used to
create this file.
static booleanH5Fget_dset_no_attrs_hint(long file_id)
H5Fget_dset_no_attrs_hint gets the file-level setting to create minimized dataset object headers.
static longH5Fget_filesize(long file_id)
static longH5Fget_freespace(long file_id)
H5Fget_freespace returns the amount of space that is unused by any objects in the file.
static H5F_info2_tH5Fget_info(long obj_id)
H5Fget_info returns global information for the file associated with the
object identifier obj_id.
static intH5Fget_intent(long file_id)
H5Fget_intent retrieves the intended access mode flag passed with H5Fopen when the file was opened.
static doubleH5Fget_mdc_hit_rate(long 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 voidH5Fget_mdc_logging_status(long file_id,
boolean[] mdc_logging_status)
H5Fget_mdc_logging_status gets the current metadata cache logging status.
static intH5Fget_mdc_size(long file_id,
long[] metadata_cache)
H5Fget_mdc_size queries the metadata cache of the target file for the desired size information.
static java.lang.StringH5Fget_name(long obj_id)
H5Fget_name retrieves the name of the file to which the object obj_id belongs.
static longH5Fget_obj_count(long file_id,
int types)
H5Fget_obj_count returns the number of open object identifiers for the file.
static longH5Fget_obj_ids(long file_id,
int types,
long max_objs,
long[] obj_id_list)
H5Fget_obj_ids returns the list of identifiers for all open HDF5 objects fitting the specified criteria.
static booleanH5Fis_hdf5(java.lang.String name)
H5Fis_hdf5 determines whether a file is in the HDF5 format.
static intH5Fmount(long loc_id,
java.lang.String name,
long child_id,
long 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 longH5Fopen(java.lang.String name,
int flags,
long access_id)
H5Fopen opens an existing file and is the primary function for accessing existing HDF5 files.
static longH5Freopen(long file_id)
H5Freopen reopens an HDF5 file.
static voidH5Freset_mdc_hit_rate_stats(long file_id)
H5Freset_mdc_hit_rate_stats resets the hit rate statistics counters in the metadata cache associated with the
specified file.
static voidH5Fset_dset_no_attrs_hint(long file_id,
boolean minimize)
H5Fset_dset_no_attrs_hint sets the file-level setting to create minimized dataset object headers.
static voidH5Fset_libver_bounds(long file_id,
int low,
int high)
H5Fset_libver_bounds sets a different low and high bounds while a file is open.
static voidH5Fstart_mdc_logging(long file_id)
H5Fstart_mdc_logging starts logging metadata cache events if logging was previously enabled.
static voidH5Fstart_swmr_write(long file_id)
H5Fstart_swmr_write will activate SWMR writing mode for a file associated with file_id.
static voidH5Fstop_mdc_logging(long file_id)
H5Fstop_mdc_logging stops logging metadata cache events if logging was previously enabled and is currently ongoing.
static intH5Funmount(long loc_id,
java.lang.String name)
Given a mount point, H5Funmount dissassociates the mount point's file from the file mounted there.
static intH5garbage_collect()
H5garbage_collect collects on all free-lists of all types.
static intH5Gclose(long group_id)
H5Gclose releases resources used by a group which was opened by a call to H5Gcreate() or H5Gopen().
static longH5Gcreate_anon(long loc_id,
long gcpl_id,
long gapl_id)
H5Gcreate_anon creates a new empty group in the file specified by loc_id.
static longH5Gcreate(long loc_id,
java.lang.String name,
long lcpl_id,
long gcpl_id,
long gapl_id)
H5Gcreate creates a new group with the specified name at the specified location, loc_id.
static intH5get_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 voidH5Gflush(long group_id)
H5Gflush causes all buffers associated with a group to be immediately flushed to disk without
removing the data from the cache.
static longH5Gget_create_plist(long 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_tH5Gget_info_by_idx(long group_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
H5Gget_info_by_idx retrieves information about a group, according to the group's position within an index.
static H5G_info_tH5Gget_info_by_name(long group_id,
java.lang.String name,
long 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_tH5Gget_info(long group_id)
H5Gget_info retrieves information about the group specified by group_id.
static intH5Gget_obj_info_all(long loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] otype,
int[] ltype,
long[] ref,
int indx_type)
static intH5Gget_obj_info_all(long loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] otype,
int[] ltype,
long[] fno,
long[] ref,
int indx_type)
static intH5Gget_obj_info_all(long loc_id,
java.lang.String name,
java.lang.String[] objNames,
int[] objTypes,
long[] objRef)
retrieves information of all objects under the group (name) located in the file or group specified by loc_id.
static intH5Gget_obj_info_full(long loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] otype,
int[] ltype,
long[] fno,
long[] ref,
int indx_type,
int indx_order)
static intH5Gget_obj_info_idx(long 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 intH5Gget_obj_info_max(long loc_id,
java.lang.String[] objNames,
int[] objTypes,
int[] lnkTypes,
long[] objRef,
long 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 longH5Gn_members(long loc_id,
java.lang.String name)
H5Gn_members report the number of objects in a Group.
static longH5Gopen(long loc_id,
java.lang.String name,
long gapl_id)
H5Gopen opens an existing group, name, at the location specified by loc_id.
static voidH5Grefresh(long group_id)
H5Grefresh causes all buffers associated with a group to be cleared and immediately re-loaded
with updated contents from disk.
static voidH5Iclear_type(int type_id,
boolean force)
H5Iclear_type deletes all identifiers of the type identified by the argument type.
static intH5Idec_ref(long obj_id)
static intH5Idec_type_ref(long type_id)
H5Idec_type_ref decrements the reference count on an identifier type.
static voidH5Idestroy_type(int type_id)
H5Idestroy_type deletes an entire identifier type.
static longH5Iget_file_id(long obj_id)
static longH5Iget_name_long(long obj_id,
java.lang.String[] name,
long size)
Deprecated.
static java.lang.StringH5Iget_name(long obj_id)
H5Iget_name_str retrieves the name of an object specified by the identifier, obj_id.
static intH5Iget_ref(long obj_id)
static intH5Iget_type_ref(long type_id)
H5Iget_type_ref retrieves the reference count on an ID type.
static intH5Iget_type(long obj_id)
H5Iget_type retrieves the type of the object identified by obj_id.
static intH5Iinc_ref(long obj_id)
static intH5Iinc_type_ref(long type_id)
H5Iinc_type_ref increments the reference count on an ID type.
static booleanH5Iis_valid(long obj_id)
H5Iis_valid indicates if the identifier type specified in obj_id is valid.
static intH5Inmembers(long type_id)
H5Inmembers returns the number of identifiers of the identifier type specified in type.
static booleanH5Itype_exists(int type_id)
H5Itype_exists indicates if the identifier type specified in type exists.
static voidH5Lcopy(long src_loc,
java.lang.String src_name,
long dst_loc,
java.lang.String dst_name,
long lcpl_id,
long lapl_id)
H5Lcopy copies a link from one location to another.
static voidH5Lcreate_external(java.lang.String file_name,
java.lang.String obj_name,
long link_loc_id,
java.lang.String link_name,
long lcpl_id,
long 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 voidH5Lcreate_hard(long cur_loc,
java.lang.String cur_name,
long dst_loc,
java.lang.String dst_name,
long lcpl_id,
long lapl_id)
H5Lcreate_hard creates a new hard link to a pre-existing object in an HDF5 file.
static voidH5Lcreate_soft(java.lang.String link_target,
long link_loc_id,
java.lang.String link_name,
long lcpl_id,
long lapl_id)
H5Lcreate_soft creates a new soft link to an object in an HDF5 file.
static voidH5Ldelete_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
H5Ldelete_by_idx removes the nth link in a group according to the specified order and in the specified index.
static voidH5Ldelete(long loc_id,
java.lang.String name,
long lapl_id)
H5Ldelete removes the link specified from a group.
static booleanH5Lexists(long loc_id,
java.lang.String name,
long lapl_id)
H5Lexists checks if a link with a particular name exists in a group.
static H5L_info_tH5Lget_info_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long 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_tH5Lget_info(long loc_id,
java.lang.String name,
long lapl_id)
H5Lget_info returns information about the specified link.
static java.lang.StringH5Lget_name_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long 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 intH5Lget_value_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
java.lang.String[] link_value,
long lapl_id)
H5Lget_value_by_idx retrieves value of the nth link in a group, according to the order within an index.
static intH5Lget_value(long loc_id,
java.lang.String name,
java.lang.String[] link_value,
long lapl_id)
H5Lget_value returns the link value of a symbolic link.
static intH5Lis_registered(int link_cls_id)
H5Lis_registered tests whether a user-defined link class is currently registered,
either by the HDF5 Library or by the user through the use of H5Lregister.
static intH5Literate_by_name(long grp_id,
java.lang.String group_name,
int idx_type,
int order,
long idx,
H5L_iterate_cb op,
H5L_iterate_t op_data,
long lapl_id)
H5Literate_by_name iterates through links in a group.
static intH5Literate(long 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 voidH5Lmove(long src_loc,
java.lang.String src_name,
long dst_loc,
java.lang.String dst_name,
long lcpl_id,
long lapl_id)
H5Lmove renames a link within an HDF5 file.
static voidH5Lunregister(int link_cls_id)
H5Lunregister unregisters a class of user-defined links, preventing them from being traversed, queried, moved, etc.
static intH5Lvisit_by_name(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
H5L_iterate_cb op,
H5L_iterate_t op_data,
long lapl_id)
H5Lvisit_by_name recursively visits all links starting from a specified group.
static intH5Lvisit(long 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 intH5Oclose(long object_id)
H5Oclose closes the group, dataset, or named datatype specified.
static voidH5Ocopy(long src_loc_id,
java.lang.String src_name,
long dst_loc_id,
java.lang.String dst_name,
long ocpypl_id,
long 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 voidH5Odecr_refcount(long object_id)
H5Odecr_refcount decrements the hard link reference count for an object.
static booleanH5Oexists_by_name(long loc_id,
java.lang.String obj_name,
long lapl_id)
H5Oexists_by_name is used by an application to check that an existing link resolves to an object.
static voidH5Oflush(long object_id)
H5Oflush causes all buffers associated with an object to be immediately flushed to disk without removing
the data from the cache.
static java.lang.StringH5Oget_comment_by_name(long loc_id,
java.lang.String name,
long lapl_id)
H5Oget_comment_by_name retrieves the comment for an object.
static java.lang.StringH5Oget_comment(long obj_id)
H5Oget_comment retrieves the comment for the specified object.
static H5O_info_tH5Oget_info_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int fields,
long lapl_id)
H5Oget_info_by_idx retrieves the metadata for an object, identifying the object by an index position.
static H5O_info_tH5Oget_info_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
H5Oget_info_by_idx retrieves the metadata for an object, identifying the object by an index position.
static H5O_info_tH5Oget_info_by_name(long loc_id,
java.lang.String name,
int fields,
long lapl_id)
H5Oget_info_by_name retrieves the metadata for an object, identifying the object by location and relative name.
static H5O_info_tH5Oget_info_by_name(long loc_id,
java.lang.String name,
long lapl_id)
H5Oget_info_by_name retrieves the metadata for an object, identifying the object by location and relative name.
static H5O_info_tH5Oget_info(long loc_id)
H5Oget_info retrieves the metadata for an object specified by an identifier.
static H5O_info_tH5Oget_info(long loc_id,
int fields)
H5Oget_info retrieves the metadata for an object specified by an identifier.
static voidH5Oincr_refcount(long object_id)
H5Oincr_refcount increments the hard link reference count for an object.
static voidH5Olink(long obj_id,
long new_loc_id,
java.lang.String new_name,
long lcpl_id,
long lapl_id)
H5Olink creates a new hard link to an object in an HDF5 file.
static longH5Oopen_by_addr(long loc_id,
long addr)
H5Oopen_by_addr opens a group, dataset, or named datatype using its address within an HDF5 file.
static longH5Oopen_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
H5Oopen_by_idx opens the nth object in the group specified.
static longH5Oopen(long loc_id,
java.lang.String name,
long lapl_id)
H5Oopen opens a group, dataset, or named datatype specified by a location and a path name.
static intH5open()
H5open initialize the library.
static voidH5Orefresh(long object_id)
H5Orefresh causes all buffers associated with an object to be cleared and immediately re-loaded with
updated contents from disk.
static voidH5Oset_comment_by_name(long loc_id,
java.lang.String name,
java.lang.String comment,
long lapl_id)
Deprecated.
As of HDF5 1.8 in favor of object attributes.
static voidH5Oset_comment(long obj_id,
java.lang.String comment)
Deprecated.
As of HDF5 1.8 in favor of object attributes.
static intH5Ovisit_by_name(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
H5O_iterate_cb op,
H5O_iterate_t op_data,
int fields,
long lapl_id)
H5Ovisit_by_name recursively visits all objects starting from a specified object.
static intH5Ovisit_by_name(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
H5O_iterate_cb op,
H5O_iterate_t op_data,
long lapl_id)
H5Ovisit_by_name recursively visits all objects starting from a specified object.
static intH5Ovisit(long 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 intH5Ovisit(long obj_id,
int idx_type,
int order,
H5O_iterate_cb op,
H5O_iterate_t op_data,
int fields)
H5Ovisit recursively visits all objects accessible from a specified object.
static booleanH5P_equal(long plid1,
long plid2)
static booleanH5Pall_filters_avail(long dcpl_id)
static intH5Pclose_class(long plid)
Closes an existing property list class
static intH5Pclose(long plist)
H5Pclose terminates access to a property list.
static intH5Pcopy_prop(long dst_id,
long src_id,
java.lang.String name)
H5Pcopy_prop copies a property from one property list or class to another
static longH5Pcopy(long plist)
H5Pcopy copies an existing property list to create a new property list.
static longH5Pcreate_class_nocb(long parent_class,
java.lang.String name)
static longH5Pcreate(long type)
H5Pcreate creates a new property as an instance of some property list class.
static intH5Pequal(long plid1,
long plid2)
H5Pequal determines if two property lists or classes are equal
static booleanH5Pexist(long plid,
java.lang.String name)
H5Pexist determines whether a property exists within a property list or class
static intH5Pfill_value_defined(long plist_id,
int[] status)
static intH5Pget_alignment(long plist,
long[] alignment)
H5Pget_alignment retrieves the current settings for alignment properties from a file access property list.
static intH5Pget_alloc_time(long plist_id,
int[] alloc_time)
static intH5Pget_attr_creation_order(long ocpl_id)
H5Pget_attr_creation_order retrieves the settings for tracking and indexing attribute creation order on an object
static intH5Pget_attr_phase_change(long ocpl_id,
int[] attributes)
H5Pget_attr_phase_change retrieves attribute storage phase change thresholds.
static intH5Pget_btree_ratios(long plist_id,
double[] left,
double[] middle,
double[] right)
H5Pget_btree_ratio Get the B-tree split ratios for a dataset transfer property list.
static longH5Pget_buffer_size(long plist)
static intH5Pget_buffer(long plist,
byte[] tconv,
byte[] bkg)
HH5Pget_buffer gets type conversion and background buffers.
static intH5Pget_cache(long plist,
int[] mdc_nelmts,
long[] rdcc_nelmts,
long[] 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 intH5Pget_char_encoding(long plist_id)
static voidH5Pget_chunk_cache(long dapl_id,
long[] rdcc_nslots,
long[] 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 on a per-datset basis.
static intH5Pget_chunk_opts(long dcpl_id)
H5Pget_chunk_opts retrieves the edge chunk option setting stored in the dataset creation property list .
static intH5Pget_chunk(long 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.StringH5Pget_class_name(long plid)
H5Pget_class_name retrieves the name of a generic property list class
static longH5Pget_class_parent(long plid)
H5Pget_class_parent retrieves an identifier for the parent class of a property class
static longH5Pget_class(long plist)
H5Pget_class returns the property list class for the property list identified by the plist parameter.
static intH5Pget_copy_object(long ocp_plist_id)
H5Pget_copy_object retrieves the properties to be used when an object is copied.
static booleanH5Pget_create_intermediate_group(long lcpl_id)
H5Pget_create_intermediate_group determines whether property is set to enable creating missing intermediate
groups.
static longH5Pget_data_transform(long 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 longH5Pget_driver(long plid)
H5Pget_driver returns the identifier of the low-level file driver associated with the file access property list
or data transfer property list plid.
static booleanH5Pget_dset_no_attrs_hint(long dcpl_id)
H5Pget_dset_no_attrs_hint accesses the flag for whether or not datasets created by the given dcpl
will be created with a "minimized" object header.
static intH5Pget_edc_check(long plist)
static java.lang.StringH5Pget_efile_prefix(long dapl_id)
H5Pget_efile_prefix Retrieves prefix applied to external file paths.
static intH5Pget_elink_acc_flags(long lapl_id)
H5Pget_elink_acc_flags retrieves the external link traversal file access flag from the specified link access
property list.
static longH5Pget_elink_fapl(long lapl_id)
H5Pget_elink_fapl Retrieves the file access property list identifier associated with the link access property
list.
static intH5Pget_elink_file_cache_size(long fapl_id)
H5Pget_elink_file_cache_size retrieves the size of the external link open file cache.
static longH5Pget_elink_prefix(long lapl_id,
java.lang.String[] prefix)
H5Pget_elink_prefix Retrieves prefix applied to external link paths.
static intH5Pget_est_link_info(long gcpl_id,
int[] link_info)
H5Pget_est_link_info Queries data required to estimate required local heap or object header size.
static booleanH5Pget_evict_on_close(long fapl_id)
H5Pget_evict_on_close retrieves the file access property list setting that determines whether an HDF5 object
will be evicted from the library's metadata cache when it is closed.
static intH5Pget_external_count(long plist)
H5Pget_external_count returns the number of external files for the specified dataset.
static intH5Pget_external(long plist,
int idx,
long name_size,
java.lang.String[] name,
long[] size)
H5Pget_external returns information about an external file.
static longH5Pget_family_offset(long fapl_id)
static voidH5Pget_fapl_core(long fapl_id,
long[] increment,
boolean[] backing_store)
static intH5Pget_fapl_direct(long fapl_id,
long[] info)
H5Pget_fapl_direct Retrieve direct I/O settings.
static intH5Pget_fapl_family(long fapl_id,
long[] memb_size,
long[] memb_fapl_id)
static booleanH5Pget_fapl_multi(long fapl_id,
int[] memb_map,
long[] memb_fapl,
java.lang.String[] memb_name,
long[] memb_addr)
H5Pget_fapl_multi Sets up use of the multi I/O driver.
static intH5Pget_fclose_degree(long plist_id)
static longH5Pget_file_space_page_size(long fcpl_id)
H5Pget_file_space_page_size Sets the file space page size for paged aggregation.
static booleanH5Pget_file_space_strategy_persist(long fcpl_id)
H5Pget_file_space_strategy_persist provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.
static longH5Pget_file_space_strategy_threshold(long fcpl_id)
H5Pget_file_space_strategy_threshold provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.
static intH5Pget_file_space_strategy(long fcpl_id,
boolean[] persist,
long[] threshold)
H5Pget_file_space_strategy provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.
static intH5Pget_fill_time(long plist_id,
int[] fill_time)
static intH5Pget_fill_value(long plist_id,
long type_id,
byte[] value)
H5Pget_fill_value queries the fill value property of a dataset creation property list.
static intH5Pget_fill_value(long plist_id,
long type_id,
java.lang.Object obj)
H5Pget_fill_value queries the fill value property of a dataset creation property list.
static intH5Pget_filter_by_id(long plist_id,
long filter_id,
int[] flags,
long[] cd_nelmts,
int[] cd_values,
long namelen,
java.lang.String[] name,
int[] filter_config)
H5Pget_filter_by_id returns information about the filter specified in filter_id, a filter identifier.
static intH5Pget_filter_by_id2(long plist_id,
long filter_id,
int[] flags,
long[] cd_nelmts,
int[] cd_values,
long namelen,
java.lang.String[] name,
int[] filter_config)
H5Pget_filter_by_id2 returns information about a filter, specified by its filter id, in a filter pipeline,
specified by the property list with which it is associated.
static intH5Pget_filter(long plist,
int filter_number,
int[] flags,
long[] cd_nelmts,
int[] cd_values,
long 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 booleanH5Pget_gc_references(long fapl_id)
H5Pget_gc_references Returns the current setting for the garbage collection refernces property from a file access
property list.
static intH5Pget_hyper_vector_size(long dxpl_id,
long[] vector_size)
static intH5Pget_istore_k(long plist,
int[] ik)
H5Pget_istore_k queries the 1/2 rank of an indexed storage B-tree.
static intH5Pget_layout(long plist)
H5Pget_layout returns the layout of the raw data for a dataset.
static intH5Pget_libver_bounds(long 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 intH5Pget_link_creation_order(long 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 intH5Pget_link_phase_change(long gcpl_id,
int[] links)
H5Pget_link_phase_change Queries the settings for conversion between compact and dense groups.
static longH5Pget_local_heap_size_hint(long gcpl_id)
H5Pget_local_heap_size_hint Retrieves the anticipated size of the local heap for original-style groups.
static H5AC_cache_config_tH5Pget_mdc_config(long plist_id)
H5Pget_mdc_config gets the initial metadata cache configuration contained in a file access property list and
loads it into the instance of H5AC_cache_config_t pointed to by the config_ptr parameter.
static java.lang.StringH5Pget_mdc_log_options(long fapl_id,
boolean[] mdc_log_options)
H5Pget_mdc_log_options gets metadata cache logging options.
static longH5Pget_meta_block_size(long fapl_id)
H5Pget_meta_block_size the current metadata block size setting.
static longH5Pget_metadata_read_attempts(long plist_id)
H5Pget_metadata_read_attempts retrieves the number of read attempts that is set in the file access property list plist_id.
static intH5Pget_nfilters(long plist)
H5Pget_nfilters returns the number of filters defined in the filter pipeline associated with the property list
plist.
static longH5Pget_nlinks(long 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 longH5Pget_nprops(long plid)
H5Pget_nprops retrieves the number of properties in a property list or class
static booleanH5Pget_obj_track_times(long ocpl_id)
H5Pget_obj_track_times queries the object creation property list, ocpl_id, to determine whether object times are
being recorded.
static intH5Pget_shared_mesg_index(long fcpl_id,
int index_num,
int[] mesg_info)
H5Pget_shared_mesg_index Retrieves the configuration settings for a shared message index.
static intH5Pget_shared_mesg_nindexes(long fcpl_id)
H5Pget_shared_mesg_nindexes retrieves number of shared object header message indexes in file creation property
list.
static intH5Pget_shared_mesg_phase_change(long fcpl_id,
int[] size)
H5Pget_shared_mesg_phase_change retrieves shared object header message phase change information.
static longH5Pget_sieve_buf_size(long fapl_id)
static longH5Pget_size(long plid,
java.lang.String name)
H5Pget_size retrieves the size of a property's value in bytes
static intH5Pget_sizes(long plist,
long[] size)
H5Pget_sizes retrieves the size of the offsets and lengths used in an HDF5 file.
static longH5Pget_small_data_block_size(long plist)
H5Pget_small_data_block_size retrieves the size of a block of small data in a file creation property list.
static intH5Pget_sym_k(long 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 intH5Pget_userblock(long plist,
long[] size)
H5Pget_userblock retrieves the size of a user block in a file creation property list.
static intH5Pget_version(long plist,
int[] version_info)
Deprecated.
As of HDF5 1.10.0 in favor of H5Fget_info.
static longH5Pget_virtual_count(long dcpl_id)
H5Pget_virtual_count gets the number of mappings for a virtual dataset that has the creation property list specified by dcpl_id.
static java.lang.StringH5Pget_virtual_dsetname(long dcpl_id,
long index)
H5Pget_virtual_dsetname takes the dataset creation property list for the virtual dataset, dcpl_id, the mapping index, index, the
size of the dataset name for a source dataset, size, and retrieves the name of the source dataset used in the mapping.
static java.lang.StringH5Pget_virtual_filename(long dcpl_id,
long index)
H5Pget_virtual_filename takes the dataset creation property list for the virtual dataset, dcpl_id, the mapping index, index,
the size of the filename for a source dataset, size, and retrieves the name of the file for a source dataset used in the mapping.
static java.lang.StringH5Pget_virtual_prefix(long dapl_id)
H5Pget_virtual_prefix Retrieves prefix applied to virtual file paths.
static longH5Pget_virtual_printf_gap(long dapl_id)
H5Pget_virtual_printf_gap returns the maximum number of missing printf-style files and/or datasets for
determining the extent of an unlimited virtual dataaset, gap_size, using the access property list for
the virtual dataset, dapl_id.
static longH5Pget_virtual_srcspace(long dcpl_id,
long index)
H5Pget_virtual_srcspace takes the dataset creation property list for the virtual dataset, dcpl_id, and the mapping index, index,
and returns a dataspace identifier for the selection within the source dataset used in the mapping.
static intH5Pget_virtual_view(long dapl_id)
H5Pget_virtual_view takes the virtual dataset access property list, dapl_id, and retrieves the flag,
view, set by the H5Pset_virtual_view call.
static longH5Pget_virtual_vspace(long dcpl_id,
long index)
H5Pget_virtual_vspace takes the dataset creation property list for the virtual dataset, dcpl_id, and the mapping index, index,
and returns a dataspace identifier for the selection within the virtual dataset used in the mapping.
static intH5Pget(long plid,
java.lang.String name)
H5Pget retrieves a copy of the value for a property in a property list (support integer only)
static voidH5Pinsert2_nocb(long plist,
java.lang.String name,
long size,
byte[] value)
static intH5Pisa_class(long plist,
long pclass)
H5Pisa_class checks to determine whether a property list is a member of the specified class
static intH5Piterate(long plist,
int[] idx,
H5P_iterate_cb op,
H5P_iterate_t op_data)
static voidH5PLappend(java.lang.String plugin_path)
H5PLappend inserts the plugin path at the end of the table.
static intH5PLget_loading_state()
H5PLget_loading_state retrieves the state of the dynamic plugins flag, plugin_flags..
static java.lang.StringH5PLget(int index)
H5PLget retrieves the plugin path at the specified index.
static voidH5PLinsert(java.lang.String plugin_path,
int index)
H5PLinsert inserts the plugin path at the specified index.
static voidH5PLprepend(java.lang.String plugin_path)
H5PLprepend inserts the plugin path at the beginning of the table.
static voidH5PLremove(int index)
H5PLremove removes the plugin path at the specified index.
static voidH5PLreplace(java.lang.String plugin_path,
int index)
H5PLreplace replaces the plugin path at the specified index.
static voidH5PLset_loading_state(int plugin_flags)
H5PLset_loading_state uses one argument to enable or disable individual plugins.
static intH5PLsize()
H5PLsize retrieves the size of the current list of plugin paths.
static intH5Pmodify_filter(long plist,
long filter,
int flags,
long cd_nelmts,
int[] cd_values)
static voidH5Pregister2_nocb(long plist_class,
java.lang.String name,
long size,
byte[] def_value)
static intH5Premove_filter(long obj_id,
long filter)
static intH5Premove(long plid,
java.lang.String name)
H5Premove removes a property from a property list
static intH5Pset_alignment(long 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 intH5Pset_alloc_time(long plist_id,
int alloc_time)
static intH5Pset_attr_creation_order(long 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 voidH5Pset_attr_phase_change(long ocpl_id,
int max_compact,
int min_dense)
H5Pset_attr_phase_change sets threshold values for attribute storage on an object.
static intH5Pset_btree_ratios(long plist_id,
double left,
double middle,
double right)
H5Pset_btree_ratio Sets B-tree split ratios for a dataset transfer property list.
static voidH5Pset_buffer_size(long plist,
long size)
H5Pset_buffer sets type conversion and background buffers.
static intH5Pset_cache(long plist,
int mdc_nelmts,
long rdcc_nelmts,
long 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 voidH5Pset_char_encoding(long plist_id,
int encoding)
static voidH5Pset_chunk_cache(long dapl_id,
long rdcc_nslots,
long rdcc_nbytes,
double rdcc_w0)
H5Pset_chunk_cache sets the number of elements (objects) in the meta data cache and the total number of bytes in
the raw data chunk cache on a per-datset basis.
static voidH5Pset_chunk_opts(long dcpl_id,
int opts)
H5Pset_chunk_opts Sets the edge chunk option in a dataset creation property list.
static intH5Pset_chunk(long plist,
int ndims,
byte[] dim)
H5Pset_chunk sets the size of the chunks used to store a chunked layout dataset.
static intH5Pset_chunk(long plist,
int ndims,
long[] dim)
static voidH5Pset_copy_object(long ocp_plist_id,
int copy_options)
H5Pset_copy_object Sets properties to be used when an object is copied.
static intH5Pset_create_intermediate_group(long lcpl_id,
boolean crt_intermed_group)
H5Pset_create_intermediate_group specifies in property list whether to create missing intermediate groups
static intH5Pset_data_transform(long plist_id,
java.lang.String expression)
H5Pset_data_transform sets a data transform expression
static intH5Pset_deflate(long plist,
int level)
H5Pset_deflate sets the compression method for a dataset.
static voidH5Pset_dset_no_attrs_hint(long dcpl_id,
boolean minimize)
H5Pset_dset_no_attrs_hint sets the dcpl to minimize (or explicitly to not minimized) dataset object
headers upon creation.
static intH5Pset_edc_check(long plist,
int check)
static voidH5Pset_efile_prefix(long dapl_id,
java.lang.String prefix)
H5Pset_efile_prefix Sets prefix to be applied to external file paths.
static intH5Pset_elink_acc_flags(long lapl_id,
int flags)
H5Pset_elink_acc_flags Sets the external link traversal file access flag in a link access property list.
static intH5Pset_elink_fapl(long lapl_id,
long fapl_id)
H5Pset_elink_fapl sets a file access property list for use in accessing a file pointed to by an external link.
static voidH5Pset_elink_file_cache_size(long fapl_id,
int efc_size)
H5Pset_elink_file_cache_size sets the number of files that can be held open in an external link open file cache.
static intH5Pset_elink_prefix(long lapl_id,
java.lang.String prefix)
H5Pset_elink_prefix Sets prefix to be applied to external link paths.
static intH5Pset_est_link_info(long 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 voidH5Pset_evict_on_close(long fapl_id,
boolean evict_on_close)
H5Pset_evict_on_close controls the library's behavior of evicting metadata associated with a closed object.
static intH5Pset_external(long plist,
java.lang.String name,
long offset,
long size)
H5Pset_external adds an external file to the list of external files.
static intH5Pset_family_offset(long fapl_id,
long offset)
static intH5Pset_fapl_core(long fapl_id,
long increment,
boolean backing_store)
static intH5Pset_fapl_direct(long fapl_id,
long alignment,
long block_size,
long cbuf_size)
H5Pset_fapl_direct Sets up use of the direct I/O driver.
static intH5Pset_fapl_family(long fapl_id,
long memb_size,
long memb_fapl_id)
static voidH5Pset_fapl_log(long fapl_id,
java.lang.String logfile,
long flags,
long buf_size)
H5Pset_fapl_log Sets up the logging virtual file driver (H5FD_LOG) for use.
static voidH5Pset_fapl_multi(long fapl_id,
int[] memb_map,
long[] memb_fapl,
java.lang.String[] memb_name,
long[] memb_addr,
boolean relax)
H5Pset_fapl_multi Sets up use of the multi I/O driver.
static intH5Pset_fapl_sec2(long fapl_id)
static voidH5Pset_fapl_split(long fapl_id,
java.lang.String meta_ext,
long meta_plist_id,
java.lang.String raw_ext,
long raw_plist_id)
static intH5Pset_fapl_stdio(long fapl_id)
static intH5Pset_fapl_windows(long fapl_id)
static intH5Pset_fclose_degree(long plist,
int degree)
static voidH5Pset_file_space_page_size(long fcpl_id,
long page_size)
H5Pset_file_space_page_size retrieves the file space page size for aggregating small metadata or raw data.
static voidH5Pset_file_space_strategy(long fcpl_id,
int strategy,
boolean persist,
long threshold)
H5Pset_file_space_strategy sets the file space management strategy for the file associated with fcpl_id to strategy.
static intH5Pset_fill_time(long plist_id,
int fill_time)
static intH5Pset_fill_value(long plist_id,
long type_id,
byte[] value)
H5Pset_fill_value sets the fill value for a dataset creation property list.
static intH5Pset_fill_value(long plist_id,
long type_id,
java.lang.Object obj)
H5Pset_fill_value sets the fill value for a dataset creation property list.
static intH5Pset_filter(long plist,
int filter,
int flags,
long cd_nelmts,
int[] cd_values)
H5Pset_filter adds the specified filter and corresponding properties to the end of an output filter pipeline.
static intH5Pset_fletcher32(long plist)
static intH5Pset_gc_references(long fapl_id,
boolean gc_ref)
H5Pset_gc_references Sets the flag for garbage collecting references for the file.
static intH5Pset_hyper_vector_size(long dxpl_id,
long vector_size)
static intH5Pset_istore_k(long plist,
int ik)
H5Pset_istore_k sets the size of the parameter used to control the B-trees for indexing chunked datasets.
static intH5Pset_layout(long plist,
int layout)
H5Pset_layout sets the type of storage used store the raw data for a dataset.
static intH5Pset_libver_bounds(long 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 intH5Pset_link_creation_order(long 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 intH5Pset_link_phase_change(long gcpl_id,
int max_compact,
int min_dense)
H5Pset_link_phase_change Sets the parameters for conversion between compact and dense groups.
static intH5Pset_local_heap_size_hint(long gcpl_id,
long size_hint)
H5Pset_local_heap_size_hint Specifies the anticipated maximum size of a local heap.
static voidH5Pset_mdc_config(long plist_id,
H5AC_cache_config_t config_ptr)
static voidH5Pset_mdc_log_options(long fapl_id,
boolean is_enabled,
java.lang.String location,
boolean start_on_access)
H5Pset_mdc_log_options sets metadata cache logging options.
static voidH5Pset_meta_block_size(long fapl_id,
long size)
H5Pset_meta_block_size sets the minimum metadata block size.
static voidH5Pset_metadata_read_attempts(long plist_id,
long attempts)
H5Pset_metadata_read_attempts sets the number of reads that the library will try when reading checksummed
metadata in an HDF5 file opened with SWMR access.
static intH5Pset_nbit(long plist_id)
H5Pset_nbit Sets up the use of the N-Bit filter.
static intH5Pset_nlinks(long 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 voidH5Pset_obj_track_times(long ocpl_id,
boolean track_times)
H5Pset_obj_track_times sets a property in the object creation property list, ocpl_id, that governs the recording
of times associated with an object.
static intH5Pset_scaleoffset(long plist_id,
int scale_type,
int scale_factor)
H5Pset_scaleoffset sets the Scale-Offset filter for a dataset.
static intH5Pset_shared_mesg_index(long 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 intH5Pset_shared_mesg_nindexes(long 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 intH5Pset_shared_mesg_phase_change(long fcpl_id,
int max_list,
int min_btree)
H5Pset_shared_mesg_phase_change sets shared object header message storage phase change thresholds.
static intH5Pset_shuffle(long plist_id)
static voidH5Pset_sieve_buf_size(long fapl_id,
long size)
static intH5Pset_sizes(long 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 intH5Pset_small_data_block_size(long 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 intH5Pset_sym_k(long plist,
int ik,
int lk)
H5Pset_sym_k sets the size of parameters used to control the symbol table nodes.
static intH5Pset_szip(long plist,
int options_mask,
int pixels_per_block)
static intH5Pset_userblock(long plist,
long size)
H5Pset_userblock sets the user block size of a file creation property list.
static voidH5Pset_virtual_prefix(long dapl_id,
java.lang.String prefix)
H5Pset_virtual_prefix Sets prefix to be applied to virtual file paths.
static voidH5Pset_virtual_printf_gap(long dapl_id,
long gap_size)
H5Pset_virtual_printf_gap sets the access property list for the virtual dataset, dapl_id, to instruct the
library to stop looking for the mapped data stored in the files and/or datasets with the printf-style names
after not finding gap_size files and/or datasets.
static voidH5Pset_virtual_view(long dapl_id,
int view)
H5Pset_virtual_view takes the access property list for the virtual dataset, dapl_id, and the flag,
view, and sets the VDS view according to the flag value.
static voidH5Pset_virtual(long dcpl_id,
long vspace_id,
java.lang.String src_file_name,
java.lang.String src_dset_name,
long src_space_id)
H5Pset_virtual maps elements of the virtual dataset (VDS) described by the
virtual dataspace identifier vspace_id to the elements of the source dataset
described by the source dataset dataspace identifier src_space_id.
static intH5Pset(long plid,
java.lang.String name,
int value)
Sets a property list value (support integer only)
static intH5Punregister(long plid,
java.lang.String name)
H5Punregister removes a property from a property list class
static byte[]H5Rcreate(long loc_id,
java.lang.String name,
int ref_type,
long space_id)
H5Rcreate creates the reference, ref, of the type specified in ref_type, pointing to the object name located at
loc_id.
static longH5Rdereference(long dataset,
long access_list,
int ref_type,
byte[] ref)
Given a reference to some object, H5Rdereference opens that object and return an identifier.
static longH5Rget_name(long 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 intH5Rget_obj_type(long loc_id,
int ref_type,
byte[] ref)
H5Rget_obj_type Given a reference to an object ref, H5Rget_obj_type returns the type of the object pointed to.
static longH5Rget_region(long 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 intH5Sclose(long space_id)
H5Sclose releases a dataspace.
static longH5Scopy(long space_id)
H5Scopy creates a new dataspace which is an exact copy of the dataspace identified by space_id.
static longH5Screate_simple(int rank,
long[] dims,
long[] maxdims)
H5Screate_simple creates a new simple data space and opens it for access.
static longH5Screate(int type)
H5Screate creates a new dataspace of a particular type.
static longH5Sdecode(byte[] buf)
H5Sdecode reconstructs the HDF5 data space object and returns a new object handle for it.
static byte[]H5Sencode(long obj_id)
H5Sencode converts a data space description into binary form in a buffer.
static intH5set_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 intH5Sextent_copy(long dest_space_id,
long source_space_id)
H5Sextent_copy copies the extent from source_space_id to dest_space_id.
static booleanH5Sextent_equal(long first_space_id,
long second_space_id)
H5Sextent_equal determines whether the dataspace extents of two dataspaces, space1_id and space2_id, are equal.
static voidH5Sget_regular_hyperslab(long space_id,
long[] start,
long[] stride,
long[] count,
long[] block)
H5Sget_regular_hyperslab determines if a hyperslab selection is regular for the dataspace specified
by space_id.
static intH5Sget_select_bounds(long 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 longH5Sget_select_elem_npoints(long spaceid)
H5Sget_select_elem_npoints returns the number of element points in the current dataspace selection.
static intH5Sget_select_elem_pointlist(long spaceid,
long startpoint,
long numpoints,
long[] buf)
H5Sget_select_elem_pointlist returns an array of of element points in the current dataspace selection.
static intH5Sget_select_hyper_blocklist(long spaceid,
long startblock,
long numblocks,
long[] buf)
H5Sget_select_hyper_blocklist returns an array of hyperslab blocks.
static longH5Sget_select_hyper_nblocks(long spaceid)
H5Sget_select_hyper_nblocks returns the number of hyperslab blocks in the current dataspace selection.
static longH5Sget_select_npoints(long space_id)
H5Sget_select_npoints determines the number of elements in the current selection of a dataspace.
static intH5Sget_select_type(long space_id)
H5Sget_select_type retrieves the type of selection currently defined for the dataspace space_id.
static intH5Sget_simple_extent_dims(long 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 intH5Sget_simple_extent_ndims(long space_id)
H5Sget_simple_extent_ndims determines the dimensionality (or rank) of a dataspace.
static longH5Sget_simple_extent_npoints(long space_id)
H5Sget_simple_extent_npoints determines the number of elements in a dataspace.
static intH5Sget_simple_extent_type(long space_id)
H5Sget_simple_extent_type queries a dataspace to determine the current class of a dataspace.
static booleanH5Sis_regular_hyperslab(long space_id)
H5Sis_regular_hyperslab retrieves a regular hyperslab selection for the dataspace specified
by space_id.
static booleanH5Sis_simple(long space_id)
H5Sis_simple determines whether a dataspace is a simple dataspace.
static intH5Soffset_simple(long space_id,
byte[] offset)
H5Soffset_simple sets the offset of a simple dataspace space_id.
static intH5Soffset_simple(long space_id,
long[] offset)
static intH5Sselect_all(long space_id)
H5Sselect_all selects the entire extent of the dataspace space_id.
static intH5Sselect_elements(long 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 intH5Sselect_hyperslab(long 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 intH5Sselect_hyperslab(long space_id,
int op,
long[] start,
long[] stride,
long[] count,
long[] block)
static intH5Sselect_none(long space_id)
H5Sselect_none resets the selection region for the dataspace space_id to include no elements.
static booleanH5Sselect_valid(long space_id)
H5Sselect_valid verifies that the selection for the dataspace.
static intH5Sset_extent_none(long space_id)
H5Sset_extent_none removes the extent from a dataspace and sets the type to H5S_NONE.
static longH5Sset_extent_simple(long space_id,
int rank,
byte[] current_size,
byte[] maximum_size)
static longH5Sset_extent_simple(long space_id,
int rank,
long[] current_size,
long[] maximum_size)
H5Sset_extent_simple sets or resets the size of an existing dataspace.
static longH5Tarray_create(long base_id,
int ndims,
long[] dim)
H5Tarray_create creates a new array datatype object.
static intH5Tclose(long type_id)
H5Tclose releases a datatype.
static voidH5Tcommit_anon(long loc_id,
long type_id,
long tcpl_id,
long 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 voidH5Tcommit(long loc_id,
java.lang.String name,
long type_id,
long lcpl_id,
long tcpl_id,
long tapl_id)
H5Tcommit saves a transient datatype as an immutable named datatype in a file.
static booleanH5Tcommitted(long type_id)
H5Tcommitted queries a type to determine whether the type specified by the type identifier is a named type or a
transient type.
static voidH5Tcompiler_conv(long src_id,
long 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 voidH5Tconvert(long src_id,
long dst_id,
long nelmts,
byte[] buf,
byte[] background,
long plist_id)
H5Tconvert converts nelmts elements from the type specified by the src_id identifier to type dst_id.
static longH5Tcopy(long type_id)
H5Tcopy copies an existing datatype.
static longH5Tcreate(int tclass,
long size)
H5Tcreate creates a new dataype of the specified class with the specified number of bytes.
static longH5Tdecode(byte[] buf)
H5Tdecode reconstructs the HDF5 data type object and returns a new object handle for it.
static booleanH5Tdetect_class(long 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 intH5Tencode(long obj_id,
byte[] buf,
long nalloc)
H5Tencode converts a data type description into binary form in a buffer.
static longH5Tenum_create(long base_id)
H5Tenum_create creates a new enumeration datatype based on the specified base datatype, parent_id, which must be
an integer type.
static voidH5Tenum_insert(long type,
java.lang.String name,
byte[] value)
H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype.
static intH5Tenum_insert(long type,
java.lang.String name,
int value)
static intH5Tenum_insert(long type,
java.lang.String name,
int[] value)
H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype.
static java.lang.StringH5Tenum_nameof(long type,
byte[] value,
long size)
H5Tenum_nameof finds the symbol name that corresponds to the specified value of the enumeration datatype type.
static intH5Tenum_nameof(long 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 voidH5Tenum_valueof(long type,
java.lang.String name,
byte[] value)
H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype type.
static intH5Tenum_valueof(long type,
java.lang.String name,
int[] value)
H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype type.
static booleanH5Tequal(long type_id1,
long type_id2)
H5Tequal determines whether two datatype identifiers refer to the same datatype.
static voidH5Tflush(long dtype_id)
H5Tflush causes all buffers associated with a committed datatype to be immediately flushed to disk
without removing the data from the cache.
static intH5Tget_array_dims(long type_id,
long[] dims)
H5Tget_array_dims returns the sizes of the dimensions of the specified array datatype object.
static intH5Tget_array_dims2(long type_id,
long[] dims)
H5Tget_array_dims2 returns the sizes of the dimensions of the specified array datatype object.
static intH5Tget_array_ndims(long type_id)
H5Tget_array_ndims returns the rank, the number of dimensions, of an array datatype object.
static java.lang.StringH5Tget_class_name(long class_id)
H5Tget_class_name returns the datatype class identifier.
static intH5Tget_class(long type_id)
H5Tget_class returns the datatype class identifier.
static longH5Tget_create_plist(long 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 intH5Tget_cset(long type_id)
H5Tget_cset retrieves the character set type of a string datatype.
static longH5Tget_ebias_long(long type_id)
H5Tget_ebias retrieves the exponent bias of a floating-point type.
static intH5Tget_ebias(long type_id)
H5Tget_ebias retrieves the exponent bias of a floating-point type.
static intH5Tget_fields(long type_id,
int[] fields)
H5Tget_fields retrieves information about the locations of the various bit fields of a floating point datatype.
static voidH5Tget_fields(long type_id,
long[] fields)
H5Tget_fields retrieves information about the locations of the various bit fields of a floating point datatype.
static intH5Tget_inpad(long type_id)
H5Tget_inpad retrieves the internal padding type for unused bits in floating-point datatypes.
static intH5Tget_member_class(long type_id,
int membno)
H5Tget_member_class returns the class of datatype of the specified member.
static intH5Tget_member_index(long type_id,
java.lang.String field_name)
H5Tget_member_index retrieves the index of a field of a compound datatype.
static java.lang.StringH5Tget_member_name(long 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 longH5Tget_member_offset(long type_id,
int membno)
H5Tget_member_offset returns the byte offset of the specified member of the compound datatype.
static longH5Tget_member_type(long type_id,
int field_idx)
H5Tget_member_type returns the datatype of the specified member.
static voidH5Tget_member_value(long type_id,
int membno,
byte[] value)
H5Tget_member_value returns the value of the enumeration datatype member memb_no.
static intH5Tget_member_value(long type_id,
int membno,
int[] value)
H5Tget_member_value returns the value of the enumeration datatype member memb_no.
static longH5Tget_native_type(long type_id)
H5Tget_native_type returns the equivalent native datatype for the datatype specified in type_id.
static longH5Tget_native_type(long type_id,
int direction)
H5Tget_native_type returns the equivalent native datatype for the datatype specified in type_id.
static intH5Tget_nmembers(long type_id)
H5Tget_nmembers retrieves the number of fields a compound datatype has.
static intH5Tget_norm(long type_id)
H5Tget_norm retrieves the mantissa normalization of a floating-point datatype.
static intH5Tget_offset(long type_id)
H5Tget_offset retrieves the bit offset of the first significant bit.
static intH5Tget_order(long type_id)
H5Tget_order returns the byte order of an atomic datatype.
static intH5Tget_pad(long type_id,
int[] pad)
H5Tget_pad retrieves the padding type of the least and most-significant bit padding.
static longH5Tget_precision_long(long type_id)
H5Tget_precision returns the precision of an atomic datatype.
static intH5Tget_precision(long type_id)
H5Tget_precision returns the precision of an atomic datatype.
static intH5Tget_sign(long type_id)
H5Tget_sign retrieves the sign type for an integer type.
static longH5Tget_size(long type_id)
H5Tget_size returns the size of a datatype in bytes.
static intH5Tget_strpad(long type_id)
H5Tget_strpad retrieves the string padding method for a string datatype.
static longH5Tget_super(long type)
H5Tget_super returns the type from which TYPE is derived.
static java.lang.StringH5Tget_tag(long type)
H5Tget_tag returns the tag associated with datatype type_id.
static intH5Tinsert(long type_id,
java.lang.String name,
long offset,
long field_id)
H5Tinsert adds another member to the compound datatype type_id.
static booleanH5Tis_variable_str(long type_id)
H5Tis_variable_str determines whether the datatype identified in type_id is a variable-length string.
static intH5Tlock(long type_id)
H5Tlock locks the datatype specified by the type_id identifier, making it read-only and non-destrucible.
static longH5Topen(long loc_id,
java.lang.String name,
long tapl_id)
H5Topen opens a named datatype at the location specified by loc_id and return an identifier for the datatype.
static intH5Tpack(long type_id)
H5Tpack recursively removes padding from within a compound datatype to make it more efficient (space-wise) to
store that data.
static voidH5Trefresh(long dtype_id)
H5Trefresh causes all buffers associated with a committed datatype to be cleared and immediately
re-loaded with updated contents from disk.
static intH5Tset_cset(long type_id,
int cset)
H5Tset_cset the character set to be used.
static intH5Tset_ebias(long type_id,
int ebias)
H5Tset_ebias sets the exponent bias of a floating-point type.
static voidH5Tset_ebias(long type_id,
long ebias)
H5Tset_ebias sets the exponent bias of a floating-point type.
static intH5Tset_fields(long 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 voidH5Tset_fields(long 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 intH5Tset_inpad(long 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 intH5Tset_norm(long type_id,
int norm)
H5Tset_norm sets the mantissa normalization of a floating-point datatype.
static intH5Tset_offset(long type_id,
int offset)
H5Tset_offset sets the bit offset of the first significant bit.
static voidH5Tset_offset(long type_id,
long offset)
H5Tset_offset sets the bit offset of the first significant bit.
static intH5Tset_order(long type_id,
int order)
H5Tset_order sets the byte ordering of an atomic datatype.
static intH5Tset_pad(long type_id,
int lsb,
int msb)
H5Tset_pad sets the least and most-significant bits padding types.
static intH5Tset_precision(long type_id,
int precision)
H5Tset_precision sets the precision of an atomic datatype.
static voidH5Tset_precision(long type_id,
long precision)
H5Tset_precision sets the precision of an atomic datatype.
static intH5Tset_sign(long type_id,
int sign)
H5Tset_sign sets the sign proprety for an integer type.
static intH5Tset_size(long 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 intH5Tset_strpad(long type_id,
int strpad)
H5Tset_strpad defines the storage mechanism for the string.
static intH5Tset_tag(long type,
java.lang.String tag)
H5Tset_tag tags an opaque datatype type_id with a unique ASCII identifier tag.
static longH5Tvlen_create(long base_id)
H5Tvlen_create creates a new variable-length (VL) dataype.
static intH5Zfilter_avail(int filter)
static intH5Zget_filter_info(int filter)
static intH5Zunregister(int filter)
static voidloadH5Lib()
-
-
Field Detail
-
LIB_VERSION
public static final 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 versions number when a different library is used.
-
H5PATH_PROPERTY_KEY
public static final java.lang.String H5PATH_PROPERTY_KEY
- See Also:
- Constant Field Values
-
H5_LIBRARY_NAME_PROPERTY_KEY
public static final java.lang.String H5_LIBRARY_NAME_PROPERTY_KEY
- See Also:
- Constant Field Values
-
Method Detail
-
loadH5Lib
public static void loadH5Lib()
-
addLibraryPath
public static void addLibraryPath(java.lang.String pathToAdd)
throws java.lang.Exception
- Throws:
java.lang.Exception
-
getOpenIDCount
public static final int getOpenIDCount()
Get number of open IDs.
- Returns:
- Returns a count of open IDs
-
getOpenIDs
public static final java.util.Collection<java.lang.Long> getOpenIDs()
Get the open IDs
- Returns:
- Returns a collection of open IDs
-
H5check_version
public static int H5check_version(int majnum,
int minnum,
int relnum)
H5check_version verifies that the arguments match the version numbers compiled into the library.
- Parameters:
majnum - The major version of the library.minnum - The minor version of the library.relnum - The release number of the library.- Returns:
- a non-negative value if successful. Upon failure (when the versions do not match), this function causes
the application to abort (i.e., crash)
See C API function: herr_t H5check_version()
-
H5close
public static int H5close()
throws HDF5LibraryException
H5close flushes all data to disk, closes all file identifiers, and cleans up all memory used by the library.
- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5open
public static int H5open()
throws HDF5LibraryException
H5open initialize the library.
- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5error_off
public 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. This
behavior may be disabled by calling H5error_off().
- Returns:
- a non-negative value if successful
-
H5error_on
public static void H5error_on()
Turn on error handling. By default, the C library prints the error stack of the HDF-5 C library on stdout. This
behavior may be reenabled by calling H5error_on().
-
H5garbage_collect
public static int H5garbage_collect()
throws HDF5LibraryException
H5garbage_collect collects on all free-lists of all types.
- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5get_libversion
public static int H5get_libversion(int[] libversion)
throws HDF5LibraryException
H5get_libversion retrieves the major, minor, and release numbers of the version of the HDF library which is
linked to the application.
- Parameters:
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.
- Returns:
- a non-negative value if successful, along with the version information.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5set_free_list_limits
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
- Throws:
HDF5LibraryException
-
H5export_dataset
public static void H5export_dataset(java.lang.String file_export_name,
java.lang.String file_name,
java.lang.String object_path,
int binary_order)
throws HDF5LibraryException
H5export_dataset is a utility function to save data in a file.
- Parameters:
file_export_name - The file name to export data into.file_name - The name of the HDF5 file containing the dataset.object_path - The full path of the dataset to be exported.binary_order - 99 - export data as text.
1 - export data as binary Native Order.
2 - export data as binary Little Endian.
3 - export data as binary Big Endian.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Aclose
public static int H5Aclose(long attr_id)
throws HDF5LibraryException
H5Aclose terminates access to the attribute specified by its identifier, attr_id.
- Parameters:
attr_id - IN: Attribute to release access to.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Acopy
public static int H5Acopy(long src_aid,
long dst_aid)
throws HDF5LibraryException
H5Acopy copies the content of one attribute to another.
- Parameters:
src_aid - the identifier of the source attributedst_aid - the identifier of the destination attribute- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Acreate
public static long H5Acreate(long loc_id,
java.lang.String attr_name,
long type_id,
long space_id,
long acpl_id,
long aapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Acreate creates an attribute, attr_name, which is attached to the object specified by the identifier loc_id.
- Parameters:
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- Returns:
- An attribute identifier if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - Name is null.
-
H5Acreate_by_name
public static long H5Acreate_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
long type_id,
long space_id,
long acpl_id,
long aapl_id,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Acreate_by_name creates an attribute, attr_name, which is attached to the object specified by loc_id and
obj_name.
- Parameters:
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- Returns:
- An attribute identifier if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Adelete
public static int H5Adelete(long loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Adelete removes the attribute specified by its name, name, from a dataset, group, or named datatype.
- Parameters:
loc_id - IN: Identifier of the dataset, group, or named datatype.name - IN: Name of the attribute to delete.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Adelete_by_idx
public static void H5Adelete_by_idx(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Adelete_by_idx removes an attribute, specified by its location in an index, from an object.
- Parameters:
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- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - obj_name is null.
-
H5Adelete_by_name
public static int H5Adelete_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Adelete_by_name removes the attribute attr_name from an object specified by location and name, loc_id and
obj_name, respectively.
- Parameters:
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.- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Aexists
public static boolean H5Aexists(long obj_id,
java.lang.String attr_name)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Aexists determines whether the attribute attr_name exists on the object specified by obj_id.
- Parameters:
obj_id - IN: Object identifier.attr_name - IN: Name of the attribute.- Returns:
- boolean true if an attribute with a given name exists.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - attr_name is null.
-
H5Aexists_by_name
public static boolean H5Aexists_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Aexists_by_name determines whether the attribute attr_name exists on an object. That object is specified by its
location and name, loc_id and obj_name, respectively.
- Parameters:
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.- Returns:
- boolean true if an attribute with a given name exists, otherwise returns false.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Aget_info
public static H5A_info_t H5Aget_info(long attr_id)
throws HDF5LibraryException
H5Aget_info retrieves attribute information, by attribute identifier.
- Parameters:
attr_id - IN: Attribute identifier- Returns:
- A buffer(H5A_info_t) for Attribute information
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Aget_info_by_idx
public static H5A_info_t H5Aget_info_by_idx(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Aget_info_by_idx Retrieves attribute information, by attribute index position.
- Parameters:
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- Returns:
- A buffer(H5A_info_t) for Attribute information
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - obj_name is null.
-
H5Aget_info_by_name
public static H5A_info_t H5Aget_info_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Aget_info_by_name Retrieves attribute information, by attribute name.
- Parameters:
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- Returns:
- A buffer(H5A_info_t) for Attribute information
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - obj_name is null.
-
H5Aget_name
public static java.lang.String H5Aget_name(long attr_id)
throws HDF5LibraryException
H5Aget_name retrieves the name of an attribute specified by the identifier, attr_id.
- Parameters:
attr_id - IN: Identifier of the attribute.- Returns:
- String for Attribute name.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Aget_name_by_idx
public static java.lang.String H5Aget_name_by_idx(long attr_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
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.
- Parameters:
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- Returns:
- String for Attribute name.
- Throws:
HDF5LibraryException - - Error from the HDF5 Library.java.lang.NullPointerException - - obj_name is null.
-
H5Aget_space
public static long H5Aget_space(long attr_id)
throws HDF5LibraryException
H5Aget_space retrieves a copy of the dataspace for an attribute.
- Parameters:
attr_id - IN: Identifier of an attribute.- Returns:
- attribute dataspace identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Aget_storage_size
public static long H5Aget_storage_size(long attr_id)
throws HDF5LibraryException
H5Aget_storage_size returns the amount of storage that is required for the specified attribute, attr_id.
- Parameters:
attr_id - IN: Identifier of the attribute to query.- Returns:
- the amount of storage size allocated for the attribute; otherwise returns 0 (zero)
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Aget_type
public static long H5Aget_type(long attr_id)
throws HDF5LibraryException
H5Aget_type retrieves a copy of the datatype for an attribute.
- Parameters:
attr_id - IN: Identifier of an attribute.- Returns:
- a datatype identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Aopen
public static long H5Aopen(long obj_id,
java.lang.String attr_name,
long aapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Aopen opens an existing attribute, attr_name, that is attached to an object specified an object identifier,
object_id.
- Parameters:
obj_id - IN: Identifier for object to which attribute is attachedattr_name - IN: Name of attribute to openaapl_id - IN: Attribute access property list identifier- Returns:
- An attribute identifier if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - Name is null.
-
H5Aopen_by_idx
public static long H5Aopen_by_idx(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long n,
long aapl_id,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Aopen_by_idx opens an existing attribute that is attached to an object specified by location and name, loc_id
and obj_name, respectively
- Parameters:
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- Returns:
- An attribute identifier if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - Name is null.
-
H5Aopen_by_name
public static long H5Aopen_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String attr_name,
long aapl_id,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Aopen_by_name Opens an attribute for an object by object name and attribute name
- Parameters:
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- Returns:
- Returns an attribute identifier if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - obj_name is null.
-
H5Aread
public static int H5Aread(long attr_id,
long mem_type_id,
byte[] obj,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
mem_type_id. The entire attribute is read into buf from the file.
- Parameters:
attr_id - IN: Identifier of an attribute to read.mem_type_id - IN: Identifier of the attribute datatype (in memory).obj - Buffer to store data read from the file.isCriticalPinning - request lock on data reference.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - data buffer is null.
-
H5Aread
public static int H5Aread(long attr_id,
long mem_type_id,
byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread
public static int H5Aread(long attr_id,
long mem_type_id,
java.lang.Object obj)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5ExceptionHDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread
public static int H5Aread(long attr_id,
long mem_type_id,
java.lang.Object obj,
boolean isCriticalPinning)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
mem_type_id. The entire attribute is read into data object from the file.
- Parameters:
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.isCriticalPinning - request lock on data reference.- Returns:
- a non-negative value if successful
- Throws:
HDF5Exception - - Failure in the data conversion.HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - data buffer is null. See public synchronized static native int H5Aread( )
-
H5Aread_double
public static int H5Aread_double(long attr_id,
long mem_type_id,
double[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_double
public static int H5Aread_double(long attr_id,
long mem_type_id,
double[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_float
public static int H5Aread_float(long attr_id,
long mem_type_id,
float[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_float
public static int H5Aread_float(long attr_id,
long mem_type_id,
float[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_int
public static int H5Aread_int(long attr_id,
long mem_type_id,
int[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_int
public static int H5Aread_int(long attr_id,
long mem_type_id,
int[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_long
public static int H5Aread_long(long attr_id,
long mem_type_id,
long[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_long
public static int H5Aread_long(long attr_id,
long mem_type_id,
long[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_reg_ref
public static int H5Aread_reg_ref(long attr_id,
long mem_type_id,
java.lang.String[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_short
public static int H5Aread_short(long attr_id,
long mem_type_id,
short[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_short
public static int H5Aread_short(long attr_id,
long mem_type_id,
short[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5AreadVL
public static int H5AreadVL(long attr_id,
long mem_type_id,
java.lang.Object[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_string
public static int H5Aread_string(long attr_id,
long mem_type_id,
java.lang.String[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Aread_VLStrings
public static int H5Aread_VLStrings(long attr_id,
long mem_type_id,
java.lang.Object[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5AreadComplex
public static int H5AreadComplex(long attr_id,
long mem_type_id,
java.lang.String[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Arename
public static int H5Arename(long loc_id,
java.lang.String old_attr_name,
java.lang.String new_attr_name)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Arename changes the name of attribute that is attached to the object specified by loc_id. The attribute named
old_attr_name is renamed new_attr_name.
- Parameters:
loc_id - IN: Location or object identifier; may be dataset or groupold_attr_name - IN: Prior attribute namenew_attr_name - IN: New attribute name- Returns:
- A non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - Name is null.
-
H5Arename_by_name
public static int H5Arename_by_name(long loc_id,
java.lang.String obj_name,
java.lang.String old_attr_name,
java.lang.String new_attr_name,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Arename_by_name changes the name of attribute that is attached to the object specified by loc_id and obj_name.
The attribute named old_attr_name is renamed new_attr_name.
- Parameters:
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- Returns:
- A non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - Name is null.
-
H5Awrite
public static int H5Awrite(long attr_id,
long mem_type_id,
byte[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
mem_type_id. The entire attribute is written from buf to the file.
- Parameters:
attr_id - IN: Identifier of an attribute to write.mem_type_id - IN: Identifier of the attribute datatype (in memory).buf - IN: Buffer with data to be written to the file.isCriticalPinning - IN: request lock on data reference.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - data is null.
-
H5Awrite
public static int H5Awrite(long attr_id,
long mem_type_id,
byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite
public static int H5Awrite(long attr_id,
long mem_type_id,
java.lang.Object obj)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5ExceptionHDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite
public static int H5Awrite(long attr_id,
long mem_type_id,
java.lang.Object obj,
boolean isCriticalPinning)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
mem_type_id. The entire attribute is written from data object to the file.
- Parameters:
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.isCriticalPinning - request lock on data reference.- Returns:
- a non-negative value if successful
- Throws:
HDF5Exception - - Failure in the data conversion.HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - data object is null
-
H5Awrite_double
public static int H5Awrite_double(long attr_id,
long mem_type_id,
double[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite_double
public static int H5Awrite_double(long attr_id,
long mem_type_id,
double[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite_float
public static int H5Awrite_float(long attr_id,
long mem_type_id,
float[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite_float
public static int H5Awrite_float(long attr_id,
long mem_type_id,
float[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite_int
public static int H5Awrite_int(long attr_id,
long mem_type_id,
int[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite_int
public static int H5Awrite_int(long attr_id,
long mem_type_id,
int[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite_long
public static int H5Awrite_long(long attr_id,
long mem_type_id,
long[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite_long
public static int H5Awrite_long(long attr_id,
long mem_type_id,
long[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite_short
public static int H5Awrite_short(long attr_id,
long mem_type_id,
short[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite_short
public static int H5Awrite_short(long attr_id,
long mem_type_id,
short[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite_string
public static int H5Awrite_string(long attr_id,
long mem_type_id,
java.lang.String[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5AwriteVL
public static int H5AwriteVL(long attr_id,
long mem_type_id,
java.lang.Object[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Awrite_VLStrings
public static int H5Awrite_VLStrings(long attr_id,
long mem_type_id,
java.lang.Object[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Awrite_VLStrings writes a variable length String dataset, specified by its identifier attr_id, from
the application memory buffer buf into the file.
---- contributed by Rosetta Biosoftware
- Parameters:
attr_id - Identifier of the attribute read from.mem_type_id - Identifier of the memory datatype.buf - Buffer with data to be written to the file.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Aget_create_plist
public static long H5Aget_create_plist(long attr_id)
throws HDF5LibraryException
H5Aget_create_plist retrieves a copy of the attribute creation property list identifier.
- Parameters:
attr_id - IN: Identifier of an attribute.- Returns:
- identifier for the attribute's creation property list if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Aiterate
public static int H5Aiterate(long loc_id,
int idx_type,
int order,
long idx,
H5A_iterate_cb op,
H5A_iterate_t op_data)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Aiterate2 iterates over the attributes attached to a dataset, named datatype, or group, as
specified by obj_id. For each attribute, user-provided data, op_data, with additional information
as defined below, is passed to a user-defined function, op, which operates on that attribute.
- Parameters:
loc_id - IN: Identifier for object to which attributes are attached; may be group, dataset, or named datatype.idx_type - IN: The type of index specified by idx_type can be one of the following:
H5_INDEX_NAME An alpha-numeric index by attribute name.
H5_INDEX_CRT_ORDER An index by creation order.order - IN: The order in which the index is to be traversed, as specified by order, can be one of the following:
H5_ITER_INC Iteration is from beginning to end, i.e., a top-down iteration
incrementing the index position at each step.
H5_ITER_DEC Iteration starts at the end of the index, i.e., a bottom-up iteration
decrementing the index position at each step.
H5_ITER_NATIVE HDF5 iterates in the fastest-available order. No information is provided
as to the order, but HDF5 ensures that each element in the index will be
visited if the iteration completes successfully.idx - IN/OUT: Initial and returned offset within index.op - IN: Callback function to operate on each value.op_data - IN/OUT: Pointer to any user-efined data for use by operator function.- Returns:
- returns the return value of the first operator that returns a positive value, or zero if all members were
processed with no operator returning non-zero.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Aiterate_by_name
public static int H5Aiterate_by_name(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
long idx,
H5A_iterate_cb op,
H5A_iterate_t op_data,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Aiterate_by_name iterates over the attributes attached to the dataset or group specified with loc_id
and obj_name. For each attribute, user-provided data, op_data, with additional information as defined
below, is passed to a user-defined function, op, which operates on that attribute.
- Parameters:
loc_id - IN: Identifier for object to which attributes are attached; may be group, dataset, or named datatype.obj_name - IN: Name of object, relative to location.idx_type - IN: The type of index specified by idx_type can be one of the following:
H5_INDEX_NAME An alpha-numeric index by attribute name.
H5_INDEX_CRT_ORDER An index by creation order.order - IN: The order in which the index is to be traversed, as specified by order, can be one of the following:
H5_ITER_INC Iteration is from beginning to end, i.e., a top-down iteration
incrementing the index position at each step.
H5_ITER_DEC Iteration starts at the end of the index, i.e., a bottom-up iteration
decrementing the index position at each step.
H5_ITER_NATIVE HDF5 iterates in the fastest-available order. No information is provided
as to the order, but HDF5 ensures that each element in the index will be
visited if the iteration completes successfully.idx - IN/OUT: Initial and returned offset within index.op - IN: Callback function to operate on each value.op_data - IN/OUT: Pointer to any user-efined data for use by operator function.lapl_id - IN: Link access property list- Returns:
- returns the return value of the first operator that returns a positive value, or zero if all members were
processed with no operator returning non-zero.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Dcopy
public static int H5Dcopy(long src_did,
long dst_did)
throws HDF5LibraryException
H5Dcopy copies the content of one dataset to another dataset.
- Parameters:
src_did - the identifier of the source datasetdst_did - the identifier of the destinaiton dataset- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Dclose
public static int H5Dclose(long dataset_id)
throws HDF5LibraryException
H5Dclose ends access to a dataset specified by dataset_id and releases resources used by it.
- Parameters:
dataset_id - Identifier of the dataset to finish access to.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Dcreate
public static long H5Dcreate(long loc_id,
java.lang.String name,
long type_id,
long space_id,
long lcpl_id,
long dcpl_id,
long dapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Dcreate creates a new dataset named name at the location specified by loc_id.
- Parameters:
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.- Returns:
- a dataset identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Dcreate_anon
public static long H5Dcreate_anon(long loc_id,
long type_id,
long space_id,
long dcpl_id,
long dapl_id)
throws HDF5LibraryException
H5Dcreate_anon creates a dataset in the file specified by loc_id.
- Parameters:
loc_id - IN: Location identifiertype_id - IN: Datatype identifierspace_id - IN: Dataspace identifierdcpl_id - IN: Identifier of dataset creation property list.dapl_id - IN: Identifier of dataset access property list.- Returns:
- a dataset identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Dfill
public static void H5Dfill(byte[] fill,
long fill_type,
byte[] buf,
long buf_type,
long space_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Dfill explicitly fills the dataspace selection in memory, space_id, with the fill value specified in fill.
- Parameters:
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_id - IN: Dataspace describing memory buffer and containing the selection to be filled.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Dget_access_plist
public static long H5Dget_access_plist(long dset_id)
throws HDF5LibraryException
H5Dget_access_plist returns an identifier for a copy of the dataset access property list for a dataset.
- Parameters:
dset_id - IN: Identifier of the dataset to query.- Returns:
- a dataset access property list identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Dget_create_plist
public static long H5Dget_create_plist(long dataset_id)
throws HDF5LibraryException
H5Dget_create_plist returns an identifier for a copy of the dataset creation property list for a dataset.
- Parameters:
dataset_id - Identifier of the dataset to query.- Returns:
- a dataset creation property list identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Dget_offset
public static long H5Dget_offset(long dset_id)
throws HDF5LibraryException
H5Dget_offset returns the address in the file of the dataset dset_id.
- Parameters:
dset_id - IN: Identifier of the dataset in question- Returns:
- the offset in bytes.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Dget_space
public static long H5Dget_space(long dataset_id)
throws HDF5LibraryException
H5Dget_space returns an identifier for a copy of the dataspace for a dataset.
- Parameters:
dataset_id - Identifier of the dataset to query.- Returns:
- a dataspace identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Dget_space_status
public static int H5Dget_space_status(long dset_id)
throws HDF5LibraryException
H5Dget_space_status determines whether space has been allocated for the dataset dset_id.
- Parameters:
dset_id - IN: Identifier of the dataset to query.- Returns:
- the space allocation status
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Dget_storage_size
public static long H5Dget_storage_size(long dataset_id)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Dget_storage_size returns the amount of storage that is required for the dataset.
- Parameters:
dataset_id - Identifier of the dataset in question- Returns:
- he amount of storage space allocated for the dataset.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException
-
H5Dget_type
public static long H5Dget_type(long dataset_id)
throws HDF5LibraryException
H5Dget_type returns an identifier for a copy of the datatype for a dataset.
- Parameters:
dataset_id - Identifier of the dataset to query.- Returns:
- a datatype identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Diterate
public static int H5Diterate(byte[] buf,
long buf_type,
long space_id,
H5D_iterate_cb op,
H5D_iterate_t op_data)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Diterate iterates over all the data elements in the memory buffer buf, executing the callback function operator
once for each such data element.
- Parameters:
buf - IN/OUT: Pointer to the memory containing the elements to iterate over.buf_type - IN: Buffer datatype identifier.space_id - IN: Dataspace describing memory buffer.op - IN: Callback function to operate on each value.op_data - IN/OUT: Pointer to any user-efined data for use by operator function.- Returns:
- returns the return value of the first operator that returns a positive value, or zero if all members were
processed with no operator returning non-zero.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Dopen
public static long H5Dopen(long loc_id,
java.lang.String name,
long dapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Dopen opens the existing dataset specified by a location identifier and name, loc_id and name, respectively.
- Parameters:
loc_id - IN: Location identifiername - IN: Dataset namedapl_id - IN: Identifier of dataset access property list.- Returns:
- a dataset identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Dread
public static int H5Dread(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
byte[] obj,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
memory buffer buf.
- Parameters:
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 - Buffer to store data read from the file.isCriticalPinning - request lock on data reference.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - data buffer is null.
-
H5Dread
public static int H5Dread(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread
public static int H5Dread(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object obj)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5ExceptionHDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread
public static int H5Dread(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object obj,
boolean isCriticalPinning)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
data object.
- Parameters:
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.isCriticalPinning - request lock on data reference.- Returns:
- a non-negative value if successful
- Throws:
HDF5Exception - - Failure in the data conversion.HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - data object is null.
-
H5Dread_double
public static int H5Dread_double(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
double[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_double
public static int H5Dread_double(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
double[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_float
public static int H5Dread_float(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
float[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_float
public static int H5Dread_float(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
float[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_int
public static int H5Dread_int(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
int[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_int
public static int H5Dread_int(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
int[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_long
public static int H5Dread_long(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
long[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_long
public static int H5Dread_long(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
long[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_reg_ref
public static int H5Dread_reg_ref(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.String[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_short
public static int H5Dread_short(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
short[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_short
public static int H5Dread_short(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
short[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5DreadVL
public static int H5DreadVL(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_string
public static int H5Dread_string(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.String[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dread_VLStrings
public static int H5Dread_VLStrings(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dset_extent
public static void H5Dset_extent(long dset_id,
long[] size)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Dset_extent sets the current dimensions of the chunked dataset dset_id to the sizes specified in size.
- Parameters:
dset_id - IN: Chunked dataset identifier.size - IN: Array containing the new magnitude of each dimension of the dataset.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - size is null.
-
H5Dvlen_get_buf_size
public static long H5Dvlen_get_buf_size(long dset_id,
long type_id,
long space_id)
throws HDF5LibraryException
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.
- Parameters:
dset_id - IN: Identifier of the dataset read from.type_id - IN: Identifier of the datatype.space_id - IN: Identifier of the dataspace.- Returns:
- the size in bytes of the memory buffer required to store the VL data.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Dvlen_reclaim
public static int H5Dvlen_reclaim(long type_id,
long space_id,
long xfer_plist_id,
byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Dvlen_reclaim reclaims buffer used for VL data.
- Parameters:
type_id - Identifier of the datatype.space_id - Identifier of the dataspace.xfer_plist_id - Identifier of a transfer property list for this I/O operation.buf - Buffer with data to be reclaimed.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Dwrite
public static int H5Dwrite(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
byte[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
buf into the file.
- Parameters:
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.isCriticalPinning - request lock on data reference.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Dwrite
public static int H5Dwrite(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite
public static int H5Dwrite(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object obj)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5ExceptionHDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite
public static int H5Dwrite(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object obj,
boolean isCriticalPinning)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory data
object into the file.
- Parameters:
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.isCriticalPinning - request lock on data reference.- Returns:
- a non-negative value if successful
- Throws:
HDF5Exception - - Failure in the data conversion.HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - data object is null.
-
H5Dwrite_double
public static int H5Dwrite_double(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
double[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite_double
public static int H5Dwrite_double(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
double[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite_float
public static int H5Dwrite_float(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
float[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite_float
public static int H5Dwrite_float(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
float[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite_int
public static int H5Dwrite_int(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
int[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite_int
public static int H5Dwrite_int(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
int[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite_long
public static int H5Dwrite_long(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
long[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite_long
public static int H5Dwrite_long(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
long[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite_short
public static int H5Dwrite_short(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
short[] buf,
boolean isCriticalPinning)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite_short
public static int H5Dwrite_short(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
short[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite_string
public static int H5Dwrite_string(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.String[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5DwriteVL
public static int H5DwriteVL(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Dwrite_VLStrings
public static int H5Dwrite_VLStrings(long dataset_id,
long mem_type_id,
long mem_space_id,
long file_space_id,
long xfer_plist_id,
java.lang.Object[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Dwrite_VLStrings writes a (partial) variable length String dataset, specified by its identifier dataset_id, from
the application memory buffer buf into the file.
---- contributed by Rosetta Biosoftware
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Dflush
public static void H5Dflush(long dset_id)
throws HDF5LibraryException
H5Dflush causes all buffers associated with a dataset to be immediately flushed to disk without removing the
data from the cache.
- Parameters:
dset_id - IN: Identifier of the dataset to be flushed.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Drefresh
public static void H5Drefresh(long dset_id)
throws HDF5LibraryException
H5Drefresh causes all buffers associated with a dataset to be cleared and immediately re-loaded with updated
contents from disk. This function essentially closes the dataset, evicts all metadata associated with it
from the cache, and then re-opens the dataset. The reopened dataset is automatically re-registered with the same ID.
- Parameters:
dset_id - IN: Identifier of the dataset to be refreshed.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Eauto_is_v2
public static boolean H5Eauto_is_v2(long stack_id)
throws HDF5LibraryException
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.
- Parameters:
stack_id - IN: Error stack identifier.- Returns:
- boolean true if the error stack conforms to H5E_auto2_t and false if it conforms to H5E_auto1_t.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Eclear
public static int H5Eclear()
throws HDF5LibraryException
H5Eclear clears the error stack for the current thread. H5Eclear can fail if there are problems initializing the
library.
This may be used by exception handlers to assure that the error condition in the HDF-5 library has been reset.
- Returns:
- Returns a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Eclear
public static void H5Eclear(long stack_id)
throws HDF5LibraryException
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.
- Parameters:
stack_id - IN: Error stack identifier.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Eclear2
public static void H5Eclear2(long stack_id)
throws HDF5LibraryException
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.
- Parameters:
stack_id - IN: Error stack identifier.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Eclose_msg
public static void H5Eclose_msg(long err_id)
throws HDF5LibraryException
H5Eclose_msg closes an error message identifier, which can be either a major or minor message.
- Parameters:
err_id - IN: Error message identifier.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Eclose_stack
public static void H5Eclose_stack(long stack_id)
throws HDF5LibraryException
H5Eclose_stack closes the object handle for an error stack and releases its resources.
- Parameters:
stack_id - IN: Error stack identifier.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Ecreate_msg
public static long H5Ecreate_msg(long cls_id,
int msg_type,
java.lang.String msg)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Ecreate_msg adds an error message to an error class defined by client library or application program.
- Parameters:
cls_id - IN: Error class identifier.msg_type - IN: The type of the error message.msg - IN: The error message.- Returns:
- a message identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - msg is null.
-
H5Ecreate_stack
public static long H5Ecreate_stack()
throws HDF5LibraryException
H5Ecreate_stack creates a new empty error stack and returns the new stack's identifier.
- Returns:
- an error stack identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Eget_class_name
public static java.lang.String H5Eget_class_name(long class_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Eget_class_name retrieves the name of the error class specified by the class identifier.
- Parameters:
class_id - IN: Error class identifier.- Returns:
- the name of the error class
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException
-
H5Eget_current_stack
public static long H5Eget_current_stack()
throws HDF5LibraryException
H5Eget_current_stack copies the current error stack and returns an error stack identifier for the new copy.
- Returns:
- an error stack identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Eset_current_stack
public static void H5Eset_current_stack(long stack_id)
throws HDF5LibraryException
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.
- Parameters:
stack_id - IN: Error stack identifier.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Eget_msg
public static java.lang.String H5Eget_msg(long msg_id,
int[] type_list)
throws HDF5LibraryException
H5Eget_msg retrieves the error message including its length and type.
- Parameters:
msg_id - IN: Name of the error class.type_list - OUT: The type of the error message. Valid values are H5E_MAJOR and H5E_MINOR.- Returns:
- the error message
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Eget_num
public static long H5Eget_num(long stack_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Eget_num retrieves the number of error records in the error stack specified by estack_id (including major,
minor messages and description).
- Parameters:
stack_id - IN: Error stack identifier.- Returns:
- the number of error messages
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException
-
H5Eprint2
public static void H5Eprint2(long stack_id,
java.lang.Object stream)
throws HDF5LibraryException
H5Eprint2 prints the error stack specified by estack_id on the specified stream, stream.
- Parameters:
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.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Epop
public static void H5Epop(long stack_id,
long count)
throws HDF5LibraryException
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).
- Parameters:
stack_id - IN: Error stack identifier.count - IN: Version of the client library or application to which the error class belongs.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Epush
public static void H5Epush(long stack_id,
java.lang.String file,
java.lang.String func,
int line,
long cls_id,
long maj_id,
long min_id,
java.lang.String msg)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Epush2 pushes a new error record onto the error stack specified by estack_id.
- Parameters:
stack_id - IN: Error stack identifier.file - IN: Name of the file in which the error was detected.func - IN: Name of the function in which the error was detected.line - IN: Line number within the file at which the error was detected.cls_id - IN: Error class identifier.maj_id - IN: Major error identifier.min_id - IN: Minor error identifier.msg - IN: Error description string.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - file, func, or msg is null.
-
H5Epush2
public static void H5Epush2(long stack_id,
java.lang.String file,
java.lang.String func,
int line,
long cls_id,
long maj_id,
long min_id,
java.lang.String msg)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Eregister_class
public static long H5Eregister_class(java.lang.String cls_name,
java.lang.String lib_name,
java.lang.String version)
throws HDF5LibraryException,
java.lang.NullPointerException
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.
- Parameters:
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.- Returns:
- a class identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Eunregister_class
public static void H5Eunregister_class(long class_id)
throws HDF5LibraryException
H5Eunregister_class removes the error class specified by class_id.
- Parameters:
class_id - IN: Error class identifier.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Ewalk
public static void H5Ewalk(long stack_id,
long direction,
H5E_walk_cb func,
H5E_walk_t client_data)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Ewalk walks the error stack specified by estack_id for the current thread and calls the
function specified in func for each error along the way.
- Parameters:
stack_id - IN: Error stack identifier.direction - IN: Direction in which the error stack is to be walked.func - IN: Function to be called for each error encountered.client_data - IN: Data to be passed with func.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - func is null.
-
H5Ewalk2
public static void H5Ewalk2(long stack_id,
long direction,
H5E_walk_cb func,
H5E_walk_t client_data)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Fclose
public static int H5Fclose(long file_id)
throws HDF5LibraryException
H5Fclose terminates access to an HDF5 file.
- Parameters:
file_id - Identifier of a file to terminate access to.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fopen
public static long H5Fopen(java.lang.String name,
int flags,
long access_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Fopen opens an existing file and is the primary function for accessing existing HDF5 files.
- Parameters:
name - Name of the file to access.flags - File access flags.access_id - Identifier for the file access properties list.- Returns:
- a file identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Freopen
public static long H5Freopen(long file_id)
throws HDF5LibraryException
H5Freopen reopens an HDF5 file.
- Parameters:
file_id - Identifier of a file to terminate and reopen access to.- Returns:
- a new file identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fcreate
public static long H5Fcreate(java.lang.String name,
int flags,
long create_id,
long access_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Fcreate is the primary function for creating HDF5 files.
- Parameters:
name - Name of the file to access.flags - File access flags. Possible values include:
-
H5F_ACC_RDWR Allow read and write access to file.
-
H5F_ACC_RDONLY Allow read-only access to file.
-
H5F_ACC_TRUNC Truncate file, if it already exists, erasing all data previously stored in the file.
-
H5F_ACC_EXCL Fail if file already exists.
-
H5P_DEFAULT Apply default file access and creation properties.
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.- Returns:
- a file identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Fflush
public static int H5Fflush(long object_id,
int scope)
throws HDF5LibraryException
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.
After this call completes, the file (or object) is in a consistent state and all data written to date is assured
to be permanent.
- Parameters:
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:
-
H5F_SCOPE_GLOBAL Flushes the entire virtual file.
-
H5F_SCOPE_LOCAL Flushes only the specified file.
- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fget_access_plist
public static long H5Fget_access_plist(long file_id)
throws HDF5LibraryException
H5Fget_access_plist returns the file access property list identifier of the specified file.
- Parameters:
file_id - Identifier of file to get access property list of- Returns:
- a file access property list identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fget_create_plist
public static long H5Fget_create_plist(long file_id)
throws HDF5LibraryException
H5Fget_create_plist returns a file creation property list identifier identifying the creation properties used to
create this file.
- Parameters:
file_id - Identifier of the file to get creation property list- Returns:
- a file creation property list identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fget_filesize
public static long H5Fget_filesize(long file_id)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Fget_freespace
public static long H5Fget_freespace(long file_id)
throws HDF5LibraryException
H5Fget_freespace returns the amount of space that is unused by any objects in the file.
- Parameters:
file_id - IN: File identifier for a currently-open HDF5 file- Returns:
- the amount of free space in the file
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fget_intent
public static int H5Fget_intent(long file_id)
throws HDF5LibraryException
H5Fget_intent retrieves the intended access mode flag passed with H5Fopen when the file was opened.
- Parameters:
file_id - IN: File identifier for a currently-open HDF5 file- Returns:
- the intended access mode flag, as originally passed with H5Fopen.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fget_mdc_hit_rate
public static double H5Fget_mdc_hit_rate(long file_id)
throws HDF5LibraryException
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.
- Parameters:
file_id - IN: Identifier of the target file.- Returns:
- the double in which the hit rate is returned.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fget_mdc_size
public static int H5Fget_mdc_size(long file_id,
long[] metadata_cache)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Fget_mdc_size queries the metadata cache of the target file for the desired size information.
- Parameters:
file_id - IN: Identifier of the target file.metadata_cache - OUT: Current metadata cache information
- metadata_cache[0] = max_size_ptr // current cache maximum size
- metadata_cache[1] = min_clean_size_ptr // current cache minimum clean size
- metadata_cache[2] = cur_size_ptr // current cache size
- Returns:
- current number of entries in the cache
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - metadata_cache is null.java.lang.IllegalArgumentException
-
H5Fget_name
public static java.lang.String H5Fget_name(long obj_id)
throws HDF5LibraryException
H5Fget_name retrieves the name of the file to which the object obj_id belongs.
- Parameters:
obj_id - IN: Identifier of the object for which the associated filename is sought.- Returns:
- the filename.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fget_obj_count
public static long H5Fget_obj_count(long file_id,
int types)
throws HDF5LibraryException
H5Fget_obj_count returns the number of open object identifiers for the file.
- Parameters:
file_id - IN: File identifier for a currently-open HDF5 filetypes - IN: Type of object for which identifiers are to be returned.
- H5F_OBJ_FILE Files only
- H5F_OBJ_DATASET Datasets only
- H5F_OBJ_GROUP Groups only
- H5F_OBJ_DATATYPE Named datatypes only
- H5F_OBJ_ATTR Attributes only
- H5F_OBJ_ALL All of the above
- H5F_OBJ_LOCAL Restrict search to objects opened through current file identifier.
- Returns:
- the number of open objects.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fget_obj_ids
public static long H5Fget_obj_ids(long file_id,
int types,
long max_objs,
long[] obj_id_list)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Fget_obj_ids returns the list of identifiers for all open HDF5 objects fitting the specified criteria.
- Parameters:
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.- Returns:
- the number of objects placed into obj_id_list.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - obj_id_list is null.
-
H5Fis_hdf5
public static boolean H5Fis_hdf5(java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Fis_hdf5 determines whether a file is in the HDF5 format.
- Parameters:
name - File name to check format.- Returns:
- true if is HDF-5, false if not.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Fmount
public static int H5Fmount(long loc_id,
java.lang.String name,
long child_id,
long plist_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Fmount mounts the file specified by child_id onto the group specified by loc_id and name using the mount
properties plist_id.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Funmount
public static int H5Funmount(long loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
Given a mount point, H5Funmount dissassociates the mount point's file from the file mounted there.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Freset_mdc_hit_rate_stats
public static void H5Freset_mdc_hit_rate_stats(long file_id)
throws HDF5LibraryException
H5Freset_mdc_hit_rate_stats resets the hit rate statistics counters in the metadata cache associated with the
specified file.
- Parameters:
file_id - IN: Identifier of the target file.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fget_info
public static H5F_info2_t H5Fget_info(long obj_id)
throws HDF5LibraryException
H5Fget_info returns global information for the file associated with the
object identifier obj_id.
- Parameters:
obj_id - IN: Object identifier for any object in the file.- Returns:
- A buffer(H5F_info2_t) for current "global" information about file
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fclear_elink_file_cache
public static void H5Fclear_elink_file_cache(long file_id)
throws HDF5LibraryException
H5Fclear_elink_file_cache evicts all the cached child files in the specified file's external file
cache, causing them to be closed if there is nothing else holding them open.
- Parameters:
file_id - IN: Identifier of the target file.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fstart_swmr_write
public static void H5Fstart_swmr_write(long file_id)
throws HDF5LibraryException
H5Fstart_swmr_write will activate SWMR writing mode for a file associated with file_id. This routine will
prepare and ensure the file is safe for SWMR writing.
- Parameters:
file_id - IN: Identifier of the target file.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fstart_mdc_logging
public static void H5Fstart_mdc_logging(long file_id)
throws HDF5LibraryException
H5Fstart_mdc_logging starts logging metadata cache events if logging was previously enabled.
- Parameters:
file_id - IN: Identifier of the target file.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fstop_mdc_logging
public static void H5Fstop_mdc_logging(long file_id)
throws HDF5LibraryException
H5Fstop_mdc_logging stops logging metadata cache events if logging was previously enabled and is currently ongoing.
- Parameters:
file_id - IN: Identifier of the target file.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fget_mdc_logging_status
public static void H5Fget_mdc_logging_status(long file_id,
boolean[] mdc_logging_status)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Fget_mdc_logging_status gets the current metadata cache logging status.
- Parameters:
file_id - IN: Identifier of the target file.mdc_logging_status - the status
mdc_logging_status[0] = is_enabled, whether logging is enabled
mdc_logging_status[1] = is_currently_logging, whether events are currently being logged- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - mdc_logging_status is null.
-
H5Fget_dset_no_attrs_hint
public static boolean H5Fget_dset_no_attrs_hint(long file_id)
throws HDF5LibraryException
H5Fget_dset_no_attrs_hint gets the file-level setting to create minimized dataset object headers.
- Parameters:
file_id - IN: Identifier of the target file.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fset_dset_no_attrs_hint
public static void H5Fset_dset_no_attrs_hint(long file_id,
boolean minimize)
throws HDF5LibraryException
H5Fset_dset_no_attrs_hint sets the file-level setting to create minimized dataset object headers.
- Parameters:
file_id - IN: Identifier of the target file.minimize - the minimize hint setting- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Fset_libver_bounds
public static void H5Fset_libver_bounds(long file_id,
int low,
int high)
throws HDF5LibraryException
H5Fset_libver_bounds sets a different low and high bounds while a file is open.
- Parameters:
file_id - IN: Identifier of the target file.low - 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.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Gclose
public static int H5Gclose(long group_id)
throws HDF5LibraryException
H5Gclose releases resources used by a group which was opened by a call to H5Gcreate() or H5Gopen().
- Parameters:
group_id - Group identifier to release.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Gcreate
public static long H5Gcreate(long loc_id,
java.lang.String name,
long lcpl_id,
long gcpl_id,
long gapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Gcreate creates a new group with the specified name at the specified location, loc_id.
- Parameters:
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.)- Returns:
- a valid group identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Gcreate_anon
public static long H5Gcreate_anon(long loc_id,
long gcpl_id,
long gapl_id)
throws HDF5LibraryException
H5Gcreate_anon creates a new empty group in the file specified by loc_id.
- Parameters:
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.)- Returns:
- a valid group identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Gget_create_plist
public static long H5Gget_create_plist(long group_id)
throws HDF5LibraryException
H5Gget_create_plist returns an identifier for the group creation property list associated with the group
specified by group_id.
- Parameters:
group_id - IN: Identifier of the group.- Returns:
- an identifier for the group's creation property list
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Gget_info
public static H5G_info_t H5Gget_info(long group_id)
throws HDF5LibraryException
H5Gget_info retrieves information about the group specified by group_id. The information is returned in the
group_info struct.
- Parameters:
group_id - IN: Identifier of the group.- Returns:
- a structure in which group information is returned
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Gget_info_by_idx
public static H5G_info_t H5Gget_info_by_idx(long group_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Gget_info_by_idx retrieves information about a group, according to the group's position within an index.
- Parameters:
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.- Returns:
- a structure in which group information is returned
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Gget_info_by_name
public static H5G_info_t H5Gget_info_by_name(long group_id,
java.lang.String name,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Gget_info_by_name retrieves information about the group group_name located in the file or group specified by
loc_id.
- Parameters:
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.- Returns:
- a structure in which group information is returned
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Gget_obj_info_all
public static int H5Gget_obj_info_all(long loc_id,
java.lang.String name,
java.lang.String[] objNames,
int[] objTypes,
long[] objRef)
throws HDF5LibraryException,
java.lang.NullPointerException
retrieves information of all objects under the group (name) located in the file or group specified by loc_id.
- Parameters:
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.objRef - OUT: Reference number of all objects under the group, name.- Returns:
- the number of items found
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Gget_obj_info_all
public static int H5Gget_obj_info_all(long loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] otype,
int[] ltype,
long[] ref,
int indx_type)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Gget_obj_info_all
public static int H5Gget_obj_info_all(long loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] otype,
int[] ltype,
long[] fno,
long[] ref,
int indx_type)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Gget_obj_info_full
public static int H5Gget_obj_info_full(long loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] otype,
int[] ltype,
long[] fno,
long[] ref,
int indx_type,
int indx_order)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Gget_obj_info_idx
public static int H5Gget_obj_info_idx(long loc_id,
java.lang.String name,
int idx,
java.lang.String[] oname,
int[] type)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Gget_obj_info_idx report the name and type of object with index 'idx' in a Group. The 'idx' corresponds to the
index maintained by H5Giterate. Each link is returned, so objects with multiple links will be counted once for
each link.
- Parameters:
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]- Returns:
- non-negative if successful, -1 if not.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Gget_obj_info_max
public static int H5Gget_obj_info_max(long loc_id,
java.lang.String[] objNames,
int[] objTypes,
int[] lnkTypes,
long[] objRef,
long objMax)
throws HDF5LibraryException,
java.lang.NullPointerException
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.
- Parameters:
loc_id - IN: File or group identifierobjNames - OUT: Names of all objects under the group, name.objTypes - OUT: Types of all objects under the group, name.lnkTypes - OUT: Types of all links under the group, name.objRef - OUT: Reference number of all objects under the group, name.objMax - IN: Maximum number of all objects under the group, name.- Returns:
- the number of items found
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Gn_members
public static long H5Gn_members(long loc_id,
java.lang.String name)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Gn_members report the number of objects in a Group. The 'objects' include everything that will be visited by
H5Giterate. Each link is returned, so objects with multiple links will be counted once for each link.
- Parameters:
loc_id - file or group ID.name - name of the group to iterate, relative to the loc_id- Returns:
- the number of members in the group or -1 if error.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Gopen
public static long H5Gopen(long loc_id,
java.lang.String name,
long gapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Gopen opens an existing group, name, at the location specified by loc_id.
- Parameters:
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.- Returns:
- a valid group identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Gflush
public static void H5Gflush(long group_id)
throws HDF5LibraryException
H5Gflush causes all buffers associated with a group to be immediately flushed to disk without
removing the data from the cache.
- Parameters:
group_id - IN: Identifier of the group to be flushed.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Grefresh
public static void H5Grefresh(long group_id)
throws HDF5LibraryException
H5Grefresh causes all buffers associated with a group to be cleared and immediately re-loaded
with updated contents from disk. This function essentially closes the group, evicts all metadata
associated with it from the cache, and then re-opens the group. The reopened group is automatically
re-registered with the same ID.
- Parameters:
group_id - IN: Identifier of the group to be refreshed.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Iget_file_id
public static long H5Iget_file_id(long obj_id)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Iget_name_long
@Deprecated
public static long H5Iget_name_long(long obj_id,
java.lang.String[] name,
long size)
throws HDF5LibraryException,
java.lang.NullPointerException
Deprecated.
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Iget_name
public static java.lang.String H5Iget_name(long obj_id)
throws HDF5LibraryException
H5Iget_name_str retrieves the name of an object specified by the identifier, obj_id.
- Parameters:
obj_id - IN: Identifier of the object.- Returns:
- String for Attribute name.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Iget_ref
public static int H5Iget_ref(long obj_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Idec_ref
public static int H5Idec_ref(long obj_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Iinc_ref
public static int H5Iinc_ref(long obj_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Iget_type
public static int H5Iget_type(long obj_id)
throws HDF5LibraryException
H5Iget_type retrieves the type of the object identified by obj_id.
- Parameters:
obj_id - IN: Object identifier whose type is to be determined.- Returns:
- the object type if successful; otherwise H5I_BADID.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Iget_type_ref
public static int H5Iget_type_ref(long type_id)
throws HDF5LibraryException
H5Iget_type_ref retrieves the reference count on an ID type. The reference count is used by the library to
indicate when an ID type can be destroyed.
- Parameters:
type_id - IN: The identifier of the type whose reference count is to be retrieved- Returns:
- The current reference count on success, negative on failure.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Idec_type_ref
public static int H5Idec_type_ref(long type_id)
throws HDF5LibraryException
H5Idec_type_ref decrements the reference count on an identifier type. The reference count is used by the
library to indicate when an identifier type can be destroyed. If the reference count reaches zero,
this function will destroy it.
- Parameters:
type_id - IN: The identifier of the type whose reference count is to be decremented- Returns:
- The current reference count on success, negative on failure.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Iinc_type_ref
public static int H5Iinc_type_ref(long type_id)
throws HDF5LibraryException
H5Iinc_type_ref increments the reference count on an ID type. The reference count is used by the library
to indicate when an ID type can be destroyed.
- Parameters:
type_id - IN: The identifier of the type whose reference count is to be incremented- Returns:
- The current reference count on success, negative on failure.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Inmembers
public static int H5Inmembers(long type_id)
throws HDF5LibraryException
H5Inmembers returns the number of identifiers of the identifier type specified in type.
- Parameters:
type_id - IN: Identifier for the identifier type whose member count will be retrieved- Returns:
- Number of identifiers of the specified identifier type
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Iis_valid
public static boolean H5Iis_valid(long obj_id)
throws HDF5LibraryException
H5Iis_valid indicates if the identifier type specified in obj_id is valid.
- Parameters:
obj_id - IN: Identifier to be checked- Returns:
- a boolean, true if the specified identifier id is valid
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Itype_exists
public static boolean H5Itype_exists(int type_id)
throws HDF5LibraryException
H5Itype_exists indicates if the identifier type specified in type exists.
- Parameters:
type_id - IN: the identifier type to be checked- Returns:
- a boolean, true if the specified identifier type exists
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Iclear_type
public static void H5Iclear_type(int type_id,
boolean force)
throws HDF5LibraryException
H5Iclear_type deletes all identifiers of the type identified by the argument type.
- Parameters:
type_id - IN: Identifier of identifier type which is to be cleared of identifiersforce - IN: Whether or not to force deletion of all identifiers- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Idestroy_type
public static void H5Idestroy_type(int type_id)
throws HDF5LibraryException
H5Idestroy_type deletes an entire identifier type. All identifiers of this type are destroyed
and no new identifiers of this type can be registered.
- Parameters:
type_id - IN: Identifier of identifier type which is to be destroyed- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Lcopy
public static void H5Lcopy(long src_loc,
java.lang.String src_name,
long dst_loc,
java.lang.String dst_name,
long lcpl_id,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lcopy copies a link from one location to another.
- Parameters:
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- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Lcreate_external
public static void H5Lcreate_external(java.lang.String file_name,
java.lang.String obj_name,
long link_loc_id,
java.lang.String link_name,
long lcpl_id,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
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.
- Parameters:
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- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Lcreate_hard
public static void H5Lcreate_hard(long cur_loc,
java.lang.String cur_name,
long dst_loc,
java.lang.String dst_name,
long lcpl_id,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lcreate_hard creates a new hard link to a pre-existing object in an HDF5 file.
- Parameters:
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- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - cur_name or dst_name is null.
-
H5Lcreate_soft
public static void H5Lcreate_soft(java.lang.String link_target,
long link_loc_id,
java.lang.String link_name,
long lcpl_id,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lcreate_soft creates a new soft link to an object in an HDF5 file.
- Parameters:
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- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - link_name is null.
-
H5Ldelete
public static void H5Ldelete(long loc_id,
java.lang.String name,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Ldelete removes the link specified from a group.
- Parameters:
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- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Ldelete_by_idx
public static void H5Ldelete_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Ldelete_by_idx removes the nth link in a group according to the specified order and in the specified index.
- Parameters:
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- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - group_name is null.
-
H5Lexists
public static boolean H5Lexists(long loc_id,
java.lang.String name,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lexists checks if a link with a particular name exists in a group.
- Parameters:
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- Returns:
- a boolean, true if the name exists, otherwise false.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Lget_info
public static H5L_info_t H5Lget_info(long loc_id,
java.lang.String name,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lget_info returns information about the specified link.
- Parameters:
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- Returns:
- a buffer(H5L_info_t) for the link information.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Lget_info_by_idx
public static H5L_info_t H5Lget_info_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lget_info_by_idx opens a named datatype at the location specified by loc_id and return an identifier for the
datatype.
- Parameters:
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- Returns:
- a buffer(H5L_info_t) for the link information.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - group_name is null.
-
H5Lget_name_by_idx
public static java.lang.String H5Lget_name_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lget_name_by_idx retrieves name of the nth link in a group, according to the order within a specified field or
index.
- Parameters:
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- Returns:
- a String for the link name.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - group_name is null.
-
H5Lget_value
public static int H5Lget_value(long loc_id,
java.lang.String name,
java.lang.String[] link_value,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lget_value returns the link value of a symbolic link. Note that this function is a combination
of H5Lget_info(), H5Lget_val() and for external links, H5Lunpack_elink_val.
- Parameters:
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- Returns:
- the link type
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Lget_value_by_idx
public static int H5Lget_value_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
java.lang.String[] link_value,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lget_value_by_idx retrieves value of the nth link in a group, according to the order within an index.
Note that this function is a combination of H5Lget_info(), H5Lget_val() and for external links,
H5Lunpack_elink_val.
- Parameters:
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- Returns:
- the link type
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - group_name is null.
-
H5Literate
public static int H5Literate(long grp_id,
int idx_type,
int order,
long idx,
H5L_iterate_cb op,
H5L_iterate_t op_data)
throws HDF5LibraryException
H5Literate iterates through links in a group.
- Parameters:
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- Returns:
- returns the return value of the first operator that returns a positive value, or zero if all members were
processed with no operator returning non-zero.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Literate_by_name
public static int H5Literate_by_name(long grp_id,
java.lang.String group_name,
int idx_type,
int order,
long idx,
H5L_iterate_cb op,
H5L_iterate_t op_data,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Literate_by_name iterates through links in a group.
- Parameters:
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- Returns:
- returns the return value of the first operator that returns a positive value, or zero if all members were
processed with no operator returning non-zero.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - group_name is null.
-
H5Lmove
public static void H5Lmove(long src_loc,
java.lang.String src_name,
long dst_loc,
java.lang.String dst_name,
long lcpl_id,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lmove renames a link within an HDF5 file.
- Parameters:
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.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Lvisit
public static int H5Lvisit(long grp_id,
int idx_type,
int order,
H5L_iterate_cb op,
H5L_iterate_t op_data)
throws HDF5LibraryException
H5Lvisit recursively visits all links starting from a specified group.
- Parameters:
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- Returns:
- returns the return value of the first operator that returns a positive value, or zero if all members were
processed with no operator returning non-zero.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Lvisit_by_name
public static int H5Lvisit_by_name(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
H5L_iterate_cb op,
H5L_iterate_t op_data,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Lvisit_by_name recursively visits all links starting from a specified group.
- Parameters:
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 linklapl_id - IN: link access property- Returns:
- returns the return value of the first operator that returns a positive value, or zero if all members were
processed with no operator returning non-zero.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - group_name is null.
-
H5Lis_registered
public static int H5Lis_registered(int link_cls_id)
throws HDF5LibraryException
H5Lis_registered tests whether a user-defined link class is currently registered,
either by the HDF5 Library or by the user through the use of H5Lregister.
- Parameters:
link_cls_id - IN: User-defined link class identifier- Returns:
- Returns a positive value if the link class has been registered and zero if it is unregistered.
Otherwise returns a negative value; this may mean that the identifier is not a valid user-defined class identifier.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Lunregister
public static void H5Lunregister(int link_cls_id)
throws HDF5LibraryException
H5Lunregister unregisters a class of user-defined links, preventing them from being traversed, queried, moved, etc.
- Parameters:
link_cls_id - IN: User-defined link class identifier- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Oclose
public static int H5Oclose(long object_id)
throws HDF5LibraryException
H5Oclose closes the group, dataset, or named datatype specified.
- Parameters:
object_id - IN: Object identifier- Returns:
- non-negative on success
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Ocopy
public static void H5Ocopy(long src_loc_id,
java.lang.String src_name,
long dst_loc_id,
java.lang.String dst_name,
long ocpypl_id,
long lcpl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Ocopy copies the group, dataset or named datatype specified from the file or group specified by source location
to the destination location.
- Parameters:
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- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Oget_comment
public static java.lang.String H5Oget_comment(long obj_id)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Oget_comment retrieves the comment for the specified object.
- Parameters:
obj_id - IN: File or group identifier- Returns:
- the comment
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException
-
H5Oset_comment
@Deprecated
public static void H5Oset_comment(long obj_id,
java.lang.String comment)
throws HDF5LibraryException
Deprecated. As of HDF5 1.8 in favor of object attributes.
H5Oset_comment sets the comment for the specified object.
- Parameters:
obj_id - IN: Identifier of the target objectcomment - IN: The new comment.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Oget_comment_by_name
public static java.lang.String H5Oget_comment_by_name(long loc_id,
java.lang.String name,
long lapl_id)
throws HDF5LibraryException,
java.lang.IllegalArgumentException,
java.lang.NullPointerException
H5Oget_comment_by_name retrieves the comment for an object.
- Parameters:
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.- Returns:
- the comment
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.java.lang.IllegalArgumentException
-
H5Oset_comment_by_name
@Deprecated
public static void H5Oset_comment_by_name(long loc_id,
java.lang.String name,
java.lang.String comment,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
Deprecated. As of HDF5 1.8 in favor of object attributes.
H5Oset_comment_by_name sets the comment for the specified object.
- Parameters:
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.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Oget_info
public static H5O_info_t H5Oget_info(long loc_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Oget_info retrieves the metadata for an object specified by an identifier.
- Parameters:
loc_id - IN: Identifier for target object- Returns:
- object information
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Oget_info
public static H5O_info_t H5Oget_info(long loc_id,
int fields)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Oget_info retrieves the metadata for an object specified by an identifier.
- Parameters:
loc_id - IN: Identifier for target objectfields - IN: Object fields to select- Returns:
- object information
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Oget_info_by_idx
public static H5O_info_t H5Oget_info_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Oget_info_by_idx retrieves the metadata for an object, identifying the object by an index position.
- Parameters:
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.)- Returns:
- object information
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Oget_info_by_idx
public static H5O_info_t H5Oget_info_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
int fields,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Oget_info_by_idx retrieves the metadata for an object, identifying the object by an index position.
- Parameters:
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 openfields - IN: Object fields to selectlapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as
H5P_DEFAULT.)- Returns:
- object information
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Oget_info_by_name
public static H5O_info_t H5Oget_info_by_name(long loc_id,
java.lang.String name,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Oget_info_by_name retrieves the metadata for an object, identifying the object by location and relative name.
- Parameters:
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.)- Returns:
- object information
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Oget_info_by_name
public static H5O_info_t H5Oget_info_by_name(long loc_id,
java.lang.String name,
int fields,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Oget_info_by_name retrieves the metadata for an object, identifying the object by location and relative name.
- Parameters:
loc_id - IN: File or group identifier specifying location of group in which object is locatedname - IN: Relative name of groupfields - IN: Object fields to selectlapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as
H5P_DEFAULT.)- Returns:
- object information
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Olink
public static void H5Olink(long obj_id,
long new_loc_id,
java.lang.String new_name,
long lcpl_id,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Olink creates a new hard link to an object in an HDF5 file.
- Parameters:
obj_id - IN: Object to be linked.new_loc_id - IN: File or group identifier specifying location at which object is to be linked.new_name - IN: Relative name of link to be created.lcpl_id - IN: Link creation property list identifier.lapl_id - IN: Access property list identifier.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Oopen
public static long H5Oopen(long loc_id,
java.lang.String name,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Oopen opens a group, dataset, or named datatype specified by a location and a path name.
- Parameters:
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- Returns:
- an object identifier for the opened object
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Ovisit
public static int H5Ovisit(long obj_id,
int idx_type,
int order,
H5O_iterate_cb op,
H5O_iterate_t op_data)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Ovisit recursively visits all objects accessible from a specified object.
- Parameters:
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- Returns:
- returns the return value of the first operator that returns a positive value, or zero if all members were
processed with no operator returning non-zero.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Ovisit
public static int H5Ovisit(long obj_id,
int idx_type,
int order,
H5O_iterate_cb op,
H5O_iterate_t op_data,
int fields)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Ovisit recursively visits all objects accessible from a specified object.
- Parameters:
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 objectfields - IN: Object fields to select- Returns:
- returns the return value of the first operator that returns a positive value, or zero if all members were
processed with no operator returning non-zero.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Ovisit_by_name
public static int H5Ovisit_by_name(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
H5O_iterate_cb op,
H5O_iterate_t op_data,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Ovisit_by_name recursively visits all objects starting from a specified object.
- Parameters:
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- Returns:
- returns the return value of the first operator that returns a positive value, or zero if all members were
processed with no operator returning non-zero.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Ovisit_by_name
public static int H5Ovisit_by_name(long loc_id,
java.lang.String obj_name,
int idx_type,
int order,
H5O_iterate_cb op,
H5O_iterate_t op_data,
int fields,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Ovisit_by_name recursively visits all objects starting from a specified object.
- Parameters:
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 objectfields - IN: Object fields to selectlapl_id - IN: Link access property list identifier- Returns:
- returns the return value of the first operator that returns a positive value, or zero if all members were
processed with no operator returning non-zero.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Oexists_by_name
public static boolean H5Oexists_by_name(long loc_id,
java.lang.String obj_name,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Oexists_by_name is used by an application to check that an existing link resolves to an object.
Primarily, it is designed to check for dangling soft, external, or user-defined links.
- Parameters:
loc_id - IN: File or group identifierobj_name - IN: Relative path to the objectlapl_id - IN: Link access property list identifier- Returns:
- Returns TRUE or FALSE if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Odecr_refcount
public static void H5Odecr_refcount(long object_id)
throws HDF5LibraryException
H5Odecr_refcount decrements the hard link reference count for an object.
- Parameters:
object_id - IN: Object identifier- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Oincr_refcount
public static void H5Oincr_refcount(long object_id)
throws HDF5LibraryException
H5Oincr_refcount increments the hard link reference count for an object.
- Parameters:
object_id - IN: Object identifier- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Oopen_by_addr
public static long H5Oopen_by_addr(long loc_id,
long addr)
throws HDF5LibraryException
H5Oopen_by_addr opens a group, dataset, or named datatype using its address within an HDF5 file.
- Parameters:
loc_id - IN: File or group identifieraddr - IN: Object's address in the file- Returns:
- an object identifier for the opened object
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Oopen_by_idx
public static long H5Oopen_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Oopen_by_idx opens the nth object in the group specified.
- Parameters:
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- Returns:
- an object identifier for the opened object
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - group_name is null.
-
_H5Oopen_by_idx
public static long _H5Oopen_by_idx(long loc_id,
java.lang.String group_name,
int idx_type,
int order,
long n,
long lapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Oflush
public static void H5Oflush(long object_id)
throws HDF5LibraryException
H5Oflush causes all buffers associated with an object to be immediately flushed to disk without removing
the data from the cache. object_id can be any named object associated with an HDF5 file including a
dataset, a group, or a committed datatype.
- Parameters:
object_id - IN: Identifier of the object to be flushed.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Orefresh
public static void H5Orefresh(long object_id)
throws HDF5LibraryException
H5Orefresh causes all buffers associated with an object to be cleared and immediately re-loaded with
updated contents from disk. This function essentially closes the object, evicts all metadata associated
with it from the cache, and then re-opens the object. The reopened object is automatically re-registered
with the same ID. object_id can be any named object associated with an HDF5 file including a
dataset, a group, or a committed datatype.
- Parameters:
object_id - IN: Identifier of the object to be refreshed.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_class_name
public static java.lang.String H5Pget_class_name(long plid)
throws HDF5LibraryException
H5Pget_class_name retrieves the name of a generic property list class
- Parameters:
plid - IN: Identifier of property object to query- Returns:
- name of a property list if successful; null if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pcreate
public static long H5Pcreate(long type)
throws HDF5LibraryException
H5Pcreate creates a new property as an instance of some property list class.
- Parameters:
type - IN: The type of property list to create.- Returns:
- a property list identifier (plist) if successful; otherwise Fail (-1).
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget
public static int H5Pget(long plid,
java.lang.String name)
throws HDF5LibraryException
H5Pget retrieves a copy of the value for a property in a property list (support integer only)
- Parameters:
plid - IN: Identifier of property object to queryname - IN: Name of property to query- Returns:
- value for a property if successful; a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset
public static int H5Pset(long plid,
java.lang.String name,
int value)
throws HDF5LibraryException
Sets a property list value (support integer only)
- Parameters:
plid - IN: Property list identifier to modifyname - IN: Name of property to modifyvalue - IN: value to set the property to- Returns:
- a non-negative value if successful; a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pexist
public static boolean H5Pexist(long plid,
java.lang.String name)
throws HDF5LibraryException
H5Pexist determines whether a property exists within a property list or class
- Parameters:
plid - IN: Identifier for the property to queryname - IN: Name of property to check for- Returns:
- a true value if the property exists in the property object; false if the property does not exist;
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_size
public static long H5Pget_size(long plid,
java.lang.String name)
throws HDF5LibraryException
H5Pget_size retrieves the size of a property's value in bytes
- Parameters:
plid - IN: Identifier of property object to queryname - IN: Name of property to query- Returns:
- size of a property's value if successful; a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_nprops
public static long H5Pget_nprops(long plid)
throws HDF5LibraryException
H5Pget_nprops retrieves the number of properties in a property list or class
- Parameters:
plid - IN: Identifier of property object to query- Returns:
- number of properties if successful; a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_class
public static long H5Pget_class(long plist)
throws HDF5LibraryException
H5Pget_class returns the property list class for the property list identified by the plist parameter.
- Parameters:
plist - IN: Identifier of property list to query.- Returns:
- a property list class if successful. Otherwise returns H5P_ROOT (-1).
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_class_parent
public static long H5Pget_class_parent(long plid)
throws HDF5LibraryException
H5Pget_class_parent retrieves an identifier for the parent class of a property class
- Parameters:
plid - IN: Identifier of the property class to query- Returns:
- a valid parent class object identifier if successful; a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pequal
public static int H5Pequal(long plid1,
long plid2)
throws HDF5LibraryException
H5Pequal determines if two property lists or classes are equal
- Parameters:
plid1 - IN: First property object to be comparedplid2 - IN: Second property object to be compared- Returns:
- positive value if equal; zero if unequal, a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5P_equal
public static boolean H5P_equal(long plid1,
long plid2)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Pisa_class
public static int H5Pisa_class(long plist,
long pclass)
throws HDF5LibraryException
H5Pisa_class checks to determine whether a property list is a member of the specified class
- Parameters:
plist - IN: Identifier of the property listpclass - IN: Identifier of the property class- Returns:
- a positive value if equal; zero if unequal; a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pcopy_prop
public static int H5Pcopy_prop(long dst_id,
long src_id,
java.lang.String name)
throws HDF5LibraryException
H5Pcopy_prop copies a property from one property list or class to another
- Parameters:
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- Returns:
- a non-negative value if successful; a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Premove
public static int H5Premove(long plid,
java.lang.String name)
throws HDF5LibraryException
H5Premove removes a property from a property list
- Parameters:
plid - IN: Identifier of the property list to modifyname - IN: Name of property to remove- Returns:
- a non-negative value if successful; a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Punregister
public static int H5Punregister(long plid,
java.lang.String name)
throws HDF5LibraryException
H5Punregister removes a property from a property list class
- Parameters:
plid - IN: Property list class from which to remove permanent propertyname - IN: Name of property to remove- Returns:
- a non-negative value if successful; a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pclose_class
public static int H5Pclose_class(long plid)
throws HDF5LibraryException
Closes an existing property list class
- Parameters:
plid - IN: Property list class to close- Returns:
- a non-negative value if successful; a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
_H5Pclose_class
public static int _H5Pclose_class(long plid)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Pclose
public static int H5Pclose(long plist)
throws HDF5LibraryException
H5Pclose terminates access to a property list.
- Parameters:
plist - IN: Identifier of the property list to terminate access to.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pcopy
public static long H5Pcopy(long plist)
throws HDF5LibraryException
H5Pcopy copies an existing property list to create a new property list.
- Parameters:
plist - IN: Identifier of property list to duplicate.- Returns:
- a property list identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pcreate_class_nocb
public static long H5Pcreate_class_nocb(long parent_class,
java.lang.String name)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Pregister2_nocb
public static void H5Pregister2_nocb(long plist_class,
java.lang.String name,
long size,
byte[] def_value)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Pinsert2_nocb
public static void H5Pinsert2_nocb(long plist,
java.lang.String name,
long size,
byte[] value)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Piterate
public static int H5Piterate(long plist,
int[] idx,
H5P_iterate_cb op,
H5P_iterate_t op_data)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Pget_attr_phase_change
public static int H5Pget_attr_phase_change(long ocpl_id,
int[] attributes)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pget_attr_phase_change retrieves attribute storage phase change thresholds.
- Parameters:
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
- Returns:
- Returns a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - size is null.
-
H5Pset_attr_phase_change
public static void H5Pset_attr_phase_change(long ocpl_id,
int max_compact,
int min_dense)
throws HDF5LibraryException
H5Pset_attr_phase_change sets threshold values for attribute storage on an object. These
thresholds determine the point at which attribute storage changes
from compact storage (i.e., storage in the object header)
to dense storage (i.e., storage in a heap and indexed with a B-tree).
- Parameters:
ocpl_id - IN: : Object (dataset or group) creation property list identifiermax_compact - IN: Maximum number of attributes to be stored in compact storage (Default: 8)min_dense - IN: Minimum number of attributes to be stored in dense storage (Default: 6)- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_attr_creation_order
public static int H5Pget_attr_creation_order(long ocpl_id)
throws HDF5LibraryException
H5Pget_attr_creation_order retrieves the settings for tracking and indexing attribute creation order on an object
- Parameters:
ocpl_id - IN: Object (group or dataset) creation property list identifier- Returns:
- Flags specifying whether to track and index attribute creation order
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_attr_creation_order
public static int H5Pset_attr_creation_order(long ocpl_id,
int crt_order_flags)
throws HDF5LibraryException
H5Pset_attr_creation_order sets flags specifying whether to track and index attribute creation order on an
object.
- Parameters:
ocpl_id - IN: Object creation property list identifiercrt_order_flags - IN: Flags specifying whether to track and index attribute creation order- Returns:
- Returns a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_obj_track_times
public static boolean H5Pget_obj_track_times(long ocpl_id)
throws HDF5LibraryException
H5Pget_obj_track_times queries the object creation property list, ocpl_id, to determine whether object times are
being recorded.
- Parameters:
ocpl_id - IN: Object creation property list identifier- Returns:
- TRUE or FALSE, specifying whether object times are being recorded
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_obj_track_times
public static void H5Pset_obj_track_times(long ocpl_id,
boolean track_times)
throws HDF5LibraryException
H5Pset_obj_track_times sets a property in the object creation property list, ocpl_id, that governs the recording
of times associated with an object.
- Parameters:
ocpl_id - IN: Object creation property list identifiertrack_times - IN: TRUE or FALSE, specifying whether object times are to be tracked- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pmodify_filter
public static int H5Pmodify_filter(long plist,
long filter,
int flags,
long cd_nelmts,
int[] cd_values)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_filter
public static int H5Pset_filter(long plist,
int filter,
int flags,
long cd_nelmts,
int[] cd_values)
throws HDF5LibraryException
H5Pset_filter adds the specified filter and corresponding properties to the end of an output filter pipeline.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_nfilters
public static int H5Pget_nfilters(long plist)
throws HDF5LibraryException
H5Pget_nfilters returns the number of filters defined in the filter pipeline associated with the property list
plist.
- Parameters:
plist - IN: Property list identifier.- Returns:
- the number of filters in the pipeline if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_filter
public static int H5Pget_filter(long plist,
int filter_number,
int[] flags,
long[] cd_nelmts,
int[] cd_values,
long namelen,
java.lang.String[] name,
int[] filter_config)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.ArrayStoreException,
HDF5LibraryException,
java.lang.NullPointerException
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.
- Parameters:
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- Returns:
- the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).
- Throws:
java.lang.ArrayIndexOutOfBoundsException - Fatal error on Copybackjava.lang.ArrayStoreException - Fatal error on CopybackHDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name or an array is null.
-
H5Pget_filter_by_id
public static int H5Pget_filter_by_id(long plist_id,
long filter_id,
int[] flags,
long[] cd_nelmts,
int[] cd_values,
long namelen,
java.lang.String[] name,
int[] filter_config)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.ArrayStoreException,
HDF5LibraryException,
java.lang.NullPointerException
H5Pget_filter_by_id returns information about the filter specified in filter_id, a filter identifier. plist_id
must be a dataset or group creation property list and filter_id must be in the associated filter pipeline. The
filter_id and flags parameters are used in the same manner as described in the discussion of H5Pset_filter. Aside
from the fact that they are used for output, the parameters cd_nelmts and cd_values[] are used in the same manner
as described in the discussion of H5Pset_filter. On input, the cd_nelmts parameter indicates the number of
entries in the cd_values[] array allocated by the calling program; on exit it contains the number of values
defined by the filter. On input, the namelen parameter indicates the number of characters allocated for the
filter name by the calling program in the array name[]. On exit name[] contains the name of the filter with one
character of the name in each element of the array. If the filter specified in filter_id is not set for the
property list, an error will be returned and H5Pget_filter_by_id1 will fail.
- Parameters:
plist_id - IN: Property list identifier.filter_id - IN: Filter identifier.flags - OUT: Bit vector specifying certain general properties of the filter.cd_nelmts - N/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- Returns:
- the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.ArrayIndexOutOfBoundsException - Fatal error on Copybackjava.lang.ArrayStoreException - Fatal error on Copybackjava.lang.NullPointerException - - name or an array is null.
-
H5Pget_filter_by_id2
public static int H5Pget_filter_by_id2(long plist_id,
long filter_id,
int[] flags,
long[] cd_nelmts,
int[] cd_values,
long namelen,
java.lang.String[] name,
int[] filter_config)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pget_filter_by_id2 returns information about a filter, specified by its filter id, in a filter pipeline,
specified by the property list with which it is associated.
- Parameters:
plist_id - IN: Property list identifier.filter_id - IN: Filter identifier.flags - OUT: Bit vector specifying certain general properties of the filter.cd_nelmts - N/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- Returns:
- the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name or an array is null.
-
H5Pall_filters_avail
public static boolean H5Pall_filters_avail(long dcpl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Premove_filter
public static int H5Premove_filter(long obj_id,
long filter)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Pset_deflate
public static int H5Pset_deflate(long plist,
int level)
throws HDF5LibraryException
H5Pset_deflate sets the compression method for a dataset.
- Parameters:
plist - IN: Identifier for the dataset creation property list.level - IN: Compression level.- Returns:
- non-negative if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_fletcher32
public static int H5Pset_fletcher32(long plist)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pget_userblock
public static int H5Pget_userblock(long plist,
long[] size)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pget_userblock retrieves the size of a user block in a file creation property list.
- Parameters:
plist - IN: Identifier for property list to query.size - OUT: Pointer to location to return user-block size.- Returns:
- a non-negative value and the size of the user block; if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - size is null.
-
H5Pset_userblock
public static int H5Pset_userblock(long plist,
long size)
throws HDF5LibraryException
H5Pset_userblock sets the user block size of a file creation property list.
- Parameters:
plist - IN: Identifier of property list to modify.size - IN: Size of the user-block in bytes.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_sizes
public static int H5Pget_sizes(long plist,
long[] size)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Pget_sizes retrieves the size of the offsets and lengths used in an HDF5 file. This function is only valid for
file creation property lists.
- Parameters:
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
- Returns:
- a non-negative value with the sizes initialized; if successful;
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - size is null.java.lang.IllegalArgumentException - - size is invalid.
-
H5Pset_sizes
public static int H5Pset_sizes(long plist,
int sizeof_addr,
int sizeof_size)
throws HDF5LibraryException
H5Pset_sizes sets the byte size of the offsets and lengths used to address objects in an HDF5 file.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_sym_k
public static int H5Pget_sym_k(long plist,
int[] size)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Pget_sym_k retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size.
- Parameters:
plist - IN: Property list to query.size - OUT: the symbol table's B-tree 1/2 rank and leaf node 1/2size.
size[0] = ik // the symbol table's B-tree 1/2 rank
size[1] = lk // leaf node 1/2 size
- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - size is null.java.lang.IllegalArgumentException - - size is invalid.
-
H5Pset_sym_k
public static int H5Pset_sym_k(long plist,
int ik,
int lk)
throws HDF5LibraryException
H5Pset_sym_k sets the size of parameters used to control the symbol table nodes.
- Parameters:
plist - IN: Identifier for property list to query.ik - IN: Symbol table tree rank.lk - IN: Symbol table node size.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_istore_k
public static int H5Pget_istore_k(long plist,
int[] ik)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pget_istore_k queries the 1/2 rank of an indexed storage B-tree.
- Parameters:
plist - IN: Identifier of property list to query.ik - OUT: Pointer to location to return the chunked storage B-tree 1/2 rank.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - ik array is null.
-
H5Pset_istore_k
public static int H5Pset_istore_k(long plist,
int ik)
throws HDF5LibraryException
H5Pset_istore_k sets the size of the parameter used to control the B-trees for indexing chunked datasets.
- Parameters:
plist - IN: Identifier of property list to query.ik - IN: 1/2 rank of chunked storage B-tree.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_shared_mesg_nindexes
public static int H5Pget_shared_mesg_nindexes(long fcpl_id)
throws HDF5LibraryException
H5Pget_shared_mesg_nindexes retrieves number of shared object header message indexes in file creation property
list.
- Parameters:
fcpl_id - IN: : File creation property list identifier- Returns:
- nindexes, the number of shared object header message indexes available in files created with this
property list
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_shared_mesg_nindexes
public static int H5Pset_shared_mesg_nindexes(long plist_id,
int nindexes)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pset_shared_mesg_nindexes sets the number of shared object header message indexes in the specified file
creation property list.
- Parameters:
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- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid value of nindexes
-
H5Pget_shared_mesg_index
public static int H5Pget_shared_mesg_index(long fcpl_id,
int index_num,
int[] mesg_info)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Pget_shared_mesg_index Retrieves the configuration settings for a shared message index.
- Parameters:
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.
- Returns:
- Returns a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - mesg_info is null.java.lang.IllegalArgumentException - - Invalid value of nindexes
-
H5Pset_shared_mesg_index
public static int H5Pset_shared_mesg_index(long fcpl_id,
int index_num,
int mesg_type_flags,
int min_mesg_size)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pset_shared_mesg_index Configures the specified shared object header message index
- Parameters:
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.- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid value of nindexes
-
H5Pget_shared_mesg_phase_change
public static int H5Pget_shared_mesg_phase_change(long fcpl_id,
int[] size)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pget_shared_mesg_phase_change retrieves shared object header message phase change information.
- Parameters:
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
- Returns:
- Returns a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - size is null.
-
H5Pset_shared_mesg_phase_change
public static int H5Pset_shared_mesg_phase_change(long fcpl_id,
int max_list,
int min_btree)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pset_shared_mesg_phase_change sets shared object header message storage phase change thresholds.
- Parameters:
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- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid values of max_list and min_btree.
-
H5Pset_file_space_strategy
public static void H5Pset_file_space_strategy(long fcpl_id,
int strategy,
boolean persist,
long threshold)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pset_file_space_strategy sets the file space management strategy for the file associated with fcpl_id to strategy.
There are four strategies that applications can select and they are described in the Parameters section.
- Parameters:
fcpl_id - IN: File creation property list identifierstrategy - IN: The strategy for file space management.
H5F_FSPACE_STRATEGY_FSM_AGGR
Mechanisms: free-space managers, aggregators, and virtual file drivers
This is the library default when not set.
H5F_FSPACE_STRATEGY_PAGE
Mechanisms: free-space managers with embedded paged aggregation and virtual file drivers
H5F_FSPACE_STRATEGY_AGGR
Mechanisms: aggregators and virtual file drivers
H5F_FSPACE_STRATEGY_NONE
Mechanisms: virtual file driverspersist - IN: True to persist free-space.threshold - IN: The free-space section threshold. The library default is 1, which is to track all free-space sections.
Passing a value of zero (0) indicates that the value of threshold is not to be modified.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid values of max_list and min_btree.
-
H5Pget_file_space_strategy
public static int H5Pget_file_space_strategy(long fcpl_id,
boolean[] persist,
long[] threshold)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pget_file_space_strategy provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.
- Parameters:
fcpl_id - IN: File creation property list identifierpersist - IN/OUT: The current free-space persistence. NULL, persist not queried.threshold - IN/OUT: The current free-space section threshold. NULL, threshold not queried.- Returns:
- the current free-space strategy.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid values of max_list and min_btree.
-
H5Pget_file_space_strategy_persist
public static boolean H5Pget_file_space_strategy_persist(long fcpl_id)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pget_file_space_strategy_persist provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.
- Parameters:
fcpl_id - IN: File creation property list identifier- Returns:
- the current free-space persistence.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid values of max_list and min_btree.
-
H5Pget_file_space_strategy_threshold
public static long H5Pget_file_space_strategy_threshold(long fcpl_id)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pget_file_space_strategy_threshold provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.
- Parameters:
fcpl_id - IN: File creation property list identifier- Returns:
- the current free-space section threshold.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid values of max_list and min_btree.
-
H5Pset_file_space_page_size
public static void H5Pset_file_space_page_size(long fcpl_id,
long page_size)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pset_file_space_page_size retrieves the file space page size for aggregating small metadata or raw data.
- Parameters:
fcpl_id - IN: File creation property list identifierpage_size - IN: the file space page size.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid values of max_list and min_btree.
-
H5Pget_file_space_page_size
public static long H5Pget_file_space_page_size(long fcpl_id)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pget_file_space_page_size Sets the file space page size for paged aggregation.
- Parameters:
fcpl_id - IN: File creation property list identifier- Returns:
- the current file space page size.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid values of max_list and min_btree.
-
H5Pget_alignment
public static int H5Pget_alignment(long plist,
long[] alignment)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Pget_alignment retrieves the current settings for alignment properties from a file access property list.
- Parameters:
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
- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - aligment array is null.java.lang.IllegalArgumentException - - aligment array is invalid.
-
H5Pset_alignment
public static int H5Pset_alignment(long plist,
long threshold,
long alignment)
throws HDF5LibraryException
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.
- Parameters:
plist - IN: Identifier for a file access property list.threshold - IN: Threshold value.alignment - IN: Alignment value.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_driver
public static long H5Pget_driver(long plid)
throws HDF5LibraryException
H5Pget_driver returns the identifier of the low-level file driver associated with the file access property list
or data transfer property list plid.
- Parameters:
plid - IN: File access or data transfer property list identifier.- Returns:
- a valid low-level driver identifier if successful; a negative value if failed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_family_offset
public static long H5Pget_family_offset(long fapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_family_offset
public static int H5Pset_family_offset(long fapl_id,
long offset)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pget_cache
public static int H5Pget_cache(long plist,
int[] mdc_nelmts,
long[] rdcc_nelmts,
long[] rdcc_nbytes,
double[] rdcc_w0)
throws HDF5LibraryException,
java.lang.NullPointerException
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.
- Parameters:
plist - IN: Identifier of the file access property list.mdc_nelmts - IN/OUT: No longer used, will be ignored.rdcc_nelmts - IN/OUT: Number of elements (objects) in the raw data chunk cache.rdcc_nbytes - IN/OUT: Total size of the raw data chunk cache, in bytes.rdcc_w0 - IN/OUT: Preemption policy.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - an array is null.
-
H5Pset_cache
public static int H5Pset_cache(long plist,
int mdc_nelmts,
long rdcc_nelmts,
long rdcc_nbytes,
double rdcc_w0)
throws HDF5LibraryException
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.
- Parameters:
plist - IN: Identifier of the file access property list.mdc_nelmts - IN: No longer used, will be ignored.rdcc_nelmts - IN: Number of elements (objects) in the raw data chunk cache.rdcc_nbytes - IN: Total size of the raw data chunk cache, in bytes.rdcc_w0 - IN: Preemption policy.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_mdc_config
public static H5AC_cache_config_t H5Pget_mdc_config(long plist_id)
throws HDF5LibraryException
H5Pget_mdc_config gets the initial metadata cache configuration contained in a file access property list and
loads it into the instance of H5AC_cache_config_t pointed to by the config_ptr parameter. This configuration is
used when the file is opened.
- Parameters:
plist_id - IN: Identifier of the file access property list.- Returns:
- A buffer(H5AC_cache_config_t) for the current metadata cache configuration information
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_mdc_config
public static void H5Pset_mdc_config(long plist_id,
H5AC_cache_config_t config_ptr)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Pget_gc_references
public static boolean H5Pget_gc_references(long fapl_id)
throws HDF5LibraryException
H5Pget_gc_references Returns the current setting for the garbage collection refernces property from a file access
property list.
- Parameters:
fapl_id - IN File access property list- Returns:
- GC is on (true) or off (false)
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_gc_references
public static int H5Pset_gc_references(long fapl_id,
boolean gc_ref)
throws HDF5LibraryException
H5Pset_gc_references Sets the flag for garbage collecting references for the file. Default value for garbage
collecting references is off.
- Parameters:
fapl_id - IN File access property listgc_ref - IN set GC on (true) or off (false)- Returns:
- non-negative if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_fclose_degree
public static int H5Pget_fclose_degree(long plist_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_fclose_degree
public static int H5Pset_fclose_degree(long plist,
int degree)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pget_meta_block_size
public static long H5Pget_meta_block_size(long fapl_id)
throws HDF5LibraryException
H5Pget_meta_block_size the current metadata block size setting.
- Parameters:
fapl_id - IN: File access property list identifier- Returns:
- the minimum size, in bytes, of metadata block allocations.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_meta_block_size
public static void H5Pset_meta_block_size(long fapl_id,
long size)
throws HDF5LibraryException
H5Pset_meta_block_size sets the minimum metadata block size.
- Parameters:
fapl_id - IN: File access property list identifiersize - IN: Minimum size, in bytes, of metadata block allocations.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_sieve_buf_size
public static long H5Pget_sieve_buf_size(long fapl_id)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Pset_sieve_buf_size
public static void H5Pset_sieve_buf_size(long fapl_id,
long size)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Pget_small_data_block_size
public static long H5Pget_small_data_block_size(long plist)
throws HDF5LibraryException
H5Pget_small_data_block_size retrieves the size of a block of small data in a file creation property list.
- Parameters:
plist - IN: Identifier for property list to query.- Returns:
- a non-negative value and the size of the user block; if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_small_data_block_size
public static int H5Pset_small_data_block_size(long plist,
long size)
throws HDF5LibraryException
H5Pset_small_data_block_size reserves blocks of size bytes for the contiguous storage of the raw data portion of
small datasets.
- Parameters:
plist - IN: Identifier of property list to modify.size - IN: Size of the blocks in bytes.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_libver_bounds
public static int H5Pget_libver_bounds(long fapl_id,
int[] libver)
throws HDF5LibraryException,
java.lang.NullPointerException
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.
- Parameters:
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.
- Returns:
- Returns a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - size is null.
-
H5Pset_libver_bounds
public static int H5Pset_libver_bounds(long fapl_id,
int low,
int high)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pset_libver_bounds Sets bounds on library versions, and indirectly format versions, to be used when creating
objects
- Parameters:
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.- Returns:
- Returns a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Argument is Illegal
-
H5Pget_elink_file_cache_size
public static int H5Pget_elink_file_cache_size(long fapl_id)
throws HDF5LibraryException
H5Pget_elink_file_cache_size retrieves the size of the external link open file cache.
- Parameters:
fapl_id - IN: File access property list identifier- Returns:
- External link open file cache size in number of files.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_elink_file_cache_size
public static void H5Pset_elink_file_cache_size(long fapl_id,
int efc_size)
throws HDF5LibraryException
H5Pset_elink_file_cache_size sets the number of files that can be held open in an external link open file cache.
- Parameters:
fapl_id - IN: File access property list identifierefc_size - IN: External link open file cache size in number of files.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_mdc_log_options
public static void H5Pset_mdc_log_options(long fapl_id,
boolean is_enabled,
java.lang.String location,
boolean start_on_access)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pset_mdc_log_options sets metadata cache logging options.
- Parameters:
fapl_id - IN: File access property list identifieris_enabled - IN: Whether logging is enabled.location - IN: Location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII).start_on_access - IN: Whether the logging begins as soon as the file is opened or created.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - location is null.
-
H5Pget_mdc_log_options
public static java.lang.String H5Pget_mdc_log_options(long fapl_id,
boolean[] mdc_log_options)
throws HDF5LibraryException
H5Pget_mdc_log_options gets metadata cache logging options.
- Parameters:
fapl_id - IN: File access property list identifiermdc_log_options - the options
mdc_logging_options[0] = is_enabled, whether logging is enabled
mdc_logging_options[1] = start_on_access, whether the logging begins as soon as the file is opened or created- Returns:
- the location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII).
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_metadata_read_attempts
public static long H5Pget_metadata_read_attempts(long plist_id)
throws HDF5LibraryException
H5Pget_metadata_read_attempts retrieves the number of read attempts that is set in the file access property list plist_id.
- Parameters:
plist_id - IN: File access property list identifier- Returns:
- The number of read attempts.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_metadata_read_attempts
public static void H5Pset_metadata_read_attempts(long plist_id,
long attempts)
throws HDF5LibraryException
H5Pset_metadata_read_attempts sets the number of reads that the library will try when reading checksummed
metadata in an HDF5 file opened with SWMR access. When reading such metadata, the library will compare the
checksum computed for the metadata just read with the checksum stored within the piece of checksum. When
performing SWMR operations on a file, the checksum check might fail when the library reads data on a system
that is not atomic. To remedy such situations, the library will repeatedly read the piece of metadata until
the check passes or finally fails the read when the allowed number of attempts is reached.
- Parameters:
plist_id - IN: File access property list identifierattempts - IN: The number of read attempts which is a value greater than 0.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_evict_on_close
public static boolean H5Pget_evict_on_close(long fapl_id)
throws HDF5LibraryException
H5Pget_evict_on_close retrieves the file access property list setting that determines whether an HDF5 object
will be evicted from the library's metadata cache when it is closed.
- Parameters:
fapl_id - IN: File access property list identifier- Returns:
- indication if the object will be evicted on close.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_evict_on_close
public static void H5Pset_evict_on_close(long fapl_id,
boolean evict_on_close)
throws HDF5LibraryException
H5Pset_evict_on_close controls the library's behavior of evicting metadata associated with a closed object.
- Parameters:
fapl_id - IN: File access property list identifierevict_on_close - IN: Whether the HDF5 object should be evicted on close.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_layout
public static int H5Pget_layout(long plist)
throws HDF5LibraryException
H5Pget_layout returns the layout of the raw data for a dataset.
- Parameters:
plist - IN: Identifier for property list to query.- Returns:
- the layout type of a dataset creation property list if successful. Otherwise returns H5D_LAYOUT_ERROR
(-1).
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_layout
public static int H5Pset_layout(long plist,
int layout)
throws HDF5LibraryException
H5Pset_layout sets the type of storage used store the raw data for a dataset.
- Parameters:
plist - IN: Identifier of property list to query.layout - IN: Type of storage layout for raw data.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_chunk
public static int H5Pget_chunk(long plist,
int max_ndims,
long[] dims)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Pget_chunk retrieves the size of chunks for the raw data of a chunked layout dataset.
- Parameters:
plist - IN: Identifier of property list to query.max_ndims - IN: Size of the dims array.dims - OUT: Array to store the chunk dimensions.- Returns:
- chunk dimensionality successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - dims array is null.java.lang.IllegalArgumentException - - max_ndims <=0
-
H5Pset_chunk
public static int H5Pset_chunk(long plist,
int ndims,
byte[] dim)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Pset_chunk sets the size of the chunks used to store a chunked layout dataset.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - dims array is null.java.lang.IllegalArgumentException - - dims <=0
-
H5Pset_chunk
public static int H5Pset_chunk(long plist,
int ndims,
long[] dim)
throws HDF5Exception,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
- Throws:
HDF5Exceptionjava.lang.NullPointerExceptionjava.lang.IllegalArgumentException
-
H5Pset_virtual
public static void H5Pset_virtual(long dcpl_id,
long vspace_id,
java.lang.String src_file_name,
java.lang.String src_dset_name,
long src_space_id)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Pset_virtual maps elements of the virtual dataset (VDS) described by the
virtual dataspace identifier vspace_id to the elements of the source dataset
described by the source dataset dataspace identifier src_space_id. The source
dataset is identified by the name of the file where it is located, src_file_name,
and the name of the dataset, src_dset_name.
- Parameters:
dcpl_id - IN: The identifier of the dataset creation property list that will be used when creating the virtual dataset.vspace_id - IN: The dataspace identifier with the selection within the virtual dataset applied, possibly an unlimited selection.src_file_name - IN: The name of the HDF5 file where the source dataset is located. The file might not exist yet. The name can be specified using a C-style printf statement.src_dset_name - IN: The path to the HDF5 dataset in the file specified by src_file_name. The dataset might not exist yet. The dataset name can be specified using a C-style printf statement.src_space_id - IN: The source dataset dataspace identifier with a selection applied, possibly an unlimited selection.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - an name string is null.java.lang.IllegalArgumentException - - An id is <=0
-
H5Pget_virtual_count
public static long H5Pget_virtual_count(long dcpl_id)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pget_virtual_count gets the number of mappings for a virtual dataset that has the creation property list specified by dcpl_id.
- Parameters:
dcpl_id - IN: The identifier of the virtual dataset creation property list.- Returns:
- a non-negative number of mappings if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - An id is <=0
-
H5Pget_virtual_vspace
public static long H5Pget_virtual_vspace(long dcpl_id,
long index)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pget_virtual_vspace takes the dataset creation property list for the virtual dataset, dcpl_id, and the mapping index, index,
and returns a dataspace identifier for the selection within the virtual dataset used in the mapping.
- Parameters:
dcpl_id - IN: The identifier of the virtual dataset creation property list.index - IN: Mapping index.- Returns:
- a valid dataspace identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - An id is <=0
-
H5Pget_virtual_srcspace
public static long H5Pget_virtual_srcspace(long dcpl_id,
long index)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pget_virtual_srcspace takes the dataset creation property list for the virtual dataset, dcpl_id, and the mapping index, index,
and returns a dataspace identifier for the selection within the source dataset used in the mapping.
- Parameters:
dcpl_id - IN: The identifier of the virtual dataset creation property list.index - IN: Mapping index.- Returns:
- a valid dataspace identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - An id is <=0
-
H5Pget_virtual_filename
public static java.lang.String H5Pget_virtual_filename(long dcpl_id,
long index)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pget_virtual_filename takes the dataset creation property list for the virtual dataset, dcpl_id, the mapping index, index,
the size of the filename for a source dataset, size, and retrieves the name of the file for a source dataset used in the mapping.
- Parameters:
dcpl_id - IN: The identifier of the virtual dataset creation property list.index - IN: Mapping index.- Returns:
- the name of the file containing the source dataset if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - An id is <=0
-
H5Pget_virtual_dsetname
public static java.lang.String H5Pget_virtual_dsetname(long dcpl_id,
long index)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pget_virtual_dsetname takes the dataset creation property list for the virtual dataset, dcpl_id, the mapping index, index, the
size of the dataset name for a source dataset, size, and retrieves the name of the source dataset used in the mapping.
- Parameters:
dcpl_id - IN: The identifier of the virtual dataset creation property list.index - IN: Mapping index.- Returns:
- the name of the source dataset if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - An id is <=0
-
H5Pget_external
public static int H5Pget_external(long plist,
int idx,
long name_size,
java.lang.String[] name,
long[] size)
throws java.lang.ArrayIndexOutOfBoundsException,
java.lang.ArrayStoreException,
HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Pget_external returns information about an external file.
- Parameters:
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.
- Returns:
- a non-negative value if successful
- Throws:
java.lang.ArrayIndexOutOfBoundsException - Fatal error on Copybackjava.lang.ArrayStoreException - Fatal error on CopybackHDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name or size is null.java.lang.IllegalArgumentException - - name_size <= 0 .
-
H5Pset_external
public static int H5Pset_external(long plist,
java.lang.String name,
long offset,
long size)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pset_external adds an external file to the list of external files.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Pget_external_count
public static int H5Pget_external_count(long plist)
throws HDF5LibraryException
H5Pget_external_count returns the number of external files for the specified dataset.
- Parameters:
plist - IN: Identifier of a dataset creation property list.- Returns:
- the number of external files if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_szip
public static int H5Pset_szip(long plist,
int options_mask,
int pixels_per_block)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_shuffle
public static int H5Pset_shuffle(long plist_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_nbit
public static int H5Pset_nbit(long plist_id)
throws HDF5LibraryException
H5Pset_nbit Sets up the use of the N-Bit filter.
- Parameters:
plist_id - IN: Dataset creation property list identifier.- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_scaleoffset
public static int H5Pset_scaleoffset(long plist_id,
int scale_type,
int scale_factor)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pset_scaleoffset sets the Scale-Offset filter for a dataset.
- Parameters:
plist_id - IN: Dataset creation property list identifier.scale_type - IN: Flag indicating compression method.scale_factor - IN: Parameter related to scale.- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid arguments
-
H5Pget_fill_value
public static int H5Pget_fill_value(long plist_id,
long type_id,
byte[] value)
throws HDF5Exception
H5Pget_fill_value queries the fill value property of a dataset creation property list.
- Parameters:
plist_id - IN: Property list identifier.type_id - IN: The datatype identifier of value.value - IN: The fill value.- Returns:
- a non-negative value if successful
- Throws:
HDF5Exception - - Error converting data array.
-
H5Pget_fill_value
public static int H5Pget_fill_value(long plist_id,
long type_id,
java.lang.Object obj)
throws HDF5Exception
H5Pget_fill_value queries the fill value property of a dataset creation property list.
- Parameters:
plist_id - IN: Property list identifier.type_id - IN: The datatype identifier of value.obj - IN: The fill value.- Returns:
- a non-negative value if successful
- Throws:
HDF5Exception - - Error converting data array.
-
H5Pset_fill_value
public static int H5Pset_fill_value(long plist_id,
long type_id,
byte[] value)
throws HDF5Exception
H5Pset_fill_value sets the fill value for a dataset creation property list.
- Parameters:
plist_id - IN: Property list identifier.type_id - IN: The datatype identifier of value.value - IN: The fill value.- Returns:
- a non-negative value if successful
- Throws:
HDF5Exception - - Error converting data array
-
H5Pset_fill_value
public static int H5Pset_fill_value(long plist_id,
long type_id,
java.lang.Object obj)
throws HDF5Exception
H5Pset_fill_value sets the fill value for a dataset creation property list.
- Parameters:
plist_id - IN: Property list identifier.type_id - IN: The datatype identifier of value.obj - IN: The fill value.- Returns:
- a non-negative value if successful
- Throws:
HDF5Exception - - Error converting data array
-
H5Pfill_value_defined
public static int H5Pfill_value_defined(long plist_id,
int[] status)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pget_alloc_time
public static int H5Pget_alloc_time(long plist_id,
int[] alloc_time)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_alloc_time
public static int H5Pset_alloc_time(long plist_id,
int alloc_time)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pget_fill_time
public static int H5Pget_fill_time(long plist_id,
int[] fill_time)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_fill_time
public static int H5Pset_fill_time(long plist_id,
int fill_time)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_chunk_opts
public static void H5Pset_chunk_opts(long dcpl_id,
int opts)
throws HDF5LibraryException
H5Pset_chunk_opts Sets the edge chunk option in a dataset creation property list.
- Parameters:
dcpl_id - IN: Dataset creation property list identifieropts - IN: Edge chunk option flag. Valid values are:
H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS - filters are not applied to partial edge chunks.
0 - Disables option; partial edge chunks will be compressed.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library
-
H5Pget_chunk_opts
public static int H5Pget_chunk_opts(long dcpl_id)
throws HDF5LibraryException
H5Pget_chunk_opts retrieves the edge chunk option setting stored in the dataset creation property list .
- Parameters:
dcpl_id - IN: Dataset creation property list- Returns:
- The edge chunk option setting.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library
-
H5Pget_dset_no_attrs_hint
public static boolean H5Pget_dset_no_attrs_hint(long dcpl_id)
throws HDF5LibraryException
H5Pget_dset_no_attrs_hint accesses the flag for whether or not datasets created by the given dcpl
will be created with a "minimized" object header.
- Parameters:
dcpl_id - IN: Dataset creation property list- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_dset_no_attrs_hint
public static void H5Pset_dset_no_attrs_hint(long dcpl_id,
boolean minimize)
throws HDF5LibraryException
H5Pset_dset_no_attrs_hint sets the dcpl to minimize (or explicitly to not minimized) dataset object
headers upon creation.
- Parameters:
dcpl_id - IN: Dataset creation property listminimize - the minimize hint setting- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_chunk_cache
public static void H5Pget_chunk_cache(long dapl_id,
long[] rdcc_nslots,
long[] rdcc_nbytes,
double[] rdcc_w0)
throws HDF5LibraryException,
java.lang.NullPointerException
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 on a per-datset basis.
- Parameters:
dapl_id - IN: Identifier of the dataset access property list.rdcc_nslots - IN/OUT: Number of elements (objects) in the raw data chunk cache.rdcc_nbytes - IN/OUT: Total size of the raw data chunk cache, in bytes.rdcc_w0 - IN/OUT: Preemption policy.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - an array is null.
-
H5Pset_chunk_cache
public static void H5Pset_chunk_cache(long dapl_id,
long rdcc_nslots,
long rdcc_nbytes,
double rdcc_w0)
throws HDF5LibraryException
H5Pset_chunk_cache sets the number of elements (objects) in the meta data cache and the total number of bytes in
the raw data chunk cache on a per-datset basis.
- Parameters:
dapl_id - IN: Identifier of the datset access property list.rdcc_nslots - IN: Number of elements (objects) in the raw data chunk cache.rdcc_nbytes - IN: Total size of the raw data chunk cache, in bytes.rdcc_w0 - IN: Preemption policy.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_virtual_view
public static void H5Pset_virtual_view(long dapl_id,
int view)
throws HDF5LibraryException
H5Pset_virtual_view takes the access property list for the virtual dataset, dapl_id, and the flag,
view, and sets the VDS view according to the flag value.
- Parameters:
dapl_id - IN: Dataset access property list identifier for the virtual datasetview - IN: Flag specifying the extent of the data to be included in the view.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library
-
H5Pget_virtual_view
public static int H5Pget_virtual_view(long dapl_id)
throws HDF5LibraryException
H5Pget_virtual_view takes the virtual dataset access property list, dapl_id, and retrieves the flag,
view, set by the H5Pset_virtual_view call.
- Parameters:
dapl_id - IN: Dataset access property list identifier for the virtual dataset- Returns:
- The flag specifying the view of the virtual dataset.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library
-
H5Pset_virtual_printf_gap
public static void H5Pset_virtual_printf_gap(long dapl_id,
long gap_size)
throws HDF5LibraryException
H5Pset_virtual_printf_gap sets the access property list for the virtual dataset, dapl_id, to instruct the
library to stop looking for the mapped data stored in the files and/or datasets with the printf-style names
after not finding gap_size files and/or datasets. The found source files and datasets will determine the
extent of the unlimited virtual dataset with the printf-style mappings.
- Parameters:
dapl_id - IN: Dataset access property list identifier for the virtual datasetgap_size - IN: Maximum number of files and/or datasets allowed to be missing for determining
the extent of an unlimited virtual dataset with printf-style mappings.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library
-
H5Pget_virtual_printf_gap
public static long H5Pget_virtual_printf_gap(long dapl_id)
throws HDF5LibraryException
H5Pget_virtual_printf_gap returns the maximum number of missing printf-style files and/or datasets for
determining the extent of an unlimited virtual dataaset, gap_size, using the access property list for
the virtual dataset, dapl_id.
- Parameters:
dapl_id - IN: Dataset access property list identifier for the virtual dataset- Returns:
- Maximum number of files and/or datasets allowed to be missing for determining
the extent of an unlimited virtual dataset with printf-style mappings.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library
-
H5Pget_virtual_prefix
public static java.lang.String H5Pget_virtual_prefix(long dapl_id)
throws HDF5LibraryException
H5Pget_virtual_prefix Retrieves prefix applied to virtual file paths.
- Parameters:
dapl_id - IN: Link access property list identifier- Returns:
- the prefix to be applied to virtual file paths.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_virtual_prefix
public static void H5Pset_virtual_prefix(long dapl_id,
java.lang.String prefix)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pset_virtual_prefix Sets prefix to be applied to virtual file paths.
- Parameters:
dapl_id - IN: Dataset access property list identifierprefix - IN: Prefix to be applied to virtual file paths- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - prefix is null.
-
H5Pget_efile_prefix
public static java.lang.String H5Pget_efile_prefix(long dapl_id)
throws HDF5LibraryException
H5Pget_efile_prefix Retrieves prefix applied to external file paths.
- Parameters:
dapl_id - IN: Link access property list identifier- Returns:
- the prefix to be applied to external file paths.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_efile_prefix
public static void H5Pset_efile_prefix(long dapl_id,
java.lang.String prefix)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pset_efile_prefix Sets prefix to be applied to external file paths.
- Parameters:
dapl_id - IN: Dataset access property list identifierprefix - IN: Prefix to be applied to external file paths- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - prefix is null.
-
H5Pget_data_transform
public static long H5Pget_data_transform(long plist_id,
java.lang.String[] expression,
long size)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pget_data_transform retrieves the data transform expression previously set in the dataset transfer property
list plist_id by H5Pset_data_transform.
- Parameters:
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- Returns:
- The size of the transform expression if successful; 0(zero) if no transform expression exists. Otherwise
returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Size is <= 0.
-
H5Pset_data_transform
public static int H5Pset_data_transform(long plist_id,
java.lang.String expression)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pset_data_transform sets a data transform expression
- Parameters:
plist_id - IN: Identifier of the property list or classexpression - IN: Pointer to the null-terminated data transform expression- Returns:
- a non-negative valule if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - expression is null.
-
H5Pget_buffer
public static int H5Pget_buffer(long plist,
byte[] tconv,
byte[] bkg)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
HH5Pget_buffer gets type conversion and background buffers. Returns buffer size, in bytes, if successful;
otherwise 0 on failure.
- Parameters:
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.- Returns:
- buffer size, in bytes, if successful; otherwise 0 on failure
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - plist is invalid.
-
H5Pget_buffer_size
public static long H5Pget_buffer_size(long plist)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
- Throws:
HDF5LibraryExceptionjava.lang.IllegalArgumentException
-
H5Pset_buffer_size
public static void H5Pset_buffer_size(long plist,
long size)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pset_buffer sets type conversion and background buffers. status to TRUE or FALSE.
Given a dataset transfer property list, H5Pset_buffer sets the maximum size for the type conversion buffer and
background buffer and optionally supplies pointers to application-allocated buffers. If the buffer size is
smaller than the entire amount of data being transferred between the application and the file, and a type
conversion buffer or background buffer is required, then strip mining will be used.
Note that there are minimum size requirements for the buffer. Strip mining can only break the data up along the
first dimension, so the buffer must be large enough to accommodate a complete slice that encompasses all of the
remaining dimensions. For example, when strip mining a 100x200x300 hyperslab of a simple data space, the buffer
must be large enough to hold 1x200x300 data elements. When strip mining a 100x200x300x150 hyperslab of a simple
data space, the buffer must be large enough to hold 1x200x300x150 data elements.
- Parameters:
plist - Identifier for the dataset transfer property list.size - Size, in bytes, of the type conversion and background buffers.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - plist is invalid.
-
H5Pget_edc_check
public static int H5Pget_edc_check(long plist)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_edc_check
public static int H5Pset_edc_check(long plist,
int check)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pget_btree_ratios
public static int H5Pget_btree_ratios(long plist_id,
double[] left,
double[] middle,
double[] right)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pget_btree_ratio Get the B-tree split ratios for a dataset transfer property list.
- Parameters:
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- Returns:
- non-negative if succeed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - an input array is null.
-
H5Pset_btree_ratios
public static int H5Pset_btree_ratios(long plist_id,
double left,
double middle,
double right)
throws HDF5LibraryException
H5Pset_btree_ratio Sets B-tree split ratios for a dataset transfer property list. The split ratios determine what
percent of children go in the first node when a node splits.
- Parameters:
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- Returns:
- non-negative if succeed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_hyper_vector_size
public static int H5Pget_hyper_vector_size(long dxpl_id,
long[] vector_size)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_hyper_vector_size
public static int H5Pset_hyper_vector_size(long dxpl_id,
long vector_size)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pget_create_intermediate_group
public static boolean H5Pget_create_intermediate_group(long lcpl_id)
throws HDF5LibraryException
H5Pget_create_intermediate_group determines whether property is set to enable creating missing intermediate
groups.
- Parameters:
lcpl_id - IN: Link creation property list identifier- Returns:
- Boolean true or false
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_create_intermediate_group
public static int H5Pset_create_intermediate_group(long lcpl_id,
boolean crt_intermed_group)
throws HDF5LibraryException
H5Pset_create_intermediate_group specifies in property list whether to create missing intermediate groups
- Parameters:
lcpl_id - IN: Link creation property list identifiercrt_intermed_group - IN: Flag specifying whether to create intermediate groups upon the creation of an object- Returns:
- a non-negative valule if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_local_heap_size_hint
public static long H5Pget_local_heap_size_hint(long gcpl_id)
throws HDF5LibraryException
H5Pget_local_heap_size_hint Retrieves the anticipated size of the local heap for original-style groups.
- Parameters:
gcpl_id - IN: Group creation property list identifier- Returns:
- size_hint, the anticipated size of local heap
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_local_heap_size_hint
public static int H5Pset_local_heap_size_hint(long gcpl_id,
long size_hint)
throws HDF5LibraryException
H5Pset_local_heap_size_hint Specifies the anticipated maximum size of a local heap.
- Parameters:
gcpl_id - IN: Group creation property list identifiersize_hint - IN: Anticipated maximum size in bytes of local heap- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_link_phase_change
public static int H5Pget_link_phase_change(long gcpl_id,
int[] links)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pget_link_phase_change Queries the settings for conversion between compact and dense groups.
- Parameters:
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
- Returns:
- Returns a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - size is null.
-
H5Pset_link_phase_change
public static int H5Pset_link_phase_change(long gcpl_id,
int max_compact,
int min_dense)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pset_link_phase_change Sets the parameters for conversion between compact and dense groups.
- Parameters:
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)- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid values of max_compact and min_dense.
-
H5Pget_est_link_info
public static int H5Pget_est_link_info(long gcpl_id,
int[] link_info)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pget_est_link_info Queries data required to estimate required local heap or object header size.
- Parameters:
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
- Returns:
- Returns a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - link_info is null.
-
H5Pset_est_link_info
public static int H5Pset_est_link_info(long gcpl_id,
int est_num_entries,
int est_name_len)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pset_est_link_info Sets estimated number of links and length of link names in a group.
- Parameters:
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- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid values to est_num_entries and est_name_len.
-
H5Pget_link_creation_order
public static int H5Pget_link_creation_order(long gcpl_id)
throws HDF5LibraryException
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.
- Parameters:
gcpl_id - IN: Group creation property list identifier- Returns:
- crt_order_flags -Creation order flag(s)
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_link_creation_order
public static int H5Pset_link_creation_order(long gcpl_id,
int crt_order_flags)
throws HDF5LibraryException
H5Pset_link_creation_order Sets flags in a group creation property list, gcpl_id, for tracking and/or indexing
links on creation order.
- Parameters:
gcpl_id - IN: Group creation property list identifiercrt_order_flags - IN: Creation order flag(s)- Returns:
- Returns a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_char_encoding
public static int H5Pget_char_encoding(long plist_id)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Pset_char_encoding
public static void H5Pset_char_encoding(long plist_id,
int encoding)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Pget_nlinks
public static long H5Pget_nlinks(long lapl_id)
throws HDF5LibraryException
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. This value is retrieved from the link access
property list lapl_id.
- Parameters:
lapl_id - IN: File access property list identifier- Returns:
- Returns a Maximum number of links to traverse.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_nlinks
public static int H5Pset_nlinks(long lapl_id,
long nlinks)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
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. This value is set in the link access property list
lapl_id.
- Parameters:
lapl_id - IN: File access property list identifiernlinks - IN: Maximum number of links to traverse- Returns:
- Returns a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Argument is Illegal
-
H5Pget_elink_prefix
public static long H5Pget_elink_prefix(long lapl_id,
java.lang.String[] prefix)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pget_elink_prefix Retrieves prefix applied to external link paths.
- Parameters:
lapl_id - IN: Link access property list identifierprefix - OUT: Prefix applied to external link paths- Returns:
- If successful, returns a non-negative value specifying the size in bytes of the prefix without the NULL
terminator; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - prefix is null.
-
H5Pset_elink_prefix
public static int H5Pset_elink_prefix(long lapl_id,
java.lang.String prefix)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pset_elink_prefix Sets prefix to be applied to external link paths.
- Parameters:
lapl_id - IN: Link access property list identifierprefix - IN: Prefix to be applied to external link paths- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - prefix is null.
-
H5Pget_elink_fapl
public static long H5Pget_elink_fapl(long lapl_id)
throws HDF5LibraryException
H5Pget_elink_fapl Retrieves the file access property list identifier associated with the link access property
list.
- Parameters:
lapl_id - IN: Link access property list identifier- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_elink_fapl
public static int H5Pset_elink_fapl(long lapl_id,
long fapl_id)
throws HDF5LibraryException
H5Pset_elink_fapl sets a file access property list for use in accessing a file pointed to by an external link.
- Parameters:
lapl_id - IN: Link access property list identifierfapl_id - IN: File access property list identifier- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_elink_acc_flags
public static int H5Pget_elink_acc_flags(long lapl_id)
throws HDF5LibraryException
H5Pget_elink_acc_flags retrieves the external link traversal file access flag from the specified link access
property list.
- Parameters:
lapl_id - IN: Link access property list identifier- Returns:
- File access flag for link traversal.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_elink_acc_flags
public static int H5Pset_elink_acc_flags(long lapl_id,
int flags)
throws HDF5LibraryException,
java.lang.IllegalArgumentException
H5Pset_elink_acc_flags Sets the external link traversal file access flag in a link access property list.
- Parameters:
lapl_id - IN: Link access property list identifierflags - IN: The access flag for external link traversal.- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.IllegalArgumentException - - Invalid Flag values.
-
H5Pget_copy_object
public static int H5Pget_copy_object(long ocp_plist_id)
throws HDF5LibraryException
H5Pget_copy_object retrieves the properties to be used when an object is copied.
- Parameters:
ocp_plist_id - IN: Object copy property list identifier- Returns:
- Copy option(s) set in the object copy property list
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_copy_object
public static void H5Pset_copy_object(long ocp_plist_id,
int copy_options)
throws HDF5LibraryException
H5Pset_copy_object Sets properties to be used when an object is copied.
- Parameters:
ocp_plist_id - IN: Object copy property list identifiercopy_options - IN: Copy option(s) to be set- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_version
public static int H5Pget_version(long plist,
int[] version_info)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
Deprecated. As of HDF5 1.10.0 in favor of H5Fget_info.
H5Pget_version retrieves the version information of various objects for a file creation property list.
- Parameters:
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 // shared object header version
- Returns:
- a non-negative value, with the values of version_info initialized, if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - version_info is null.java.lang.IllegalArgumentException - - version_info is illegal.
-
H5Pget_fapl_core
public static void H5Pget_fapl_core(long fapl_id,
long[] increment,
boolean[] backing_store)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_fapl_core
public static int H5Pset_fapl_core(long fapl_id,
long increment,
boolean backing_store)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pget_fapl_direct
public static int H5Pget_fapl_direct(long fapl_id,
long[] info)
throws HDF5LibraryException
H5Pget_fapl_direct Retrieve direct I/O settings.
- Parameters:
fapl_id - IN: File access property list identifierinfo - OUT: Returned property list information info[0] = alignment Required memory alignment boundary info[1]
= block_size File system block size info[2] = cbuf_size Copy buffer size- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pset_fapl_direct
public static int H5Pset_fapl_direct(long fapl_id,
long alignment,
long block_size,
long cbuf_size)
throws HDF5LibraryException
H5Pset_fapl_direct Sets up use of the direct I/O driver.
- Parameters:
fapl_id - IN: File access property list identifieralignment - IN: Required memory alignment boundaryblock_size - IN: File system block sizecbuf_size - IN: Copy buffer size- Returns:
- a non-negative value if successful; otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Pget_fapl_family
public static int H5Pget_fapl_family(long fapl_id,
long[] memb_size,
long[] memb_fapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_fapl_family
public static int H5Pset_fapl_family(long fapl_id,
long memb_size,
long memb_fapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pget_fapl_multi
public static boolean H5Pget_fapl_multi(long fapl_id,
int[] memb_map,
long[] memb_fapl,
java.lang.String[] memb_name,
long[] memb_addr)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pget_fapl_multi Sets up use of the multi I/O driver.
- Parameters:
fapl_id - IN: File access property list identifiermemb_map - IN: Maps memory usage types to other memory usage types.memb_fapl - IN: Property list for each memory usage type.memb_name - IN: Name generator for names of member files.memb_addr - IN: The offsets within the virtual address space, from 0 (zero) to HADDR_MAX, at which each type of
data storage begins.- Returns:
- a boolean value; Allows read-only access to incomplete file sets when TRUE.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - an array is null.
-
H5Pset_fapl_multi
public static void H5Pset_fapl_multi(long fapl_id,
int[] memb_map,
long[] memb_fapl,
java.lang.String[] memb_name,
long[] memb_addr,
boolean relax)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pset_fapl_multi Sets up use of the multi I/O driver.
- Parameters:
fapl_id - IN: File access property list identifiermemb_map - IN: Maps memory usage types to other memory usage types.memb_fapl - IN: Property list for each memory usage type.memb_name - IN: Name generator for names of member files.memb_addr - IN: The offsets within the virtual address space, from 0 (zero) to HADDR_MAX, at which each type of
data storage begins.relax - IN: Allows read-only access to incomplete file sets when TRUE.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - an array is null.
-
H5Pset_fapl_log
public static void H5Pset_fapl_log(long fapl_id,
java.lang.String logfile,
long flags,
long buf_size)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Pset_fapl_log Sets up the logging virtual file driver (H5FD_LOG) for use. H5Pset_fapl_log modifies the file
access property list to use the logging driver, H5FD_LOG. The logging virtual file driver (VFD) is a clone of the
standard SEC2 (H5FD_SEC2) driver with additional facilities for logging VFD metrics and activity to a file.
- Parameters:
fapl_id - IN: File access property list identifier.logfile - IN: logfile is the name of the file in which the logging entries are to be recorded.flags - IN: Flags specifying the types of logging activity.buf_size - IN: The size of the logging buffers, in bytes.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - logfile is null.
-
H5Pset_fapl_sec2
public static int H5Pset_fapl_sec2(long fapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_fapl_split
public static void H5Pset_fapl_split(long fapl_id,
java.lang.String meta_ext,
long meta_plist_id,
java.lang.String raw_ext,
long raw_plist_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_fapl_stdio
public static int H5Pset_fapl_stdio(long fapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Pset_fapl_windows
public static int H5Pset_fapl_windows(long fapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5PLset_loading_state
public static void H5PLset_loading_state(int plugin_flags)
throws HDF5LibraryException
H5PLset_loading_state uses one argument to enable or disable individual plugins.
The plugin_flags parameter is an encoded integer in which each bit controls a specific
plugin or class of plugins.
A plugin bit set to 0 (zero) prevents the use of the dynamic plugin corresponding
to that bit position. A plugin bit set to 1 (one) allows the use of that dynamic plugin.
All dynamic plugins can be enabled by setting plugin_flags to a negative value.
A value of 0 (zero) will disable all dynamic plugins.
H5PLset_loading_state inspects the HDF5_PLUGIN_PRELOAD environment variable every
time it is called. If the environment variable is set to the special :: string,
all dynamic plugins will be disabled.
- Parameters:
plugin_flags - IN: The list of dynamic plugin types to enable or disable.
A plugin bit set to 0 (zero) prevents use of that dynamic plugin.
A plugin bit set to 1 (one) enables use of that dynamic plugin.
Setting plugin_flags to a negative value enables all dynamic plugins.
Setting plugin_flags to 0 (zero) disables all dynamic plugins.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5PLget_loading_state
public static int H5PLget_loading_state()
throws HDF5LibraryException
H5PLget_loading_state retrieves the state of the dynamic plugins flag, plugin_flags..
- Returns:
- the list of dynamic plugin types that are enabled or disabled.
A plugin bit set to 0 (zero) indicates that that dynamic plugin is disabled.
A plugin bit set to 1 (one) indicates that that dynamic plugin is enabled.
If the value of plugin_flags is negative, all dynamic plugins are enabled.
If the value of plugin_flags is 0 (zero), all dynamic plugins are disabled.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5PLappend
public static void H5PLappend(java.lang.String plugin_path)
throws HDF5LibraryException
H5PLappend inserts the plugin path at the end of the table.
- Parameters:
plugin_path - IN: Path for location of filter plugin libraries.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5PLprepend
public static void H5PLprepend(java.lang.String plugin_path)
throws HDF5LibraryException
H5PLprepend inserts the plugin path at the beginning of the table.
- Parameters:
plugin_path - IN: Path for location of filter plugin libraries.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5PLreplace
public static void H5PLreplace(java.lang.String plugin_path,
int index)
throws HDF5LibraryException
H5PLreplace replaces the plugin path at the specified index.
- Parameters:
plugin_path - IN: Path for location of filter plugin libraries.index - IN: The table index (0-based).- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5PLinsert
public static void H5PLinsert(java.lang.String plugin_path,
int index)
throws HDF5LibraryException
H5PLinsert inserts the plugin path at the specified index.
- Parameters:
plugin_path - IN: Path for location of filter plugin libraries.index - IN: The table index (0-based).- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5PLremove
public static void H5PLremove(int index)
throws HDF5LibraryException
H5PLremove removes the plugin path at the specified index.
- Parameters:
index - IN: The table index (0-based).- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5PLget
public static java.lang.String H5PLget(int index)
throws HDF5LibraryException
H5PLget retrieves the plugin path at the specified index.
- Parameters:
index - IN: The table index (0-based).- Returns:
- the current path at the index in plugin path table
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5PLsize
public static int H5PLsize()
throws HDF5LibraryException
H5PLsize retrieves the size of the current list of plugin paths.
- Returns:
- the current number of paths in the plugin path table
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Rcreate
public static byte[] H5Rcreate(long loc_id,
java.lang.String name,
int ref_type,
long space_id)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Rcreate creates the reference, ref, of the type specified in ref_type, pointing to the object name located at
loc_id.
- Parameters:
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.- Returns:
- the reference (byte[]) if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - an input array is null.java.lang.IllegalArgumentException - - an input array is invalid.
-
H5Rdereference
public static long H5Rdereference(long dataset,
long access_list,
int ref_type,
byte[] ref)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
Given a reference to some object, H5Rdereference opens that object and return an identifier.
- Parameters:
dataset - IN: Dataset containing reference object.access_list - IN: Property list of the object being referenced.ref_type - IN: The reference type of ref.ref - IN: reference to an object- Returns:
- valid identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - output array is null.java.lang.IllegalArgumentException - - output array is invalid.
-
H5Rget_name
public static long H5Rget_name(long loc_id,
int ref_type,
byte[] ref,
java.lang.String[] name,
long size)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Rget_name retrieves a name for the object identified by ref.
- Parameters:
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.- Returns:
- Returns the length of the name if successful, returning 0 (zero) if no name is associated with the
identifier. Otherwise returns a negative value.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - size is null.java.lang.IllegalArgumentException - - Argument is illegal.
-
H5Rget_obj_type
public static int H5Rget_obj_type(long loc_id,
int ref_type,
byte[] ref)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Rget_obj_type Given a reference to an object ref, H5Rget_obj_type returns the type of the object pointed to.
- Parameters:
loc_id - IN: loc_id of the reference object.ref_type - IN: Type of reference to query.ref - IN: the reference- Returns:
- Returns the object type
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - array is null.java.lang.IllegalArgumentException - - array is invalid.
-
H5Rget_region
public static long H5Rget_region(long loc_id,
int ref_type,
byte[] ref)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
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.
- Parameters:
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- Returns:
- a valid identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - output array is null.java.lang.IllegalArgumentException - - output array is invalid.
-
H5Sclose
public static int H5Sclose(long space_id)
throws HDF5LibraryException
H5Sclose releases a dataspace.
- Parameters:
space_id - Identifier of dataspace to release.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Scopy
public static long H5Scopy(long space_id)
throws HDF5LibraryException
H5Scopy creates a new dataspace which is an exact copy of the dataspace identified by space_id.
- Parameters:
space_id - Identifier of dataspace to copy.- Returns:
- a dataspace identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Screate
public static long H5Screate(int type)
throws HDF5LibraryException
H5Screate creates a new dataspace of a particular type.
- Parameters:
type - IN: The type of dataspace to be created.- Returns:
- a dataspace identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Screate_simple
public static long H5Screate_simple(int rank,
long[] dims,
long[] maxdims)
throws HDF5Exception,
java.lang.NullPointerException
H5Screate_simple creates a new simple data space and opens it for access.
- Parameters:
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.- Returns:
- a dataspace identifier
- Throws:
HDF5Exception - - Error from the HDF-5 Library.java.lang.NullPointerException - - dims or maxdims is null.
-
H5Sdecode
public static long H5Sdecode(byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Sdecode reconstructs the HDF5 data space object and returns a new object handle for it.
- Parameters:
buf - IN: Buffer for the data space object to be decoded.- Returns:
- a new object handle
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Sencode
public static byte[] H5Sencode(long obj_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Sencode converts a data space description into binary form in a buffer.
- Parameters:
obj_id - IN: Identifier of the object to be encoded.- Returns:
- the buffer for the object to be encoded into.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException
-
H5Sextent_copy
public static int H5Sextent_copy(long dest_space_id,
long source_space_id)
throws HDF5LibraryException
H5Sextent_copy copies the extent from source_space_id to dest_space_id. This action may change the type of the
dataspace.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sextent_equal
public static boolean H5Sextent_equal(long first_space_id,
long second_space_id)
throws HDF5LibraryException
H5Sextent_equal determines whether the dataspace extents of two dataspaces, space1_id and space2_id, are equal.
- Parameters:
first_space_id - IN: The identifier for the first dataspace.second_space_id - IN: The identifier for the seconddataspace.- Returns:
- true if successful, else false
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sget_select_bounds
public static int H5Sget_select_bounds(long spaceid,
long[] start,
long[] end)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Sget_select_bounds retrieves the coordinates of the bounding box containing the current selection and places
them into user-supplied buffers.
The start and end buffers must be large enough to hold the dataspace rank number of coordinates.
- Parameters:
spaceid - Identifier of dataspace to release.start - coordinates of lowest corner of bounding box.end - coordinates of highest corner of bounding box.- Returns:
- a non-negative value if successful,with start and end initialized.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - start or end is null.
-
H5Sget_select_elem_npoints
public static long H5Sget_select_elem_npoints(long spaceid)
throws HDF5LibraryException
H5Sget_select_elem_npoints returns the number of element points in the current dataspace selection.
- Parameters:
spaceid - Identifier of dataspace to release.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sget_select_elem_pointlist
public static int H5Sget_select_elem_pointlist(long spaceid,
long startpoint,
long numpoints,
long[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Sget_select_elem_pointlist returns an array of of element points in the current dataspace selection. The point
coordinates have the same dimensionality (rank) as the dataspace they are located within, one coordinate per
point.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Sget_select_hyper_blocklist
public static int H5Sget_select_hyper_blocklist(long spaceid,
long startblock,
long numblocks,
long[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Sget_select_hyper_blocklist returns an array of hyperslab blocks. The block coordinates have the same
dimensionality (rank) as the dataspace they are located within. The list of blocks is formatted as follows:
<"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.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Sget_select_hyper_nblocks
public static long H5Sget_select_hyper_nblocks(long spaceid)
throws HDF5LibraryException
H5Sget_select_hyper_nblocks returns the number of hyperslab blocks in the current dataspace selection.
- Parameters:
spaceid - Identifier of dataspace to release.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sget_select_npoints
public static long H5Sget_select_npoints(long space_id)
throws HDF5LibraryException
H5Sget_select_npoints determines the number of elements in the current selection of a dataspace.
- Parameters:
space_id - IN: Identifier of the dataspace object to query- Returns:
- the number of elements in the selection if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sget_select_type
public static int H5Sget_select_type(long space_id)
throws HDF5LibraryException
H5Sget_select_type retrieves the type of selection currently defined for the dataspace space_id.
- Parameters:
space_id - IN: Identifier of the dataspace object to query- Returns:
- the dataspace selection type if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sget_simple_extent_dims
public static int H5Sget_simple_extent_dims(long space_id,
long[] dims,
long[] maxdims)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Sget_simple_extent_dims returns the size and maximum sizes of each dimension of a dataspace through the dims
and maxdims parameters.
- Parameters:
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.- Returns:
- the number of dimensions in the dataspace if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - dims or maxdims is null.
-
H5Sget_simple_extent_ndims
public static int H5Sget_simple_extent_ndims(long space_id)
throws HDF5LibraryException
H5Sget_simple_extent_ndims determines the dimensionality (or rank) of a dataspace.
- Parameters:
space_id - IN: Identifier of the dataspace- Returns:
- the number of dimensions in the dataspace if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sget_simple_extent_npoints
public static long H5Sget_simple_extent_npoints(long space_id)
throws HDF5LibraryException
H5Sget_simple_extent_npoints determines the number of elements in a dataspace.
- Parameters:
space_id - ID of the dataspace object to query- Returns:
- the number of elements in the dataspace if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sget_simple_extent_type
public static int H5Sget_simple_extent_type(long space_id)
throws HDF5LibraryException
H5Sget_simple_extent_type queries a dataspace to determine the current class of a dataspace.
- Parameters:
space_id - Dataspace identifier.- Returns:
- a dataspace class name if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sis_simple
public static boolean H5Sis_simple(long space_id)
throws HDF5LibraryException
H5Sis_simple determines whether a dataspace is a simple dataspace.
- Parameters:
space_id - Identifier of the dataspace to query- Returns:
- true if is a simple dataspace
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Soffset_simple
public static int H5Soffset_simple(long space_id,
byte[] offset)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Soffset_simple sets the offset of a simple dataspace space_id.
- Parameters:
space_id - IN: The identifier for the dataspace object to reset.offset - IN: The offset at which to position the selection.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - offset array is null.
-
H5Soffset_simple
public static int H5Soffset_simple(long space_id,
long[] offset)
throws HDF5Exception,
java.lang.NullPointerException
- Throws:
HDF5Exceptionjava.lang.NullPointerException
-
H5Sselect_all
public static int H5Sselect_all(long space_id)
throws HDF5LibraryException
H5Sselect_all selects the entire extent of the dataspace space_id.
- Parameters:
space_id - IN: The identifier of the dataspace to be selected.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sselect_elements
public static int H5Sselect_elements(long space_id,
int op,
int num_elements,
long[][] coord2D)
throws HDF5Exception,
HDF5LibraryException,
java.lang.NullPointerException
H5Sselect_elements selects array elements to be included in the selection for the space_id dataspace.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5Exception - - Error in the data conversionHDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - cord array is
-
H5Sselect_hyperslab
public static int H5Sselect_hyperslab(long space_id,
int op,
byte[] start,
byte[] stride,
byte[] count,
byte[] block)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Sselect_hyperslab selects a hyperslab region to add to the current selected region for the dataspace specified
by space_id. The start, stride, count, and block arrays must be the same size as the rank of the dataspace.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - an input array is null.java.lang.IllegalArgumentException - - an input array is invalid.
-
H5Sselect_hyperslab
public static int H5Sselect_hyperslab(long space_id,
int op,
long[] start,
long[] stride,
long[] count,
long[] block)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerExceptionjava.lang.IllegalArgumentException
-
H5Sselect_none
public static int H5Sselect_none(long space_id)
throws HDF5LibraryException
H5Sselect_none resets the selection region for the dataspace space_id to include no elements.
- Parameters:
space_id - IN: The identifier of the dataspace to be reset.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sselect_valid
public static boolean H5Sselect_valid(long space_id)
throws HDF5LibraryException
H5Sselect_valid verifies that the selection for the dataspace.
- Parameters:
space_id - The identifier for the dataspace in which the selection is being reset.- Returns:
- true if the selection is contained within the extent and FALSE if it is not or is an error.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sset_extent_none
public static int H5Sset_extent_none(long space_id)
throws HDF5LibraryException
H5Sset_extent_none removes the extent from a dataspace and sets the type to H5S_NONE.
- Parameters:
space_id - The identifier for the dataspace from which the extent is to be removed.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Sset_extent_simple
public static long H5Sset_extent_simple(long space_id,
int rank,
long[] current_size,
long[] maximum_size)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Sset_extent_simple sets or resets the size of an existing dataspace.
- Parameters:
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.- Returns:
- a dataspace identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException
-
H5Sset_extent_simple
public static long H5Sset_extent_simple(long space_id,
int rank,
byte[] current_size,
byte[] maximum_size)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Sget_regular_hyperslab
public static void H5Sget_regular_hyperslab(long space_id,
long[] start,
long[] stride,
long[] count,
long[] block)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Sget_regular_hyperslab determines if a hyperslab selection is regular for the dataspace specified
by space_id. The start, stride, count, and block arrays must be the same size as the rank of the dataspace.
- Parameters:
space_id - IN: Identifier of dataspace selection to modifystart - OUT: Offset of start of hyperslabstride - OUT: Hyperslab stride.count - OUT: Number of blocks included in hyperslab.block - OUT: Size of block in hyperslab.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - an output array is null.java.lang.IllegalArgumentException - - an output array is invalid.
-
H5Sis_regular_hyperslab
public static boolean H5Sis_regular_hyperslab(long space_id)
throws HDF5LibraryException
H5Sis_regular_hyperslab retrieves a regular hyperslab selection for the dataspace specified
by space_id.
- Parameters:
space_id - IN: Identifier of dataspace selection to query- Returns:
- a TRUE/FALSE for hyperslab selection if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tarray_create
public static long H5Tarray_create(long base_id,
int ndims,
long[] dim)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tarray_create creates a new array datatype object.
- Parameters:
base_id - IN: Datatype identifier for the array base datatype.ndims - IN: Rank of the array.dim - IN: Size of each array dimension.- Returns:
- a valid datatype identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - dim is null.
-
H5Tclose
public static int H5Tclose(long type_id)
throws HDF5LibraryException
H5Tclose releases a datatype.
- Parameters:
type_id - IN: Identifier of datatype to release.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tcommit
public static void H5Tcommit(long loc_id,
java.lang.String name,
long type_id,
long lcpl_id,
long tcpl_id,
long tapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tcommit saves a transient datatype as an immutable named datatype in a file.
- Parameters:
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.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Tcommit_anon
public static void H5Tcommit_anon(long loc_id,
long type_id,
long tcpl_id,
long tapl_id)
throws HDF5LibraryException
H5Tcommit_anon commits a transient datatype (not immutable) to a file, turning it into a named datatype with the
specified creation and property lists.
- Parameters:
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.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tcommitted
public static boolean H5Tcommitted(long type_id)
throws HDF5LibraryException
H5Tcommitted queries a type to determine whether the type specified by the type identifier is a named type or a
transient type.
- Parameters:
type_id - IN: Identifier of datatype.- Returns:
- true the datatype has been committed
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tcompiler_conv
public static void H5Tcompiler_conv(long src_id,
long dst_id)
throws HDF5LibraryException
H5Tcompiler_conv finds out whether the library's conversion function from type src_id to type dst_id is a
compiler (hard) conversion.
- Parameters:
src_id - IN: Identifier of source datatype.dst_id - IN: Identifier of destination datatype.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tconvert
public static void H5Tconvert(long src_id,
long dst_id,
long nelmts,
byte[] buf,
byte[] background,
long plist_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tconvert converts nelmts elements from the type specified by the src_id identifier to type dst_id.
- Parameters:
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.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Tcopy
public static long H5Tcopy(long type_id)
throws HDF5LibraryException
H5Tcopy copies an existing datatype. The returned type is always transient and unlocked.
- Parameters:
type_id - IN: Identifier of datatype to copy. Can be a datatype identifier, a predefined datatype (defined in
H5Tpublic.h), or a dataset Identifier.- Returns:
- a datatype identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tcreate
public static long H5Tcreate(int tclass,
long size)
throws HDF5LibraryException
H5Tcreate creates a new dataype of the specified class with the specified number of bytes.
- Parameters:
tclass - IN: Class of datatype to create.size - IN: The number of bytes in the datatype to create.- Returns:
- datatype identifier
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tdecode
public static long H5Tdecode(byte[] buf)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tdecode reconstructs the HDF5 data type object and returns a new object handle for it.
- Parameters:
buf - IN: Buffer for the data type object to be decoded.- Returns:
- a new object handle
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Tdetect_class
public static boolean H5Tdetect_class(long type_id,
int cls)
throws HDF5LibraryException
H5Tdetect_class determines whether the datatype specified in dtype_id contains any datatypes of the datatype
class specified in dtype_class.
- Parameters:
type_id - IN: Identifier of datatype to query.cls - IN: Identifier of datatype cls.- Returns:
- true if the datatype specified in dtype_id contains any datatypes of the datatype class
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tencode
public static int H5Tencode(long obj_id,
byte[] buf,
long nalloc)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tencode converts a data type description into binary form in a buffer.
- Parameters:
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.- Returns:
- the size needed for the allocated buffer.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - buf is null.
-
H5Tenum_create
public static long H5Tenum_create(long base_id)
throws HDF5LibraryException
H5Tenum_create creates a new enumeration datatype based on the specified base datatype, parent_id, which must be
an integer type.
- Parameters:
base_id - IN: Identifier of the parent datatype to release.- Returns:
- the datatype identifier for the new enumeration datatype
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tenum_insert
public static void H5Tenum_insert(long type,
java.lang.String name,
byte[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype.
- Parameters:
type - IN: Identifier of datatype.name - IN: The name of the membervalue - IN: The value of the member, data of the correct type- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Tenum_insert
public static int H5Tenum_insert(long type,
java.lang.String name,
int[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype.
- Parameters:
type - IN: Identifier of datatype.name - IN: The name of the membervalue - IN: The value of the member, data of the correct type- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Tenum_insert
public static int H5Tenum_insert(long type,
java.lang.String name,
int value)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Tenum_nameof
public static java.lang.String H5Tenum_nameof(long type,
byte[] value,
long size)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tenum_nameof finds the symbol name that corresponds to the specified value of the enumeration datatype type.
- Parameters:
type - IN: Identifier of datatype.value - IN: The value of the member, data of the correctsize - IN: The probable length of the name- Returns:
- the symbol name.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - value is null.
-
H5Tenum_nameof
public static int H5Tenum_nameof(long type,
int[] value,
java.lang.String[] name,
int size)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tenum_nameof finds the symbol name that corresponds to the specified value of the enumeration datatype type.
- Parameters:
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- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Tenum_valueof
public static void H5Tenum_valueof(long type,
java.lang.String name,
byte[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype type.
- Parameters:
type - IN: Identifier of datatype.name - IN: The name of the membervalue - OUT: The value of the member- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException
-
H5Tenum_valueof
public static int H5Tenum_valueof(long type,
java.lang.String name,
int[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype type.
- Parameters:
type - IN: Identifier of datatype.name - IN: The name of the membervalue - OUT: The value of the member- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Tequal
public static boolean H5Tequal(long type_id1,
long type_id2)
throws HDF5LibraryException
H5Tequal determines whether two datatype identifiers refer to the same datatype.
- Parameters:
type_id1 - IN: Identifier of datatype to compare.type_id2 - IN: Identifier of datatype to compare.- Returns:
- true if the datatype identifiers refer to the same datatype, else false.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_array_dims
public static int H5Tget_array_dims(long type_id,
long[] dims)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tget_array_dims returns the sizes of the dimensions of the specified array datatype object.
- Parameters:
type_id - IN: Datatype identifier of array object.dims - OUT: Sizes of array dimensions.- Returns:
- the non-negative number of dimensions of the array type
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - dims is null.
-
H5Tget_array_dims2
public static int H5Tget_array_dims2(long type_id,
long[] dims)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tget_array_dims2 returns the sizes of the dimensions of the specified array datatype object.
- Parameters:
type_id - IN: Datatype identifier of array object.dims - OUT: Sizes of array dimensions.- Returns:
- the non-negative number of dimensions of the array type
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - dims is null.
-
H5Tget_array_ndims
public static int H5Tget_array_ndims(long type_id)
throws HDF5LibraryException
H5Tget_array_ndims returns the rank, the number of dimensions, of an array datatype object.
- Parameters:
type_id - IN: Datatype identifier of array object.- Returns:
- the rank of the array
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_class
public static int H5Tget_class(long type_id)
throws HDF5LibraryException
H5Tget_class returns the datatype class identifier.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- datatype class identifier if successful; otherwise H5T_NO_CLASS(-1).
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_class_name
public static java.lang.String H5Tget_class_name(long class_id)
H5Tget_class_name returns the datatype class identifier.
- Parameters:
class_id - IN: Identifier of class from H5Tget_class.- Returns:
- class name if successful; otherwise H5T_NO_CLASS.
-
H5Tget_create_plist
public static long H5Tget_create_plist(long type_id)
throws HDF5LibraryException
H5Tget_create_plist returns a property list identifier for the datatype creation property list associated with
the datatype specified by type_id.
- Parameters:
type_id - IN: Identifier of datatype.- Returns:
- a datatype property list identifier.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_cset
public static int H5Tget_cset(long type_id)
throws HDF5LibraryException
H5Tget_cset retrieves the character set type of a string datatype.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- a valid character set type if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_cset
public static int H5Tset_cset(long type_id,
int cset)
throws HDF5LibraryException
H5Tset_cset the character set to be used.
- Parameters:
type_id - IN: Identifier of datatype to modify.cset - IN: Character set type.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_ebias
public static int H5Tget_ebias(long type_id)
throws HDF5LibraryException
H5Tget_ebias retrieves the exponent bias of a floating-point type.
- Parameters:
type_id - Identifier of datatype to query.- Returns:
- the bias if successful; otherwise 0.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_ebias
public static int H5Tset_ebias(long type_id,
int ebias)
throws HDF5LibraryException
H5Tset_ebias sets the exponent bias of a floating-point type.
- Parameters:
type_id - Identifier of datatype to set.ebias - Exponent bias value.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_ebias_long
public static long H5Tget_ebias_long(long type_id)
throws HDF5LibraryException
H5Tget_ebias retrieves the exponent bias of a floating-point type.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- the bias
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_ebias
public static void H5Tset_ebias(long type_id,
long ebias)
throws HDF5LibraryException
H5Tset_ebias sets the exponent bias of a floating-point type.
- Parameters:
type_id - IN: Identifier of datatype to set.ebias - IN: Exponent bias value.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_fields
public static void H5Tget_fields(long type_id,
long[] fields)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Tget_fields retrieves information about the locations of the various bit fields of a floating point datatype.
- Parameters:
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.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - fields is null.java.lang.IllegalArgumentException - - fields array is invalid.
-
H5Tget_fields
public static int H5Tget_fields(long type_id,
int[] fields)
throws HDF5LibraryException,
java.lang.NullPointerException,
java.lang.IllegalArgumentException
H5Tget_fields retrieves information about the locations of the various bit fields of a floating point datatype.
- Parameters:
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.
- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - fields is null.java.lang.IllegalArgumentException - - fields array is invalid.
-
H5Tset_fields
public static void H5Tset_fields(long type_id,
long spos,
long epos,
long esize,
long mpos,
long msize)
throws HDF5LibraryException
H5Tset_fields sets the locations and sizes of the various floating point bit fields.
- Parameters:
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.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_fields
public static int H5Tset_fields(long type_id,
int spos,
int epos,
int esize,
int mpos,
int msize)
throws HDF5LibraryException
H5Tset_fields sets the locations and sizes of the various floating point bit fields.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_inpad
public static int H5Tget_inpad(long type_id)
throws HDF5LibraryException
H5Tget_inpad retrieves the internal padding type for unused bits in floating-point datatypes.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- a valid padding type if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_inpad
public static int H5Tset_inpad(long type_id,
int inpad)
throws HDF5LibraryException
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.
- Parameters:
type_id - IN: Identifier of datatype to modify.inpad - IN: Padding type.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_member_class
public static int H5Tget_member_class(long type_id,
int membno)
throws HDF5LibraryException
H5Tget_member_class returns the class of datatype of the specified member.
- Parameters:
type_id - IN: Datatype identifier of compound object.membno - IN: Compound object member number.- Returns:
- the class of the datatype of the field if successful;
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_member_index
public static int H5Tget_member_index(long type_id,
java.lang.String field_name)
H5Tget_member_index retrieves the index of a field of a compound datatype.
- Parameters:
type_id - IN: Identifier of datatype to query.field_name - IN: Field name of the field index to retrieve.- Returns:
- if field is defined, the index; else negative.
-
H5Tget_member_name
public static java.lang.String H5Tget_member_name(long 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.
- Parameters:
type_id - IN: Identifier of datatype to query.field_idx - IN: Field index (0-based) of the field name to retrieve.- Returns:
- a valid pointer to the name if successful; otherwise null.
-
H5Tget_member_offset
public static long H5Tget_member_offset(long type_id,
int membno)
throws HDF5LibraryException
H5Tget_member_offset returns the byte offset of the specified member of the compound datatype. This is the byte
offset in the HDF-5 file/library, NOT the offset of any Java object which might be mapped to this data item.
- Parameters:
type_id - IN: Identifier of datatype to query.membno - IN: Field index (0-based) of the field type to retrieve.- Returns:
- the offset of the member.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_member_type
public static long H5Tget_member_type(long type_id,
int field_idx)
throws HDF5LibraryException
H5Tget_member_type returns the datatype of the specified member.
- Parameters:
type_id - IN: Identifier of datatype to query.field_idx - IN: Field index (0-based) of the field type to retrieve.- Returns:
- the identifier of a copy of the datatype of the field if successful;
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_member_value
public static void H5Tget_member_value(long type_id,
int membno,
byte[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tget_member_value returns the value of the enumeration datatype member memb_no.
- Parameters:
type_id - IN: Datatype identifier for the enumeration datatype.membno - IN: Number of the enumeration datatype member.value - OUT: The value of the member- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - value is null.
-
H5Tget_member_value
public static int H5Tget_member_value(long type_id,
int membno,
int[] value)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tget_member_value returns the value of the enumeration datatype member memb_no.
- Parameters:
type_id - IN: Identifier of datatype.membno - IN: The name of the membervalue - OUT: The value of the member- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - value is null.
-
H5Tget_native_type
public static long H5Tget_native_type(long type_id)
throws HDF5LibraryException
H5Tget_native_type returns the equivalent native datatype for the datatype specified in type_id.
- Parameters:
type_id - IN: Identifier of datatype to query. Direction of search is assumed to be in ascending order.- Returns:
- the native datatype identifier for the specified dataset datatype.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_native_type
public static long H5Tget_native_type(long type_id,
int direction)
throws HDF5LibraryException
H5Tget_native_type returns the equivalent native datatype for the datatype specified in type_id.
- Parameters:
type_id - IN: Identifier of datatype to query.direction - IN: Direction of search.- Returns:
- the native datatype identifier for the specified dataset datatype.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_nmembers
public static int H5Tget_nmembers(long type_id)
throws HDF5LibraryException
H5Tget_nmembers retrieves the number of fields a compound datatype has.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- number of members datatype has if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_norm
public static int H5Tget_norm(long type_id)
throws HDF5LibraryException
H5Tget_norm retrieves the mantissa normalization of a floating-point datatype.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- a valid normalization type if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_norm
public static int H5Tset_norm(long type_id,
int norm)
throws HDF5LibraryException
H5Tset_norm sets the mantissa normalization of a floating-point datatype.
- Parameters:
type_id - IN: Identifier of datatype to set.norm - IN: Mantissa normalization type.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_offset
public static int H5Tget_offset(long type_id)
throws HDF5LibraryException
H5Tget_offset retrieves the bit offset of the first significant bit.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- a positive offset value if successful; otherwise 0.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_offset
public static int H5Tset_offset(long type_id,
int offset)
throws HDF5LibraryException
H5Tset_offset sets the bit offset of the first significant bit.
- Parameters:
type_id - Identifier of datatype to set.offset - Offset of first significant bit.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_offset
public static void H5Tset_offset(long type_id,
long offset)
throws HDF5LibraryException
H5Tset_offset sets the bit offset of the first significant bit.
- Parameters:
type_id - IN: Identifier of datatype to set.offset - IN: Offset of first significant bit.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_order
public static int H5Tget_order(long type_id)
throws HDF5LibraryException
H5Tget_order returns the byte order of an atomic datatype.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- a byte order constant if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_order
public static int H5Tset_order(long type_id,
int order)
throws HDF5LibraryException
H5Tset_order sets the byte ordering of an atomic datatype.
- Parameters:
type_id - IN: Identifier of datatype to set.order - IN: Byte ordering constant.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_pad
public static int H5Tget_pad(long type_id,
int[] pad)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tget_pad retrieves the padding type of the least and most-significant bit padding.
- Parameters:
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
- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - pad is null.
-
H5Tset_pad
public static int H5Tset_pad(long type_id,
int lsb,
int msb)
throws HDF5LibraryException
H5Tset_pad sets the least and most-significant bits padding types.
- Parameters:
type_id - IN: Identifier of datatype to set.lsb - IN: Padding type for least-significant bits.msb - IN: Padding type for most-significant bits.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_precision
public static int H5Tget_precision(long type_id)
throws HDF5LibraryException
H5Tget_precision returns the precision of an atomic datatype.
- Parameters:
type_id - Identifier of datatype to query.- Returns:
- the number of significant bits if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_precision
public static int H5Tset_precision(long type_id,
int precision)
throws HDF5LibraryException
H5Tset_precision sets the precision of an atomic datatype.
- Parameters:
type_id - Identifier of datatype to set.precision - Number of bits of precision for datatype.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_precision_long
public static long H5Tget_precision_long(long type_id)
throws HDF5LibraryException
H5Tget_precision returns the precision of an atomic datatype.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- the number of significant bits if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_precision
public static void H5Tset_precision(long type_id,
long precision)
throws HDF5LibraryException
H5Tset_precision sets the precision of an atomic datatype.
- Parameters:
type_id - IN: Identifier of datatype to set.precision - IN: Number of bits of precision for datatype.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_sign
public static int H5Tget_sign(long type_id)
throws HDF5LibraryException
H5Tget_sign retrieves the sign type for an integer type.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- a valid sign type if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_sign
public static int H5Tset_sign(long type_id,
int sign)
throws HDF5LibraryException
H5Tset_sign sets the sign proprety for an integer type.
- Parameters:
type_id - IN: Identifier of datatype to set.sign - IN: Sign type.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_size
public static long H5Tget_size(long type_id)
throws HDF5LibraryException
H5Tget_size returns the size of a datatype in bytes.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- the size of the datatype in bytes
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_size
public static int H5Tset_size(long type_id,
long size)
throws HDF5LibraryException
H5Tset_size sets the total size in bytes, size, for an atomic datatype (this operation is not permitted on
compound datatypes).
- Parameters:
type_id - IN: Identifier of datatype to change size.size - IN: Size in bytes to modify datatype.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_strpad
public static int H5Tget_strpad(long type_id)
throws HDF5LibraryException
H5Tget_strpad retrieves the string padding method for a string datatype.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- a valid string padding type if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_strpad
public static int H5Tset_strpad(long type_id,
int strpad)
throws HDF5LibraryException
H5Tset_strpad defines the storage mechanism for the string.
- Parameters:
type_id - IN: Identifier of datatype to modify.strpad - IN: String padding type.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_super
public static long H5Tget_super(long type)
throws HDF5LibraryException
H5Tget_super returns the type from which TYPE is derived.
- Parameters:
type - IN: Identifier of datatype.- Returns:
- the parent type
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tget_tag
public static java.lang.String H5Tget_tag(long type)
throws HDF5LibraryException
H5Tget_tag returns the tag associated with datatype type_id.
- Parameters:
type - IN: Identifier of datatype.- Returns:
- the tag
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tset_tag
public static int H5Tset_tag(long type,
java.lang.String tag)
throws HDF5LibraryException
H5Tset_tag tags an opaque datatype type_id with a unique ASCII identifier tag.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tinsert
public static int H5Tinsert(long type_id,
java.lang.String name,
long offset,
long field_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Tinsert adds another member to the compound datatype type_id.
- Parameters:
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.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Tis_variable_str
public static boolean H5Tis_variable_str(long type_id)
throws HDF5LibraryException
H5Tis_variable_str determines whether the datatype identified in type_id is a variable-length string.
- Parameters:
type_id - IN: Identifier of datatype to query.- Returns:
- true if type_id is a variable-length string.
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tlock
public static int H5Tlock(long type_id)
throws HDF5LibraryException
H5Tlock locks the datatype specified by the type_id identifier, making it read-only and non-destrucible.
- Parameters:
type_id - IN: Identifier of datatype to lock.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Topen
public static long H5Topen(long loc_id,
java.lang.String name,
long tapl_id)
throws HDF5LibraryException,
java.lang.NullPointerException
H5Topen opens a named datatype at the location specified by loc_id and return an identifier for the datatype.
- Parameters:
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.- Returns:
- a named datatype identifier if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.java.lang.NullPointerException - - name is null.
-
H5Tpack
public static int H5Tpack(long type_id)
throws HDF5LibraryException
H5Tpack recursively removes padding from within a compound datatype to make it more efficient (space-wise) to
store that data.
WARNING: This call only affects the C-data, even if it succeeds, there may be no visible effect on Java
objects.
- Parameters:
type_id - IN: Identifier of datatype to modify.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tvlen_create
public static long H5Tvlen_create(long base_id)
throws HDF5LibraryException
H5Tvlen_create creates a new variable-length (VL) dataype.
- Parameters:
base_id - IN: Identifier of parent datatype.- Returns:
- a non-negative value if successful
- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Tflush
public static void H5Tflush(long dtype_id)
throws HDF5LibraryException
H5Tflush causes all buffers associated with a committed datatype to be immediately flushed to disk
without removing the data from the cache.
- Parameters:
dtype_id - IN: Identifier of the committed datatype to be flushed.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Trefresh
public static void H5Trefresh(long dtype_id)
throws HDF5LibraryException
H5Trefresh causes all buffers associated with a committed datatype to be cleared and immediately
re-loaded with updated contents from disk. This function essentially closes the datatype, evicts
all metadata associated with it from the cache, and then re-opens the datatype. The reopened datatype
is automatically re-registered with the same ID.
- Parameters:
dtype_id - IN: Identifier of the committed datatype to be refreshed.- Throws:
HDF5LibraryException - - Error from the HDF-5 Library.
-
H5Zfilter_avail
public static int H5Zfilter_avail(int filter)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException
-
H5Zget_filter_info
public static int H5Zget_filter_info(int filter)
throws HDF5LibraryException
- Throws:
HDF5LibraryException
-
H5Zunregister
public static int H5Zunregister(int filter)
throws HDF5LibraryException,
java.lang.NullPointerException
- Throws:
HDF5LibraryExceptionjava.lang.NullPointerException