|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectncsa.hdf.hdf5lib.H5
public class H5
This code is the called by Java programs to access the entry points of the HDF5 1.2 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://hdf.ncsa.uiuc.edu/HDF5/
Mapping of arguments for Java
In general, arguments to the HDF Java API are straightforward translations from the 'C' API described in the HDF Reference Manual.
HDF-5 | Java |
H5T_NATIVE_INT | int, Integer |
H5T_NATIVE_SHORT | short, Short |
H5T_NATIVE_FLOAT | float, Float |
H5T_NATIVE_DOUBLE | double, Double |
H5T_NATIVE_CHAR | byte, Byte |
H5T_C_S1 | java.lang.String |
void * (i.e., pointer to `Any') | Special -- see HDFArray |
In general, arguments passed IN to Java are the analogous basic types, as above. The exception is for arrays, which are discussed below.
The return value of Java methods is also the analogous type, as above. A major exception to that rule is that all HDF functions that return SUCCEED/FAIL are declared boolean in the Java version, rather than int as in the C. Functions that return a value or else FAIL are declared the equivalent to the C function. However, in most cases the Java method will raise an exception instead of returning an error code. See Errors and Exceptions below.
Java does not support pass by reference of arguments, so arguments that are returned through OUT parameters must be wrapped in an object or array. The Java API for HDF consistently wraps arguments in arrays.
For instance, a function that returns two integers is declared:
h_err_t HDF5dummy( int *a1, int *a2)For the Java interface, this would be declared:
public static native int HDF5dummy( int args[] );where a1 is args[0] and a2 is args[1], and would be invoked:
H5.HDF5dummy( a );
All the routines where this convention is used will have specific documentation of the details, given below.
HDF5 needs to read and write multi-dimensional arrays of any number type (and records). The HDF5 API describes the layout of the source and destination, and the data for the array passed as a block of bytes, for instance,
herr_t H5Dread(int fid, int filetype, int memtype, int memspace, void * data);
where ``void *'' means that the data may be any valid numeric type, and is a contiguous block of bytes that is the data for a multi-dimensional array. The other parameters describe the dimensions, rank, and datatype of the array on disk (source) and in memory (destination).
For Java, this ``ANY'' is a problem, as the type of data must
always be declared. Furthermore, multidimensional arrays
are definitely not layed out contiguously
in memory.
It would be infeasible to declare a separate routine for
every combination of number type and dimensionality.
For that reason, the
HDF-5 Constants
The HDF-5 API defines a set of constants and enumerated values.
Most of these values are available to Java programs via the class
HDF5Constants.
For example, the parameters for the h5open() call include two
numeric values, HDFConstants.H5F_ACC_RDWR and
HDF5Constants.H5P_DEFAULT. As would be expected,
these numbers correspond to the C constants H5F_ACC_RDWR
and H5P_DEFAULT.
The HDF-5 API defines a set of values that describe number types and
sizes, such as "H5T_NATIVE_INT" and "hsize_t". These values are
determined at run time by the HDF-5 C library.
To support these parameters,
the Java class
HDF5CDataTypes looks up the values when
initiated. The values can be accessed as public variables of the
Java class, such as:
Error handling and Exceptions
The HDF5 error API (H5E) manages the behavior of the error stack in
the HDF-5 library. This API is omitted from the JHI5. Errors
are converted into Java exceptions. This is totally different from the
C interface, but is very natural for Java programming.
The exceptions of the JHI5 are organized as sub-classes of the class
HDF5Exception. There are two subclasses of
HDF5Exception,
HDF5LibraryException
and
HDF5JavaException. The sub-classes of the former
represent errors from the HDF-5 C library, while sub-classes of the latter
represent errors in the JHI5 wrapper and support code.
The super-class HDF5LibraryException implements the method
'printStackTrace()', which prints out the HDF-5 error stack,
as described in the HDF-5 C API H5Eprint(). This may
be used by Java exception handlers to print out the HDF-5 error stack.
int data_type = HDF5CDataTypes.JH5T_NATIVE_INT;
The Java application uses both types of constants the same way, the only
difference is that the HDF5CDataTypes may have different
values on different platforms.
Field Summary | |
---|---|
static java.lang.String |
H5PATH_PROPERTY_KEY
|
Constructor Summary | |
---|---|
H5()
|
Method Summary | |
---|---|
static int |
H5Aclose(int attr_id)
H5Aclose terminates access to the attribute specified by its identifier, attr_id. |
static int |
H5Acreate(int loc_id,
java.lang.String name,
int type_id,
int space_id,
int create_plist)
H5Acreate creates an attribute which is attached to the object specified with loc_id. |
static int |
H5Adelete(int loc_id,
java.lang.String name)
H5Adelete removes the attribute specified by its name, name, from a dataset, group, or named datatype. |
static long |
H5Aget_name(int attr_id,
long buf_size,
java.lang.String[] name)
H5Aget_name retrieves the name of an attribute specified by the identifier, attr_id. |
static int |
H5Aget_num_attrs(int loc_id)
H5Aget_num_attrs returns the number of attributes attached to the object specified by its identifier, loc_id. |
static int |
H5Aget_space(int attr_id)
H5Aget_space retrieves a copy of the dataspace for an attribute. |
static int |
H5Aget_type(int attr_id)
H5Aget_type retrieves a copy of the datatype for an attribute. |
static int |
H5Aopen_idx(int loc_id,
int idx)
H5Aopen_idx opens an attribute which is attached to the object specified with loc_id. |
static int |
H5Aopen_name(int loc_id,
java.lang.String name)
H5Aopen_name opens an attribute specified by its name, name, which is attached to the object specified with loc_id. |
static int |
H5Aread(int attr_id,
int mem_type_id,
byte[] buf)
H5Aread reads an attribute, specified with attr_id. |
static int |
H5Aread(int attr_id,
int mem_type_id,
java.lang.Object obj)
H5Aread reads an attribute, specified with attr_id. |
static int |
H5Awrite(int attr_id,
int mem_type_id,
byte[] buf)
H5Awrite writes an attribute, specified with attr_id. |
static int |
H5Awrite(int attr_id,
int mem_type_id,
java.lang.Object obj)
H5Awrite writes an attribute, specified with attr_id. |
static int |
H5check_version(int majnum,
int minnum,
int relnum)
H5check_version verifies that the arguments match the version numbers compiled into the library. |
static int |
H5close()
H5close flushes all data to disk, closes all file identifiers, and cleans up all memory used by the library. |
static int |
H5Dclose(int dataset_id)
H5Dclose ends access to a dataset specified by dataset_id and releases resources used by it. |
static int |
H5Dcreate(int loc_id,
java.lang.String name,
int type_id,
int space_id,
int create_plist_id)
H5Dcreate creates a data set with a name, name, in the file or in the group specified by the identifier loc_id. |
static int |
H5Dextend(int dataset_id,
long[] size)
H5Dextend verifies that the dataset is at least of size size. |
static int |
H5Dget_create_plist(int dataset_id)
H5Dget_create_plist returns an identifier for a copy of the dataset creation property list for a dataset. |
static int |
H5Dget_space(int dataset_id)
H5Dget_space returns an identifier for a copy of the dataspace for a dataset. |
static long |
H5Dget_storage_size(int dataset_id)
H5Dget_storage_size returns the amount of storage that is required for the dataset. |
static int |
H5Dget_type(int dataset_id)
H5Dget_type returns an identifier for a copy of the datatype for a dataset. |
static int |
H5Dopen(int loc_id,
java.lang.String name)
H5Dopen opens an existing dataset for access in the file or group specified in loc_id. |
static int |
H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf)
H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application memory buffer buf. |
static int |
H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj)
H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application data object. |
static int |
H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf)
H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer buf into the file. |
static int |
H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj)
H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory data object into the file. |
static int |
H5Eclear()
H5Eclear clears the error stack for the current thread. |
static int |
H5Fclose(int file_id)
H5Fclose terminates access to an HDF5 file. |
static int |
H5Fcreate(java.lang.String name,
int flags,
int create_id,
int access_id)
H5Fcreate is the primary function for creating HDF5 files. |
static int |
H5Fflush(int object_id,
int scope)
H5Fflush causes all buffers associated with a file or object to be immediately flushed (written) to disk without removing the data from the (memory) cache. |
static int |
H5Fget_access_plist(int file_id)
H5Fget_access_plist returns the file access property list identifier of the specified file. |
static int |
H5Fget_create_plist(int file_id)
H5Fget_create_plist returns a file creation property list identifier identifying the creation properties used to create this file. |
static boolean |
H5Fis_hdf5(java.lang.String name)
H5Fis_hdf5 determines whether a file is in the HDF5 format. |
static int |
H5Fmount(int loc_id,
java.lang.String name,
int child_id,
int plist_id)
H5Fmount mounts the file specified by child_id onto the group specified by loc_id and name using the mount properties plist_id. |
static int |
H5Fopen(java.lang.String name,
int flags,
int access_id)
H5Fopen opens an existing file and is the primary function for accessing existing HDF5 files. |
static int |
H5Freopen(int file_id)
H5Freopen reopens an HDF5 file. |
static int |
H5Funmount(int loc_id,
java.lang.String name)
Given a mount point, H5Funmount dissassociates the mount point's file from the file mounted there. |
static int |
H5Gclose(int group_id)
H5Gclose releases resources used by a group which was opened by a call to H5Gcreate() or H5Gopen(). |
static int |
H5Gcreate(int loc_id,
java.lang.String name,
int size_hint)
H5Gcreate creates a new group with the specified name at the specified location, loc_id. |
static int |
H5get_libversion(int[] libversion)
H5get_libversion retrieves the major, minor, and release numbers of the version of the HDF library which is linked to the application. |
static int |
H5Gget_comment(int loc_id,
java.lang.String name,
int bufsize,
java.lang.String[] comment)
H5Gget_comment retrieves the comment for the the object name. |
static int |
H5Gget_linkval(int loc_id,
java.lang.String name,
int size,
java.lang.String[] value)
H5Gget_linkval returns size characters of the link value through the value argument if loc_id (a file or group identifier) and name specify a symbolic link. |
static int |
H5Gget_obj_info_idx(int loc_id,
java.lang.String name,
int idx,
java.lang.String[] oname,
int[] type)
|
static int |
H5Gget_objinfo(int loc_id,
java.lang.String name,
boolean follow_link,
HDF5GroupInfo info)
H5Gget_objinfo returns information about the specified object in an HDF5GroupInfo object. |
static int |
H5Gget_objinfo(int loc_id,
java.lang.String name,
boolean follow_link,
long[] fileno,
long[] objno,
int[] link_info,
long[] mtime)
H5Gget_objinfo returns information about the specified object. |
static int |
H5Glink(int loc_id,
int link_type,
java.lang.String current_name,
java.lang.String new_name)
H5Glink creates a new name for an already existing object. |
static int |
H5Gmove(int loc_id,
java.lang.String src,
java.lang.String dst)
H5Gmove renames an object within an HDF5 file. |
static int |
H5Gn_members(int loc_id,
java.lang.String name)
|
static int |
H5Gopen(int loc_id,
java.lang.String name)
H5Gopen opens an existing group with the specified name at the specified location, loc_id. |
static int |
H5Gset_comment(int loc_id,
java.lang.String name,
java.lang.String comment)
H5Gset_comment sets the comment for the the object name to comment. |
static int |
H5Gunlink(int loc_id,
java.lang.String name)
H5Gunlink removes an association between a name and an object. |
static int |
H5Iget_type(int obj_id)
H5Iget_type retrieves the type of the object identified by obj_id. |
static int |
H5open()
H5open initialize the library. |
static int |
H5Pclose(int plist)
H5Pclose terminates access to a property list. |
static int |
H5Pcopy(int plist)
H5Pcopy copies an existing property list to create a new property list. |
static int |
H5Pcreate(int type)
H5Pcreate creates a new property as an instance of some property list class. |
static int |
H5Pget_alignment(int plist,
long[] alignment)
H5Pget_alignment retrieves the current settings for alignment properties from a file access property list. |
static int |
H5Pget_btree_ratios(int plist_id,
double[] left,
double[] middle,
double[] right)
H5Pget_btree_ratio Get the B-tree split ratios for a dataset transfer property list. |
static int |
H5Pget_cache(int plist,
int[] mdc_nelmts,
int[] rdcc_nelmts,
int[] rdcc_nbytes,
double[] rdcc_w0)
Retrieves the maximum possible number of elements in the meta data cache and the maximum possible number of bytes and the RDCC_W0 value in the raw data chunk cache. |
static int |
H5Pget_chunk(int plist,
int max_ndims,
long[] dims)
H5Pget_chunk retrieves the size of chunks for the raw data of a chunked layout dataset. |
static int |
H5Pget_class(int plist)
H5Pget_class returns the property list class for the property list identified by the plist parameter. |
static boolean |
H5Pget_core(int plist,
int[] increment)
H5Pget_core checks to determine whether the file access property list is set to the core driver. |
static int |
H5Pget_driver(int plist)
H5Pget_driver returns the identifier of the low-level file driver. |
static int |
H5Pget_external_count(int plist)
H5Pget_external_count returns the number of external files for the specified dataset. |
static int |
H5Pget_external(int plist,
int idx,
int name_size,
java.lang.String[] name,
long[] size)
H5Pget_external returns information about an external file. |
static int |
H5Pget_family(int tid,
long[] memb_size,
int[] memb_plist)
H5Pget_family checks to determine whether the file access property list is set to the family driver. |
static int |
H5Pget_fill_value(int plist_id,
int type_id,
byte[] value)
H5Pget_fill_value queries the fill value property of a dataset creation property list. |
static int |
H5Pget_fill_value(int plist_id,
int type_id,
java.lang.Object obj)
H5Pget_fill_value queries the fill value property of a dataset creation property list. |
static int |
H5Pget_filter(int plist,
int filter_number,
int[] flags,
int[] cd_nelmts,
int[] cd_values,
int namelen,
java.lang.String[] name)
H5Pget_filter returns information about a filter, specified by its filter number, in a filter pipeline, specified by the property list with which it is associated. |
static int |
H5Pget_gc_reference(int fapl_id,
boolean[] gc_ref)
H5Pget_gc_references Returns the current setting for the garbage collection refernces property from a file access property list. |
static int |
H5Pget_hyper_cache(int plist_id,
boolean[] cache,
int[] limit)
H5Pget_hyper_cache Find whether to hyperslab blocks are cached during I/O. |
static int |
H5Pget_istore_k(int plist,
int[] ik)
H5Pget_istore_k queries the 1/2 rank of an indexed storage B-tree. |
static int |
H5Pget_layout(int plist)
H5Pget_layout returns the layout of the raw data for a dataset. |
static int |
H5Pget_nfilters(int plist)
H5Pget_nfilters returns the number of filters defined in the filter pipeline associated with the property list plist. |
static int |
H5Pget_preserve(int plist)
H5Pget_preserve checks the status of the dataset transfer property list. |
static boolean |
H5Pget_sec2(int plist)
H5Pget_sec2 checks to determine whether the file access property list is set to the sec2 driver. |
static int |
H5Pget_sizes(int plist,
int[] size)
H5Pget_sizes retrieves the size of the offsets and lengths used in an HDF5 file. |
static boolean |
H5Pget_split(int plist,
int meta_ext_size,
java.lang.String[] meta_ext,
int[] meta_properties,
int raw_ext_size,
java.lang.String[] raw_ext,
int[] raw_properties)
H5Pget_split checks to determine whether the file access property list is set to the split driver. |
static boolean |
H5Pget_stdio(int plist)
H5Pget_stdio checks to determine whether the file access property list is set to the stdio driver. |
static int |
H5Pget_sym_k(int plist,
int[] size)
H5Pget_sym_k retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size. |
static int |
H5Pget_userblock(int plist,
long[] size)
H5Pget_userblock retrieves the size of a user block in a file creation property list. |
static int |
H5Pget_version(int plist,
int[] version_info)
H5Pget_version retrieves the version information of various objects for a file creation property list. |
static int |
H5Pset_alignment(int plist,
long threshold,
long alignment)
H5Pset_alignment sets the alignment properties of a file access property list so that any file object >= THRESHOLD bytes will be aligned on an address which is a multiple of ALIGNMENT. |
static int |
H5Pset_btree_ratios(int plist_id,
double left,
double middle,
double right)
H5Pset_btree_ratio Sets B-tree split ratios for a dataset transfer property list. |
static int |
H5Pset_cache(int plist,
int mdc_nelmts,
int rdcc_nelmts,
int rdcc_nbytes,
double rdcc_w0)
H5Pset_cache sets the number of elements (objects) in the meta data cache and the total number of bytes in the raw data chunk cache. |
static int |
H5Pset_chunk(int plist,
int ndims,
long[] dim)
H5Pset_chunk sets the size of the chunks used to store a chunked layout dataset. |
static int |
H5Pset_core(int plist,
int increment)
H5Pset_core sets the low-level file driver to use malloc() and free(). |
static boolean |
H5Pset_deflate(int plist,
int level)
H5Pset_deflate sets the compression method for a dataset. |
static int |
H5Pset_external(int plist,
java.lang.String name,
long offset,
long size)
H5Pset_external adds an external file to the list of external files. |
static int |
H5Pset_family(int plist,
long memb_size,
int memb_plist)
H5Pset_family sets the file access properties to use the family driver; any previously defined driver properties are erased from the property list. |
static int |
H5Pset_fill_value(int plist_id,
int type_id,
byte[] value)
H5Pset_fill_value sets the fill value for a dataset creation property list. |
static int |
H5Pset_fill_value(int plist_id,
int type_id,
java.lang.Object obj)
H5Pset_fill_value sets the fill value for a dataset creation property list. |
static int |
H5Pset_filter(int plist,
int filter,
int flags,
int cd_nelmts,
int[] cd_values)
H5Pset_filter adds the specified filter and corresponding properties to the end of an output filter pipeline. |
static int |
H5Pset_gc_references(int fapl_id,
boolean gc_ref)
H5Pset_gc_references Sets the flag for garbage collecting references for the file. |
static int |
H5Pset_hyper_cache(int plist_id,
boolean cache,
int limit)
H5Pset_hyper_cache Indicates whether to cache hyperslab blocks during I/O. |
static int |
H5Pset_istore_k(int plist,
int ik)
H5Pset_istore_k sets the size of the parameter used to control the B-trees for indexing chunked datasets. |
static int |
H5Pset_layout(int plist,
int layout)
H5Pset_layout sets the type of storage used store the raw data for a dataset. |
static int |
H5Pset_preserve(int plist,
boolean status)
H5Pset_preserve sets the dataset transfer property list status to TRUE or FALSE. |
static int |
H5Pset_sec2(int plist)
H5Pset_sec2 sets the low-level file driver to use the functions declared in the unistd.h file: open(), lseek() or lseek64(), read(), write(), and close(). |
static int |
H5Pset_sizes(int plist,
int sizeof_addr,
int sizeof_size)
H5Pset_sizes sets the byte size of the offsets and lengths used to address objects in an HDF5 file. |
static int |
H5Pset_split(int plist,
java.lang.String meta_ext,
int meta_plist,
java.lang.String raw_ext,
int raw_plist)
H5Pset_split sets the low-level driver to split meta data from raw data, storing meta data in one file and raw data in another file. |
static int |
H5Pset_stdio(int plist)
H5Pset_stdio sets the low level file driver to use the functions declared in the stdio.h file: fopen(), fseek() or fseek64(), fread(), fwrite(), and fclose(). |
static int |
H5Pset_sym_k(int plist,
int ik,
int lk)
H5Pset_sym_k sets the size of parameters used to control the symbol table nodes. |
static int |
H5Pset_userblock(int plist,
long size)
H5Pset_userblock sets the user block size of a file creation property list. |
static byte[] |
H5Rcreate(int loc_id,
java.lang.String name,
int ref_type,
int space_id)
H5Rcreate creates the reference, ref, of the type specified in ref_type, pointing to the object name located at loc_id. |
static int |
H5Rdereference(int dataset,
int ref_type,
byte[] ref)
Given a reference to some object, H5Rdereference opens that object and return an identifier. |
static int |
H5Rget_object_type(int loc_id,
byte[] ref)
Given a reference to an object ref, H5Rget_object_type returns the type of the object pointed to. |
static int |
H5Rget_region(int loc_id,
int ref_type,
byte[] ref)
Given a reference to an object ref, H5Rget_region creates a copy of the dataspace of the dataset pointed to and defines a selection in the copy which is the region pointed to. |
static int |
H5Sclose(int space_id)
H5Sclose releases a dataspace. |
static int |
H5Scopy(int space_id)
H5Scopy creates a new dataspace which is an exact copy of the dataspace identified by space_id. |
static int |
H5Screate_simple(int rank,
long[] dims,
long[] maxdims)
H5Screate_simple creates a new simple data space and opens it for access. |
static int |
H5Screate(int type)
H5Screate creates a new dataspace of a particular type. |
static int |
H5Sextent_copy(int dest_space_id,
int source_space_id)
H5Sextent_copy copies the extent from source_space_id to dest_space_id. |
static int |
H5Sget_select_bounds(int spaceid,
long[] start,
long[] end)
H5Sget_select_bounds retrieves the coordinates of the bounding box containing the current selection and places them into user-supplied buffers. |
static long |
H5Sget_select_elem_npoints(int spaceid)
H5Sget_select_elem_npoints returns the number of element points in the current dataspace selection. |
static int |
H5Sget_select_elem_pointlist(int spaceid,
long startpoint,
long numpoints,
long[] buf)
H5Sget_select_elem_pointlist returns an array of of element points in the current dataspace selection. |
static int |
H5Sget_select_hyper_blocklist(int spaceid,
long startblock,
long numblocks,
long[] buf)
H5Sget_select_hyper_blocklist returns an array of hyperslab blocks. |
static long |
H5Sget_select_hyper_nblocks(int spaceid)
H5Sget_select_hyper_nblocks returns the number of hyperslab blocks in the current dataspace selection. |
static long |
H5Sget_select_npoints(int space_id)
H5Sget_select_npoints determines the number of elements in the current selection of a dataspace. |
static int |
H5Sget_simple_extent_dims(int space_id,
long[] dims,
long[] maxdims)
H5Sget_simple_extent_dims returns the size and maximum sizes of each dimension of a dataspace through the dims and maxdims parameters. |
static int |
H5Sget_simple_extent_ndims(int space_id)
H5Sget_simple_extent_ndims determines the dimensionality (or rank) of a dataspace. |
static long |
H5Sget_simple_extent_npoints(int space_id)
H5Sget_simple_extent_npoints determines the number of elements in a dataspace. |
static int |
H5Sget_simple_extent_type(int space_id)
H5Sget_simple_extent_type queries a dataspace to determine the current class of a dataspace. |
static boolean |
H5Sis_simple(int space_id)
H5Sis_simple determines whether a dataspace is a simple dataspace. |
static int |
H5Soffset_simple(int space_id,
long[] offset)
H5Soffset_simple sets the offset of a simple dataspace space_id. |
static int |
H5Sselect_all(int space_id)
H5Sselect_all selects the entire extent of the dataspace space_id. |
static int |
H5Sselect_elements(int space_id,
int op,
int num_elements,
long[][] coord2D)
H5Sselect_elements selects array elements to be included in the selection for the space_id dataspace. |
static int |
H5Sselect_hyperslab(int space_id,
int op,
long[] start,
long[] stride,
long[] count,
long[] block)
H5Sselect_hyperslab selects a hyperslab region to add to the current selected region for the dataspace specified by space_id. |
static int |
H5Sselect_none(int space_id)
H5Sselect_none resets the selection region for the dataspace space_id to include no elements. |
static boolean |
H5Sselect_valid(int space_id)
H5Sselect_valid verifies that the selection for the dataspace. |
static int |
H5Sset_extent_none(int space_id)
H5Sset_extent_none removes the extent from a dataspace and sets the type to H5S_NONE. |
static int |
H5Sset_extent_simple(int space_id,
int rank,
long[] current_size,
long[] maximum_size)
H5Sset_extent_simple sets or resets the size of an existing dataspace. |
static int |
H5Tclose(int type_id)
H5Tclose releases a datatype. |
static int |
H5Tcommit(int loc_id,
java.lang.String name,
int type)
H5Tcommit commits a transient datatype (not immutable) to a file, turned it into a named datatype. |
static boolean |
H5Tcommitted(int type)
H5Tcommitted queries a type to determine whether the type specified by the type identifier is a named type or a transient type. |
static int |
H5Tcopy(int type_id)
H5Tcopy copies an existing datatype. |
static int |
H5Tcreate(int dclass,
int size)
H5Tcreate creates a new dataype of the specified class with the specified number of bytes. |
static int |
H5Tenum_create(int base_id)
H5Tenum_create creates a new enumeration datatype based on the specified base datatype, parent_id, which must be an integer type. |
static int |
H5Tenum_insert(int type,
java.lang.String name,
int[] value)
H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype. |
static int |
H5Tenum_nameof(int type,
int[] value,
java.lang.String[] name,
int size)
H5Tenum_nameof finds the symbol name that corresponds to the specified value of the enumeration datatype type. |
static int |
H5Tenum_valueof(int type,
java.lang.String name,
int[] value)
H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype type. |
static boolean |
H5Tequal(int type_id1,
int type_id2)
H5Tequal determines whether two datatype identifiers refer to the same datatype. |
static int |
H5Tget_class(int type_id)
H5Tget_class returns the datatype class identifier. |
static int |
H5Tget_cset(int type_id)
H5Tget_cset retrieves the character set type of a string datatype. |
static int |
H5Tget_ebias(int type_id)
H5Tget_ebias retrieves the exponent bias of a floating-point type. |
static int |
H5Tget_fields(int type_id,
int[] fields)
H5Tget_fields retrieves information about the locations of the various bit fields of a floating point datatype. |
static int |
H5Tget_inpad(int type_id)
H5Tget_inpad retrieves the internal padding type for unused bits in floating-point datatypes. |
static int |
H5Tget_member_dims(int type_id,
int field_idx,
int[] dims,
int[] perm)
H5Tget_member_dims returns the dimensionality of the field. |
static java.lang.String |
H5Tget_member_name(int type_id,
int field_idx)
H5Tget_member_name retrieves the name of a field of a compound datatype. |
static long |
H5Tget_member_offset(int type_id,
int membno)
H5Tget_member_offset returns the byte offset of the specified member of the compound datatype. |
static int |
H5Tget_member_type(int type_id,
int field_idx)
H5Tget_member_type returns the datatype of the specified member. |
static int |
H5Tget_member_value(int type_id,
int membno,
int[] value)
H5Tget_member_value returns the value of the enumeration datatype member memb_no. |
static int |
H5Tget_nmembers(int type_id)
H5Tget_nmembers retrieves the number of fields a compound datatype has. |
static int |
H5Tget_norm(int type_id)
H5Tget_norm retrieves the mantissa normalization of a floating-point datatype. |
static int |
H5Tget_offset(int type_id)
H5Tget_offset retrieves the bit offset of the first significant bit. |
static int |
H5Tget_order(int type_id)
H5Tget_order returns the byte order of an atomic datatype. |
static int |
H5Tget_pad(int type_id,
int[] pad)
H5Tget_pad retrieves the padding type of the least and most-significant bit padding. |
static int |
H5Tget_precision(int type_id)
H5Tget_precision returns the precision of an atomic datatype. |
static int |
H5Tget_sign(int type_id)
H5Tget_sign retrieves the sign type for an integer type. |
static int |
H5Tget_size(int type_id)
H5Tget_size returns the size of a datatype in bytes. |
static int |
H5Tget_strpad(int type_id)
H5Tget_strpad retrieves the string padding method for a string datatype. |
static int |
H5Tget_super(int type)
H5Tget_super returns the type from which TYPE is derived. |
static java.lang.String |
H5Tget_tag(int type)
H5Tget_tag returns the tag associated with datatype type_id. |
static int |
H5Tinsert_array(int parent_id,
java.lang.String name,
int offset,
int ndims,
int[] dim,
int[] perm,
int member_id)
H5Tinsert_array adds a new member to the compound datatype parent_id. |
static int |
H5Tinsert(int type_id,
java.lang.String name,
long offset,
int field_id)
H5Tinsert adds another member to the compound datatype type_id. |
static int |
H5Tlock(int type_id)
H5Tlock locks the datatype specified by the type_id identifier, making it read-only and non-destrucible. |
static int |
H5Topen(int loc_id,
java.lang.String name)
H5Topen opens a named datatype at the location specified by loc_id and return an identifier for the datatype. |
static int |
H5Tpack(int type_id)
H5Tpack recursively removes padding from within a compound datatype to make it more efficient (space-wise) to store that data. |
static int |
H5Tset_cset(int type_id,
int cset)
H5Tset_cset the character set to be used. |
static int |
H5Tset_ebias(int type_id,
int ebias)
H5Tset_ebias sets the exponent bias of a floating-point type. |
static int |
H5Tset_fields(int type_id,
int spos,
int epos,
int esize,
int mpos,
int msize)
H5Tset_fields sets the locations and sizes of the various floating point bit fields. |
static int |
H5Tset_inpad(int type_id,
int inpad)
If any internal bits of a floating point type are unused (that is, those significant bits which are not part of the sign, exponent, or mantissa), then H5Tset_inpad will be filled according to the value of the padding value property inpad. |
static int |
H5Tset_norm(int type_id,
int norm)
H5Tset_norm sets the mantissa normalization of a floating-point datatype. |
static int |
H5Tset_offset(int type_id,
int offset)
H5Tset_offset sets the bit offset of the first significant bit. |
static int |
H5Tset_order(int type_id,
int order)
H5Tset_order sets the byte ordering of an atomic datatype. |
static int |
H5Tset_pad(int type_id,
int lsb,
int msb)
H5Tset_pad sets the least and most-significant bits padding types. |
static int |
H5Tset_precision(int type_id,
int precision)
H5Tset_precision sets the precision of an atomic datatype. |
static int |
H5Tset_sign(int type_id,
int sign)
H5Tset_sign sets the sign proprety for an integer type. |
static int |
H5Tset_size(int type_id,
int size)
H5Tset_size sets the total size in bytes, size, for an atomic datatype (this operation is not permitted on compound datatypes). |
static int |
H5Tset_strpad(int type_id,
int strpad)
H5Tset_strpad defines the storage mechanism for the string. |
static int |
H5Tset_tag(int type,
java.lang.String tag)
H5Tset_tag tags an opaque datatype type_id with a unique ASCII identifier tag. |
static int |
H5Tvlen_create(int base_id)
H5Tvlen_create creates a new variable-length (VL) dataype. |
static int |
J2C(int java_constant)
J2C converts a Java constant to an HDF5 constant determined at runtime |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String H5PATH_PROPERTY_KEY
Constructor Detail |
---|
public H5()
Method Detail |
---|
public static int J2C(int java_constant)
java_constant
- The value of Java constant
public static int H5open() throws HDF5LibraryException
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5close() throws HDF5LibraryException
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5get_libversion(int[] libversion) throws HDF5LibraryException
libversion
- The version information of the HDF library.
libversion[0] = The major version of the library. libversion[1] = The minor version of the library. libversion[2] = The release number of the library.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5check_version(int majnum, int minnum, int relnum)
majnum
- The major version of the library.minnum
- The minor version of the library.relnum
- The release number of the library.patnum
- The patch number of the library.
API function: herr_t H5check_version()
public static int H5Eclear() throws HDF5LibraryException
This may be used by exception handlers to assure that the error condition in the HDF-5 library has been reset.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Acreate(int loc_id, java.lang.String name, int type_id, int space_id, int create_plist) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- IN: Object (dataset, group, or named datatype) to be attached to.name
- IN: Name of attribute to create.type_id
- IN: Identifier of datatype for attribute.space_id
- IN: Identifier of dataspace for attribute.create_plist
- IN: Identifier of creation property
list (currently not used).
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Aopen_name(int loc_id, java.lang.String name) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- IN: Identifier of a group, dataset, or named datatype atttributename
- IN: Attribute name.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Aopen_idx(int loc_id, int idx) throws HDF5LibraryException
loc_id
- IN: Identifier of the group, dataset, or
named datatype attributeidx
- IN: Index of the attribute to open.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Awrite(int attr_id, int mem_type_id, byte[] buf) throws HDF5LibraryException, java.lang.NullPointerException
attr_id
- IN: Identifier of an attribute to write.mem_type_id
- IN: Identifier of the attribute datatype
(in memory).buf
- IN: Data to be written.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - data is null.public static int H5Awrite(int attr_id, int mem_type_id, java.lang.Object obj) throws HDF5Exception, java.lang.NullPointerException
attr_id
- IN: Identifier of an attribute to write.mem_type_id
- IN: Identifier of the attribute datatype
(in memory).obj
- IN: Data object to be written.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - data object is null.
HDF5Exception
static native int H5Awrite(int attr_id, int mem_type_id, byte[] buf);
public static int H5Aread(int attr_id, int mem_type_id, byte[] buf) throws HDF5LibraryException, java.lang.NullPointerException
attr_id
- IN: Identifier of an attribute to read.mem_type_id
- IN: Identifier of the attribute datatype
(in memory).buf
- IN: Buffer for data to be read.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - data buffer is null.public static int H5Aread(int attr_id, int mem_type_id, java.lang.Object obj) throws HDF5Exception, java.lang.NullPointerException
attr_id
- IN: Identifier of an attribute to read.mem_type_id
- IN: Identifier of the attribute datatype
(in memory).obj
- IN: Object for data to be read.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - data buffer is null.
HDF5Exception
static native int H5Aread( )
public static int H5Aget_space(int attr_id) throws HDF5LibraryException
attr_id
- IN: Identifier of an attribute.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Aget_type(int attr_id) throws HDF5LibraryException
attr_id
- IN: Identifier of an attribute.
HDF5LibraryException
- - Error from the HDF-5 Library.public static long H5Aget_name(int attr_id, long buf_size, java.lang.String[] name) throws java.lang.ArrayIndexOutOfBoundsException, java.lang.ArrayStoreException, HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
attr_id
- IN: Identifier of the attribute.buf_size
- IN: The size of the buffer to store the
name in.name
- OUT: Buffer to store name in.
java.lang.ArrayIndexOutOfBoundsException
- JNI error writing
back array
java.lang.ArrayStoreException
- JNI error writing back array
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.
java.lang.IllegalArgumentException
- - bub_size <= 0.public static int H5Aget_num_attrs(int loc_id) throws HDF5LibraryException
loc_id
- IN: Identifier of a group, dataset, or named
datatype.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Adelete(int loc_id, java.lang.String name) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- IN: Identifier of the dataset, group, or
named datatype.name
- IN: Name of the attribute to delete.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Aclose(int attr_id) throws HDF5LibraryException
attr_id
- IN: Attribute to release access to.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Dcreate(int loc_id, java.lang.String name, int type_id, int space_id, int create_plist_id) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- Identifier of the file or group to create the
dataset within.name
- The name of the dataset to create.type_id
- Identifier of the datatype to use when
creating the dataset.space_id
- Identifier of the dataspace to use when
creating the dataset.create_plist_id
- Identifier of the set creation
property list.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Dopen(int loc_id, java.lang.String name) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- Identifier of the dataset to open or the file
or groupname
- The name of the dataset to access.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Dget_space(int dataset_id) throws HDF5LibraryException
dataset_id
- Identifier of the dataset to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Dget_type(int dataset_id) throws HDF5LibraryException
dataset_id
- Identifier of the dataset to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Dget_create_plist(int dataset_id) throws HDF5LibraryException
dataset_id
- Identifier of the dataset to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Dread(int dataset_id, int mem_type_id, int mem_space_id, int file_space_id, int xfer_plist_id, byte[] buf) throws HDF5LibraryException, java.lang.NullPointerException
dataset_id
- Identifier of the dataset read from.mem_type_id
- Identifier of the memory datatype.mem_space_id
- Identifier of the memory dataspace.file_space_id
- Identifier of the dataset's dataspace
in the file.xfer_plist_id
- Identifier of a transfer property
list for this I/O operation.buf
- Buffer to store data read from the file.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - data buffer is null.public static int H5Dread(int dataset_id, int mem_type_id, int mem_space_id, int file_space_id, int xfer_plist_id, java.lang.Object obj) throws HDF5Exception, HDF5LibraryException, java.lang.NullPointerException
dataset_id
- Identifier of the dataset read from.mem_type_id
- Identifier of the memory datatype.mem_space_id
- Identifier of the memory dataspace.file_space_id
- Identifier of the dataset's dataspace
in the file.xfer_plist_id
- Identifier of a transfer property
list for this I/O operation.obj
- Object to store data read from the file.
HDF5Exception
- - Failure in the data conversion.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - data object is null.public static int H5Dwrite(int dataset_id, int mem_type_id, int mem_space_id, int file_space_id, int xfer_plist_id, byte[] buf) throws HDF5LibraryException, java.lang.NullPointerException
dataset_id
- Identifier of the dataset read from.mem_type_id
- Identifier of the memory datatype.mem_space_id
- Identifier of the memory dataspace.file_space_id
- Identifier of the dataset's dataspace
in the file.xfer_plist_id
- Identifier of a transfer property
list for this I/O operation.buf
- Buffer with data to be written to the file.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Dwrite(int dataset_id, int mem_type_id, int mem_space_id, int file_space_id, int xfer_plist_id, java.lang.Object obj) throws HDF5Exception, HDF5LibraryException, java.lang.NullPointerException
dataset_id
- Identifier of the dataset read from.mem_type_id
- Identifier of the memory datatype.mem_space_id
- Identifier of the memory dataspace.file_space_id
- Identifier of the dataset's dataspace
in the file.xfer_plist_id
- Identifier of a transfer property
list for this I/O operation.obj
- Object with data to be written to the file.
HDF5Exception
- - Failure in the data conversion.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - data object is null.public static int H5Dextend(int dataset_id, long[] size) throws HDF5LibraryException, java.lang.NullPointerException
dataset_id
- Identifier of the dataset.size
- Array containing the new magnitude of each
dimension.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - size array is null.public static int H5Dclose(int dataset_id) throws HDF5LibraryException
dataset_id
- Identifier of the dataset to finish
access to.
HDF5LibraryException
- - Error from the HDF-5 Library.public static long H5Dget_storage_size(int dataset_id) throws HDF5LibraryException
dataset_id
- Identifier of the dataset in question
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Fopen(java.lang.String name, int flags, int access_id) throws HDF5LibraryException, java.lang.NullPointerException
name
- Name of the file to access.flags
- File access flags.access_id
- Identifier for the file access properties
list.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Fcreate(java.lang.String name, int flags, int create_id, int access_id) throws HDF5LibraryException, java.lang.NullPointerException
name
- Name of the file to access.flags
- File access flags. Possible values include:
create_id
- File creation property list identifier,
used when modifying default file meta-data.
Use H5P_DEFAULT for default access properties.access_id
- File access property list identifier.
If parallel file access is desired,
this is a collective call according to the communicator
stored in the access_id (not supported in Java).
Use H5P_DEFAULT for default access properties.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Fflush(int object_id, int scope) throws HDF5LibraryException
After this call completes, the file (or object) is in a consistent state and all data written to date is assured to be permanent.
object_id
- Identifier of object used to identify
the file. object_id can be any object associated
with the file, including the file itself, a dataset,
a group, an attribute, or a named data type.
scope specifies whether the scope of the flushing action is global or local. Valid values are
H5F_SCOPE_GLOBAL
Flushes the entire virtual file.
H5F_SCOPE_LOCAL
Flushes only the specified file.H5F_scope_t
- scope Specifies the scope of the
flushing action, in the case that the HDF-5 file is not
a single physical file.
Valid values are:
HDF5LibraryException
- - Error from the HDF-5 Library.public static boolean H5Fis_hdf5(java.lang.String name) throws HDF5LibraryException, java.lang.NullPointerException
name
- File name to check format.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Fget_create_plist(int file_id) throws HDF5LibraryException
file_id
- Identifier of the file to get creation
property list
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Fget_access_plist(int file_id) throws HDF5LibraryException
file_id
- Identifier of file to get access property
list of
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Fclose(int file_id) throws HDF5LibraryException
file_id
- Identifier of a file to terminate access to.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Fmount(int loc_id, java.lang.String name, int child_id, int plist_id) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- The identifier for the group onto which
the file specified by child_id is to be mounted.name
- The name of the group onto which the file
specified by child_id is to be mounted.child_id
- The identifier of the file to be mounted.plist_id
- The identifier of the property list to be used.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Funmount(int loc_id, java.lang.String name) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- The identifier for the location at which
the specified file is to be unmounted.name
- The name of the file to be unmounted.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Freopen(int file_id) throws HDF5LibraryException
file_id
- Identifier of a file to terminate and
reopen access to.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Gcreate(int loc_id, java.lang.String name, int size_hint) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- The file or group identifier.name
- The absolute or relative name of the new group.size_hint
- An optional parameter indicating the
number of bytes to reserve for the names that will appear
in the group.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Gopen(int loc_id, java.lang.String name) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- File or group identifier within which group
is to be open.name
- Name of group to open.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Gclose(int group_id) throws HDF5LibraryException
group_id
- Group identifier to release.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Glink(int loc_id, int link_type, java.lang.String current_name, java.lang.String new_name) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- File, group, dataset, or datatype identifier.H5G_link_t
- link_type Link type. Possible values are:
current_name
- A name of the existing object if link is
a hard link. Can be anything for the soft link.new_name
- New name for the object.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - current_name or name is null.public static int H5Gunlink(int loc_id, java.lang.String name) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- Identifier of the file containing the object.name
- Name of the object to unlink.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Gn_members(int loc_id, java.lang.String name) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- file or group ID.name
- name of the group to iterate, relative to
the loc_id
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Gget_obj_info_idx(int loc_id, java.lang.String name, int idx, java.lang.String[] oname, int[] type) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- IN: file or group ID.name
- IN: name of the group to iterate,
relative to the loc_ididx
- IN: the index of the object to iterate.oname
- the name of the object [OUT]type
- the type of the object [OUT]
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Gmove(int loc_id, java.lang.String src, java.lang.String dst) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- File or group identifier.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - src or dst is null.public static int H5Gget_objinfo(int loc_id, java.lang.String name, boolean follow_link, long[] fileno, long[] objno, int[] link_info, long[] mtime) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
loc_id
- IN: File, group, dataset, or datatype
identifier.name
- IN: Name of the object for which status is
being sought.follow_link
- IN: Link flag.fileno
- OUT: file id numbers.objno
- OUT: object id numbers.link_info
- OUT: link information.
link_info[0] = nlink link_info[1] = type link_info[2] = linklen
mtime
- OUT: modification time
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name or array is null.
java.lang.IllegalArgumentException
- - bad argument.public static int H5Gget_objinfo(int loc_id, java.lang.String name, boolean follow_link, HDF5GroupInfo info) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- IN: File, group, dataset, or datatype
identifier.name
- IN: Name of the object for which status
is being sought.follow_link
- IN: Link flag.info
- OUT: the HDF5GroupInfo object to store the
object infomation
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.HDF5GroupInfo
,
static native int H5Gget_objinfo();
public static int H5Gget_linkval(int loc_id, java.lang.String name, int size, java.lang.String[] value) throws java.lang.ArrayIndexOutOfBoundsException, java.lang.ArrayStoreException, HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
loc_id
- IN: Identifier of the file, group, dataset,
or datatype.name
- IN: Name of the object whose link value is to
be checked.size
- IN: Maximum number of characters of value to
be returned.char
- *value OUT: Link value.
java.lang.ArrayIndexOutOfBoundsException
- Copy back failed
java.lang.ArrayStoreException
- Copy back failed
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.
java.lang.IllegalArgumentException
- - size is invalidpublic static int H5Gset_comment(int loc_id, java.lang.String name, java.lang.String comment) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- IN: Identifier of the file, group, dataset,
or datatype.name
- IN: Name of the object whose comment is to
be set or reset.comment
- IN: The new comment.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name or comment is null.public static int H5Gget_comment(int loc_id, java.lang.String name, int bufsize, java.lang.String[] comment) throws java.lang.ArrayIndexOutOfBoundsException, java.lang.ArrayStoreException, HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
loc_id
- IN: Identifier of the file, group, dataset,
or datatype.name
- IN: Name of the object whose comment is to be
set or reset.bufsize
- IN: Anticipated size of the buffer required
to hold comment.comment
- OUT: The comment.
java.lang.ArrayIndexOutOfBoundsException
- - JNI error writing
back data
java.lang.ArrayStoreException
- - JNI error writing
back data
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.
java.lang.IllegalArgumentException
- - size < 1,
comment is invalid.public static int H5Iget_type(int obj_id) throws HDF5LibraryException
obj_id
- IN: Object identifier whose type is to be
determined.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pcreate(int type) throws HDF5LibraryException
H5P_class_t
- type IN: The type of property list
to create.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pclose(int plist) throws HDF5LibraryException
plist
- IN: Identifier of the property list to
terminate access to.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_class(int plist) throws HDF5LibraryException
plist
- IN: Identifier of property list to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pcopy(int plist) throws HDF5LibraryException
plist
- IN: Identifier of property list to duplicate.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_version(int plist, int[] version_info) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
plist
- IN: Identifier of the file creation property
list.version_info
- OUT: version information.
version_info[0] = boot // boot block version number version_info[1] = freelist // global freelist version version_info[2] = stab // symbol tabl version number version_info[3] = shhdr // hared object header version
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - version_info is null.
java.lang.IllegalArgumentException
- - version_info is illegal.public static int H5Pset_userblock(int plist, long size) throws HDF5LibraryException
plist
- IN: Identifier of property list to modify.size
- IN: Size of the user-block in bytes.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_userblock(int plist, long[] size) throws HDF5LibraryException, java.lang.NullPointerException
plist
- IN: Identifier for property list to query.size
- OUT: Pointer to location to return user-block
size.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - size is null.public static int H5Pset_sizes(int plist, int sizeof_addr, int sizeof_size) throws HDF5LibraryException
plist
- IN: Identifier of property list to modify.sizeof_addr
- IN: Size of an object offset in bytes.sizeof_size
- IN: Size of an object length in bytes.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_sizes(int plist, int[] size) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
plist
- IN: Identifier of property list to query.size
- OUT: the size of the offsets and length.
size[0] = sizeof_addr // offset size in bytes size[1] = sizeof_size // length size in bytes
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - size is null.
java.lang.IllegalArgumentException
- - size is invalid.public static int H5Pset_sym_k(int plist, int ik, int lk) throws HDF5LibraryException
plist
- IN: Identifier for property list to query.ik
- IN: Symbol table tree rank.lk
- IN: Symbol table node size.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_sym_k(int plist, int[] size) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
plist
- IN: Property list to query.size
- OUT: the symbol table's B-tree 1/2 rank
and leaf node 1/2 size.
size[0] = ik // the symbol table's B-tree 1/2 rank size[1] = lk // leaf node 1/2 size
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - size is null.
java.lang.IllegalArgumentException
- - size is invalid.public static int H5Pset_istore_k(int plist, int ik) throws HDF5LibraryException
plist
- IN: Identifier of property list to query.ik
- IN: 1/2 rank of chunked storage B-tree.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_istore_k(int plist, int[] ik) throws HDF5LibraryException, java.lang.NullPointerException
plist
- IN: Identifier of property list to query.ik
- OUT: Pointer to location to return the chunked
storage B-tree 1/2 rank.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - ik array is null.public static int H5Pset_layout(int plist, int layout) throws HDF5LibraryException
plist
- IN: Identifier of property list to query.layout
- IN: Type of storage layout for raw data.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_layout(int plist) throws HDF5LibraryException
plist
- IN: Identifier for property list to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pset_chunk(int plist, int ndims, long[] dim) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
plist
- IN: Identifier for property list to query.ndims
- IN: The number of dimensions of each chunk.dim
- IN: An array containing the size of each chunk.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - dims array is null.
java.lang.IllegalArgumentException
- - dims <=0public static int H5Pget_chunk(int plist, int max_ndims, long[] dims) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
plist
- IN: Identifier of property list to query.max_ndims
- OUT: Size of the dims array.dims
- OUT: Array to store the chunk dimensions.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - dims array is null.
java.lang.IllegalArgumentException
- - max_ndims <=0public static int H5Pset_alignment(int plist, long threshold, long alignment) throws HDF5LibraryException
plist
- IN: Identifier for a file access property list.threshold
- IN: Threshold value.alignment
- IN: Alignment value.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_alignment(int plist, long[] alignment) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
plist
- IN: Identifier of a file access property list.alignment
- OUT: threshold value and alignment value.
alignment[0] = threshold // threshold value alignment[1] = alignment // alignment value
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - aligment array is null.
java.lang.IllegalArgumentException
- - aligment array is
invalid.public static int H5Pset_external(int plist, java.lang.String name, long offset, long size) throws HDF5LibraryException, java.lang.NullPointerException
plist
- IN: Identifier of a dataset creation property
list.name
- IN: Name of an external file.offset
- IN: Offset, in bytes, from the beginning
of the file to the location in the file where the
data starts.size
- IN: Number of bytes reserved in the file for
the data.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Pget_external_count(int plist) throws HDF5LibraryException
plist
- IN: Identifier of a dataset creation property
list.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_external(int plist, int idx, int name_size, java.lang.String[] name, long[] size) throws java.lang.ArrayIndexOutOfBoundsException, java.lang.ArrayStoreException, HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
plist
- IN: Identifier of a dataset creation property
list.idx
- IN: External file index.name_size
- IN: Maximum length of name array.name
- OUT: Name of the external file.size
- OUT: the offset value and the size of
the external file data.
size[0] = offset // a location to return an offset value size[1] = size // a location to return the size of // the external file data.
java.lang.ArrayIndexOutOfBoundsException
- Fatal
error on Copyback
java.lang.ArrayStoreException
- Fatal error on Copyback
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name or size is null.
java.lang.IllegalArgumentException
- - name_size <= 0 .public static int H5Pset_fill_value(int plist_id, int type_id, byte[] value) throws HDF5Exception
plist_id
- IN: Property list identifier.type_id,
- IN: The datatype identifier of value.value
- IN: The fill value.
HDF5Exception
- - Error converting data arraypublic static int H5Pset_fill_value(int plist_id, int type_id, java.lang.Object obj) throws HDF5Exception
plist_id
- IN: Property list identifier.type_id,
- IN: The datatype identifier of value.obj
- IN: The fill value.
HDF5Exception
- - Error converting data arraypublic static int H5Pget_fill_value(int plist_id, int type_id, byte[] value) throws HDF5Exception
plist_id
- IN: Property list identifier.type_id
- IN: The datatype identifier of value.value
- IN: The fill value.
HDF5Exception
public static int H5Pget_fill_value(int plist_id, int type_id, java.lang.Object obj) throws HDF5Exception
plist_id
- IN: Property list identifier.type_id
- IN: The datatype identifier of value.obj
- IN: The fill value.
HDF5Exception
public static int H5Pset_filter(int plist, int filter, int flags, int cd_nelmts, int[] cd_values) throws HDF5LibraryException
plist
- IN: Property list identifier.flags
- IN: Bit vector specifying certain general
properties of the filter.cd_nelmts
- IN: Number of elements in cd_valuescd_values[]
- IN: Auxiliary data for the filter.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_nfilters(int plist) throws HDF5LibraryException
plist
- IN: Property list identifier.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_filter(int plist, int filter_number, int[] flags, int[] cd_nelmts, int[] cd_values, int namelen, java.lang.String[] name) throws java.lang.ArrayIndexOutOfBoundsException, java.lang.ArrayStoreException, HDF5LibraryException, java.lang.NullPointerException
plist
- IN: Property list identifier.filter_number
- IN: Sequence number within the
filter pipeline of the filter for which information is sought.flags
- OUT: Bit vector specifying certain general
properties of the filter.cd_nelmts
- IN/OUT: Number of elements in cd_valuescd_values
- OUT: Auxiliary data for the filter.namelen
- IN: Anticipated number of characters in name.name[]
- OUT: Name of the filter.
java.lang.ArrayIndexOutOfBoundsException
- Fatal error on Copyback
java.lang.ArrayStoreException
- Fatal error on Copyback
java.lang.NullPointerException
- - name or an array is null.
HDF5LibraryException
public static int H5Pget_driver(int plist) throws HDF5LibraryException
Valid identifiers are:
plist
- IN: Identifier of a file access property list.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pset_stdio(int plist) throws HDF5LibraryException
plist
- IN: Identifier of a file access property list.
HDF5LibraryException
public static boolean H5Pget_stdio(int plist)
plist
- IN: Identifier of a file access property list.
public static int H5Pset_sec2(int plist) throws HDF5LibraryException
plist
- IN: Identifier of a file access property list.
HDF5LibraryException
- - Error from the HDF-5 Library.public static boolean H5Pget_sec2(int plist) throws HDF5LibraryException
plist
- IN: Identifier of a file access property list.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pset_core(int plist, int increment) throws HDF5LibraryException
plist
- IN: Identifier of a file access property list.increment
- IN: File block size in bytes.
HDF5LibraryException
- - Error from the HDF-5 Library.public static boolean H5Pget_core(int plist, int[] increment) throws HDF5LibraryException
plist
- IN: Identifier of the file access property list.increment
- OUT: A location to return the file block size
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pset_split(int plist, java.lang.String meta_ext, int meta_plist, java.lang.String raw_ext, int raw_plist) throws HDF5LibraryException, java.lang.NullPointerException
plist
- IN: Identifier of the file access property list.meta_ext
- IN: Name of the extension for the metafile
filename. Recommended default value: .meta.meta_plist
- IN: Identifier of the meta file access
property list.raw_ext
- IN: Name extension for the raw file filename.
Recommended default value: .raw.raw_plist
- IN: Identifier of the raw file access
property list.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - a string is null.public static boolean H5Pget_split(int plist, int meta_ext_size, java.lang.String[] meta_ext, int[] meta_properties, int raw_ext_size, java.lang.String[] raw_ext, int[] raw_properties) throws java.lang.ArrayIndexOutOfBoundsException, java.lang.ArrayStoreException, HDF5LibraryException, java.lang.NullPointerException
plist
- IN: Identifier of the file access property list.meta_ext_size
- IN: Number of characters of the
meta file extension to be copied to the meta_ext buffer.meta_ext
- IN: Meta file extension.*meta_properties
- OUT: A copy of the meta file
access property list.raw_ext_size
- IN: Number of characters of the
raw file extension to be copied to the raw_ext buffer.raw_ext
- OUT: Raw file extension.*raw_properties
- OUT: A copy of the raw file
access property list.
java.lang.ArrayIndexOutOfBoundsException
- JNI error
writing back array
java.lang.ArrayStoreException
- JNI error writing back array
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - a string or array is null.public static int H5Pset_family(int plist, long memb_size, int memb_plist) throws HDF5LibraryException
plist
- IN: Identifier of the file access property list.memb_size
- IN: Logical size, in bytes, of each
family member.memb_plist
- IN: Identifier of the file access
property list for each member of the family.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_family(int tid, long[] memb_size, int[] memb_plist) throws HDF5LibraryException, java.lang.NullPointerException
plist
- IN: Identifier of the file access property list.memb_size
- OUT: Logical size, in bytes, of each
family member.*memb_plist
- OUT: Identifier of the file access
property list for each member of the family.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - an array is null.public static int H5Pset_cache(int plist, int mdc_nelmts, int rdcc_nelmts, int rdcc_nbytes, double rdcc_w0) throws HDF5LibraryException
plist
- IN: Identifier of the file access property list.mdc_nelmts
- IN: Number of elements (objects) in the
meta data cache.rdcc_nbytes
- IN: Total size of the raw data chunk
cache, in bytes.rdcc_w0
- IN: Preemption policy.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_cache(int plist, int[] mdc_nelmts, int[] rdcc_nelmts, int[] rdcc_nbytes, double[] rdcc_w0) throws HDF5LibraryException, java.lang.NullPointerException
plist
- IN: Identifier of the file access property list.mdc_nelmts
- IN/OUT: Number of elements (objects) in
the meta data cache.rdcc_nbytes
- IN/OUT: Total size of the raw data
chunk cache, in bytes.rdcc_w0
- IN/OUT: Preemption policy.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - an array is null.public static int H5Pset_preserve(int plist, boolean status) throws HDF5LibraryException, java.lang.IllegalArgumentException
plist
- IN: Identifier for the dataset transfer
property list.status
- IN: Status of for the dataset transfer
property list.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.IllegalArgumentException
- - plist is invalid.public static int H5Pget_preserve(int plist) throws HDF5LibraryException
plist
- IN: Identifier for the dataset transfer
property list.
HDF5LibraryException
- - Error from the HDF-5 Library.public static boolean H5Pset_deflate(int plist, int level) throws HDF5LibraryException
plist
- IN: Identifier for the dataset creation
property list.level
- IN: Compression level.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pset_gc_references(int fapl_id, boolean gc_ref) throws HDF5LibraryException
fapl_id
- IN File access property listgc_ref
- IN set GC on (true) or off (false)
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_gc_reference(int fapl_id, boolean[] gc_ref) throws HDF5LibraryException, java.lang.NullPointerException
fapl_id
- IN File access property listgc_ref
- OUT GC is on (true) or off (false)
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - array is null.public static int H5Pset_hyper_cache(int plist_id, boolean cache, int limit) throws HDF5LibraryException
Given a dataset transfer property list, H5Pset_hyper_cache indicates whether to cache hyperslab blocks during I/O, a process which can significantly increase I/O speeds.
plist_id
- IN Dataset transfer property listcache
- IN cache on (true)/off (false)limit
- IN Maximum size of the hyperslab block
to cache. 0 (zero) indicates no limit.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_hyper_cache(int plist_id, boolean[] cache, int[] limit) throws HDF5LibraryException, java.lang.NullPointerException
plist_id
- IN Dataset transfer property listcache
- OUT cache on (true)/off (false)limit
- OUT Maximum size of the hyperslab block
to cache. 0 (zero) indicates no limit.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - an array is null.public static int H5Pset_btree_ratios(int plist_id, double left, double middle, double right) throws HDF5LibraryException
plist_id
- IN Dataset transfer property listleft
- IN split ratio for leftmost nodesright
- IN split ratio for righttmost nodesmiddle
- IN split ratio for all other nodes
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Pget_btree_ratios(int plist_id, double[] left, double[] middle, double[] right) throws HDF5LibraryException, java.lang.NullPointerException
plist_id
- IN Dataset transfer property listleft
- OUT split ratio for leftmost nodesright
- OUT split ratio for righttmost nodesmiddle
- OUT split ratio for all other nodes
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - an input array is null.public static byte[] H5Rcreate(int loc_id, java.lang.String name, int ref_type, int space_id) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
loc_id
- IN: Location identifier used to locate
the object being pointed to.name
- IN: Name of object at location loc_id.ref_type
- IN: Type of reference.space_id
- IN: Dataspace identifier with selection.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - an input array is null.
java.lang.IllegalArgumentException
- - an input array is
invalid.public static int H5Rdereference(int dataset, int ref_type, byte[] ref) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
dataset
- IN: Dataset containing reference object.ref
- IN: reference to an object
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - output array is null.
java.lang.IllegalArgumentException
- - output array is invalid.public static int H5Rget_region(int loc_id, int ref_type, byte[] ref) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
loc_id,
- IN: loc_id of the reference object.ref_type,
- IN: The reference type of ref.reference
- OUT: the reference to the object and region
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - output array is null.
java.lang.IllegalArgumentException
- - output array is invalid.public static int H5Rget_object_type(int loc_id, byte[] ref) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
loc_id,
- IN: loc_id of the reference object.ref
- IN: the reference
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - array is null.
java.lang.IllegalArgumentException
- - array is invalid.public static int H5Screate(int type) throws HDF5LibraryException
type
- The type of dataspace to be created.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Screate_simple(int rank, long[] dims, long[] maxdims) throws HDF5LibraryException, java.lang.NullPointerException
rank
- Number of dimensions of dataspace.dims
- An array of the size of each dimension.maxdims
- An array of the maximum size of each dimension.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - dims or maxdims is null.public static int H5Scopy(int space_id) throws HDF5LibraryException
space_id
- Identifier of dataspace to copy.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Sselect_elements(int space_id, int op, int num_elements, long[][] coord2D) throws HDF5Exception, HDF5LibraryException, java.lang.NullPointerException
space_id
- Identifier of the dataspace.op
- operator specifying how the new selection is
combined.num_elements
- Number of elements to be selected.coord
- A 2-dimensional array specifying the
coordinates of the elements.
HDF5Exception
- - Error in the data conversion
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - cord array ispublic static int H5Sselect_all(int space_id) throws HDF5LibraryException
space_id
- IN: The identifier of the dataspace
to be selected.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Sselect_none(int space_id) throws HDF5LibraryException
space_id
- IN: The identifier of the dataspace to
be reset.
HDF5LibraryException
- - Error from the HDF-5 Library.public static boolean H5Sselect_valid(int space_id) throws HDF5LibraryException
space_id
- The identifier for the dataspace in
which the selection is being reset.
HDF5LibraryException
- - Error from the HDF-5 Library.public static long H5Sget_simple_extent_npoints(int space_id) throws HDF5LibraryException
space_id
- ID of the dataspace object to query
HDF5LibraryException
- - Error from the HDF-5 Library.public static long H5Sget_select_npoints(int space_id) throws HDF5LibraryException
space_id
- Dataspace identifier.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Sget_simple_extent_ndims(int space_id) throws HDF5LibraryException
space_id
- Identifier of the dataspace
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Sget_simple_extent_dims(int space_id, long[] dims, long[] maxdims) throws HDF5LibraryException, java.lang.NullPointerException
space_id
- IN: Identifier of the dataspace object to
querydims
- OUT: Pointer to array to store the size of
each dimension.maxdims
- OUT: Pointer to array to store the maximum
size of each dimension.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - dims or maxdims is null.public static int H5Sget_simple_extent_type(int space_id) throws HDF5LibraryException
space_id
- Dataspace identifier.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Sset_extent_simple(int space_id, int rank, long[] current_size, long[] maximum_size) throws HDF5LibraryException, java.lang.NullPointerException
space_id
- Dataspace identifier.rank
- Rank, or dimensionality, of the dataspace.current_size
- Array containing current size of dataspace.maximum_size
- Array containing maximum size of dataspace.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
public static boolean H5Sis_simple(int space_id) throws HDF5LibraryException
space_id
- Identifier of the dataspace to query
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Soffset_simple(int space_id, long[] offset) throws HDF5LibraryException, java.lang.NullPointerException
space_id
- IN: The identifier for the dataspace
object to reset.offset
- IN: The offset at which to position the
selection.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - offset array is null.public static int H5Sextent_copy(int dest_space_id, int source_space_id) throws HDF5LibraryException
dest_space_id
- IN: The identifier for the dataspace
from which the extent is copied.source_space_id
- IN: The identifier for the
dataspace to which the extent is copied.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Sset_extent_none(int space_id) throws HDF5LibraryException
space_id
- The identifier for the dataspace from
which the extent is to be removed.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Sselect_hyperslab(int space_id, int op, long[] start, long[] stride, long[] count, long[] block) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
space_id
- IN: Identifier of dataspace selection
to modifyop
- IN: Operation to perform on current selection.start
- IN: Offset of start of hyperslabcount
- IN: Number of blocks included in hyperslab.stride
- IN: Hyperslab stride.block
- IN: Size of block in hyperslab.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - an input array is null.
java.lang.NullPointerException
- - an input array is invalid.
java.lang.IllegalArgumentException
public static int H5Sclose(int space_id) throws HDF5LibraryException
space_id
- Identifier of dataspace to release.
HDF5LibraryException
- - Error from the HDF-5 Library.public static long H5Sget_select_hyper_nblocks(int spaceid) throws HDF5LibraryException
spaceid
- Identifier of dataspace to release.
HDF5LibraryException
- - Error from the HDF-5 Library.public static long H5Sget_select_elem_npoints(int spaceid) throws HDF5LibraryException
spaceid
- Identifier of dataspace to release.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Sget_select_hyper_blocklist(int spaceid, long startblock, long numblocks, long[] buf) throws HDF5LibraryException, java.lang.NullPointerException
<"start" coordinate>, immediately followed by <"opposite" corner coordinate>, followed by the next "start" and "opposite" coordinates, etc. until all of the selected blocks have been listed.
spaceid
- Identifier of dataspace to release.startblock
- first block to retrievenumblock
- number of blocks to retrievebuf
- returns blocks startblock to startblock+num-1,
each block is rank * 2 (corners) longs.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - buf is null.public static int H5Sget_select_elem_pointlist(int spaceid, long startpoint, long numpoints, long[] buf) throws HDF5LibraryException, java.lang.NullPointerException
spaceid
- Identifier of dataspace to release.startpoint
- first point to retrievenumpoints
- number of points to retrievebuf
- returns points startblock to startblock+num-1,
each points is rank longs.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - buf is null.public static int H5Sget_select_bounds(int spaceid, long[] start, long[] end) throws HDF5LibraryException, java.lang.NullPointerException
The start and end buffers must be large enough to hold the dataspace rank number of coordinates.
spaceid
- Identifier of dataspace to release.start
- coordinates of lowest corner of bounding box.end
- coordinates of highest corner of bounding box.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - start or end is null.public static int H5Topen(int loc_id, java.lang.String name) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- A file, group, or datatype identifier.name
- A datatype name.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Tcommit(int loc_id, java.lang.String name, int type) throws HDF5LibraryException, java.lang.NullPointerException
loc_id
- A file or group identifier.name
- A datatype name.type
- A datatype identifier.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static boolean H5Tcommitted(int type) throws HDF5LibraryException
type
- Datatype identifier.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tcreate(int dclass, int size) throws HDF5LibraryException
dclass
- Class of datatype to create.size
- The number of bytes in the datatype to create.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tcopy(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to copy. Can
be a datatype identifier, a predefined datatype
(defined in H5Tpublic.h), or a dataset Identifier.
HDF5LibraryException
- - Error from the HDF-5 Library.public static boolean H5Tequal(int type_id1, int type_id2) throws HDF5LibraryException
type_id1
- Identifier of datatype to compare.type_id2
- Identifier of datatype to compare.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tlock(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to lock.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_class(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_size(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tset_size(int type_id, int size) throws HDF5LibraryException
type_id
- Identifier of datatype to change size.size
- Size in bytes to modify datatype.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_order(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tset_order(int type_id, int order) throws HDF5LibraryException
type_id
- Identifier of datatype to set.order
- Byte ordering constant.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_precision(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tset_precision(int type_id, int precision) throws HDF5LibraryException
type_id
- Identifier of datatype to set.precision
- Number of bits of precision for datatype.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_offset(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tset_offset(int type_id, int offset) throws HDF5LibraryException
type_id
- Identifier of datatype to set.offset
- Offset of first significant bit.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_pad(int type_id, int[] pad) throws HDF5LibraryException, java.lang.NullPointerException
type_id
- IN: Identifier of datatype to query.pad
- OUT: locations to return least-significant
and most-significant bit padding type.
pad[0] = lsb // least-significant bit padding type pad[1] = msb // most-significant bit padding type
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - pad is null.public static int H5Tset_pad(int type_id, int lsb, int msb) throws HDF5LibraryException
type_id
- Identifier of datatype to set.lsb
- Padding type for least-significant bits.msb
- Padding type for most-significant bits.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_sign(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tset_sign(int type_id, int sign) throws HDF5LibraryException
type_id
- Identifier of datatype to set.sign
- Sign type.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_fields(int type_id, int[] fields) throws HDF5LibraryException, java.lang.NullPointerException, java.lang.IllegalArgumentException
type_id
- IN: Identifier of datatype to query.fields
- OUT: location of size and bit-position.
fields[0] = spos OUT: location to return size of in bits. fields[1] = epos OUT: location to return exponent bit-position. fields[2] = esize OUT: location to return size of exponent in bits. fields[3] = mpos OUT: location to return mantissa bit-position. fields[4] = msize OUT: location to return size of mantissa in bits.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - fileds is null.
java.lang.IllegalArgumentException
- - fileds array is invalid.public static int H5Tset_fields(int type_id, int spos, int epos, int esize, int mpos, int msize) throws HDF5LibraryException
type_id
- Identifier of datatype to set.spos
- Size position.epos
- Exponent bit position.esize
- Size of exponent in bits.mpos
- Mantissa bit position.msize
- Size of mantissa in bits.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_ebias(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tset_ebias(int type_id, int ebias) throws HDF5LibraryException
type_id
- Identifier of datatype to set.ebias
- Exponent bias value.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_norm(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tset_norm(int type_id, int norm) throws HDF5LibraryException
type_id
- Identifier of datatype to set.norm
- Mantissa normalization type.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_inpad(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tset_inpad(int type_id, int inpad) throws HDF5LibraryException
type_id
- Identifier of datatype to modify.inpad
- Padding type.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_cset(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tset_cset(int type_id, int cset) throws HDF5LibraryException
type_id
- Identifier of datatype to modify.cset
- Character set type.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_strpad(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tset_strpad(int type_id, int strpad) throws HDF5LibraryException
type_id
- Identifier of datatype to modify.strpad
- String padding type.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_nmembers(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to query.
HDF5LibraryException
- - Error from the HDF-5 Library.public static java.lang.String H5Tget_member_name(int type_id, int field_idx)
type_id
- Identifier of datatype to query.field_idx
- Field index (0-based) of the field name
to retrieve.
public static int H5Tget_member_dims(int type_id, int field_idx, int[] dims, int[] perm) throws HDF5LibraryException, java.lang.NullPointerException
type_id
- Identifier of datatype to query.field_idx
- Field index (0-based) of the field dims
to retrieve.dims
- Pointer to buffer to store the dimensions of
the field.perm
- Pointer to buffer to store the permutation
vector of the field.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
public static int H5Tget_member_type(int type_id, int field_idx) throws HDF5LibraryException
type_id
- Identifier of datatype to query.field_idx
- Field index (0-based) of the field type to
retrieve.
HDF5LibraryException
- - Error from the HDF-5 Library.public static long H5Tget_member_offset(int type_id, int membno) throws HDF5LibraryException
type_id
- Identifier of datatype to query.field_idx
- Field index (0-based) of the field type to
retrieve.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tinsert(int type_id, java.lang.String name, long offset, int field_id) throws HDF5LibraryException, java.lang.NullPointerException
type_id
- Identifier of compound datatype to modify.name
- Name of the field to insert.offset
- Offset in memory structure of the field to
insert.field_id
- Datatype identifier of the field to insert.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Tpack(int type_id) throws HDF5LibraryException
WARNING: This call only affects the C-data, even if it succeeds, there may be no visible effect on Java objects.
type_id
- Identifier of datatype to modify.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tinsert_array(int parent_id, java.lang.String name, int offset, int ndims, int[] dim, int[] perm, int member_id) throws HDF5LibraryException, java.lang.NullPointerException
parent_id
- Identifier of the parent compound datatype.name
- Name of new member.offset
- Offset to start of new member within compound
datatype.ndims
- Dimensionality of new member.dim
- Size of new member array.perm
- Buffer to store the permutation vector of
the field.member_id
- Identifier of the datatype of the new member.
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Tclose(int type_id) throws HDF5LibraryException
type_id
- Identifier of datatype to release.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tenum_create(int base_id) throws HDF5LibraryException
base_id
- Identifier of the parent datatype to release.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tenum_insert(int type, java.lang.String name, int[] value) throws HDF5LibraryException, java.lang.NullPointerException
type
- Identifier of datatype.name
- The name of the memberobj
- The value of the member, data of the correct
type
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Tenum_nameof(int type, int[] value, java.lang.String[] name, int size) throws HDF5LibraryException, java.lang.NullPointerException
type
- IN: Identifier of datatype.obj
- IN: The value of the member, data of the correctname
- OUT: The name of the membersize
- IN: The max length of the name
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Tenum_valueof(int type, java.lang.String name, int[] value) throws HDF5LibraryException, java.lang.NullPointerException
type
- IN: Identifier of datatype.name
- IN: The name of the membervalue
- OUT: The value of the member
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.public static int H5Tvlen_create(int base_id) throws HDF5LibraryException
base_id_type
- IN: Identifier of parent datatype.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tset_tag(int type, java.lang.String tag) throws HDF5LibraryException
type
- IN: Identifier of parent datatype.tag
- IN: Name of the tag (will be stored as
ASCII)
HDF5LibraryException
- - Error from the HDF-5 Library.public static java.lang.String H5Tget_tag(int type) throws HDF5LibraryException
type
- IN: Identifier of datatype.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_super(int type) throws HDF5LibraryException
type
- IN: Identifier of datatype.
HDF5LibraryException
- - Error from the HDF-5 Library.public static int H5Tget_member_value(int type_id, int membno, int[] value) throws HDF5LibraryException, java.lang.NullPointerException
type_id
- IN: Identifier of datatype.membno
- IN: The name of the membervalue
- OUT: The value of the member
HDF5LibraryException
- - Error from the HDF-5 Library.
java.lang.NullPointerException
- - name is null.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |