summaryrefslogtreecommitdiffstats
path: root/java/src/hdf
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2022-08-09 23:09:42 (GMT)
committerGitHub <noreply@github.com>2022-08-09 23:09:42 (GMT)
commit2672e64bf4f630cc92bf923e8a544c8220e2db0a (patch)
tree5fc413d258c1f2fe91b823d7584e4f2b88837b9e /java/src/hdf
parent40fc2cca16cd562954d3b724fa56badb3b9da72b (diff)
downloadhdf5-2672e64bf4f630cc92bf923e8a544c8220e2db0a.zip
hdf5-2672e64bf4f630cc92bf923e8a544c8220e2db0a.tar.gz
hdf5-2672e64bf4f630cc92bf923e8a544c8220e2db0a.tar.bz2
Update java code with doxygen tags, add menu files. (#1972)
* Update java code with doxygen tags, add menu files. * Add -Xdoclint:none to autotools javadoc command * Committing clang-format changes * Add fortran RM list descriptions * delete empty file * doc tag location changes * Spelling corrections Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Diffstat (limited to 'java/src/hdf')
-rw-r--r--java/src/hdf/hdf5lib/CMakeLists.txt1
-rw-r--r--java/src/hdf/hdf5lib/H5.java2594
-rw-r--r--java/src/hdf/hdf5lib/HDF5Constants.java9
-rw-r--r--java/src/hdf/hdf5lib/HDF5GroupInfo.java182
-rw-r--r--java/src/hdf/hdf5lib/HDFArray.java7
-rw-r--r--java/src/hdf/hdf5lib/HDFNativeData.java7
-rw-r--r--java/src/hdf/hdf5lib/callbacks/Callbacks.java6
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5L_iterate_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5O_iterate_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java2
-rw-r--r--java/src/hdf/hdf5lib/callbacks/package-info.java1
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5AtomException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5AttributeException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5BtreeException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5DataFiltersException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5DataStorageException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5DatasetInterfaceException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5DataspaceInterfaceException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5DatatypeInterfaceException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5Exception.java18
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5ExternalFileListException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5FileInterfaceException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5FunctionArgumentException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5FunctionEntryExitException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5HeapException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5InternalErrorException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5JavaException.java8
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5LibraryException.java44
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5LowLevelIOException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5MetaDataCacheException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5ObjectHeaderException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5PropertyListInterfaceException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5ReferenceException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5ResourceUnavailableException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/HDF5SymbolTableException.java6
-rw-r--r--java/src/hdf/hdf5lib/exceptions/package-info.java1
-rw-r--r--java/src/hdf/hdf5lib/package-info.java114
-rw-r--r--java/src/hdf/overview.html8
52 files changed, 2190 insertions, 970 deletions
diff --git a/java/src/hdf/hdf5lib/CMakeLists.txt b/java/src/hdf/hdf5lib/CMakeLists.txt
index 089af1b..723ee3a 100644
--- a/java/src/hdf/hdf5lib/CMakeLists.txt
+++ b/java/src/hdf/hdf5lib/CMakeLists.txt
@@ -99,7 +99,6 @@ set (HDF5_JAVADOC_HDF_HDF5_STRUCTS_SOURCES
set (HDF5_JAVA_HDF_HDF5_SOURCES
HDFArray.java
HDF5Constants.java
- HDF5GroupInfo.java
HDFNativeData.java
H5.java
)
diff --git a/java/src/hdf/hdf5lib/H5.java b/java/src/hdf/hdf5lib/H5.java
index c6ccd7e..60d220a 100644
--- a/java/src/hdf/hdf5lib/H5.java
+++ b/java/src/hdf/hdf5lib/H5.java
@@ -57,55 +57,55 @@ import hdf.hdf5lib.structs.H5L_info_t;
import hdf.hdf5lib.structs.H5O_info_t;
/**
+ * @page HDF5LIB HDF5 Java API Package
* This class is the Java interface for the HDF5 library.
* <p>
* This code is the called by Java programs to access the entry points of the HDF5 library. Each routine wraps
* a single HDF5 entry point, generally with the arguments and return codes analogous to the C interface.
* <p>
- * For details of the HDF5 library, see the HDF5 Documentation at:
- * <a href="http://hdfgroup.org/HDF5/">http://hdfgroup.org/HDF5/</a>
+ * For details of the HDF5 library, @see @ref RM
* <hr>
* <p>
* <b>Mapping of arguments for Java</b>
*
* <p>
* In general, arguments to the HDF Java API are straightforward translations from the 'C' API described in
- * the HDF Reference Manual.
+ * the @ref RM.
*
* <table border=1>
- * <caption><b>HDF-5 C types to Java types</b> </caption>
+ * <caption><b>HDF5 C types to Java types</b> </caption>
* <tr>
- * <td><b>HDF-5</b></td>
+ * <td><b>HDF5</b></td>
* <td><b>Java</b></td>
* </tr>
* <tr>
- * <td>H5T_NATIVE_INT</td>
+ * <td>@ref H5T_NATIVE_INT</td>
* <td>int, Integer</td>
* </tr>
* <tr>
- * <td>H5T_NATIVE_SHORT</td>
+ * <td>@ref H5T_NATIVE_SHORT</td>
* <td>short, Short</td>
* </tr>
* <tr>
- * <td>H5T_NATIVE_FLOAT</td>
+ * <td>@ref H5T_NATIVE_FLOAT</td>
* <td>float, Float</td>
* </tr>
* <tr>
- * <td>H5T_NATIVE_DOUBLE</td>
+ * <td>@ref H5T_NATIVE_DOUBLE</td>
* <td>double, Double</td>
* </tr>
* <tr>
- * <td>H5T_NATIVE_CHAR</td>
+ * <td>@ref H5T_NATIVE_CHAR</td>
* <td>byte, Byte</td>
* </tr>
* <tr>
- * <td>H5T_C_S1</td>
+ * <td>@ref H5T_C_S1</td>
* <td>java.lang.String</td>
* </tr>
* <tr>
- * <td>void * <BR>
+ * <td>void * <br />
* (i.e., pointer to `Any')</td>
- * <td>Special -- see HDFArray</td>
+ * <td>Special -- see @ref HDFARRAY</td>
* </tr>
* </table>
* <b>General Rules for Passing Arguments and Results</b>
@@ -114,17 +114,17 @@ import hdf.hdf5lib.structs.H5O_info_t;
* for arrays, which are discussed below.
* <p>
* The <i>return value</i> 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 <i>boolean</i> in the Java version,
- * rather than <i>int</i> as in the C. Functions that return a value or else FAIL are declared the
+ * rule is that all HDF Java functions will raise an exception upon failure in the Java version,
+ * rather than just return <i>int</i> as in the C. Functions that return a value are declared
* equivalent to the C function.
* However, in most cases the Java method will raise an exception instead of returning an error code.
- * See <a href="#ERRORS">Errors and Exceptions</a> below.
+ * @see @ref ERRORS.
* <p>
* Java does not support pass by reference of arguments, so arguments that are returned through <b>OUT</b>
* parameters must be wrapped in an object or array. The Java API for HDF consistently wraps arguments in
- * arrays.
+ * arrays. Where possible the Java function may return the OUT parameter as an object or basic type.
* <p>
- * For instance, a function that returns two integers is declared:
+ * For instance, a function that returns two integers declared as:
*
* <pre>
* h_err_t HDF5dummy( int *a1, int *a2)
@@ -135,26 +135,34 @@ import hdf.hdf5lib.structs.H5O_info_t;
* <pre>
* public synchronized static native int HDF5dummy(int args[]);
* </pre>
+ * OR
+ * <pre>
+ * public synchronized static native int[] HDF5dummy();
+ * </pre>
*
* where <i>a1</i> is <i>args[0]</i> and <i>a2</i> is <i>args[1]</i>, and would be invoked:
*
* <pre>
* H5.HDF5dummy(a);
* </pre>
+ * OR
+ * <pre>
+ * a = H5.HDF5dummy();
+ * </pre>
*
* <p>
* All the routines where this convention is used will have specific documentation of the details, given
* below.
* <p>
- * <b>Arrays</b>
+ * <b>@ref HDFARRAY</b>
* <p>
* 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,
*
- * <pre>
- * herr_t H5Dread(long fid, long filetype, long memtype, long memspace, void * data);
- * </pre>
+ * @code
+ * herr_t H5Dread(long fid, long filetype, long memtype, long memspace, void *data);
+ * @endcode
*
* <p>
* where ``void *'' means that the data may be any valid numeric type, and is a contiguous block of bytes that
@@ -164,7 +172,7 @@ import hdf.hdf5lib.structs.H5O_info_t;
* For Java, this ``ANY'' is a problem, as the type of data must always be declared. Furthermore,
* multidimensional arrays are definitely <i>not</i> laid 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
- * <a href="./hdf.hdf5lib.HDFArray.html"><b>HDFArray</b></a> class is used to discover the type, shape, and
+ * @ref HDFARRAY <b>HDFArray</b> class is used to discover the type, shape, and
* size of the data array at run time, and to convert to and from a contiguous array of bytes in synchronized
* static native C order.
* <p>
@@ -172,88 +180,103 @@ import hdf.hdf5lib.structs.H5O_info_t;
* passed as an ``Object'', and the Java API will translate to and from the appropriate packed array of bytes
* needed by the C library. So the function above would be declared:
*
- * <pre>
- * public synchronized static native int H5Dread(long fid, long filetype, long memtype, long memspace,
- * Object data);
- * </pre>
- * OPEN_IDS.addElement(id);
-
+ * @code
+ * public synchronized static int H5Dread(long dataset_id, long mem_type_id, long mem_space_id,
+ * long file_space_id, long xfer_plist_id, Object obj,
+ * boolean isCriticalPinning)
+ * throws HDF5Exception, HDF5LibraryException, NullPointerException;
+ * @endcode
+ *
* and the parameter <i>data</i> can be any multi-dimensional array of numbers, such as float[][], or
* int[][][], or Double[][].
* <p>
- * <b>HDF-5 Constants</b>
+ * <b>@ref HDF5CONST</b>
* <p>
- * The HDF-5 API defines a set of constants and enumerated values. Most of these values are available to Java
- * programs via the class <a href="./hdf.hdf5lib.HDF5Constants.html"> <b>HDF5Constants</b></a>. For example,
+ * The HDF5 API defines a set of constants and enumerated values. Most of these values are available to Java
+ * programs via the class @ref HDF5CONST <b>HDF5Constants</b></a>. For example,
* the parameters for the h5open() call include two numeric values, <b><i>HDFConstants.H5F_ACC_RDWR</i></b>
* and <b><i>HDF5Constants.H5P_DEFAULT</i></b>.
* As would be expected, these numbers correspond to the C constants
- * <b><i>H5F_ACC_RDWR</i></b> and <b><i>H5P_DEFAULT</i></b>.
+ * <b><i>#H5F_ACC_RDWR</i></b> and <b><i>#H5P_DEFAULT</i></b>.
* <p>
- * 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 <a href="./hdf.hdf5lib.HDF5CDataTypes.html"> <b>HDF5CDataTypes</b></a> looks up the values
+ * The HDF5 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 HDF5 C library. To support these parameters,
+ * the Java HDFConstants class looks up the values
* when initiated. The values can be accessed as public variables of the Java class, such as:
*
- * <pre>
- * long data_type = HDF5CDataTypes.JH5T_NATIVE_INT;
- * </pre>
+ * @code
+ * long data_type = HDFConstants.H5T_NATIVE_INT;
+ * @endcode
*
* The Java application uses both types of constants the same way, the only difference is that the
- * <b><i>HDF5CDataTypes</i></b> may have different values on different platforms.
- * <p>
- * <b>Error handling and Exceptions</b>
+ * <b><i>HDFConstants</i></b> may have different values on different platforms.
* <p>
- * 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.
+ * <b>@ref ERRORS</b>
* <p>
- * The exceptions of the JHI5 are organized as sub-classes of the class
- * <a href="./hdf.hdf5lib.exceptions.HDF5Exception.html"> <b>HDF5Exception</b></a>. There are two subclasses
- * of
- * <b>HDF5Exception</b>, <a href="./hdf.hdf5lib.exceptions.HDF5LibraryException.html">
- <b>HDF5LibraryException</b></a>
- * and <a href="./hdf.hdf5lib.exceptions.HDF5JavaException.html"> <b>HDF5JavaException</b></a>. The
- * sub-classes of the former represent errors from the HDF-5 C library, while sub-classes of the latter
+ * The HDF5 error API (@ref H5E) manages the behavior of the error stack in the HDF5 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. <p> The exceptions of the JHI5 are organized as
+ * sub-classes of the class
+ * @ref ERRORS <b>HDF5Exception</b>. There are two subclasses of
+ * <b>HDF5Exception</b>, @ref ERRORSLIB <b>HDF5LibraryException</b>
+ * and @ref ERRORSJAVA <b>HDF5JavaException</b>. The
+ * sub-classes of the former represent errors from the HDF5 C library, while sub-classes of the latter
* represent errors in the JHI5 wrapper and support code.
* <p>
* The super-class <b><i>HDF5LibraryException</i></b> implements the method '<b><i>printStackTrace()</i></b>',
- * which prints out the HDF-5 error stack, as described in the HDF-5 C API <i><b>H5Eprint()</b>.</i> This may
- * be used by Java exception handlers to print out the HDF-5 error stack.
- * <hr>
+ * which prints out the HDF5 error stack, as described in the HDF5 C API <i><b>@ref H5Eprint()</b>.</i> This
+ * may be used by Java exception handlers to print out the HDF5 error stack. <hr>
+ *
+ * @version HDF5 1.10.10 <br />
+ * <b>See also: </b>
+ * @ref HDFARRAY hdf.hdf5lib.HDFArray<br />
+ * @ref HDF5CONST hdf.hdf5lib.HDF5Constants<br />
+ * @ref ERRORS hdf.hdf5lib.HDF5Exception<br />
+ * <a href="https://hdfgroup.org/HDF5/">HDF5</a>
+ *
+ * For details of the HDF5 library, @see @ref RM
+ */
+
+/**
+ * This class is the Java interface for the HDF5 library.
*
- * @version HDF5 1.10.10 <BR>
- * <b>See also: <a href ="./hdf.hdf5lib.HDFArray.html"> hdf.hdf5lib.HDFArray</a> </b><BR>
- * <a href ="./hdf.hdf5lib.HDF5Constants.html"> hdf.hdf5lib.HDF5Constants</a><BR>
- * <a href ="./hdf.hdf5lib.HDF5CDataTypes.html"> hdf.hdf5lib.HDF5CDataTypes</a><BR>
- * <a href ="./hdf.hdf5lib.HDF5Exception.html"> hdf.hdf5lib.HDF5Exception</a><BR>
- * <a href="http://hdfgroup.org/HDF5/"> http://hdfgroup.org/HDF5"</a>
+ * @defgroup JH5 HDF5 Library Java Interface
+ *
+ * This code is the called by Java programs to access the entry points of the HDF5 library. Each routine wraps
+ * a single HDF5 entry point, generally with the arguments and return codes analogous to the C interface.
*
*/
public class H5 implements java.io.Serializable {
/**
- *
+ * Serialization ID
*/
private static final long serialVersionUID = 6129888282117053288L;
private final static org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(H5.class);
/**
- * The version number of the HDF5 library:
- * LIB_VERSION[0]: The major version of the library.
- * LIB_VERSION[1]: The minor version of the library.
- * LIB_VERSION[2]: The release number of the library.
+ * @ingroup JH5
*
+ * The version number of the HDF5 library:
+ * <ul>
+ * <li>LIB_VERSION[0]: The major version of the library.</li>
+ * <li>LIB_VERSION[1]: The minor version of the library.</li>
+ * <li>LIB_VERSION[2]: The release number of the library.</li>
+ * </ul>
* Make sure to update the versions number when a different library is used.
*/
public final static int LIB_VERSION[] = {1, 10, 10};
/**
+ * @ingroup JH5
+ *
* add system property to load library by path
*/
public final static String H5PATH_PROPERTY_KEY = "hdf.hdf5lib.H5.hdf5lib";
/**
+ * @ingroup JH5
+ *
* add system property to load library by name from library path, via System.loadLibrary()
*/
public final static String H5_LIBRARY_NAME_PROPERTY_KEY = "hdf.hdf5lib.H5.loadLibraryName";
@@ -266,6 +289,8 @@ public class H5 implements java.io.Serializable {
static { loadH5Lib(); }
/**
+ * @ingroup JH5
+ *
* load native library
*/
public static void loadH5Lib()
@@ -370,6 +395,8 @@ public class H5 implements java.io.Serializable {
// ////////////////////////////////////////////////////////////
/**
+ * @ingroup JH5
+ *
* Get number of open IDs.
*
* @return Returns a count of open IDs
@@ -377,6 +404,8 @@ public class H5 implements java.io.Serializable {
public final static int getOpenIDCount() { return OPEN_IDS.size(); }
/**
+ * @ingroup JH5
+ *
* Get the open IDs
*
* @return Returns a collection of open IDs
@@ -384,6 +413,8 @@ public class H5 implements java.io.Serializable {
public final static Collection<Long> getOpenIDs() { return OPEN_IDS; }
/**
+ * @ingroup JH5
+ *
* H5check_version verifies that the arguments match the version numbers compiled into the library.
*
* @param majnum
@@ -395,47 +426,55 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful. Upon failure (when the versions do not match), this
* function causes the application to abort (i.e., crash)
*
- * See C API function: herr_t H5check_version()
+ * See C API function: @ref herr_t H5check_version(unsigned majnum, unsigned minnum, unsigned relnum)
**/
public synchronized static native int H5check_version(int majnum, int minnum, int relnum);
/**
+ * @ingroup JH5
+ *
* H5close flushes all data to disk, closes all file identifiers, and cleans up all memory used by the
* library.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5close() throws HDF5LibraryException;
/**
+ * @ingroup JH5
+ *
* H5open initialize the library.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5open() throws HDF5LibraryException;
/**
+ * @ingroup JH5
+ *
* H5dont_atexit indicates to the library that an atexit() cleanup routine should not be installed. In
* order to be effective, this routine must be called before any other HDF function calls, and must be
* called each time the library is loaded/linked into the application (the first time and after it's been
- * unloaded). <P> This is called by the static initializer, so this should never need to be explicitly
+ * unloaded). <p> This is called by the static initializer, so this should never need to be explicitly
* called by a Java program.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
private synchronized static native int H5dont_atexit() throws HDF5LibraryException;
/**
- * Turn off error handling. By default, the C library prints the error stack of the HDF-5 C library on
+ * @ingroup JH5
+ *
+ * Turn off error handling. By default, the C library prints the error stack of the HDF5 C library on
* stdout. This behavior may be disabled by calling H5error_off().
*
* @return a non-negative value if successful
@@ -443,29 +482,35 @@ public class H5 implements java.io.Serializable {
public synchronized static native int H5error_off();
/**
- * Turn on error handling. By default, the C library prints the error stack of the HDF-5 C library on
+ * @ingroup JH5
+ *
+ * Turn on error handling. By default, the C library prints the error stack of the HDF5 C library on
* stdout. This behavior may be re-enabled by calling H5error_on().
*/
public synchronized static native void H5error_on();
/**
+ * @ingroup JH5
+ *
* H5garbage_collect collects on all free-lists of all types.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5garbage_collect() throws HDF5LibraryException;
/**
+ * @ingroup JH5
+ *
* H5get_libversion retrieves the major, minor, and release numbers of the version of the HDF library
* which is linked to the application.
*
* @param libversion
* The version information of the HDF library.
*
- * <pre>
+ * <pre>
* libversion[0] = The major version of the library.
* libversion[1] = The minor version of the library.
* libversion[2] = The release number of the library.
@@ -473,11 +518,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful, along with the version information.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5get_libversion(int[] libversion) throws HDF5LibraryException;
/**
+ * @ingroup JH5
+ *
* H5set_free_list_limits
* Sets limits on the different kinds of free lists. Setting a value
* of -1 for a limit means no limit of that type. These limits are global
@@ -504,7 +551,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful, along with the version information.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native int H5set_free_list_limits(int reg_global_lim, int reg_list_lim,
int arr_global_lim, int arr_list_lim,
@@ -512,6 +559,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException;
/**
+ * @ingroup JH5
+ *
* H5export_dataset is a utility function to save data in a file.
*
* @param file_export_name
@@ -527,13 +576,15 @@ public class H5 implements java.io.Serializable {
* 3 - export data as binary Big Endian.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5export_dataset(String file_export_name, long file_id,
String object_path, int binary_order)
throws HDF5LibraryException;
/**
+ * @ingroup JH5
+ *
* H5export_dataset is a utility function to save data in a file.
*
* @param file_export_name
@@ -549,7 +600,7 @@ public class H5 implements java.io.Serializable {
* 3 - export data as binary Big Endian.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static void H5export_dataset(String file_export_name, String file_name, String object_path,
int binary_order) throws HDF5LibraryException
@@ -561,6 +612,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException;
/**
+ * @ingroup JH5
+ *
* H5export_attribute is a utility function to save data in a file.
*
* @param file_export_name
@@ -576,13 +629,15 @@ public class H5 implements java.io.Serializable {
* 3 - export data as binary Big Endian.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5export_attribute(String file_export_name, long dataset_id,
String attribute_name, int binary_order)
throws HDF5LibraryException;
/**
+ * @ingroup JH5
+ *
* H5is_library_threadsafe Checks to see if the library was built with thread-safety enabled.
*
* @return true if hdf5 library implements threadsafe
@@ -597,11 +652,23 @@ public class H5 implements java.io.Serializable {
// ////////////////////////////////////////////////////////////
// //
- // H5A: HDF5 1.8 Attribute Interface API Functions //
+ // H5A: HDF5 Attribute Interface API Functions //
// //
// ////////////////////////////////////////////////////////////
+ /**
+ * @defgroup JH5A Java Attribute (H5A) Interface
+ *
+ * An HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary
+ *data object. A primary data object may be a dataset, group, or committed datatype.
+ *
+ * @see H5A, C-API
+ *
+ * @see @ref H5A_UG, User Guide
+ **/
/**
+ * @ingroup JH5A
+ *
* H5Aclose terminates access to the attribute specified by its identifier, attr_id.
*
* @param attr_id
@@ -610,7 +677,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Aclose(long attr_id) throws HDF5LibraryException
{
@@ -626,6 +693,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native int _H5Aclose(long attr_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5A
+ *
* H5Acopy copies the content of one attribute to another.
*
* @param src_aid
@@ -636,11 +705,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native int H5Acopy(long src_aid, long dst_aid) throws HDF5LibraryException;
/**
+ * @ingroup JH5A
+ *
* H5Acreate creates an attribute, attr_name, which is attached to the object specified by the identifier
* loc_id.
*
@@ -660,7 +731,7 @@ public class H5 implements java.io.Serializable {
* @return An attribute identifier if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* Name is null.
**/
@@ -677,6 +748,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Acreate2 an attribute, attr_name, which is attached to the object specified by the identifier loc_id.
*
* @see public static long H5Acreate( long loc_id, String attr_name, long type_id, long space_id, long
@@ -687,6 +760,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Acreate_by_name creates an attribute, attr_name, which is attached to the object specified by loc_id
* and obj_name.
*
@@ -710,7 +785,7 @@ public class H5 implements java.io.Serializable {
* @return An attribute identifier if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -734,6 +809,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Adelete removes the attribute specified by its name, name, from a dataset, group, or named datatype.
*
* @param loc_id
@@ -744,7 +821,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -752,6 +829,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Adelete_by_idx removes an attribute, specified by its location in an index, from an object.
*
* @param loc_id
@@ -768,7 +847,7 @@ public class H5 implements java.io.Serializable {
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* obj_name is null.
**/
@@ -777,6 +856,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Adelete_by_name removes the attribute attr_name from an object specified by location and name, loc_id
* and obj_name, respectively.
*
@@ -792,7 +873,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -801,6 +882,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aexists determines whether the attribute attr_name exists on the object specified by obj_id.
*
* @param obj_id
@@ -811,7 +894,7 @@ public class H5 implements java.io.Serializable {
* @return boolean true if an attribute with a given name exists.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* attr_name is null.
**/
@@ -819,6 +902,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aexists_by_name determines whether the attribute attr_name exists on an object. That object is
* specified by its location and name, loc_id and obj_name, respectively.
*
@@ -834,7 +919,7 @@ public class H5 implements java.io.Serializable {
* @return boolean true if an attribute with a given name exists, otherwise returns false.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -843,6 +928,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aget_info retrieves attribute information, by attribute identifier.
*
* @param attr_id
@@ -851,11 +938,13 @@ public class H5 implements java.io.Serializable {
* @return A buffer(H5A_info_t) for Attribute information
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native H5A_info_t H5Aget_info(long attr_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5A
+ *
* H5Aget_info_by_idx Retrieves attribute information, by attribute index position.
*
* @param loc_id
@@ -874,7 +963,7 @@ public class H5 implements java.io.Serializable {
* @return A buffer(H5A_info_t) for Attribute information
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* obj_name is null.
**/
@@ -884,6 +973,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aget_info_by_name Retrieves attribute information, by attribute name.
*
* @param loc_id
@@ -898,7 +989,7 @@ public class H5 implements java.io.Serializable {
* @return A buffer(H5A_info_t) for Attribute information
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* obj_name is null.
**/
@@ -907,6 +998,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aget_name retrieves the name of an attribute specified by the identifier, attr_id.
*
* @param attr_id
@@ -915,11 +1008,13 @@ public class H5 implements java.io.Serializable {
* @return String for Attribute name.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native String H5Aget_name(long attr_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5A
+ *
* H5Aget_name_by_idx retrieves the name of an attribute that is attached to an object, which is specified
* by its location and name, loc_id and obj_name, respectively.
*
@@ -948,6 +1043,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aget_space retrieves a copy of the dataspace for an attribute.
*
* @param attr_id
@@ -956,7 +1053,7 @@ public class H5 implements java.io.Serializable {
* @return attribute dataspace identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Aget_space(long attr_id) throws HDF5LibraryException
{
@@ -972,6 +1069,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Aget_space(long attr_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5A
+ *
* H5Aget_storage_size returns the amount of storage that is required for the specified attribute,
* attr_id.
*
@@ -981,11 +1080,13 @@ public class H5 implements java.io.Serializable {
* @return the amount of storage size allocated for the attribute; otherwise returns 0 (zero)
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Aget_storage_size(long attr_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5A
+ *
* H5Aget_type retrieves a copy of the datatype for an attribute.
*
* @param attr_id
@@ -994,7 +1095,7 @@ public class H5 implements java.io.Serializable {
* @return a datatype identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Aget_type(long attr_id) throws HDF5LibraryException
{
@@ -1010,6 +1111,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Aget_type(long attr_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5A
+ *
* H5Aopen opens an existing attribute, attr_name, that is attached to an object specified an object
* identifier, object_id.
*
@@ -1023,7 +1126,7 @@ public class H5 implements java.io.Serializable {
* @return An attribute identifier if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* Name is null.
**/
@@ -1043,6 +1146,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aopen_by_idx opens an existing attribute that is attached to an object specified by location and
* name, loc_id and obj_name, respectively
*
@@ -1064,7 +1169,7 @@ public class H5 implements java.io.Serializable {
* @return An attribute identifier if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* Name is null.
**/
@@ -1086,6 +1191,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aopen_by_name Opens an attribute for an object by object name and attribute name
*
* @param loc_id
@@ -1102,7 +1209,7 @@ public class H5 implements java.io.Serializable {
* @return Returns an attribute identifier if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* obj_name is null.
**/
@@ -1123,6 +1230,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer from the file.
*
@@ -1138,7 +1247,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1147,6 +1256,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer from the file.
*
@@ -1160,7 +1271,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1171,6 +1282,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer from the file.
*
@@ -1184,7 +1297,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1195,6 +1308,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into data object from the file.
*
@@ -1212,7 +1327,7 @@ public class H5 implements java.io.Serializable {
* @exception HDF5Exception
* Failure in the data conversion.
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null. See public synchronized static native int H5Aread( )
**/
@@ -1294,6 +1409,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of double from the file.
*
@@ -1309,7 +1426,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1318,6 +1435,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of double from the file.
*
@@ -1331,7 +1450,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1357,7 +1476,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1366,6 +1485,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of float from the file.
*
@@ -1379,7 +1500,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1390,6 +1511,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of int from the file.
*
@@ -1405,7 +1528,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1414,6 +1537,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of int from the file.
*
@@ -1427,7 +1552,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1438,6 +1563,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of long from the file.
*
@@ -1453,7 +1580,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1462,6 +1589,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of long from the file.
*
@@ -1475,7 +1604,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1486,6 +1615,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of String from the file.
*
@@ -1499,7 +1630,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1507,6 +1638,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of short from the file.
*
@@ -1522,7 +1655,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1531,6 +1664,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of shortfrom the file.
*
@@ -1544,7 +1679,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1555,6 +1690,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of variable-lenght from the file.
*
@@ -1568,7 +1705,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1576,6 +1713,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of String from the file.
*
@@ -1589,7 +1728,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1597,6 +1736,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of variable-lenght strings from the file.
*
@@ -1610,7 +1751,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1618,6 +1759,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of string from the file.
*
@@ -1631,7 +1774,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -1639,8 +1782,10 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Arename changes the name of attribute that is attached to the object specified by loc_id. The
- *attribute named old_attr_name is renamed new_attr_name.
+ * attribute named old_attr_name is renamed new_attr_name.
*
* @param loc_id
* IN: Location or object identifier; may be dataset or group
@@ -1652,7 +1797,7 @@ public class H5 implements java.io.Serializable {
* @return A non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* Name is null.
**/
@@ -1660,6 +1805,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Arename_by_name changes the name of attribute that is attached to the object specified by loc_id and
* obj_name. The attribute named old_attr_name is renamed new_attr_name.
*
@@ -1677,7 +1824,7 @@ public class H5 implements java.io.Serializable {
* @return A non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* Name is null.
**/
@@ -1686,6 +1833,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buf to the file.
*
@@ -1701,7 +1850,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -1710,6 +1859,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buf to the file.
*
@@ -1723,7 +1874,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -1734,6 +1885,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buf to the file.
*
@@ -1747,7 +1900,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -1758,6 +1911,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from data object to the file.
*
@@ -1775,7 +1930,7 @@ public class H5 implements java.io.Serializable {
* @exception HDF5Exception
* Failure in the data conversion.
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data object is null
**/
@@ -1834,6 +1989,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of double to the file.
*
@@ -1849,7 +2006,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -1858,6 +2015,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of double to the file.
*
@@ -1871,7 +2030,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -1882,6 +2041,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of float to the file.
*
@@ -1897,7 +2058,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -1906,6 +2067,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of float to the file.
*
@@ -1919,7 +2082,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -1930,6 +2093,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of int to the file.
*
@@ -1945,7 +2110,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -1954,6 +2119,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of int to the file.
*
@@ -1967,7 +2134,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -1978,6 +2145,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of long to the file.
*
@@ -1993,7 +2162,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -2002,6 +2171,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of long to the file.
*
@@ -2015,7 +2186,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -2026,6 +2197,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of short to the file.
*
@@ -2041,7 +2214,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -2050,6 +2223,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of short to the file.
*
@@ -2063,7 +2238,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -2074,6 +2249,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of string to the file.
*
@@ -2087,7 +2264,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -2095,6 +2272,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of variable-lenght to the file.
*
@@ -2108,7 +2287,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data is null.
**/
@@ -2116,6 +2295,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Awrite_VLStrings writes a variable length String dataset, specified by its identifier attr_id, from
* the application memory buffer buffer of variable-lenght strings into the file.
*
@@ -2131,7 +2312,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -2140,6 +2321,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aget_create_plist retrieves a copy of the attribute creation property list identifier.
*
* @param attr_id
@@ -2148,7 +2331,7 @@ public class H5 implements java.io.Serializable {
* @return identifier for the attribute's creation property list if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Aget_create_plist(long attr_id) throws HDF5LibraryException
{
@@ -2164,6 +2347,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Aget_create_plist(long attr_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5A
+ *
* H5Aiterate2 iterates over the attributes attached to a dataset, named datatype, or group, as
* specified by obj_id. For each attribute, user-provided data, op_data, with additional information
* as defined below, is passed to a user-defined function, op, which operates on that attribute.
@@ -2196,7 +2381,7 @@ public class H5 implements java.io.Serializable {
* members were processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -2205,6 +2390,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5A
+ *
* H5Aiterate_by_name iterates over the attributes attached to the dataset or group specified with loc_id
* and obj_name. For each attribute, user-provided data, op_data, with additional information as defined
* below, is passed to a user-defined function, op, which operates on that attribute.
@@ -2241,7 +2428,7 @@ public class H5 implements java.io.Serializable {
* members were processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -2287,8 +2474,13 @@ public class H5 implements java.io.Serializable {
// H5D: Datasets Interface Functions //
// //
// ////////////////////////////////////////////////////////////
+ /**
+ * @defgroup JH5D Java Datasets (H5D) Interface
+ **/
/**
+ * @ingroup JH5D
+ *
* H5Dcopy copies the content of one dataset to another dataset.
*
* @param src_did
@@ -2299,11 +2491,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native int H5Dcopy(long src_did, long dst_did) throws HDF5LibraryException;
/**
+ * @ingroup JH5D
+ *
* H5Dclose ends access to a dataset specified by dataset_id and releases resources used by it.
*
* @param dataset_id
@@ -2312,7 +2506,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Dclose(long dataset_id) throws HDF5LibraryException
{
@@ -2328,6 +2522,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native int _H5Dclose(long dataset_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5D
+ *
* H5Dcreate creates a new dataset named name at the location specified by loc_id.
*
* @param loc_id
@@ -2348,7 +2544,7 @@ public class H5 implements java.io.Serializable {
* @return a dataset identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -2365,6 +2561,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dcreate2 creates a new dataset named name at the location specified by loc_id.
*
* @see public static int H5Dcreate(int loc_id, String name, int type_id, int space_id, int lcpl_id, int
@@ -2375,6 +2573,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dcreate_anon creates a dataset in the file specified by loc_id.
*
* @param loc_id
@@ -2391,7 +2591,7 @@ public class H5 implements java.io.Serializable {
* @return a dataset identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Dcreate_anon(long loc_id, long type_id, long space_id, long dcpl_id, long dapl_id)
throws HDF5LibraryException
@@ -2410,6 +2610,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException;
/**
+ * @ingroup JH5D
+ *
* H5Dfill explicitly fills the dataspace selection in memory, space_id, with the fill value specified in
* fill.
*
@@ -2425,7 +2627,7 @@ public class H5 implements java.io.Serializable {
* IN: Dataspace describing memory buffer and containing the selection to be filled.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -2434,6 +2636,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dget_access_plist returns an identifier for a copy of the dataset access property list for a dataset.
*
* @param dset_id
@@ -2442,11 +2646,13 @@ public class H5 implements java.io.Serializable {
* @return a dataset access property list identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Dget_access_plist(long dset_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5D
+ *
* H5Dget_create_plist returns an identifier for a copy of the dataset creation property list for a
* dataset.
*
@@ -2455,7 +2661,7 @@ public class H5 implements java.io.Serializable {
* @return a dataset creation property list identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Dget_create_plist(long dataset_id) throws HDF5LibraryException
{
@@ -2471,6 +2677,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Dget_create_plist(long dataset_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5D
+ *
* H5Dget_offset returns the address in the file of the dataset dset_id.
*
* @param dset_id
@@ -2479,11 +2687,13 @@ public class H5 implements java.io.Serializable {
* @return the offset in bytes.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Dget_offset(long dset_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5D
+ *
* H5Dget_space returns an identifier for a copy of the dataspace for a dataset.
*
* @param dataset_id
@@ -2492,7 +2702,7 @@ public class H5 implements java.io.Serializable {
* @return a dataspace identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Dget_space(long dataset_id) throws HDF5LibraryException
{
@@ -2508,6 +2718,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Dget_space(long dataset_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5D
+ *
* H5Dget_space_status determines whether space has been allocated for the dataset dset_id.
*
* @param dset_id
@@ -2516,11 +2728,13 @@ public class H5 implements java.io.Serializable {
* @return the space allocation status
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Dget_space_status(long dset_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5D
+ *
* H5Dget_storage_size returns the amount of storage that is required for the dataset.
*
* @param dataset_id
@@ -2529,12 +2743,14 @@ public class H5 implements java.io.Serializable {
* @return he amount of storage space allocated for the dataset.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Dget_storage_size(long dataset_id)
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5D
+ *
* H5Dget_type returns an identifier for a copy of the datatype for a dataset.
*
* @param dataset_id
@@ -2543,7 +2759,7 @@ public class H5 implements java.io.Serializable {
* @return a datatype identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Dget_type(long dataset_id) throws HDF5LibraryException
{
@@ -2559,6 +2775,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Dget_type(long dataset_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5D
+ *
* H5Diterate iterates over all the data elements in the memory buffer buf, executing the callback
* function operator once for each such data element.
*
@@ -2577,7 +2795,7 @@ public class H5 implements java.io.Serializable {
* members were processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -2586,6 +2804,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dopen opens the existing dataset specified by a location identifier and name, loc_id and name,
* respectively.
*
@@ -2599,7 +2819,7 @@ public class H5 implements java.io.Serializable {
* @return a dataset identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -2616,6 +2836,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dopen2 opens the existing dataset specified by a location identifier and name, loc_id and name,
* respectively.
*
@@ -2625,6 +2847,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer buf.
*
@@ -2646,7 +2870,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -2656,6 +2880,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer buf.
*
@@ -2675,7 +2901,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -2687,6 +2913,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer buf.
*
@@ -2706,7 +2934,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -2718,6 +2946,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application data object.
*
@@ -2741,7 +2971,7 @@ public class H5 implements java.io.Serializable {
* @exception HDF5Exception
* Failure in the data conversion.
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data object is null.
**/
@@ -2833,6 +3063,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of type double.
*
@@ -2854,7 +3086,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -2864,6 +3096,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of type double.
*
@@ -2883,7 +3117,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -2895,6 +3129,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of float.
*
@@ -2916,7 +3152,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -2926,6 +3162,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of float.
*
@@ -2945,7 +3183,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -2957,6 +3195,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of int.
*
@@ -2978,7 +3218,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -2988,6 +3228,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of int.
*
@@ -3007,7 +3249,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -3019,6 +3261,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of long.
*
@@ -3040,7 +3284,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -3050,6 +3294,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of long.
*
@@ -3069,7 +3315,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -3081,6 +3327,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of string.
*
@@ -3100,7 +3348,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -3110,6 +3358,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of short.
*
@@ -3131,7 +3381,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -3141,6 +3391,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of short.
*
@@ -3160,7 +3412,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -3172,6 +3424,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of variable-lenght.
*
@@ -3191,7 +3445,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -3200,6 +3454,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of string.
*
@@ -3219,7 +3475,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -3228,6 +3484,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the
* application memory buffer of variable-lenght strings.
*
@@ -3247,7 +3505,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data buffer is null.
**/
@@ -3257,6 +3515,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dset_extent sets the current dimensions of the chunked dataset dset_id to the sizes specified in
* size.
*
@@ -3266,7 +3526,7 @@ public class H5 implements java.io.Serializable {
* IN: Array containing the new magnitude of each dimension of the dataset.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* size is null.
**/
@@ -3274,6 +3534,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dvlen_get_buf_size determines the number of bytes required to store the VL data from the dataset,
* using the space_id for the selection in the dataset on disk and the type_id for the memory
* representation of the VL data in memory.
@@ -3288,7 +3550,7 @@ public class H5 implements java.io.Serializable {
* @return the size in bytes of the memory buffer required to store the VL data.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -3296,6 +3558,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException;
/**
+ * @ingroup JH5D
+ *
* H5Dvlen_reclaim reclaims buffer used for VL data.
*
* @param type_id
@@ -3310,7 +3574,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -3319,6 +3583,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3340,7 +3606,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3350,6 +3616,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3369,7 +3637,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3381,6 +3649,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3400,7 +3670,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3412,6 +3682,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory data object into the file.
*
@@ -3435,7 +3707,7 @@ public class H5 implements java.io.Serializable {
* @exception HDF5Exception
* Failure in the data conversion.
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* data object is null.
**/
@@ -3507,6 +3779,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3528,7 +3802,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3538,6 +3812,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3557,7 +3833,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3570,6 +3846,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3591,7 +3869,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3601,6 +3879,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3620,7 +3900,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3632,6 +3912,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3653,7 +3935,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3663,6 +3945,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3682,7 +3966,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3694,6 +3978,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3715,7 +4001,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3725,6 +4011,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3744,7 +4032,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3756,6 +4044,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3777,7 +4067,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3787,6 +4077,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3806,7 +4098,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3818,6 +4110,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3837,7 +4131,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3847,6 +4141,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application
* memory buffer into the file.
*
@@ -3866,7 +4162,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3875,6 +4171,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dwrite_VLStrings writes a (partial) variable length String dataset, specified by its identifier
* dataset_id, from the application memory buffer buf into the file.
*
@@ -3896,7 +4194,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -3907,6 +4205,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5D
+ *
* H5Dflush causes all buffers associated with a dataset to be immediately flushed to disk without
* removing the data from the cache.
*
@@ -3914,11 +4214,13 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the dataset to be flushed.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Dflush(long dset_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5D
+ *
* H5Drefresh causes all buffers associated with a dataset to be cleared and immediately re-loaded with
* updated contents from disk. This function essentially closes the dataset, evicts all metadata
* associated with it from the cache, and then re-opens the dataset. The reopened dataset is automatically
@@ -3928,7 +4230,7 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the dataset to be refreshed.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Drefresh(long dset_id) throws HDF5LibraryException;
@@ -3948,8 +4250,14 @@ public class H5 implements java.io.Serializable {
// H5E: Error Stack //
// //
// ////////////////////////////////////////////////////////////
+ /**
+ *
+ * @defgroup JH5E Java Error (H5E) Interface
+ */
/**
+ * @ingroup JH5E
+ *
* H5Eauto_is_v2 determines whether the error auto reporting function for an error stack conforms to the
* H5E_auto2_t typedef or the H5E_auto1_t typedef.
*
@@ -3960,19 +4268,21 @@ public class H5 implements java.io.Serializable {
* H5E_auto1_t.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Eauto_is_v2(long stack_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5E
+ *
* H5Eclear clears the error stack for the current thread. H5Eclear can fail if there are problems
* initializing the library. <p> This may be used by exception handlers to assure that the error condition
- * in the HDF-5 library has been reset.
+ * in the HDF5 library has been reset.
*
* @return Returns a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Eclear() throws HDF5LibraryException
{
@@ -3981,6 +4291,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5E
+ *
* H5Eclear clears the error stack specified by estack_id, or, if estack_id is set to H5E_DEFAULT, the
* error stack for the current thread.
*
@@ -3988,11 +4300,13 @@ public class H5 implements java.io.Serializable {
* IN: Error stack identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static void H5Eclear(long stack_id) throws HDF5LibraryException { H5Eclear2(stack_id); }
/**
+ * @ingroup JH5E
+ *
* H5Eclear2 clears the error stack specified by estack_id, or, if estack_id is set to H5E_DEFAULT, the
* error stack for the current thread.
*
@@ -4000,33 +4314,39 @@ public class H5 implements java.io.Serializable {
* IN: Error stack identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Eclear2(long stack_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5E
+ *
* H5Eclose_msg closes an error message identifier, which can be either a major or minor message.
*
* @param err_id
* IN: Error message identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Eclose_msg(long err_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5E
+ *
* H5Eclose_stack closes the object handle for an error stack and releases its resources.
*
* @param stack_id
* IN: Error stack identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Eclose_stack(long stack_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5E
+ *
* H5Ecreate_msg adds an error message to an error class defined by client library or application program.
*
* @param cls_id
@@ -4039,7 +4359,7 @@ public class H5 implements java.io.Serializable {
* @return a message identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* msg is null.
**/
@@ -4047,16 +4367,20 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5E
+ *
* H5Ecreate_stack creates a new empty error stack and returns the new stack's identifier.
*
* @return an error stack identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Ecreate_stack() throws HDF5LibraryException;
/**
+ * @ingroup JH5E
+ *
* H5Eget_class_name retrieves the name of the error class specified by the class identifier.
*
* @param class_id
@@ -4065,23 +4389,27 @@ public class H5 implements java.io.Serializable {
* @return the name of the error class
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native String H5Eget_class_name(long class_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5E
+ *
* H5Eget_current_stack copies the current error stack and returns an error stack identifier for the new
* copy.
*
* @return an error stack identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Eget_current_stack() throws HDF5LibraryException;
/**
+ * @ingroup JH5E
+ *
* H5Eset_current_stack replaces the content of the current error stack with a copy of the content of the
* error stack specified by estack_id.
*
@@ -4089,11 +4417,13 @@ public class H5 implements java.io.Serializable {
* IN: Error stack identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Eset_current_stack(long stack_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5E
+ *
* H5Eget_msg retrieves the error message including its length and type.
*
* @param msg_id
@@ -4104,12 +4434,14 @@ public class H5 implements java.io.Serializable {
* @return the error message
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native String H5Eget_msg(long msg_id, int[] type_list)
throws HDF5LibraryException;
/**
+ * @ingroup JH5E
+ *
* H5Eget_num retrieves the number of error records in the error stack specified by estack_id (including
* major, minor messages and description).
*
@@ -4119,12 +4451,14 @@ public class H5 implements java.io.Serializable {
* @return the number of error messages
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Eget_num(long stack_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5E
+ *
* H5Eprint2 prints the error stack specified by estack_id on the specified stream, stream.
*
* @param stack_id
@@ -4134,12 +4468,14 @@ public class H5 implements java.io.Serializable {
* IN: File pointer, or stderr if null.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Eprint2(long stack_id, Object stream)
throws HDF5LibraryException;
/**
+ * @ingroup JH5E
+ *
* H5Epop deletes the number of error records specified in count from the top of the error stack specified
* by estack_id (including major, minor messages and description).
*
@@ -4149,11 +4485,13 @@ public class H5 implements java.io.Serializable {
* IN: Version of the client library or application to which the error class belongs.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Epop(long stack_id, long count) throws HDF5LibraryException;
/**
+ * @ingroup JH5E
+ *
* H5Epush pushes a new error record onto the error stack specified by estack_id.
*
* @param stack_id
@@ -4174,7 +4512,7 @@ public class H5 implements java.io.Serializable {
* IN: Error description string.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* file, func, or msg is null.
**/
@@ -4184,6 +4522,8 @@ public class H5 implements java.io.Serializable {
H5Epush2(stack_id, file, func, line, cls_id, maj_id, min_id, msg);
}
/**
+ * @ingroup JH5E
+ *
* H5Epush2 pushes a new error record onto the error stack specified by estack_id.
*
* @param stack_id
@@ -4204,7 +4544,7 @@ public class H5 implements java.io.Serializable {
* IN: Error description string.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* file, func, or msg is null.
**/
@@ -4213,6 +4553,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5E
+ *
* H5Eregister_class registers a client library or application program to the HDF5 error API so that the
* client library or application program can report errors together with HDF5 library.
*
@@ -4226,7 +4568,7 @@ public class H5 implements java.io.Serializable {
* @return a class identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -4234,17 +4576,21 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5E
+ *
* H5Eunregister_class removes the error class specified by class_id.
*
* @param class_id
* IN: Error class identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Eunregister_class(long class_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5E
+ *
* H5Ewalk walks the error stack specified by estack_id for the current thread and calls the
* function specified in func for each error along the way.
*
@@ -4258,7 +4604,7 @@ public class H5 implements java.io.Serializable {
* IN: Data to be passed with func.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* func is null.
**/
@@ -4268,6 +4614,8 @@ public class H5 implements java.io.Serializable {
H5Ewalk2(stack_id, direction, func, client_data);
}
/**
+ * @ingroup JH5E
+ *
* H5Ewalk2 walks the error stack specified by estack_id for the current thread and calls the
* function specified in func for each error along the way.
*
@@ -4281,7 +4629,7 @@ public class H5 implements java.io.Serializable {
* IN: Data to be passed with func.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* func is null.
**/
@@ -4320,8 +4668,14 @@ public class H5 implements java.io.Serializable {
// H5F: File Interface Functions //
// //
// ////////////////////////////////////////////////////////////
+ /**
+ *
+ * @defgroup JH5F Java File (H5F) Interface
+ */
/**
+ * @ingroup JH5F
+ *
* H5Fclose terminates access to an HDF5 file.
*
* @param file_id
@@ -4330,7 +4684,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Fclose(long file_id) throws HDF5LibraryException
{
@@ -4346,6 +4700,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native int _H5Fclose(long file_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fopen opens an existing file and is the primary function for accessing existing HDF5 files.
*
* @param name
@@ -4358,7 +4714,7 @@ public class H5 implements java.io.Serializable {
* @return a file identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -4378,6 +4734,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5F
+ *
* H5Freopen reopens an HDF5 file.
*
* @param file_id
@@ -4386,7 +4744,7 @@ public class H5 implements java.io.Serializable {
* @return a new file identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Freopen(long file_id) throws HDF5LibraryException
{
@@ -4402,25 +4760,27 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Freopen(long file_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fcreate is the primary function for creating HDF5 files.
*
* @param name
* Name of the file to access.
* @param flags
* File access flags. Possible values include:
- * <UL>
- * <LI>
- * H5F_ACC_RDWR Allow read and write access to file.</LI>
- * <LI>
- * H5F_ACC_RDONLY Allow read-only access to file.</LI>
- * <LI>
- * H5F_ACC_TRUNC Truncate file, if it already exists, erasing all data previously stored in the
- * file.</LI>
- * <LI>
- * H5F_ACC_EXCL Fail if file already exists.</LI>
- * <LI>
- * H5P_DEFAULT Apply default file access and creation properties.</LI>
- * </UL>
+ * <ul>
+ * <li>
+ * @ref H5F_ACC_RDWR Allow read and write access to file.</li>
+ * <li>
+ * @ref H5F_ACC_RDONLY Allow read-only access to file.</li>
+ * <li>
+ * @ref H5F_ACC_TRUNC Truncate file, if it already exists, erasing all data previously stored
+ * in the file.</li>
+ * <li>
+ * @ref H5F_ACC_EXCL Fail if file already exists.</li>
+ * <li>
+ * @ref H5P_DEFAULT Apply default file access and creation properties.</li>
+ * </ul>
*
* @param create_id
* File creation property list identifier, used when modifying default file meta-data. Use
@@ -4433,7 +4793,7 @@ public class H5 implements java.io.Serializable {
* @return a file identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -4453,8 +4813,10 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5F
+ *
* 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. <P> After this call completes, the file (or
+ * disk without removing the data from the (memory) cache. <p> After this call completes, the file (or
* object) is in a consistent state and all data written to date is assured to be permanent.
*
* @param object_id
@@ -4462,9 +4824,9 @@ public class H5 implements java.io.Serializable {
* associated with the file, including the file itself, a dataset, a group, an attribute,
* or a named data type.
* @param scope
- * specifies the scope of the flushing action, in the case that the HDF-5 file is not a single
+ * specifies the scope of the flushing action, in the case that the HDF5 file is not a single
* physical file.
- * <P> Valid values are:
+ * <p> Valid values are:
* <UL>
* <LI> H5F_SCOPE_GLOBAL Flushes the entire virtual file.</LI>
* <LI> H5F_SCOPE_LOCAL Flushes only the specified file.</LI>
@@ -4473,11 +4835,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Fflush(long object_id, int scope) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_access_plist returns the file access property list identifier of the specified file.
*
* @param file_id
@@ -4486,7 +4850,7 @@ public class H5 implements java.io.Serializable {
* @return a file access property list identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Fget_access_plist(long file_id) throws HDF5LibraryException
{
@@ -4502,6 +4866,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Fget_access_plist(long file_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_create_plist returns a file creation property list identifier identifying the creation
* properties used to create this file.
*
@@ -4511,7 +4877,7 @@ public class H5 implements java.io.Serializable {
* @return a file creation property list identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Fget_create_plist(long file_id) throws HDF5LibraryException
{
@@ -4527,6 +4893,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Fget_create_plist(long file_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_filesize retrieves the file size of the HDF5 file. This function
* is called after an existing file is opened in order
* to learn the true size of the underlying file.
@@ -4537,11 +4905,13 @@ public class H5 implements java.io.Serializable {
* @return the file size of the HDF5 file
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Fget_filesize(long file_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_freespace returns the amount of space that is unused by any objects in the file.
*
* @param file_id
@@ -4550,11 +4920,13 @@ public class H5 implements java.io.Serializable {
* @return the amount of free space in the file
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Fget_freespace(long file_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_intent retrieves the intended access mode flag passed with H5Fopen when the file was opened.
*
* @param file_id
@@ -4563,11 +4935,13 @@ public class H5 implements java.io.Serializable {
* @return the intended access mode flag, as originally passed with H5Fopen.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Fget_intent(long file_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_mdc_hit_rate queries the metadata cache of the target file to obtain its hit rate (cache hits /
* (cache hits + cache misses)) since the last time hit rate statistics were reset.
*
@@ -4577,11 +4951,13 @@ public class H5 implements java.io.Serializable {
* @return the double in which the hit rate is returned.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native double H5Fget_mdc_hit_rate(long file_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_mdc_size queries the metadata cache of the target file for the desired size information.
*
* @param file_id
@@ -4597,7 +4973,7 @@ public class H5 implements java.io.Serializable {
* @return current number of entries in the cache
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* metadata_cache is null.
**/
@@ -4605,6 +4981,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_name retrieves the name of the file to which the object obj_id belongs.
*
* @param obj_id
@@ -4613,11 +4991,13 @@ public class H5 implements java.io.Serializable {
* @return the filename.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native String H5Fget_name(long obj_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_obj_count returns the number of open object identifiers for the file.
*
* @param file_id
@@ -4637,12 +5017,14 @@ public class H5 implements java.io.Serializable {
* @return the number of open objects.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Fget_obj_count(long file_id, int types)
throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_obj_ids returns the list of identifiers for all open HDF5 objects fitting the specified
* criteria.
*
@@ -4658,7 +5040,7 @@ public class H5 implements java.io.Serializable {
* @return the number of objects placed into obj_id_list.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* obj_id_list is null.
**/
@@ -4667,15 +5049,17 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5F
+ *
* H5Fis_hdf5 determines whether a file is in the HDF5 format.
*
* @param name
* File name to check format.
*
- * @return true if is HDF-5, false if not.
+ * @return true if is HDF5, false if not.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -4683,6 +5067,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5F
+ *
* H5Fmount mounts the file specified by child_id onto the group specified by loc_id and name using the
* mount properties plist_id.
*
@@ -4698,7 +5084,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -4706,6 +5092,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5F
+ *
* Given a mount point, H5Funmount disassociates the mount point's file from the file mounted there.
*
* @param loc_id
@@ -4716,7 +5104,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -4724,6 +5112,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5F
+ *
* H5Freset_mdc_hit_rate_stats resets the hit rate statistics counters in the metadata cache associated
* with the specified file.
*
@@ -4731,12 +5121,14 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the target file.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Freset_mdc_hit_rate_stats(long file_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_info returns global information for the file associated with the
* object identifier obj_id.
*
@@ -4745,11 +5137,13 @@ public class H5 implements java.io.Serializable {
* @return A buffer(H5F_info2_t) for current "global" information about file
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native H5F_info2_t H5Fget_info(long obj_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fclear_elink_file_cache evicts all the cached child files in the specified file's external file
* cache, causing them to be closed if there is nothing else holding them open.
*
@@ -4757,12 +5151,14 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the target file.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Fclear_elink_file_cache(long file_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fstart_swmr_write will activate SWMR writing mode for a file associated with file_id. This routine
* will prepare and ensure the file is safe for SWMR writing.
*
@@ -4770,22 +5166,26 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the target file.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Fstart_swmr_write(long file_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fstart_mdc_logging starts logging metadata cache events if logging was previously enabled.
*
* @param file_id
* IN: Identifier of the target file.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Fstart_mdc_logging(long file_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fstop_mdc_logging stops logging metadata cache events if logging was previously enabled and is
* currently ongoing.
*
@@ -4793,11 +5193,13 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the target file.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Fstop_mdc_logging(long file_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_mdc_logging_status gets the current metadata cache logging status.
*
* @param file_id
@@ -4809,7 +5211,7 @@ public class H5 implements java.io.Serializable {
* mdc_logging_status[1] = is_currently_logging, whether events are currently being logged
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* mdc_logging_status is null.
**/
@@ -4818,6 +5220,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5F
+ *
* H5Fget_dset_no_attrs_hint gets the file-level setting to create minimized dataset object headers.
*
* @param file_id
@@ -4826,12 +5230,14 @@ public class H5 implements java.io.Serializable {
* @return true if the file-level is set to create minimized dataset object headers, false if not.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Fget_dset_no_attrs_hint(long file_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fset_dset_no_attrs_hint sets the file-level setting to create minimized dataset object headers.
*
* @param file_id
@@ -4840,12 +5246,14 @@ public class H5 implements java.io.Serializable {
* the minimize hint setting
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Fset_dset_no_attrs_hint(long file_id, boolean minimize)
throws HDF5LibraryException;
/**
+ * @ingroup JH5F
+ *
* H5Fset_libver_bounds sets a different low and high bounds while a file is open.
*
* @param file_id
@@ -4856,7 +5264,7 @@ public class H5 implements java.io.Serializable {
* IN: The latest version of the library that will be used for writing objects.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Fset_libver_bounds(long file_id, int low, int high)
throws HDF5LibraryException;
@@ -4889,7 +5297,7 @@ public class H5 implements java.io.Serializable {
// * @return a pointer to the file handle being used by the low-level
// virtual file driver.
// *
- // * @exception HDF5LibraryException - Error from the HDF-5 Library.
+ // * @exception HDF5LibraryException - Error from the HDF5 Library.
// **/
// public synchronized static native Pointer file_handle
// H5Fget_vfd_handle(int file_id, int fapl)
@@ -4906,7 +5314,7 @@ public class H5 implements java.io.Serializable {
// *
// * @return none
// *
- // * @exception HDF5LibraryException - Error from the HDF-5 Library.
+ // * @exception HDF5LibraryException - Error from the HDF5 Library.
// * @exception NullPointerException - config_ptr is null.
// **/
// public synchronized static native void H5Fget_mdc_config(int file_id, H5AC_cache_config_t config_ptr)
@@ -4922,7 +5330,7 @@ public class H5 implements java.io.Serializable {
// *
// * @return none
// *
- // * @exception HDF5LibraryException - Error from the HDF-5 Library.
+ // * @exception HDF5LibraryException - Error from the HDF5 Library.
// * @exception NullPointerException - config_ptr is null.
// **/
// public synchronized static native int H5Fset_mdc_config(int file_id, H5AC_cache_config_t config_ptr)
@@ -4967,8 +5375,13 @@ public class H5 implements java.io.Serializable {
// H5G: Group Interface Functions //
// //
// ////////////////////////////////////////////////////////////
+ /**
+ * @defgroup JH5G Java Group (H5G) Interface
+ **/
/**
+ * @ingroup JH5G
+ *
* H5Gclose releases resources used by a group which was opened by a call to H5Gcreate() or H5Gopen().
*
* @param group_id
@@ -4977,7 +5390,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Gclose(long group_id) throws HDF5LibraryException
{
@@ -4993,6 +5406,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native int _H5Gclose(long group_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5G
+ *
* H5Gcreate creates a new group with the specified name at the specified location, loc_id.
*
* @param loc_id
@@ -5010,7 +5425,7 @@ public class H5 implements java.io.Serializable {
* @return a valid group identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -5031,6 +5446,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5G
+ *
* H5Gcreate_anon creates a new empty group in the file specified by loc_id.
*
* @param loc_id
@@ -5044,7 +5461,7 @@ public class H5 implements java.io.Serializable {
* @return a valid group identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Gcreate_anon(long loc_id, long gcpl_id, long gapl_id) throws HDF5LibraryException
{
@@ -5061,6 +5478,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException;
/**
+ * @ingroup JH5G
+ *
* H5Gget_create_plist returns an identifier for the group creation property list associated with the
* group specified by group_id.
*
@@ -5070,11 +5489,13 @@ public class H5 implements java.io.Serializable {
* @return an identifier for the group's creation property list
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Gget_create_plist(long group_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5G
+ *
* H5Gget_info retrieves information about the group specified by group_id. The information is returned in
* the group_info struct.
*
@@ -5084,11 +5505,13 @@ public class H5 implements java.io.Serializable {
* @return a structure in which group information is returned
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native H5G_info_t H5Gget_info(long group_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5G
+ *
* H5Gget_info_by_idx retrieves information about a group, according to the group's position within an
* index.
*
@@ -5108,7 +5531,7 @@ public class H5 implements java.io.Serializable {
* @return a structure in which group information is returned
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -5118,6 +5541,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5G
+ *
* H5Gget_info_by_name retrieves information about the group group_name located in the file or group
* specified by loc_id.
*
@@ -5131,7 +5556,7 @@ public class H5 implements java.io.Serializable {
* @return a structure in which group information is returned
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -5139,6 +5564,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5G
+ *
* retrieves information of all objects under the group (name) located in the file or group specified by
* loc_id.
*
@@ -5156,7 +5583,7 @@ public class H5 implements java.io.Serializable {
* @return the number of items found
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
*/
@@ -5173,6 +5600,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5G
+ *
* retrieves information of all objects under the group (name) located in the file or group specified by
* loc_id.
*
@@ -5194,7 +5623,7 @@ public class H5 implements java.io.Serializable {
* @return the number of items found
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
*/
@@ -5207,6 +5636,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5G
+ *
* retrieves information of all objects under the group (name) located in the file or group specified by
* loc_id.
*
@@ -5230,7 +5661,7 @@ public class H5 implements java.io.Serializable {
* @return the number of items found
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
*/
@@ -5243,6 +5674,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5G
+ *
* retrieves information of all objects under the group (name) located in the file or group specified by
* loc_id.
*
@@ -5268,7 +5701,7 @@ public class H5 implements java.io.Serializable {
* @return the number of items found
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
*/
@@ -5319,6 +5752,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5G
+ *
* H5Gget_obj_info_idx report the name and type of object with index 'idx' in a Group. The 'idx'
* corresponds to the index maintained by H5Giterate. Each link is returned, so objects with multiple
* links will be counted once for each link.
@@ -5337,7 +5772,7 @@ public class H5 implements java.io.Serializable {
* @return non-negative if successful, -1 if not.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
*/
@@ -5361,6 +5796,8 @@ public class H5 implements java.io.Serializable {
* a lot of time to finish if the number of objects is more than 10,000
*/
/**
+ * @ingroup JH5G
+ *
* retrieves information of all objects (recurvisely) under the group (name) located in the file or group
* specified by loc_id up to maximum specified by objMax.
*
@@ -5380,7 +5817,7 @@ public class H5 implements java.io.Serializable {
* @return the number of items found
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
*/
@@ -5420,6 +5857,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5G
+ *
* H5Gn_members report the number of objects in a Group. The 'objects' include everything that will be
* visited by H5Giterate. Each link is returned, so objects with multiple links will be counted once for
* each link.
@@ -5432,7 +5871,7 @@ public class H5 implements java.io.Serializable {
* @return the number of members in the group or -1 if error.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
*/
@@ -5454,6 +5893,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5G
+ *
* H5Gopen opens an existing group, name, at the location specified by loc_id.
*
* @param loc_id
@@ -5466,7 +5907,7 @@ public class H5 implements java.io.Serializable {
* @return a valid group identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -5486,6 +5927,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5G
+ *
* H5Gflush causes all buffers associated with a group to be immediately flushed to disk without
* removing the data from the cache.
*
@@ -5493,11 +5936,13 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the group to be flushed.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Gflush(long group_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5G
+ *
* H5Grefresh causes all buffers associated with a group to be cleared and immediately re-loaded
* with updated contents from disk. This function essentially closes the group, evicts all metadata
* associated with it from the cache, and then re-opens the group. The reopened group is automatically
@@ -5507,7 +5952,7 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the group to be refreshed.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Grefresh(long group_id) throws HDF5LibraryException;
@@ -5540,8 +5985,13 @@ public class H5 implements java.io.Serializable {
// H5I: HDF5 Identifier Interface API Functions //
// //
// ////////////////////////////////////////////////////////////
+ /**
+ * @defgroup JH5I Java Identifier (H5I) Interface
+ **/
/**
+ * @ingroup JH5I
+ *
* H5Iget_file_id obtains the file ID specified by the identifier, obj_id.
*
* @param obj_id
@@ -5550,11 +6000,13 @@ public class H5 implements java.io.Serializable {
* @return the file ID.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Iget_file_id(long obj_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5I
+ *
* H5Iget_name_long retrieves the name of an object specified by the identifier, obj_id.
* @deprecated
*
@@ -5568,12 +6020,14 @@ public class H5 implements java.io.Serializable {
* @return the length of the name retrieved.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
@Deprecated
public synchronized static native long H5Iget_name_long(long obj_id, String[] name, long size)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5I
+ *
* H5Iget_name retrieves the name of an object specified by the identifier, obj_id.
*
* @param obj_id
@@ -5582,11 +6036,13 @@ public class H5 implements java.io.Serializable {
* @return String for Attribute name.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native String H5Iget_name(long obj_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5I
+ *
* H5Iget_ref obtains the number of references outstanding specified by the identifier, obj_id.
*
* @param obj_id
@@ -5595,12 +6051,14 @@ public class H5 implements java.io.Serializable {
* @return the reference count.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Iget_ref(long obj_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5I
+ *
* H5Idec_ref decrements the reference count specified by the identifier, obj_id.
* If the reference count for an ID reaches zero, the object will be closed.
*
@@ -5610,12 +6068,14 @@ public class H5 implements java.io.Serializable {
* @return the reference count.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Idec_ref(long obj_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5I
+ *
* H5Iinc_ref increments the reference count specified by the identifier, obj_id.
*
* @param obj_id
@@ -5624,12 +6084,14 @@ public class H5 implements java.io.Serializable {
* @return the reference count.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Iinc_ref(long obj_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5I
+ *
* H5Iget_type retrieves the type of the object identified by obj_id.
*
* @param obj_id
@@ -5638,11 +6100,13 @@ public class H5 implements java.io.Serializable {
* @return the object type if successful; otherwise H5I_BADID.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Iget_type(long obj_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5I
+ *
* H5Iget_type_ref retrieves the reference count on an ID type. The reference count is used by the library
* to indicate when an ID type can be destroyed.
*
@@ -5652,11 +6116,13 @@ public class H5 implements java.io.Serializable {
* @return The current reference count on success, negative on failure.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Iget_type_ref(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5I
+ *
* H5Idec_type_ref decrements the reference count on an identifier type. The reference count is used by
* the library to indicate when an identifier type can be destroyed. If the reference count reaches zero,
* this function will destroy it.
@@ -5667,11 +6133,13 @@ public class H5 implements java.io.Serializable {
* @return The current reference count on success, negative on failure.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Idec_type_ref(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5I
+ *
* H5Iinc_type_ref increments the reference count on an ID type. The reference count is used by the
* library to indicate when an ID type can be destroyed.
*
@@ -5681,11 +6149,13 @@ public class H5 implements java.io.Serializable {
* @return The current reference count on success, negative on failure.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Iinc_type_ref(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5I
+ *
* H5Inmembers returns the number of identifiers of the identifier type specified in type.
*
* @param type_id
@@ -5694,11 +6164,13 @@ public class H5 implements java.io.Serializable {
* @return Number of identifiers of the specified identifier type
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Inmembers(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5I
+ *
* H5Iis_valid indicates if the identifier type specified in obj_id is valid.
*
* @param obj_id
@@ -5707,11 +6179,13 @@ public class H5 implements java.io.Serializable {
* @return a boolean, true if the specified identifier id is valid
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Iis_valid(long obj_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5I
+ *
* H5Itype_exists indicates if the identifier type specified in type exists.
*
* @param type_id
@@ -5720,11 +6194,13 @@ public class H5 implements java.io.Serializable {
* @return a boolean, true if the specified identifier type exists
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Itype_exists(int type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5I
+ *
* H5Iclear_type deletes all identifiers of the type identified by the argument type.
*
* @param type_id
@@ -5733,12 +6209,14 @@ public class H5 implements java.io.Serializable {
* IN: Whether or not to force deletion of all identifiers
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Iclear_type(int type_id, boolean force)
throws HDF5LibraryException;
/**
+ * @ingroup JH5I
+ *
* H5Idestroy_type deletes an entire identifier type. All identifiers of this type are destroyed
* and no new identifiers of this type can be registered.
*
@@ -5746,7 +6224,7 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of identifier type which is to be destroyed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Idestroy_type(int type_id) throws HDF5LibraryException;
@@ -5765,8 +6243,13 @@ public class H5 implements java.io.Serializable {
// //////////////////////////////////////////////////////////////////
// H5L: Link Interface Functions //
// //////////////////////////////////////////////////////////////////
+ /**
+ * @defgroup JH5L Java Link (H5L) Interface
+ **/
/**
+ * @ingroup JH5L
+ *
* H5Lcopy copies a link from one location to another.
*
* @param src_loc
@@ -5783,7 +6266,7 @@ public class H5 implements java.io.Serializable {
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -5792,6 +6275,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lcreate_external creates a new soft link to an external object, which is an object in a different
* HDF5 file from the location of the link.
*
@@ -5809,7 +6294,7 @@ public class H5 implements java.io.Serializable {
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -5819,6 +6304,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lcreate_hard creates a new hard link to a pre-existing object in an HDF5 file.
*
* @param cur_loc
@@ -5835,7 +6322,7 @@ public class H5 implements java.io.Serializable {
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* cur_name or dst_name is null.
**/
@@ -5844,6 +6331,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lcreate_soft creates a new soft link to an object in an HDF5 file.
*
* @param link_target
@@ -5858,7 +6347,7 @@ public class H5 implements java.io.Serializable {
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* link_name is null.
**/
@@ -5867,6 +6356,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Ldelete removes the link specified from a group.
*
* @param loc_id
@@ -5877,7 +6368,7 @@ public class H5 implements java.io.Serializable {
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -5885,6 +6376,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Ldelete_by_idx removes the nth link in a group according to the specified order and in the specified
* index.
*
@@ -5902,7 +6395,7 @@ public class H5 implements java.io.Serializable {
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* group_name is null.
**/
@@ -5911,6 +6404,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lexists checks if a link with a particular name exists in a group.
*
* @param loc_id
@@ -5923,7 +6418,7 @@ public class H5 implements java.io.Serializable {
* @return a boolean, true if the name exists, otherwise false.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -5931,6 +6426,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lget_info returns information about the specified link.
*
* @param loc_id
@@ -5943,7 +6440,7 @@ public class H5 implements java.io.Serializable {
* @return a buffer(H5L_info_t) for the link information.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -5951,6 +6448,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lget_info_by_idx opens a named datatype at the location specified by loc_id and return an identifier
* for the datatype.
*
@@ -5970,7 +6469,7 @@ public class H5 implements java.io.Serializable {
* @return a buffer(H5L_info_t) for the link information.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* group_name is null.
**/
@@ -5980,6 +6479,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lget_name_by_idx retrieves name of the nth link in a group, according to the order within a specified
* field or index.
*
@@ -5999,7 +6500,7 @@ public class H5 implements java.io.Serializable {
* @return a String for the link name.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* group_name is null.
**/
@@ -6008,6 +6509,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lget_value returns the link value of a symbolic link. Note that this function is a combination
* of H5Lget_info(), H5Lget_val() and for external links, H5Lunpack_elink_val.
*
@@ -6023,7 +6526,7 @@ public class H5 implements java.io.Serializable {
* @return the link type
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6032,6 +6535,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lget_value_by_idx retrieves value of the nth link in a group, according to the order within an index.
* Note that this function is a combination of H5Lget_info(), H5Lget_val() and for external links,
* H5Lunpack_elink_val.
@@ -6054,7 +6559,7 @@ public class H5 implements java.io.Serializable {
* @return the link type
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* group_name is null.
**/
@@ -6064,6 +6569,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Literate iterates through links in a group.
*
* @param grp_id
@@ -6083,13 +6590,15 @@ public class H5 implements java.io.Serializable {
* members were processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Literate(long grp_id, int idx_type, int order, long idx,
H5L_iterate_cb op, H5L_iterate_t op_data)
throws HDF5LibraryException;
/**
+ * @ingroup JH5L
+ *
* H5Literate_by_name iterates through links in a group.
*
* @param grp_id
@@ -6113,7 +6622,7 @@ public class H5 implements java.io.Serializable {
* members were processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* group_name is null.
**/
@@ -6123,6 +6632,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lmove renames a link within an HDF5 file.
*
* @param src_loc
@@ -6139,7 +6650,7 @@ public class H5 implements java.io.Serializable {
* IN: Link access property list identifier to be associated with the new link.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6148,6 +6659,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lvisit recursively visits all links starting from a specified group.
*
* @param grp_id
@@ -6165,12 +6678,14 @@ public class H5 implements java.io.Serializable {
* members were processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Lvisit(long grp_id, int idx_type, int order, H5L_iterate_cb op,
H5L_iterate_t op_data) throws HDF5LibraryException;
/**
+ * @ingroup JH5L
+ *
* H5Lvisit_by_name recursively visits all links starting from a specified group.
*
* @param loc_id
@@ -6192,7 +6707,7 @@ public class H5 implements java.io.Serializable {
* members were processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* group_name is null.
**/
@@ -6202,6 +6717,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5L
+ *
* H5Lis_registered tests whether a user-defined link class is currently registered,
* either by the HDF5 Library or by the user through the use of H5Lregister.
*
@@ -6213,11 +6730,13 @@ public class H5 implements java.io.Serializable {
* user-defined class identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Lis_registered(int link_cls_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5L
+ *
* H5Lunregister unregisters a class of user-defined links, preventing them from being traversed, queried,
* moved, etc.
*
@@ -6225,7 +6744,7 @@ public class H5 implements java.io.Serializable {
* IN: User-defined link class identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Lunregister(int link_cls_id) throws HDF5LibraryException;
@@ -6259,8 +6778,13 @@ public class H5 implements java.io.Serializable {
// H5O: HDF5 1.8 Object Interface API Functions //
// //
// ////////////////////////////////////////////////////////////
+ /**
+ * @defgroup JH5O Java Object (H5O) Interface
+ **/
/**
+ * @ingroup JH5O
+ *
* H5Oclose closes the group, dataset, or named datatype specified.
*
* @param object_id
@@ -6269,7 +6793,7 @@ public class H5 implements java.io.Serializable {
* @return non-negative on success
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Oclose(long object_id) throws HDF5LibraryException
{
@@ -6285,6 +6809,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native int _H5Oclose(long object_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5O
+ *
* H5Ocopy copies the group, dataset or named datatype specified from the file or group specified by
* source location to the destination location.
*
@@ -6302,7 +6828,7 @@ public class H5 implements java.io.Serializable {
* IN: Link creation property list for the new hard link
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6311,6 +6837,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Oget_comment retrieves the comment for the specified object.
*
* @param obj_id
@@ -6319,12 +6847,14 @@ public class H5 implements java.io.Serializable {
* @return the comment
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native String H5Oget_comment(long obj_id)
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5O
+ *
* H5Oset_comment sets the comment for the specified object.
*
* @param obj_id
@@ -6333,7 +6863,7 @@ public class H5 implements java.io.Serializable {
* IN: The new comment.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
* @deprecated As of HDF5 1.8 in favor of object attributes.
**/
@@ -6342,6 +6872,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException;
/**
+ * @ingroup JH5O
+ *
* H5Oget_comment_by_name retrieves the comment for an object.
*
* @param loc_id
@@ -6354,7 +6886,7 @@ public class H5 implements java.io.Serializable {
* @return the comment
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6362,6 +6894,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Oset_comment_by_name sets the comment for the specified object.
*
* @param loc_id
@@ -6374,7 +6908,7 @@ public class H5 implements java.io.Serializable {
* IN: Link access property list identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
*
@@ -6386,6 +6920,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Oget_info retrieves the metadata for an object specified by an identifier.
*
* @param loc_id
@@ -6394,7 +6930,7 @@ public class H5 implements java.io.Serializable {
* @return object information
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6404,6 +6940,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5O
+ *
* H5Oget_info retrieves the metadata for an object specified by an identifier.
*
* @param loc_id
@@ -6414,7 +6952,7 @@ public class H5 implements java.io.Serializable {
* @return object information
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6422,6 +6960,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Oget_info_by_idx retrieves the metadata for an object, identifying the object by an index position.
*
* @param loc_id
@@ -6441,7 +6981,7 @@ public class H5 implements java.io.Serializable {
* @return object information
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6454,6 +6994,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5O
+ *
* H5Oget_info_by_idx retrieves the metadata for an object, identifying the object by an index position.
*
* @param loc_id
@@ -6475,7 +7017,7 @@ public class H5 implements java.io.Serializable {
* @return object information
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6485,6 +7027,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Oget_info_by_name retrieves the metadata for an object, identifying the object by location and
* relative name.
*
@@ -6499,7 +7043,7 @@ public class H5 implements java.io.Serializable {
* @return object information
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6510,6 +7054,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5O
+ *
* H5Oget_info_by_name retrieves the metadata for an object, identifying the object by location and
* relative name.
*
@@ -6526,7 +7072,7 @@ public class H5 implements java.io.Serializable {
* @return object information
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6535,6 +7081,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Olink creates a new hard link to an object in an HDF5 file.
*
* @param obj_id
@@ -6549,7 +7097,7 @@ public class H5 implements java.io.Serializable {
* IN: Access property list identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6558,6 +7106,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Oopen opens a group, dataset, or named datatype specified by a location and a path name.
*
* @param loc_id
@@ -6570,7 +7120,7 @@ public class H5 implements java.io.Serializable {
* @return an object identifier for the opened object
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6590,6 +7140,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Ovisit recursively visits all objects accessible from a specified object.
*
* @param obj_id
@@ -6608,7 +7160,7 @@ public class H5 implements java.io.Serializable {
* members were processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6619,6 +7171,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5O
+ *
* H5Ovisit recursively visits all objects accessible from a specified object.
*
* @param obj_id
@@ -6639,7 +7193,7 @@ public class H5 implements java.io.Serializable {
* members were processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6648,6 +7202,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Ovisit_by_name recursively visits all objects starting from a specified object.
*
* @param loc_id
@@ -6670,7 +7226,7 @@ public class H5 implements java.io.Serializable {
* members were processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6683,6 +7239,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5O
+ *
* H5Ovisit_by_name recursively visits all objects starting from a specified object.
*
* @param loc_id
@@ -6707,7 +7265,7 @@ public class H5 implements java.io.Serializable {
* members were processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6717,6 +7275,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Oexists_by_name is used by an application to check that an existing link resolves to an object.
* Primarily, it is designed to check for dangling soft, external, or user-defined links.
*
@@ -6730,7 +7290,7 @@ public class H5 implements java.io.Serializable {
* @return Returns TRUE or FALSE if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -6738,28 +7298,34 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Odecr_refcount decrements the hard link reference count for an object.
*
* @param object_id
* IN: Object identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Odecr_refcount(long object_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5O
+ *
* H5Oincr_refcount increments the hard link reference count for an object.
*
* @param object_id
* IN: Object identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Oincr_refcount(long object_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5O
+ *
* H5Oopen_by_addr opens a group, dataset, or named datatype using its address within an HDF5 file.
*
* @param loc_id
@@ -6770,7 +7336,7 @@ public class H5 implements java.io.Serializable {
* @return an object identifier for the opened object
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Oopen_by_addr(long loc_id, long addr) throws HDF5LibraryException
{
@@ -6789,6 +7355,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Oopen_by_idx opens the nth object in the group specified.
*
* @param loc_id
@@ -6807,7 +7375,7 @@ public class H5 implements java.io.Serializable {
* @return an object identifier for the opened object
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* group_name is null.
**/
@@ -6828,6 +7396,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5O
+ *
* H5Oflush causes all buffers associated with an object to be immediately flushed to disk without
* removing the data from the cache. object_id can be any named object associated with an HDF5 file
* including a dataset, a group, or a committed datatype.
@@ -6836,11 +7406,13 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the object to be flushed.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Oflush(long object_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5O
+ *
* H5Orefresh causes all buffers associated with an object to be cleared and immediately re-loaded with
* updated contents from disk. This function essentially closes the object, evicts all metadata associated
* with it from the cache, and then re-opens the object. The reopened object is automatically
@@ -6851,11 +7423,13 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the object to be refreshed.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Orefresh(long object_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5O
+ *
* H5Odisable_mdc_flushes corks an object, keeping dirty entries associated with the object in the
* metadata cache.
*
@@ -6863,7 +7437,10 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the object to be corked.
**/
public synchronized static native void H5Odisable_mdc_flushes(long object_id);
+
/**
+ * @ingroup JH5O
+ *
* H5Oenable_mdc_flushes uncorks an object, keeping dirty entries associated with the object in the
* metadata cache.
*
@@ -6871,7 +7448,10 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the object to be uncorked.
**/
public synchronized static native void H5Oenable_mdc_flushes(long object_id);
+
/**
+ * @ingroup JH5O
+ *
* H5Oare_mdc_flushes_disabled retrieve the object's "cork" status.
*
* @param object_id
@@ -6890,8 +7470,13 @@ public class H5 implements java.io.Serializable {
// ////////////////////////////////////////////////////////////
// /////// Generic property list routines ///////
+ /**
+ * @defgroup JH5P Java Property List (H5P) Interface
+ **/
/**
+ * @ingroup JH5P
+ *
* H5Pget_class_name retrieves the name of a generic property list class
*
* @param plid
@@ -6899,11 +7484,13 @@ public class H5 implements java.io.Serializable {
* @return name of a property list if successful; null if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native String H5Pget_class_name(long plid) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pcreate creates a new property as an instance of some property list class.
*
* @param type
@@ -6912,7 +7499,7 @@ public class H5 implements java.io.Serializable {
* @return a property list identifier (plist) if successful; otherwise Fail (-1).
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Pcreate(long type) throws HDF5LibraryException
{
@@ -6928,6 +7515,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Pcreate(long type) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget retrieves a copy of the value for a property in a property list (support integer only)
*
* @param plid
@@ -6937,11 +7526,13 @@ public class H5 implements java.io.Serializable {
* @return value for a property if successful; a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native int H5Pget(long plid, String name) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* Sets a property list value (support integer only)
*
* @param plid
@@ -6953,12 +7544,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native int H5Pset(long plid, String name, int value)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pexist determines whether a property exists within a property list or class
*
* @param plid
@@ -6969,11 +7562,13 @@ public class H5 implements java.io.Serializable {
* exist;
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native boolean H5Pexist(long plid, String name) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_size retrieves the size of a property's value in bytes
*
* @param plid
@@ -6983,11 +7578,13 @@ public class H5 implements java.io.Serializable {
* @return size of a property's value if successful; a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native long H5Pget_size(long plid, String name) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_nprops retrieves the number of properties in a property list or class
*
* @param plid
@@ -6995,11 +7592,13 @@ public class H5 implements java.io.Serializable {
* @return number of properties if successful; a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native long H5Pget_nprops(long plid) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_class returns the property list class for the property list identified by the plist parameter.
*
* @param plist
@@ -7007,11 +7606,13 @@ public class H5 implements java.io.Serializable {
* @return a property list class if successful. Otherwise returns H5P_ROOT (-1).
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Pget_class(long plist) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_class_parent retrieves an identifier for the parent class of a property class
*
* @param plid
@@ -7019,11 +7620,13 @@ public class H5 implements java.io.Serializable {
* @return a valid parent class object identifier if successful; a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native long H5Pget_class_parent(long plid) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pequal determines if two property lists or classes are equal
*
* @param plid1
@@ -7034,11 +7637,13 @@ public class H5 implements java.io.Serializable {
* @return positive value if equal; zero if unequal, a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native int H5Pequal(long plid1, long plid2) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pequal determines if two property lists or classes are equal
*
* @param plid1
@@ -7049,7 +7654,7 @@ public class H5 implements java.io.Serializable {
* @return TRUE if equal, FALSE if unequal
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public static boolean H5P_equal(long plid1, long plid2) throws HDF5LibraryException
{
@@ -7059,6 +7664,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5P
+ *
* H5Pisa_class checks to determine whether a property list is a member of the specified class
*
* @param plist
@@ -7068,11 +7675,13 @@ public class H5 implements java.io.Serializable {
* @return a positive value if equal; zero if unequal; a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native int H5Pisa_class(long plist, long pclass) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pcopy_prop copies a property from one property list or class to another
*
* @param dst_id
@@ -7084,12 +7693,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native int H5Pcopy_prop(long dst_id, long src_id, String name)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Premove removes a property from a property list
*
* @param plid
@@ -7099,11 +7710,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native int H5Premove(long plid, String name) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Punregister removes a property from a property list class
*
* @param plid
@@ -7113,11 +7726,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native int H5Punregister(long plid, String name) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* Closes an existing property list class
*
* @param plid
@@ -7125,7 +7740,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public static int H5Pclose_class(long plid) throws HDF5LibraryException
{
@@ -7141,6 +7756,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native int _H5Pclose_class(long plid) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pclose terminates access to a property list.
*
* @param plist
@@ -7148,7 +7765,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Pclose(long plist) throws HDF5LibraryException
{
@@ -7164,6 +7781,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native int _H5Pclose(long plist) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pcopy copies an existing property list to create a new property list.
*
* @param plist
@@ -7172,7 +7791,7 @@ public class H5 implements java.io.Serializable {
* @return a property list identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Pcopy(long plist) throws HDF5LibraryException
{
@@ -7209,6 +7828,8 @@ public class H5 implements java.io.Serializable {
// typedef herr_t (*H5P_iterate_t)(hid_t id, const char *name, void *iter_data);
/**
+ * @ingroup JH5P
+ *
* H5Pcreate_class_nocb creates an new property class with no callback functions.
*
* @param parent_class
@@ -7219,7 +7840,7 @@ public class H5 implements java.io.Serializable {
* @return a property list identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Pcreate_class_nocb(long parent_class, String name) throws HDF5LibraryException
{
@@ -7255,6 +7876,8 @@ public class H5 implements java.io.Serializable {
// H5P_cls_close_func_t close_data) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pregister2_nocb registers a property list with no callback functions.
*
* @param plist_class
@@ -7267,7 +7890,7 @@ public class H5 implements java.io.Serializable {
* IN: Default value of the property
*
* @exception HDF5LibraryException
- * - Error from the HDF-5 Library.
+ * - Error from the HDF5 Library.
**/
public synchronized static native void H5Pregister2_nocb(long plist_class, String name, long size,
byte[] def_value) throws HDF5LibraryException;
@@ -7278,6 +7901,8 @@ public class H5 implements java.io.Serializable {
// H5P_prp_compare_func_cb prp_cmp, H5P_prp_close_func_cb prp_close) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pinsert2_nocb inserts a property list with no callback functions.
*
* @param plist
@@ -7290,7 +7915,7 @@ public class H5 implements java.io.Serializable {
* IN: Default value of the property
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Pinsert2_nocb(long plist, String name, long size, byte[] value)
throws HDF5LibraryException;
@@ -7301,6 +7926,8 @@ public class H5 implements java.io.Serializable {
// H5P_prp_close_func_cb prp_close) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Piterate iterates over the properties in a property list or class
*
* @param plist
@@ -7316,7 +7943,7 @@ public class H5 implements java.io.Serializable {
* zero if all properties have been processed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* size is null.
*
@@ -7327,6 +7954,8 @@ public class H5 implements java.io.Serializable {
// /////// Object creation property list (OCPL) routines ///////
/**
+ * @ingroup JH5P
+ *
* H5Pget_attr_phase_change retrieves attribute storage phase change thresholds.
*
* @param ocpl_id
@@ -7342,7 +7971,7 @@ public class H5 implements java.io.Serializable {
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* size is null.
*
@@ -7351,6 +7980,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_attr_phase_change sets threshold values for attribute storage on an object. These
* thresholds determine the point at which attribute storage changes
* from compact storage (i.e., storage in the object header)
@@ -7364,7 +7995,7 @@ public class H5 implements java.io.Serializable {
* IN: Minimum number of attributes to be stored in dense storage (Default: 6)
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native void H5Pset_attr_phase_change(long ocpl_id, int max_compact,
@@ -7372,6 +8003,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_attr_creation_order retrieves the settings for tracking and indexing attribute creation order on
* an object.
*
@@ -7381,13 +8014,15 @@ public class H5 implements java.io.Serializable {
* @return Flags specifying whether to track and index attribute creation order
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_attr_creation_order(long ocpl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_attr_creation_order sets flags specifying whether to track and index attribute creation order on
* an object.
*
@@ -7399,13 +8034,15 @@ public class H5 implements java.io.Serializable {
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_attr_creation_order(long ocpl_id, int crt_order_flags)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_obj_track_times queries the object creation property list, ocpl_id, to determine whether object
* times are being recorded.
*
@@ -7415,13 +8052,15 @@ public class H5 implements java.io.Serializable {
* @return TRUE or FALSE, specifying whether object times are being recorded
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native boolean H5Pget_obj_track_times(long ocpl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_obj_track_times sets a property in the object creation property list, ocpl_id, that governs the
* recording of times associated with an object.
*
@@ -7432,13 +8071,15 @@ public class H5 implements java.io.Serializable {
* IN: TRUE or FALSE, specifying whether object times are to be tracked
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native void H5Pset_obj_track_times(long ocpl_id, boolean track_times)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pmodify_filter modifies the specified FILTER in the transient or permanent output filter pipeline
* depending on whether PLIST is a dataset creation or dataset
* transfer property list. The FLAGS argument specifies certain
@@ -7478,7 +8119,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name or an array is null.
*
@@ -7488,6 +8129,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_filter adds the specified filter and corresponding properties to the end of an output filter
* pipeline.
*
@@ -7505,12 +8148,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_filter(long plist, int filter, int flags, long cd_nelmts,
int[] cd_values) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_nfilters returns the number of filters defined in the filter pipeline associated with the
* property list plist.
*
@@ -7520,11 +8165,13 @@ public class H5 implements java.io.Serializable {
* @return the number of filters in the pipeline if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pget_nfilters(long plist) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* 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.
*
@@ -7553,7 +8200,7 @@ public class H5 implements java.io.Serializable {
* @exception ArrayStoreException
* Fatal error on Copyback
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name or an array is null.
*
@@ -7567,6 +8214,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5P
+ *
* H5Pget_filter2 returns information about a filter, specified by its filter number, in a filter
* pipeline, specified by the property list with which it is associated.
*
@@ -7581,6 +8230,8 @@ public class H5 implements java.io.Serializable {
NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_filter_by_id returns information about the filter specified in filter_id, a filter identifier.
* plist_id must be a dataset or group creation property list and filter_id must be in the associated
* filter pipeline. The filter_id and flags parameters are used in the same manner as described in the
@@ -7613,7 +8264,7 @@ public class H5 implements java.io.Serializable {
* @return the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception ArrayIndexOutOfBoundsException
* Fatal error on Copyback
* @exception ArrayStoreException
@@ -7631,6 +8282,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5P
+ *
* H5Pget_filter_by_id2 returns information about a filter, specified by its filter id, in a filter
* pipeline, specified by the property list with which it is associated.
*
@@ -7654,7 +8307,7 @@ public class H5 implements java.io.Serializable {
* @return the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name or an array is null.
*
@@ -7665,6 +8318,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pall_filters_avail query to verify that all the filters set
* in the dataset creation property list are available currently.
*
@@ -7676,12 +8331,14 @@ public class H5 implements java.io.Serializable {
* FALSE if one or more filters not currently available.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Pall_filters_avail(long dcpl_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Premove_filter deletes a filter from the dataset creation property list;
* deletes all filters if filter is H5Z_FILTER_NONE
*
@@ -7693,12 +8350,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value and the size of the user block; if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Premove_filter(long obj_id, long filter)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_deflate sets the compression method for a dataset.
*
* @param plist
@@ -7709,11 +8368,13 @@ public class H5 implements java.io.Serializable {
* @return non-negative if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_deflate(long plist, int level) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fletcher32 sets Fletcher32 checksum of EDC for a dataset creation
* property list or group creation property list.
*
@@ -7723,7 +8384,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value and the size of the user block; if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_fletcher32(long plist)
throws HDF5LibraryException, NullPointerException;
@@ -7731,6 +8392,8 @@ public class H5 implements java.io.Serializable {
// /////// File creation property list (FCPL) routines ///////
/**
+ * @ingroup JH5P
+ *
* H5Pget_userblock retrieves the size of a user block in a file creation property list.
*
* @param plist
@@ -7741,7 +8404,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value and the size of the user block; if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* size is null.
**/
@@ -7749,6 +8412,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_userblock sets the user block size of a file creation property list.
*
* @param plist
@@ -7759,11 +8424,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_userblock(long plist, long size) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_sizes retrieves the size of the offsets and lengths used in an HDF5 file. This function is only
* valid for file creation property lists.
*
@@ -7779,7 +8446,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value with the sizes initialized; if successful;
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* size is null.
* @exception IllegalArgumentException
@@ -7789,6 +8456,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_sizes sets the byte size of the offsets and lengths used to address objects in an HDF5 file.
*
* @param plist
@@ -7801,12 +8470,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_sizes(long plist, int sizeof_addr, int sizeof_size)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_sym_k retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2
* size.
*
@@ -7823,7 +8494,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* size is null.
* @exception IllegalArgumentException
@@ -7833,6 +8504,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_sym_k sets the size of parameters used to control the symbol table nodes.
*
* @param plist
@@ -7845,12 +8518,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_sym_k(long plist, int ik, int lk)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_istore_k queries the 1/2 rank of an indexed storage B-tree.
*
* @param plist
@@ -7861,7 +8536,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* ik array is null.
**/
@@ -7869,6 +8544,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_istore_k sets the size of the parameter used to control the B-trees for indexing chunked
* datasets.
*
@@ -7880,11 +8557,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_istore_k(long plist, int ik) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_shared_mesg_nindexes retrieves number of shared object header message indexes in file creation
* property list.
*
@@ -7895,13 +8574,15 @@ public class H5 implements java.io.Serializable {
* this property list
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_shared_mesg_nindexes(long fcpl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_shared_mesg_nindexes sets the number of shared object header message indexes in the specified
* file creation property list.
*
@@ -7914,7 +8595,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid value of nindexes
*
@@ -7923,6 +8604,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_shared_mesg_index Retrieves the configuration settings for a shared message index.
*
* @param fcpl_id
@@ -7940,7 +8623,7 @@ public class H5 implements java.io.Serializable {
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* mesg_info is null.
* @exception IllegalArgumentException
@@ -7952,6 +8635,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_shared_mesg_index Configures the specified shared object header message index
*
* @param fcpl_id
@@ -7966,7 +8651,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid value of nindexes
*
@@ -7976,6 +8661,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_shared_mesg_phase_change retrieves shared object header message phase change information.
*
* @param fcpl_id
@@ -7992,7 +8679,7 @@ public class H5 implements java.io.Serializable {
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* size is null.
*
@@ -8001,6 +8688,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_shared_mesg_phase_change sets shared object header message storage phase change thresholds.
*
* @param fcpl_id
@@ -8015,7 +8704,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid values of max_list and min_btree.
*
@@ -8025,6 +8714,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_file_space_strategy sets the file space management strategy for the file associated with fcpl_id
* to strategy. There are four strategies that applications can select and they are described in the
* Parameters section.
@@ -8051,7 +8742,7 @@ public class H5 implements java.io.Serializable {
* is not to be modified.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid values of max_list and min_btree.
*
@@ -8061,6 +8752,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_file_space_strategy provides the means for applications to manage the HDF5 file's file space
* strategy for their specific needs.
*
@@ -8074,7 +8767,7 @@ public class H5 implements java.io.Serializable {
* @return the current free-space strategy.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid values of max_list and min_btree.
*
@@ -8084,6 +8777,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_file_space_strategy_persist provides the means for applications to manage the HDF5 file's file
* space strategy for their specific needs.
*
@@ -8093,7 +8788,7 @@ public class H5 implements java.io.Serializable {
* @return the current free-space persistence.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid values of max_list and min_btree.
*
@@ -8102,6 +8797,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_file_space_strategy_threshold provides the means for applications to manage the HDF5 file's file
* space strategy for their specific needs.
*
@@ -8111,7 +8808,7 @@ public class H5 implements java.io.Serializable {
* @return the current free-space section threshold.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid values of max_list and min_btree.
*
@@ -8120,6 +8817,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_file_space_page_size retrieves the file space page size for aggregating small metadata or raw
* data.
*
@@ -8130,7 +8829,7 @@ public class H5 implements java.io.Serializable {
*
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid values of max_list and min_btree.
*
@@ -8139,6 +8838,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_file_space_page_size Sets the file space page size for paged aggregation.
*
* @param fcpl_id
@@ -8147,7 +8848,7 @@ public class H5 implements java.io.Serializable {
* @return the current file space page size.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid values of max_list and min_btree.
*
@@ -8158,6 +8859,8 @@ public class H5 implements java.io.Serializable {
// /////// File access property list (FAPL) routines ///////
/**
+ * @ingroup JH5P
+ *
* H5Pget_alignment retrieves the current settings for alignment properties from a file access property
* list.
*
@@ -8173,7 +8876,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* alignment array is null.
* @exception IllegalArgumentException
@@ -8183,6 +8886,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_alignment sets the alignment properties of a file access property list so that any file object
* &gt;= THRESHOLD bytes will be aligned on an address which is a multiple of ALIGNMENT.
*
@@ -8196,12 +8901,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_alignment(long plist, long threshold, long alignment)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_driver returns the identifier of the low-level file driver associated with the file access
* property list or data transfer property list plid.
*
@@ -8210,11 +8917,13 @@ public class H5 implements java.io.Serializable {
* @return a valid low-level driver identifier if successful; a negative value if failed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*/
public synchronized static native long H5Pget_driver(long plid) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_family_offset gets offset for family driver.
*
* @param fapl_id
@@ -8223,12 +8932,14 @@ public class H5 implements java.io.Serializable {
* @return the offset.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native long H5Pget_family_offset(long fapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_family_offset sets the offset for family driver.
*
* @param fapl_id
@@ -8239,13 +8950,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_family_offset(long fapl_id, long offset)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* 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.
*
@@ -8263,7 +8976,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an array is null.
**/
@@ -8272,6 +8985,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* 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.
*
@@ -8289,13 +9004,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_cache(long plist, int mdc_nelmts, long rdcc_nelmts,
long rdcc_nbytes, double rdcc_w0)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_mdc_config gets the initial metadata cache configuration contained in a file access property
* list. This configuration is used when the file is opened.
*
@@ -8305,12 +9022,14 @@ public class H5 implements java.io.Serializable {
* @return A buffer(H5AC_cache_config_t) for the current metadata cache configuration information
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native H5AC_cache_config_t H5Pget_mdc_config(long plist_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_mdc_config sets the initial metadata cache configuration contained in a file access property
* list and loads it into the instance of H5AC_cache_config_t pointed to by the config_ptr parameter. This
* configuration is used when the file is opened.
@@ -8321,12 +9040,14 @@ public class H5 implements java.io.Serializable {
* IN: H5AC_cache_config_t, the initial metadata cache configuration.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Pset_mdc_config(long plist_id, H5AC_cache_config_t config_ptr)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_gc_references Returns the current setting for the garbage collection references property from a
* file access property list.
*
@@ -8336,11 +9057,13 @@ public class H5 implements java.io.Serializable {
* @return GC is on (true) or off (false)
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Pget_gc_references(long fapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_gc_references Sets the flag for garbage collecting references for the file. Default value for
* garbage collecting references is off.
*
@@ -8352,12 +9075,14 @@ public class H5 implements java.io.Serializable {
* @return non-negative if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_gc_references(long fapl_id, boolean gc_ref)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_fclose_degree returns the degree for the file close behavior for a file access
* property list.
*
@@ -8367,12 +9092,14 @@ public class H5 implements java.io.Serializable {
* @return the degree for the file close behavior
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pget_fclose_degree(long fapl_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fclose_degree sets the degree for the file close behavior.
*
* @param fapl_id
@@ -8383,12 +9110,14 @@ public class H5 implements java.io.Serializable {
* @return non-negative if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_fclose_degree(long fapl_id, int degree)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_meta_block_size the current metadata block size setting.
*
* @param fapl_id
@@ -8397,12 +9126,14 @@ public class H5 implements java.io.Serializable {
* @return the minimum size, in bytes, of metadata block allocations.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native long H5Pget_meta_block_size(long fapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_meta_block_size sets the minimum metadata block size.
*
* @param fapl_id
@@ -8411,13 +9142,15 @@ public class H5 implements java.io.Serializable {
* IN: Minimum size, in bytes, of metadata block allocations.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native void H5Pset_meta_block_size(long fapl_id, long size)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_sieve_buf_size retrieves the current settings for the data sieve buffer size
* property from a file access property list.
*
@@ -8427,11 +9160,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value and the size of the user block; if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Pget_sieve_buf_size(long fapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_sieve_buf_size Sets the maximum size of the data seive buffer used for file
* drivers which are capable of using data sieving. The data sieve
* buffer is used when performing I/O on datasets in the file. Using a
@@ -8449,12 +9184,14 @@ public class H5 implements java.io.Serializable {
* IN: maximum size of the data seive buffer.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Pset_sieve_buf_size(long fapl_id, long size)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_small_data_block_size retrieves the size of a block of small data in a file creation property
* list.
*
@@ -8464,12 +9201,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value and the size of the user block; if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Pget_small_data_block_size(long plist)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_small_data_block_size reserves blocks of size bytes for the contiguous storage of the raw data
* portion of small datasets.
*
@@ -8481,12 +9220,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_small_data_block_size(long plist, long size)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_libver_bounds retrieves the lower and upper bounds on the HDF5 Library versions that indirectly
* determine the object formats versions used when creating objects in the file.
*
@@ -8503,7 +9244,7 @@ public class H5 implements java.io.Serializable {
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* size is null.
*
@@ -8512,6 +9253,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_libver_bounds Sets bounds on library versions, and indirectly format versions, to be used when
* creating objects
*
@@ -8526,7 +9269,7 @@ public class H5 implements java.io.Serializable {
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Argument is Illegal
*
@@ -8535,6 +9278,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_elink_file_cache_size retrieves the size of the external link open file cache.
*
* @param fapl_id
@@ -8543,13 +9288,15 @@ public class H5 implements java.io.Serializable {
* @return External link open file cache size in number of files.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_elink_file_cache_size(long fapl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_elink_file_cache_size sets the number of files that can be held open in an external link open
* file cache.
*
@@ -8559,13 +9306,15 @@ public class H5 implements java.io.Serializable {
* IN: External link open file cache size in number of files.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native void H5Pset_elink_file_cache_size(long fapl_id, int efc_size)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_mdc_log_options sets metadata cache logging options.
*
* @param fapl_id
@@ -8578,7 +9327,7 @@ public class H5 implements java.io.Serializable {
* IN: Whether the logging begins as soon as the file is opened or created.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* location is null.
*
@@ -8588,6 +9337,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_mdc_log_options gets metadata cache logging options.
*
* @param fapl_id
@@ -8601,13 +9352,15 @@ public class H5 implements java.io.Serializable {
* @return the location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII).
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native String H5Pget_mdc_log_options(long fapl_id, boolean[] mdc_log_options)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_metadata_read_attempts retrieves the number of read attempts that is set in the file access
* property list plist_id.
*
@@ -8617,13 +9370,15 @@ public class H5 implements java.io.Serializable {
* @return The number of read attempts.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native long H5Pget_metadata_read_attempts(long plist_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_metadata_read_attempts sets the number of reads that the library will try when reading
* checksummed metadata in an HDF5 file opened with SWMR access. When reading such metadata, the library
* will compare the checksum computed for the metadata just read with the checksum stored within the piece
@@ -8638,13 +9393,15 @@ public class H5 implements java.io.Serializable {
* IN: The number of read attempts which is a value greater than 0.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native void H5Pset_metadata_read_attempts(long plist_id, long attempts)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_evict_on_close retrieves the file access property list setting that determines whether an HDF5
* object will be evicted from the library's metadata cache when it is closed.
*
@@ -8654,12 +9411,14 @@ public class H5 implements java.io.Serializable {
* @return indication if the object will be evicted on close.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native boolean H5Pget_evict_on_close(long fapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_evict_on_close controls the library's behavior of evicting metadata associated with a closed
* object.
*
@@ -8669,13 +9428,15 @@ public class H5 implements java.io.Serializable {
* IN: Whether the HDF5 object should be evicted on close.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native void H5Pset_evict_on_close(long fapl_id, boolean evict_on_close)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_use_file_locking retrieves whether we are using file locking.
*
* @param fapl_id
@@ -8684,13 +9445,15 @@ public class H5 implements java.io.Serializable {
* @return indication if file locking is used.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native boolean H5Pget_use_file_locking(long fapl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_use_file_locking retrieves whether we ignore file locks when they are disabled.
*
* @param fapl_id
@@ -8699,13 +9462,15 @@ public class H5 implements java.io.Serializable {
* @return indication if file locking is ignored.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native boolean H5Pget_ignore_disabled_file_locking(long fapl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_file_locking sets parameters related to file locking.
*
* @param fapl_id
@@ -8719,7 +9484,7 @@ public class H5 implements java.io.Serializable {
* IN: Whether file locking will be ignored when disabled on a file system (useful for Lustre).
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native void H5Pset_file_locking(long fapl_id, boolean use_file_locking,
@@ -8729,6 +9494,8 @@ public class H5 implements java.io.Serializable {
// Dataset creation property list (DCPL) routines //
/**
+ * @ingroup JH5P
+ *
* H5Pget_layout returns the layout of the raw data for a dataset.
*
* @param plist
@@ -8738,11 +9505,13 @@ public class H5 implements java.io.Serializable {
* H5D_LAYOUT_ERROR (-1).
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pget_layout(long plist) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_layout sets the type of storage used store the raw data for a dataset.
*
* @param plist
@@ -8753,11 +9522,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_layout(long plist, int layout) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_chunk retrieves the size of chunks for the raw data of a chunked layout dataset.
*
* @param plist
@@ -8770,7 +9541,7 @@ public class H5 implements java.io.Serializable {
* @return chunk dimensionality successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* dims array is null.
* @exception IllegalArgumentException
@@ -8780,6 +9551,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_chunk sets the size of the chunks used to store a chunked layout dataset.
*
* @param plist
@@ -8792,7 +9565,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* dims array is null.
* @exception IllegalArgumentException
@@ -8802,6 +9575,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_chunk sets the size of the chunks used to store a chunked layout dataset.
*
* @param plist
@@ -8814,7 +9589,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5Exception
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* dims array is null.
* @exception IllegalArgumentException
@@ -8838,6 +9613,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5P
+ *
* H5Pset_virtual maps elements of the virtual dataset (VDS) described by the
* virtual dataspace identifier vspace_id to the elements of the source dataset
* described by the source dataset dataspace identifier src_space_id. The source
@@ -8861,7 +9638,7 @@ public class H5 implements java.io.Serializable {
* selection.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an name string is null.
* @exception IllegalArgumentException
@@ -8872,6 +9649,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_virtual_count gets the number of mappings for a virtual dataset that has the creation property
* list specified by dcpl_id.
*
@@ -8881,7 +9660,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative number of mappings if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* An id is &lt;=0
**/
@@ -8889,6 +9668,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_virtual_vspace takes the dataset creation property list for the virtual dataset, dcpl_id, and
* the mapping index, index, and returns a dataspace identifier for the selection within the virtual
* dataset used in the mapping.
@@ -8901,7 +9682,7 @@ public class H5 implements java.io.Serializable {
* @return a valid dataspace identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* An id is &lt;=0
**/
@@ -8909,6 +9690,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_virtual_srcspace takes the dataset creation property list for the virtual dataset, dcpl_id, and
* the mapping index, index, and returns a dataspace identifier for the selection within the source
* dataset used in the mapping.
@@ -8921,7 +9704,7 @@ public class H5 implements java.io.Serializable {
* @return a valid dataspace identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* An id is &lt;=0
**/
@@ -8929,6 +9712,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_virtual_filename takes the dataset creation property list for the virtual dataset, dcpl_id, the
* mapping index, index, the size of the filename for a source dataset, size, and retrieves the name of
* the file for a source dataset used in the mapping.
@@ -8941,7 +9726,7 @@ public class H5 implements java.io.Serializable {
* @return the name of the file containing the source dataset if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* An id is &lt;=0
**/
@@ -8949,6 +9734,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_virtual_dsetname takes the dataset creation property list for the virtual dataset, dcpl_id, the
* mapping index, index, the size of the dataset name for a source dataset, size, and retrieves the name
* of the source dataset used in the mapping.
@@ -8961,7 +9748,7 @@ public class H5 implements java.io.Serializable {
* @return the name of the source dataset if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* An id is &lt;=0
**/
@@ -8978,7 +9765,7 @@ public class H5 implements java.io.Serializable {
// * @return VDS link open file cache size in number of files.
// *
// * @exception HDF5LibraryException
- // * Error from the HDF-5 Library.
+ // * Error from the HDF5 Library.
// *
// **/
// public synchronized static native int H5Pget_vds_file_cache_size(long fapl_id) throws
@@ -8994,13 +9781,15 @@ public class H5 implements java.io.Serializable {
// * IN: VDS link open file cache size in number of files.
// *
// * @exception HDF5LibraryException
- // * Error from the HDF-5 Library.
+ // * Error from the HDF5 Library.
// *
// **/
// public synchronized static native void H5Pset_vds_file_cache_size(long fapl_id, int efc_size)
// throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_external returns information about an external file.
*
* @param plist
@@ -9027,7 +9816,7 @@ public class H5 implements java.io.Serializable {
* @exception ArrayStoreException
* Fatal error on Copyback
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name or size is null.
* @exception IllegalArgumentException
@@ -9040,6 +9829,8 @@ public class H5 implements java.io.Serializable {
NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_external adds an external file to the list of external files.
*
* @param plist
@@ -9055,7 +9846,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -9063,6 +9854,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_external_count returns the number of external files for the specified dataset.
*
* @param plist
@@ -9071,11 +9864,13 @@ public class H5 implements java.io.Serializable {
* @return the number of external files if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pget_external_count(long plist) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_szip Sets up the use of the szip filter.
*
* @param plist
@@ -9088,13 +9883,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_szip(long plist, int options_mask, int pixels_per_block)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_shuffle Sets up the use of the shuffle filter.
*
* @param plist_id
@@ -9103,13 +9900,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_shuffle(long plist_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_nbit Sets up the use of the N-Bit filter.
*
* @param plist_id
@@ -9118,12 +9917,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_nbit(long plist_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_scaleoffset sets the Scale-Offset filter for a dataset.
*
* @param plist_id
@@ -9136,7 +9937,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid arguments
*
@@ -9145,6 +9946,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_fill_value queries the fill value property of a dataset creation property list.
*
* @param plist_id
@@ -9163,6 +9966,8 @@ public class H5 implements java.io.Serializable {
throws HDF5Exception;
/**
+ * @ingroup JH5P
+ *
* H5Pget_fill_value queries the fill value property of a dataset creation property list.
*
* @param plist_id
@@ -9191,6 +9996,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5P
+ *
* H5Pset_fill_value sets the fill value for a dataset creation property list.
*
* @param plist_id
@@ -9209,6 +10016,8 @@ public class H5 implements java.io.Serializable {
throws HDF5Exception;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fill_value sets the fill value for a dataset creation property list.
*
* @param plist_id
@@ -9237,6 +10046,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5P
+ *
* H5Pset_fill_value checks if the fill value is defined for a dataset creation property list.
*
* @param plist_id
@@ -9257,6 +10068,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_alloc_time Gets space allocation time for dataset during creation.
*
* @param plist_id
@@ -9267,13 +10080,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_alloc_time(long plist_id, int[] alloc_time)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_alloc_time Sets space allocation time for dataset during creation.
*
* @param plist_id
@@ -9284,13 +10099,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_alloc_time(long plist_id, int alloc_time)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fill_time Gets fill value writing time.
*
* @param plist_id
@@ -9301,13 +10118,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_fill_time(long plist_id, int[] fill_time)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fill_time Sets the fill value writing time.
*
* @param plist_id
@@ -9318,13 +10137,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_fill_time(long plist_id, int fill_time)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_chunk_opts Sets the edge chunk option in a dataset creation property list.
*
* @param dcpl_id
@@ -9335,12 +10156,14 @@ public class H5 implements java.io.Serializable {
* 0 - Disables option; partial edge chunks will be compressed.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library
+ * Error from the HDF5 Library
**/
public synchronized static native void H5Pset_chunk_opts(long dcpl_id, int opts)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_chunk_opts retrieves the edge chunk option setting stored in the dataset creation property list
*
* @param dcpl_id
@@ -9349,12 +10172,14 @@ public class H5 implements java.io.Serializable {
* @return The edge chunk option setting.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library
+ * Error from the HDF5 Library
*
*/
public synchronized static native int H5Pget_chunk_opts(long dcpl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_dset_no_attrs_hint accesses the flag for whether or not datasets created by the given dcpl
* will be created with a "minimized" object header.
*
@@ -9364,12 +10189,14 @@ public class H5 implements java.io.Serializable {
* @return true if the given dcpl is set to create minimized dataset object headers, false if not.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Pget_dset_no_attrs_hint(long dcpl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_dset_no_attrs_hint sets the dcpl to minimize (or explicitly to not minimized) dataset object
* headers upon creation.
*
@@ -9380,7 +10207,7 @@ public class H5 implements java.io.Serializable {
* IN: the minimize hint setting
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Pset_dset_no_attrs_hint(long dcpl_id, boolean minimize)
throws HDF5LibraryException;
@@ -9388,6 +10215,8 @@ public class H5 implements java.io.Serializable {
// /////// Dataset access property list (DAPL) routines ///////
/**
+ * @ingroup JH5P
+ *
* Retrieves the maximum possible number of elements in the meta data cache and the maximum possible
* number of bytes and the RDCC_W0 value in the raw data chunk cache on a per-datset basis.
*
@@ -9401,7 +10230,7 @@ public class H5 implements java.io.Serializable {
* IN/OUT: Preemption policy.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an array is null.
**/
@@ -9410,6 +10239,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_chunk_cache sets the number of elements (objects) in the meta data cache and the total number of
* bytes in the raw data chunk cache on a per-datset basis.
*
@@ -9423,13 +10254,15 @@ public class H5 implements java.io.Serializable {
* IN: Preemption policy.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Pset_chunk_cache(long dapl_id, long rdcc_nslots,
long rdcc_nbytes, double rdcc_w0)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_virtual_view takes the access property list for the virtual dataset, dapl_id, and the flag,
* view, and sets the VDS view according to the flag value.
*
@@ -9439,12 +10272,14 @@ public class H5 implements java.io.Serializable {
* IN: Flag specifying the extent of the data to be included in the view.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library
+ * Error from the HDF5 Library
**/
public synchronized static native void H5Pset_virtual_view(long dapl_id, int view)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_virtual_view takes the virtual dataset access property list, dapl_id, and retrieves the flag,
* view, set by the H5Pset_virtual_view call.
*
@@ -9454,12 +10289,14 @@ public class H5 implements java.io.Serializable {
* @return The flag specifying the view of the virtual dataset.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library
+ * Error from the HDF5 Library
*
*/
public synchronized static native int H5Pget_virtual_view(long dapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_virtual_printf_gap sets the access property list for the virtual dataset, dapl_id, to instruct
* the library to stop looking for the mapped data stored in the files and/or datasets with the
* printf-style names after not finding gap_size files and/or datasets. The found source files and
@@ -9472,12 +10309,14 @@ public class H5 implements java.io.Serializable {
* the extent of an unlimited virtual dataset with printf-style mappings.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library
+ * Error from the HDF5 Library
**/
public synchronized static native void H5Pset_virtual_printf_gap(long dapl_id, long gap_size)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_virtual_printf_gap returns the maximum number of missing printf-style files and/or datasets for
* determining the extent of an unlimited virtual dataaset, gap_size, using the access property list for
* the virtual dataset, dapl_id.
@@ -9489,13 +10328,15 @@ public class H5 implements java.io.Serializable {
* the extent of an unlimited virtual dataset with printf-style mappings.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library
+ * Error from the HDF5 Library
*
*/
public synchronized static native long H5Pget_virtual_printf_gap(long dapl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_virtual_prefix Retrieves prefix applied to virtual file paths.
*
* @param dapl_id
@@ -9504,12 +10345,14 @@ public class H5 implements java.io.Serializable {
* @return the prefix to be applied to virtual file paths.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native String H5Pget_virtual_prefix(long dapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_virtual_prefix Sets prefix to be applied to virtual file paths.
*
* @param dapl_id
@@ -9518,7 +10361,7 @@ public class H5 implements java.io.Serializable {
* IN: Prefix to be applied to virtual file paths
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* prefix is null.
*
@@ -9527,6 +10370,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_efile_prefix Retrieves prefix applied to external file paths.
*
* @param dapl_id
@@ -9535,12 +10380,14 @@ public class H5 implements java.io.Serializable {
* @return the prefix to be applied to external file paths.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native String H5Pget_efile_prefix(long dapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_efile_prefix Sets prefix to be applied to external file paths.
*
* @param dapl_id
@@ -9549,7 +10396,7 @@ public class H5 implements java.io.Serializable {
* IN: Prefix to be applied to external file paths
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* prefix is null.
*
@@ -9566,6 +10413,8 @@ public class H5 implements java.io.Serializable {
// /////// Dataset xfer property list (DXPL) routines ///////
/**
+ * @ingroup JH5P
+ *
* H5Pget_data_transform retrieves the data transform expression previously set in the dataset transfer
* property list plist_id by H5Pset_data_transform.
*
@@ -9581,7 +10430,7 @@ public class H5 implements java.io.Serializable {
*
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Size is &lt;= 0.
*
@@ -9591,6 +10440,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_data_transform sets a data transform expression
*
* @param plist_id
@@ -9601,7 +10452,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative valule if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* expression is null.
*
@@ -9610,7 +10461,9 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
- * HH5Pget_buffer gets type conversion and background buffers. Returns buffer size, in bytes, if
+ * @ingroup JH5P
+ *
+ * H5Pget_buffer gets type conversion and background buffers. Returns buffer size, in bytes, if
* successful; otherwise 0 on failure.
*
* @param plist
@@ -9623,7 +10476,7 @@ public class H5 implements java.io.Serializable {
* @return buffer size, in bytes, if successful; otherwise 0 on failure
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* plist is invalid.
**/
@@ -9631,6 +10484,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_buffer_size gets type conversion and background buffer size, in bytes, if successful;
* otherwise 0 on failure.
*
@@ -9640,7 +10495,7 @@ public class H5 implements java.io.Serializable {
* @return buffer size, in bytes, if successful; otherwise 0 on failure
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* plist is invalid.
**/
@@ -9648,6 +10503,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_buffer sets type conversion and background buffers. status to TRUE or FALSE.
*
* Given a dataset transfer property list, H5Pset_buffer sets the maximum size for the type conversion
@@ -9668,7 +10525,7 @@ public class H5 implements java.io.Serializable {
* Size, in bytes, of the type conversion and background buffers.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* plist is invalid.
**/
@@ -9676,6 +10533,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_edc_check gets the error-detecting algorithm in use.
*
* @param plist
@@ -9684,11 +10543,13 @@ public class H5 implements java.io.Serializable {
* @return the error-detecting algorithm
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pget_edc_check(long plist) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_edc_check sets the error-detecting algorithm.
*
* @param plist
@@ -9699,11 +10560,13 @@ public class H5 implements java.io.Serializable {
* @return non-negative if succeed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_edc_check(long plist, int check) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_btree_ratio Get the B-tree split ratios for a dataset transfer property list.
*
* @param plist_id
@@ -9718,7 +10581,7 @@ public class H5 implements java.io.Serializable {
* @return non-negative if succeed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an input array is null.
**/
@@ -9727,6 +10590,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_btree_ratio Sets B-tree split ratios for a dataset transfer property list. The split ratios
* determine what percent of children go in the first node when a node splits.
*
@@ -9742,12 +10607,14 @@ public class H5 implements java.io.Serializable {
* @return non-negative if succeed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Pset_btree_ratios(long plist_id, double left, double middle,
double right) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_hyper_vector_size reads values previously set with H5Pset_hyper_vector_size.
*
* @param dxpl_id
@@ -9758,13 +10625,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_hyper_vector_size(long dxpl_id, long[] vector_size)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_hyper_vector_size sets the number of
* "I/O vectors" (offset and length pairs) which are to be
* accumulated in memory before being issued to the lower levels
@@ -9784,7 +10653,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_hyper_vector_size(long dxpl_id, long vector_size)
@@ -9793,6 +10662,8 @@ public class H5 implements java.io.Serializable {
// /////// Link creation property list (LCPL) routines ///////
/**
+ * @ingroup JH5P
+ *
* H5Pget_create_intermediate_group determines whether property is set to enable creating missing
* intermediate groups.
*
@@ -9802,13 +10673,15 @@ public class H5 implements java.io.Serializable {
* @return Boolean true or false
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native boolean H5Pget_create_intermediate_group(long lcpl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_create_intermediate_group specifies in property list whether to create missing intermediate
* groups
*
@@ -9820,7 +10693,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative valule if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_create_intermediate_group(long lcpl_id,
@@ -9830,6 +10703,8 @@ public class H5 implements java.io.Serializable {
// /////// Group creation property list (GCPL) routines ///////
/**
+ * @ingroup JH5P
+ *
* H5Pget_local_heap_size_hint Retrieves the anticipated size of the local heap for original-style groups.
*
* @param gcpl_id
@@ -9838,13 +10713,15 @@ public class H5 implements java.io.Serializable {
* @return size_hint, the anticipated size of local heap
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native long H5Pget_local_heap_size_hint(long gcpl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_local_heap_size_hint Specifies the anticipated maximum size of a local heap.
*
* @param gcpl_id
@@ -9855,13 +10732,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_local_heap_size_hint(long gcpl_id, long size_hint)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_link_phase_change Queries the settings for conversion between compact and dense groups.
*
* @param gcpl_id
@@ -9878,7 +10757,7 @@ public class H5 implements java.io.Serializable {
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* size is null.
*
@@ -9887,6 +10766,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_link_phase_change Sets the parameters for conversion between compact and dense groups.
*
* @param gcpl_id
@@ -9899,7 +10780,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid values of max_compact and min_dense.
*
@@ -9909,6 +10790,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_est_link_info Queries data required to estimate required local heap or object header size.
*
* @param gcpl_id
@@ -9925,7 +10808,7 @@ public class H5 implements java.io.Serializable {
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* link_info is null.
*
@@ -9934,6 +10817,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_est_link_info Sets estimated number of links and length of link names in a group.
*
* @param gcpl_id
@@ -9946,7 +10831,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid values to est_num_entries and est_name_len.
*
@@ -9956,6 +10841,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_link_creation_order queries the group creation property list, gcpl_id, and returns a flag
* indicating whether link creation order is tracked and/or indexed in a group.
*
@@ -9965,13 +10852,15 @@ public class H5 implements java.io.Serializable {
* @return crt_order_flags -Creation order flag(s)
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_link_creation_order(long gcpl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_link_creation_order Sets flags in a group creation property list, gcpl_id, for tracking and/or
* indexing links on creation order.
*
@@ -9984,7 +10873,7 @@ public class H5 implements java.io.Serializable {
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_link_creation_order(long gcpl_id, int crt_order_flags)
@@ -9993,6 +10882,8 @@ public class H5 implements java.io.Serializable {
// /////// String creation property list (STRCPL) routines ///////
/**
+ * @ingroup JH5P
+ *
* H5Pget_char_encoding gets the character encoding of the string.
*
* @param plist_id
@@ -10001,12 +10892,14 @@ public class H5 implements java.io.Serializable {
* @return Returns the character encoding of the string.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_char_encoding(long plist_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_char_encoding sets the character encoding of the string.
*
* @param plist_id
@@ -10015,7 +10908,7 @@ public class H5 implements java.io.Serializable {
* IN: the character encoding of the string
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native void H5Pset_char_encoding(long plist_id, int encoding)
@@ -10024,6 +10917,8 @@ public class H5 implements java.io.Serializable {
// /////// Link access property list (LAPL) routines ///////
/**
+ * @ingroup JH5P
+ *
* H5Pget_nlinks retrieves the maximum number of soft or user-defined link traversals allowed, nlinks,
* before the library assumes it has found a cycle and aborts the traversal. This value is retrieved from
* the link access property list lapl_id.
@@ -10034,12 +10929,14 @@ public class H5 implements java.io.Serializable {
* @return Returns a Maximum number of links to traverse.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native long H5Pget_nlinks(long lapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_nlinks sets the maximum number of soft or user-defined link traversals allowed, nlinks, before
* the library assumes it has found a cycle and aborts the traversal. This value is set in the link access
* property list lapl_id.
@@ -10052,7 +10949,7 @@ public class H5 implements java.io.Serializable {
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Argument is Illegal
*
@@ -10061,6 +10958,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, IllegalArgumentException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_elink_prefix Retrieves prefix applied to external link paths.
*
* @param lapl_id
@@ -10072,7 +10971,7 @@ public class H5 implements java.io.Serializable {
* the NULL terminator; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* prefix is null.
*
@@ -10081,6 +10980,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_elink_prefix Sets prefix to be applied to external link paths.
*
* @param lapl_id
@@ -10091,7 +10992,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* prefix is null.
*
@@ -10100,6 +11001,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_elink_fapl Retrieves the file access property list identifier associated with the link access
* property list.
*
@@ -10109,7 +11012,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public static long H5Pget_elink_fapl(long lapl_id) throws HDF5LibraryException
@@ -10126,6 +11029,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Pget_elink_fapl(long lapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_elink_fapl sets a file access property list for use in accessing a file pointed to by an
* external link.
*
@@ -10137,13 +11042,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_elink_fapl(long lapl_id, long fapl_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_elink_acc_flags retrieves the external link traversal file access flag from the specified link
* access property list.
*
@@ -10153,12 +11060,14 @@ public class H5 implements java.io.Serializable {
* @return File access flag for link traversal.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_elink_acc_flags(long lapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_elink_acc_flags Sets the external link traversal file access flag in a link access property
* list.
*
@@ -10170,7 +11079,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception IllegalArgumentException
* Invalid Flag values.
*
@@ -10181,6 +11090,8 @@ public class H5 implements java.io.Serializable {
// /////// Object copy property list (OCPYPL) routines ///////
/**
+ * @ingroup JH5P
+ *
* H5Pget_copy_object retrieves the properties to be used when an object is copied.
*
* @param ocp_plist_id
@@ -10189,12 +11100,14 @@ public class H5 implements java.io.Serializable {
* @return Copy option(s) set in the object copy property list
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_copy_object(long ocp_plist_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_copy_object Sets properties to be used when an object is copied.
*
* @param ocp_plist_id
@@ -10203,13 +11116,15 @@ public class H5 implements java.io.Serializable {
* IN: Copy option(s) to be set
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native void H5Pset_copy_object(long ocp_plist_id, int copy_options)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_version retrieves the version information of various objects for a file creation property list.
*
* @param plist
@@ -10226,7 +11141,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value, with the values of version_info initialized, if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* version_info is null.
* @exception IllegalArgumentException
@@ -10241,6 +11156,8 @@ public class H5 implements java.io.Serializable {
// /////// file drivers property list routines ///////
/**
+ * @ingroup JH5P
+ *
* H5Pget_fapl_core retrieve H5FD_CORE I/O settings.
*
* @param fapl_id
@@ -10251,7 +11168,7 @@ public class H5 implements java.io.Serializable {
* OUT: write to file name on flush setting
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native void H5Pget_fapl_core(long fapl_id, long[] increment,
@@ -10259,6 +11176,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fapl_core modifies the file access property list to use the H5FD_CORE driver.
*
* @param fapl_id
@@ -10271,7 +11190,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_fapl_core(long fapl_id, long increment,
@@ -10279,6 +11198,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_fapl_direct queries properties set by the H5Pset_fapl_direct.
*
* @param fapl_id
@@ -10291,13 +11212,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_fapl_direct(long fapl_id, long[] info)
throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fapl_direct Sets up use of the direct I/O driver.
*
* @param fapl_id
@@ -10312,13 +11235,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_fapl_direct(long fapl_id, long alignment, long block_size,
long cbuf_size) throws HDF5LibraryException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_fapl_family Returns information about the family file access property list.
*
* @param fapl_id
@@ -10331,7 +11256,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pget_fapl_family(long fapl_id, long[] memb_size,
@@ -10339,6 +11264,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fapl_family Sets up use of the direct I/O driver.
*
* @param fapl_id
@@ -10351,13 +11278,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_fapl_family(long fapl_id, long memb_size, long memb_fapl_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fapl_hdfs Modify the file access property list to use the H5FD_HDFS driver.
*
* @param fapl_id
@@ -10368,13 +11297,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_fapl_hdfs(long fapl_id, H5FD_hdfs_fapl_t fapl_conf)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_fapl_hdfs gets the properties hdfs I/O driver.
*
* @param fapl_id
@@ -10383,13 +11314,15 @@ public class H5 implements java.io.Serializable {
* @return the properties of the hdfs driver.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native H5FD_hdfs_fapl_t H5Pget_fapl_hdfs(long fapl_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_fapl_multi Sets up use of the multi I/O driver.
*
* @param fapl_id
@@ -10407,7 +11340,7 @@ public class H5 implements java.io.Serializable {
* @return a boolean value; Allows read-only access to incomplete file sets when TRUE.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an array is null.
*
@@ -10418,6 +11351,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fapl_multi Sets up use of the multi I/O driver.
*
* @param fapl_id
@@ -10435,7 +11370,7 @@ public class H5 implements java.io.Serializable {
* IN: Allows read-only access to incomplete file sets when TRUE.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an array is null.
*
@@ -10446,6 +11381,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fapl_log Sets up the logging virtual file driver (H5FD_LOG) for use. H5Pset_fapl_log modifies
* the file access property list to use the logging driver, H5FD_LOG. The logging virtual file driver
* (VFD) is a clone of the standard SEC2 (H5FD_SEC2) driver with additional facilities for logging VFD
@@ -10461,7 +11398,7 @@ public class H5 implements java.io.Serializable {
* IN: The size of the logging buffers, in bytes.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* logfile is null.
**/
@@ -10470,6 +11407,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fapl_sec2 Sets up use of the sec2 I/O driver.
*
* @param fapl_id
@@ -10478,13 +11417,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_fapl_sec2(long fapl_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fapl_split Sets up use of the split I/O driver. Makes the multi driver act like the
* old split driver which stored meta data in one file and raw
* data in another file
@@ -10501,7 +11442,7 @@ public class H5 implements java.io.Serializable {
* IN: File access property list identifier raw data
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native void
@@ -10509,6 +11450,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fapl_stdio Sets up use of the stdio I/O driver.
*
* @param fapl_id
@@ -10517,13 +11460,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_fapl_stdio(long fapl_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fapl_windows Sets up use of the windows I/O driver.
*
* @param fapl_id
@@ -10532,13 +11477,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_fapl_windows(long fapl_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pset_fapl_ros3 Modify the file access property list to use the H5FD_ROS3 driver.
*
* @param fapl_id
@@ -10549,13 +11496,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native int H5Pset_fapl_ros3(long fapl_id, H5FD_ros3_fapl_t fapl_conf)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5P
+ *
* H5Pget_fapl_ros3 gets the properties of the ros3 I/O driver.
*
* @param fapl_id
@@ -10564,7 +11513,7 @@ public class H5 implements java.io.Serializable {
* @return the properties of the ros3 driver.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
*
**/
public synchronized static native H5FD_ros3_fapl_t H5Pget_fapl_ros3(long fapl_id)
@@ -10652,6 +11601,12 @@ public class H5 implements java.io.Serializable {
// //
// ////////////////////////////////////////////////////////////
/**
+ * @defgroup JH5PL Java Plugin (H5PL) Interface
+ **/
+
+ /**
+ * @ingroup JH5PL
+ *
* H5PLset_loading_state uses one argument to enable or disable individual plugins.
* The plugin_flags parameter is an encoded integer in which each bit controls a specific
* plugin or class of plugins.
@@ -10673,12 +11628,14 @@ public class H5 implements java.io.Serializable {
*
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5PLset_loading_state(int plugin_flags)
throws HDF5LibraryException;
/**
+ * @ingroup JH5PL
+ *
* H5PLget_loading_state retrieves the state of the dynamic plugins flag, plugin_flags..
*
* @return the list of dynamic plugin types that are enabled or disabled.
@@ -10688,33 +11645,39 @@ public class H5 implements java.io.Serializable {
* If the value of plugin_flags is 0 (zero), all dynamic plugins are disabled.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5PLget_loading_state() throws HDF5LibraryException;
/**
+ * @ingroup JH5PL
+ *
* H5PLappend inserts the plugin path at the end of the table.
*
* @param plugin_path
* IN: Path for location of filter plugin libraries.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5PLappend(String plugin_path) throws HDF5LibraryException;
/**
+ * @ingroup JH5PL
+ *
* H5PLprepend inserts the plugin path at the beginning of the table.
*
* @param plugin_path
* IN: Path for location of filter plugin libraries.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5PLprepend(String plugin_path) throws HDF5LibraryException;
/**
+ * @ingroup JH5PL
+ *
* H5PLreplace replaces the plugin path at the specified index.
*
* @param plugin_path
@@ -10723,12 +11686,14 @@ public class H5 implements java.io.Serializable {
* IN: The table index (0-based).
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5PLreplace(String plugin_path, int index)
throws HDF5LibraryException;
/**
+ * @ingroup JH5PL
+ *
* H5PLinsert inserts the plugin path at the specified index.
*
* @param plugin_path
@@ -10737,23 +11702,27 @@ public class H5 implements java.io.Serializable {
* IN: The table index (0-based).
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5PLinsert(String plugin_path, int index)
throws HDF5LibraryException;
/**
+ * @ingroup JH5PL
+ *
* H5PLremove removes the plugin path at the specified index.
*
* @param index
* IN: The table index (0-based).
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5PLremove(int index) throws HDF5LibraryException;
/**
+ * @ingroup JH5PL
+ *
* H5PLget retrieves the plugin path at the specified index.
*
* @param index
@@ -10762,17 +11731,19 @@ public class H5 implements java.io.Serializable {
* @return the current path at the index in plugin path table
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native String H5PLget(int index) throws HDF5LibraryException;
/**
+ * @ingroup JH5PL
+ *
* H5PLsize retrieves the size of the current list of plugin paths.
*
* @return the current number of paths in the plugin path table
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5PLsize() throws HDF5LibraryException;
@@ -10782,11 +11753,17 @@ public class H5 implements java.io.Serializable {
// //
// ////////////////////////////////////////////////////////////
+ /**
+ * @defgroup JH5R Java Reference (H5R) Interface
+ **/
+
private synchronized static native int H5Rcreate(byte[] ref, long loc_id, String name, int ref_type,
long space_id)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5R
+ *
* H5Rcreate creates the reference, ref, of the type specified in ref_type, pointing to the object name
* located at loc_id.
*
@@ -10802,7 +11779,7 @@ public class H5 implements java.io.Serializable {
* @return the reference (byte[]) if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an input array is null.
* @exception IllegalArgumentException
@@ -10825,6 +11802,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5R
+ *
* Given a reference to some object, H5Rdereference opens that object and return an identifier.
*
* @param dataset
@@ -10839,7 +11818,7 @@ public class H5 implements java.io.Serializable {
* @return valid identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* output array is null.
* @exception IllegalArgumentException
@@ -10862,6 +11841,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5R
+ *
* H5Rget_name retrieves a name for the object identified by ref.
*
* @param loc_id
@@ -10879,7 +11860,7 @@ public class H5 implements java.io.Serializable {
* the identifier. Otherwise returns a negative value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* size is null.
* @exception IllegalArgumentException
@@ -10890,6 +11871,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5R
+ *
* H5Rget_name_string retrieves a name for the object identified by ref.
*
* @param loc_id
@@ -10903,7 +11886,7 @@ public class H5 implements java.io.Serializable {
* the identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* size is null.
* @exception IllegalArgumentException
@@ -10913,6 +11896,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5R
+ *
* H5Rget_obj_type Given a reference to an object ref, H5Rget_obj_type returns the type of the object
* pointed to.
*
@@ -10926,7 +11911,7 @@ public class H5 implements java.io.Serializable {
* @return Returns the object type
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an input array is null.
* @exception IllegalArgumentException
@@ -10936,6 +11921,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5R
+ *
* H5Rget_obj_type2 Retrieves the type of object that an object reference points to.
*
* @see public static int H5Rget_obj_type(int loc_id, int ref_type, byte ref[])
@@ -10945,6 +11932,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5R
+ *
* 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.
*
@@ -10958,7 +11947,7 @@ public class H5 implements java.io.Serializable {
* @return a valid identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an input array is null.
* @exception IllegalArgumentException
@@ -10984,10 +11973,15 @@ public class H5 implements java.io.Serializable {
// H5S: Dataspace Interface Functions //
// //
// ////////////////////////////////////////////////////////////
+ /**
+ * @defgroup JH5S Java Dataspace (H5S) Interface
+ **/
/**************** Operations on dataspaces ********************/
/**
+ * @ingroup JH5S
+ *
* H5Screate creates a new dataspace of a particular type.
*
* @param type
@@ -10996,7 +11990,7 @@ public class H5 implements java.io.Serializable {
* @return a dataspace identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Screate(int type) throws HDF5LibraryException
{
@@ -11012,6 +12006,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Screate(int type) throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Screate_simple creates a new simple data space and opens it for access.
*
* @param rank
@@ -11024,7 +12020,7 @@ public class H5 implements java.io.Serializable {
* @return a dataspace identifier
*
* @exception HDF5Exception
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* dims or maxdims is null.
**/
@@ -11044,6 +12040,8 @@ public class H5 implements java.io.Serializable {
throws HDF5Exception, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Sset_extent_simple sets or resets the size of an existing dataspace.
*
* @param space_id
@@ -11058,13 +12056,15 @@ public class H5 implements java.io.Serializable {
* @return a dataspace identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Sset_extent_simple(long space_id, int rank, long[] current_size,
long[] maximum_size)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Sset_extent_simple sets or resets the size of an existing dataspace.
*
* @param space_id
@@ -11079,7 +12079,7 @@ public class H5 implements java.io.Serializable {
* @return a dataspace identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static long H5Sset_extent_simple(long space_id, int rank, byte[] current_size,
byte[] maximum_size)
@@ -11094,6 +12094,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5S
+ *
* H5Scopy creates a new dataspace which is an exact copy of the dataspace identified by space_id.
*
* @param space_id
@@ -11101,7 +12103,7 @@ public class H5 implements java.io.Serializable {
* @return a dataspace identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Scopy(long space_id) throws HDF5LibraryException
{
@@ -11117,6 +12119,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Scopy(long space_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sclose releases a dataspace.
*
* @param space_id
@@ -11125,7 +12129,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Sclose(long space_id) throws HDF5LibraryException
{
@@ -11141,6 +12145,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native int _H5Sclose(long space_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sencode converts a data space description into binary form in a buffer.
*
* @param obj_id
@@ -11149,12 +12155,14 @@ public class H5 implements java.io.Serializable {
* @return the buffer for the object to be encoded into.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native byte[] H5Sencode(long obj_id)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Sdecode reconstructs the HDF5 data space object and returns a new object handle for it.
*
* @param buf
@@ -11163,7 +12171,7 @@ public class H5 implements java.io.Serializable {
* @return a new object handle
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -11171,6 +12179,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Sget_simple_extent_npoints determines the number of elements in a dataspace.
*
* @param space_id
@@ -11179,12 +12189,14 @@ public class H5 implements java.io.Serializable {
* @return the number of elements in the dataspace if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Sget_simple_extent_npoints(long space_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sget_simple_extent_ndims determines the dimensionality (or rank) of a dataspace.
*
* @param space_id
@@ -11193,12 +12205,14 @@ public class H5 implements java.io.Serializable {
* @return the number of dimensions in the dataspace if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Sget_simple_extent_ndims(long space_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sget_simple_extent_dims returns the size and maximum sizes of each dimension of a dataspace through
* the dims and maxdims parameters.
*
@@ -11212,7 +12226,7 @@ public class H5 implements java.io.Serializable {
* @return the number of dimensions in the dataspace if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* dims or maxdims is null.
**/
@@ -11221,6 +12235,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Sis_simple determines whether a dataspace is a simple dataspace.
*
* @param space_id
@@ -11229,11 +12245,13 @@ public class H5 implements java.io.Serializable {
* @return true if is a simple dataspace
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Sis_simple(long space_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sget_simple_extent_type queries a dataspace to determine the current class of a dataspace.
*
* @param space_id
@@ -11242,12 +12260,14 @@ public class H5 implements java.io.Serializable {
* @return a dataspace class name if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Sget_simple_extent_type(long space_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sset_extent_none removes the extent from a dataspace and sets the type to H5S_NONE.
*
* @param space_id
@@ -11256,11 +12276,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Sset_extent_none(long space_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sextent_copy copies the extent from source_space_id to dest_space_id. This action may change the type
* of the dataspace.
*
@@ -11272,12 +12294,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Sextent_copy(long dest_space_id, long source_space_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sextent_equal determines whether the dataspace extents of two dataspaces, space1_id and space2_id,
* are equal.
*
@@ -11289,7 +12313,7 @@ public class H5 implements java.io.Serializable {
* @return true if successful, else false
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Sextent_equal(long first_space_id, long second_space_id)
throws HDF5LibraryException;
@@ -11297,6 +12321,8 @@ public class H5 implements java.io.Serializable {
/***************** Operations on dataspace selections *****************/
/**
+ * @ingroup JH5S
+ *
* H5Sget_select_type retrieves the type of selection currently defined for the dataspace space_id.
*
* @param space_id
@@ -11305,11 +12331,13 @@ public class H5 implements java.io.Serializable {
* @return the dataspace selection type if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Sget_select_type(long space_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sget_select_npoints determines the number of elements in the current selection of a dataspace.
*
* @param space_id
@@ -11318,11 +12346,13 @@ public class H5 implements java.io.Serializable {
* @return the number of elements in the selection if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Sget_select_npoints(long space_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sselect_copy copies all the selection information (including offset) from the source
* dataspace to the destination dataspace.
*
@@ -11332,12 +12362,14 @@ public class H5 implements java.io.Serializable {
* ID of the source dataspace
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Sselect_copy(long dst_id, long src_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sselect_valid verifies that the selection for the dataspace.
*
* @param space_id
@@ -11346,11 +12378,13 @@ public class H5 implements java.io.Serializable {
* @return true if the selection is contained within the extent and FALSE if it is not or is an error.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Sselect_valid(long space_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sselect_adjust moves a selection by subtracting an offset from it.
*
* @param space_id
@@ -11359,7 +12393,7 @@ public class H5 implements java.io.Serializable {
* Offset to subtract
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* offset is null.
**/
@@ -11367,8 +12401,10 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Sget_select_bounds retrieves the coordinates of the bounding box containing the current selection and
- * places them into user-supplied buffers. <P> The start and end buffers must be large enough to hold the
+ * places them into user-supplied buffers. <p> The start and end buffers must be large enough to hold the
* dataspace rank number of coordinates.
*
* @param space_id
@@ -11381,7 +12417,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful,with start and end initialized.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* start or end is null.
**/
@@ -11389,6 +12425,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Sselect_shape_same checks to see if the current selection in the dataspaces are the same
* dimensionality and shape.
* This is primarily used for reading the entire selection in one swoop.
@@ -11402,12 +12440,14 @@ public class H5 implements java.io.Serializable {
* false otherwise
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Sselect_shape_same(long space1_id, long space2_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sselect_intersect_block checks to see if the current selection in the
* dataspace intersects with the block given.
*
@@ -11422,7 +12462,7 @@ public class H5 implements java.io.Serializable {
* FALSE otherwise
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* offset is null.
**/
@@ -11431,6 +12471,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Soffset_simple sets the offset of a simple dataspace space_id.
*
* @param space_id
@@ -11441,7 +12483,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* offset array is null.
**/
@@ -11449,6 +12491,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Soffset_simple sets the offset of a simple dataspace space_id.
*
* @param space_id
@@ -11459,7 +12503,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* offset array is null.
**/
@@ -11480,6 +12524,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5S
+ *
* H5Sselect_all selects the entire extent of the dataspace space_id.
*
* @param space_id
@@ -11488,11 +12534,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Sselect_all(long space_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sselect_none resets the selection region for the dataspace space_id to include no elements.
*
* @param space_id
@@ -11501,11 +12549,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Sselect_none(long space_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sselect_elements selects array elements to be included in the selection for the space_id dataspace.
*
* @param space_id
@@ -11520,13 +12570,15 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
private synchronized static native int H5Sselect_elements(long space_id, int op, int num_elements,
byte[] coord)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Sselect_elements selects array elements to be included in the selection for the space_id dataspace.
*
* @param space_id
@@ -11543,7 +12595,7 @@ public class H5 implements java.io.Serializable {
* @exception HDF5Exception
* Error in the data conversion
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* cord array is
**/
@@ -11565,6 +12617,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5S
+ *
* H5Sget_select_elem_npoints returns the number of element points in the current dataspace selection.
*
* @param spaceid
@@ -11573,12 +12627,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Sget_select_elem_npoints(long spaceid)
throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sget_select_elem_pointlist returns an array of of element points in the current dataspace selection.
* The point coordinates have the same dimensionality (rank) as the dataspace they are located within, one
* coordinate per point.
@@ -11595,7 +12651,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -11604,6 +12660,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Sselect_hyperslab selects a hyperslab region to add to the current selected region for the dataspace
* specified by space_id. The start, stride, count, and block arrays must be the same size as the rank of
* the dataspace.
@@ -11624,7 +12682,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an input array is null.
* @exception IllegalArgumentException
@@ -11647,6 +12705,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5S
+ *
* H5Sselect_hyperslab selects a hyperslab region to add to the current selected region for the dataspace
* specified by space_id. The start, stride, count, and block arrays must be the same size as the rank of
* the dataspace.
@@ -11667,7 +12727,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an input array is null.
* @exception IllegalArgumentException
@@ -11678,6 +12738,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5S
+ *
* H5Scombine_hyperslab combines a hyperslab selection with the current selection for a dataspace,
* creating a new dataspace to return the generated selection.
* If the current selection is not a hyperslab, it is freed and the hyperslab
@@ -11701,7 +12763,7 @@ public class H5 implements java.io.Serializable {
* @return a dataspace ID on success / H5I_INVALID_HID on failure
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an input array is null.
* @exception IllegalArgumentException
@@ -11712,6 +12774,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5S
+ *
* H5Smodify_select refine an existing hyperslab selection with an operation, using a second
* hyperslab. The first selection is modified to contain the result of
* space1 operated on by space2.
@@ -11724,12 +12788,14 @@ public class H5 implements java.io.Serializable {
* ID of the source dataspace
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Smodify_select(long space1_id, int op, long space2_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Scombine_select combines two existing hyperslab selections with an operation, returning
* a new dataspace with the resulting selection. The dataspace extent from
* space1 is copied for the dataspace extent of the newly created dataspace.
@@ -11744,12 +12810,14 @@ public class H5 implements java.io.Serializable {
* @return a dataspace ID on success / H5I_INVALID_HID on failure
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Scombine_select(long space1_id, int op, long space2_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sis_regular_hyperslab retrieves a regular hyperslab selection for the dataspace specified
* by space_id.
*
@@ -11759,12 +12827,14 @@ public class H5 implements java.io.Serializable {
* @return a TRUE/FALSE for hyperslab selection if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Sis_regular_hyperslab(long space_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sget_regular_hyperslab determines if a hyperslab selection is regular for the dataspace specified
* by space_id. The start, stride, count, and block arrays must be the same size as the rank of the
* dataspace.
@@ -11781,7 +12851,7 @@ public class H5 implements java.io.Serializable {
* OUT: Size of block in hyperslab.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* an output array is null.
* @exception IllegalArgumentException
@@ -11792,6 +12862,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5S
+ *
* H5Sget_select_hyper_nblocks returns the number of hyperslab blocks in the current dataspace selection.
*
* @param spaceid
@@ -11800,12 +12872,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Sget_select_hyper_nblocks(long spaceid)
throws HDF5LibraryException;
/**
+ * @ingroup JH5S
+ *
* H5Sget_select_hyper_blocklist returns an array of hyperslab blocks. The block coordinates have the same
* dimensionality (rank) as the dataspace they are located within. The list of blocks is formatted as
* follows:
@@ -11831,7 +12905,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -11840,6 +12914,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5S
+ *
* H5Sselect_project_intersection projects the intersection of the selections of src_space_id and
* src_intersect_space_id within the selection of src_space_id as a
* selection within the selection of dst_space_id.
@@ -11856,7 +12932,7 @@ public class H5 implements java.io.Serializable {
* src_intersect_space_id and src_space_id projected from src_space to dst_space on success
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long
H5Sselect_project_intersection(long src_space_id, long dst_space_id, long src_intersect_space_id)
@@ -11867,8 +12943,13 @@ public class H5 implements java.io.Serializable {
// H5T: Datatype Interface Functions //
// //
// ////////////////////////////////////////////////////////////
+ /**
+ * @defgroup JH5T Java Datatype (H5T) Interface
+ **/
/**
+ * @ingroup JH5T
+ *
* H5Tarray_create creates a new array datatype object.
*
* @param base_id
@@ -11881,7 +12962,7 @@ public class H5 implements java.io.Serializable {
* @return a valid datatype identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* dim is null.
**/
@@ -11901,6 +12982,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tclose releases a datatype.
*
* @param type_id
@@ -11909,7 +12992,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Tclose(long type_id) throws HDF5LibraryException
{
@@ -11925,6 +13008,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native int _H5Tclose(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tcommit saves a transient datatype as an immutable named datatype in a file.
*
* @param loc_id
@@ -11941,7 +13026,7 @@ public class H5 implements java.io.Serializable {
* IN: Datatype access property list.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -11950,6 +13035,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tcommit_anon commits a transient datatype (not immutable) to a file, turning it into a named datatype
* with the specified creation and property lists.
*
@@ -11963,12 +13050,14 @@ public class H5 implements java.io.Serializable {
* IN: Datatype access property list.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Tcommit_anon(long loc_id, long type_id, long tcpl_id,
long tapl_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tcommitted queries a type to determine whether the type specified by the type identifier is a named
* type or a transient type.
*
@@ -11978,13 +13067,15 @@ public class H5 implements java.io.Serializable {
* @return true the datatype has been committed
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Tcommitted(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tcompiler_conv finds out whether the library's conversion function from type src_id to type dst_id is
- *a compiler (hard) conversion.
+ * a compiler (hard) conversion.
*
* @param src_id
* IN: Identifier of source datatype.
@@ -11992,12 +13083,14 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of destination datatype.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Tcompiler_conv(long src_id, long dst_id)
throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tconvert converts nelmts elements from the type specified by the src_id identifier to type dst_id.
*
* @param src_id
@@ -12014,7 +13107,7 @@ public class H5 implements java.io.Serializable {
* IN: Dataset transfer property list identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -12025,6 +13118,8 @@ public class H5 implements java.io.Serializable {
// int H5Tconvert(int src_id, int dst_id, long nelmts, Pointer buf, Pointer background, int plist_id);
/**
+ * @ingroup JH5T
+ *
* H5Tcopy copies an existing datatype. The returned type is always transient and unlocked.
*
* @param type_id
@@ -12034,7 +13129,7 @@ public class H5 implements java.io.Serializable {
* @return a datatype identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Tcopy(long type_id) throws HDF5LibraryException
{
@@ -12050,6 +13145,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Tcopy(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tcreate creates a new dataype of the specified class with the specified number of bytes.
*
* @param tclass
@@ -12060,7 +13157,7 @@ public class H5 implements java.io.Serializable {
* @return datatype identifier
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Tcreate(int tclass, long size) throws HDF5LibraryException
{
@@ -12076,6 +13173,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Tcreate(int type, long size) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tdecode reconstructs the HDF5 data type object and returns a new object handle for it.
*
* @param buf
@@ -12084,7 +13183,7 @@ public class H5 implements java.io.Serializable {
* @return a new object handle
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -12103,6 +13202,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tdetect_class determines whether the datatype specified in dtype_id contains any datatypes of the
* datatype class specified in dtype_class.
*
@@ -12114,12 +13215,14 @@ public class H5 implements java.io.Serializable {
* @return true if the datatype specified in dtype_id contains any datatypes of the datatype class
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Tdetect_class(long type_id, int cls)
throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tencode converts a data type description into binary form in a buffer.
*
* @param obj_id
@@ -12133,7 +13236,7 @@ public class H5 implements java.io.Serializable {
* @return the size needed for the allocated buffer.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* buf is null.
**/
@@ -12141,20 +13244,24 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
// /**
- // * H5Tencode converts a data type description into binary form in a buffer.
- // *
- // * @param obj_id
- // * IN: Identifier of the object to be encoded.
- // *
- // * @return the buffer for the object to be encoded into.
- // *
- // * @exception HDF5LibraryException
- // * Error from the HDF-5 Library.
- // **/
+ // * @ingroup JH5T
+ // *
+ // * H5Tencode converts a data type description into binary form in a buffer.
+ // *
+ // * @param obj_id
+ // * IN: Identifier of the object to be encoded.
+ // *
+ // * @return the buffer for the object to be encoded into.
+ // *
+ // * @exception HDF5LibraryException
+ // * Error from the HDF5 Library.
+ // **/
// public synchronized static native byte[] H5Tencode(int obj_id)
// throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tenum_create creates a new enumeration datatype based on the specified base datatype, parent_id,
* which must be an integer type.
*
@@ -12164,7 +13271,7 @@ public class H5 implements java.io.Serializable {
* @return the datatype identifier for the new enumeration datatype
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Tenum_create(long base_id) throws HDF5LibraryException
{
@@ -12180,6 +13287,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Tenum_create(long base_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype.
*
* @param type
@@ -12190,7 +13299,7 @@ public class H5 implements java.io.Serializable {
* IN: The value of the member, data of the correct type
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -12198,6 +13307,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype.
*
* @param type
@@ -12210,7 +13321,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -12221,6 +13332,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5T
+ *
* H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype.
*
* @param type
@@ -12233,7 +13346,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -12248,6 +13361,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tenum_nameof finds the symbol name that corresponds to the specified value of the enumeration
* datatype type.
*
@@ -12261,7 +13376,7 @@ public class H5 implements java.io.Serializable {
* @return the symbol name.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* value is null.
**/
@@ -12271,6 +13386,8 @@ public class H5 implements java.io.Serializable {
// int H5Tenum_nameof(int type, Pointer value, Buffer name/* out */, long size);
/**
+ * @ingroup JH5T
+ *
* H5Tenum_nameof finds the symbol name that corresponds to the specified value of the enumeration
* datatype type.
*
@@ -12286,7 +13403,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -12300,6 +13417,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype
* type.
*
@@ -12311,12 +13430,14 @@ public class H5 implements java.io.Serializable {
* OUT: The value of the member
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Tenum_valueof(long type, String name, byte[] value)
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype
* type.
*
@@ -12330,7 +13451,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -12344,6 +13465,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tequal determines whether two datatype identifiers refer to the same datatype.
*
* @param type_id1
@@ -12354,12 +13477,14 @@ public class H5 implements java.io.Serializable {
* @return true if the datatype identifiers refer to the same datatype, else false.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Tequal(long type_id1, long type_id2)
throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_array_dims returns the sizes of the dimensions of the specified array datatype object.
*
* @param type_id
@@ -12370,7 +13495,7 @@ public class H5 implements java.io.Serializable {
* @return the non-negative number of dimensions of the array type
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* dims is null.
**/
@@ -12381,6 +13506,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5T
+ *
* H5Tget_array_dims2 returns the sizes of the dimensions of the specified array datatype object.
*
* @param type_id
@@ -12391,7 +13518,7 @@ public class H5 implements java.io.Serializable {
* @return the non-negative number of dimensions of the array type
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* dims is null.
**/
@@ -12399,6 +13526,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_array_ndims returns the rank, the number of dimensions, of an array datatype object.
*
* @param type_id
@@ -12407,11 +13536,13 @@ public class H5 implements java.io.Serializable {
* @return the rank of the array
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_array_ndims(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_class returns the datatype class identifier.
*
* @param type_id
@@ -12420,11 +13551,13 @@ public class H5 implements java.io.Serializable {
* @return datatype class identifier if successful; otherwise H5T_NO_CLASS(-1).
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_class(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_class_name returns the datatype class identifier.
*
* @param class_id
@@ -12465,6 +13598,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5T
+ *
* H5Tget_create_plist returns a property list identifier for the datatype creation property list
* associated with the datatype specified by type_id.
*
@@ -12474,7 +13609,7 @@ public class H5 implements java.io.Serializable {
* @return a datatype property list identifier.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Tget_create_plist(long type_id) throws HDF5LibraryException
{
@@ -12490,6 +13625,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Tget_create_plist(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_cset retrieves the character set type of a string datatype.
*
* @param type_id
@@ -12498,11 +13635,13 @@ public class H5 implements java.io.Serializable {
* @return a valid character set type if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_cset(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_cset the character set to be used.
*
* @param type_id
@@ -12513,11 +13652,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tset_cset(long type_id, int cset) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_ebias retrieves the exponent bias of a floating-point type.
*
* @param type_id
@@ -12526,11 +13667,13 @@ public class H5 implements java.io.Serializable {
* @return the bias if successful; otherwise 0.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_ebias(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_ebias sets the exponent bias of a floating-point type.
*
* @param type_id
@@ -12541,7 +13684,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Tset_ebias(long type_id, int ebias) throws HDF5LibraryException
{
@@ -12550,6 +13693,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5T
+ *
* H5Tget_ebias retrieves the exponent bias of a floating-point type.
*
* @param type_id
@@ -12558,11 +13703,13 @@ public class H5 implements java.io.Serializable {
* @return the bias
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Tget_ebias_long(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_ebias sets the exponent bias of a floating-point type.
*
* @param type_id
@@ -12571,11 +13718,13 @@ public class H5 implements java.io.Serializable {
* IN: Exponent bias value.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Tset_ebias(long type_id, long ebias) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_fields retrieves information about the locations of the various bit fields of a floating point
* datatype.
*
@@ -12592,7 +13741,7 @@ public class H5 implements java.io.Serializable {
* </ul>
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* fields is null.
* @exception IllegalArgumentException
@@ -12602,6 +13751,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_fields retrieves information about the locations of the various bit fields of a floating point
* datatype.
*
@@ -12621,7 +13772,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* fields is null.
* @exception IllegalArgumentException
@@ -12637,6 +13788,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_fields sets the locations and sizes of the various floating point bit fields.
*
* @param type_id
@@ -12653,12 +13806,14 @@ public class H5 implements java.io.Serializable {
* IN: Size of mantissa in bits.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Tset_fields(long type_id, long spos, long epos, long esize,
long mpos, long msize) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_fields sets the locations and sizes of the various floating point bit fields.
*
* @param type_id
@@ -12677,7 +13832,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Tset_fields(long type_id, int spos, int epos, int esize, int mpos, int msize)
throws HDF5LibraryException
@@ -12687,6 +13842,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5T
+ *
* H5Tget_inpad retrieves the internal padding type for unused bits in floating-point datatypes.
*
* @param type_id
@@ -12695,11 +13852,13 @@ public class H5 implements java.io.Serializable {
* @return a valid padding type if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_inpad(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* 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.
@@ -12712,11 +13871,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tset_inpad(long type_id, int inpad) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_member_class returns the class of datatype of the specified member.
*
* @param type_id
@@ -12727,12 +13888,14 @@ public class H5 implements java.io.Serializable {
* @return the class of the datatype of the field if successful;
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_member_class(long type_id, int membno)
throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_member_index retrieves the index of a field of a compound datatype.
*
* @param type_id
@@ -12743,12 +13906,14 @@ public class H5 implements java.io.Serializable {
* @return if field is defined, the index; else negative.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_member_index(long type_id, String field_name)
throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_member_name retrieves the name of a field of a compound datatype or an element of an enumeration
* datatype.
*
@@ -12760,14 +13925,16 @@ public class H5 implements java.io.Serializable {
* @return a valid pointer to the name if successful; otherwise null.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native String H5Tget_member_name(long type_id, int field_idx)
throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_member_offset returns the byte offset of the specified member of the compound datatype. This is
- * the byte offset in the HDF-5 file/library, NOT the offset of any Java object which might be mapped to
+ * the byte offset in the HDF5 file/library, NOT the offset of any Java object which might be mapped to
* this data item.
*
* @param type_id
@@ -12780,6 +13947,8 @@ public class H5 implements java.io.Serializable {
public synchronized static native long H5Tget_member_offset(long type_id, int membno);
/**
+ * @ingroup JH5T
+ *
* H5Tget_member_type returns the datatype of the specified member.
*
* @param type_id
@@ -12790,7 +13959,7 @@ public class H5 implements java.io.Serializable {
* @return the identifier of a copy of the datatype of the field if successful;
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Tget_member_type(long type_id, int field_idx) throws HDF5LibraryException
{
@@ -12807,6 +13976,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_member_value returns the value of the enumeration datatype member memb_no.
*
* @param type_id
@@ -12817,7 +13988,7 @@ public class H5 implements java.io.Serializable {
* OUT: The value of the member
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* value is null.
**/
@@ -12825,6 +13996,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_member_value returns the value of the enumeration datatype member memb_no.
*
* @param type_id
@@ -12837,7 +14010,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* value is null.
**/
@@ -12851,6 +14024,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_native_type returns the equivalent native datatype for the datatype specified in type_id.
*
* @param type_id
@@ -12860,7 +14035,7 @@ public class H5 implements java.io.Serializable {
* @return the native datatype identifier for the specified dataset datatype.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static long H5Tget_native_type(long type_id) throws HDF5LibraryException
{
@@ -12868,6 +14043,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5T
+ *
* H5Tget_native_type returns the equivalent native datatype for the datatype specified in type_id.
*
* @param type_id
@@ -12878,7 +14055,7 @@ public class H5 implements java.io.Serializable {
* @return the native datatype identifier for the specified dataset datatype.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Tget_native_type(long type_id, int direction) throws HDF5LibraryException
{
@@ -12895,6 +14072,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_nmembers retrieves the number of fields a compound datatype has.
*
* @param type_id
@@ -12903,11 +14082,13 @@ public class H5 implements java.io.Serializable {
* @return number of members datatype has if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_nmembers(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_norm retrieves the mantissa normalization of a floating-point datatype.
*
* @param type_id
@@ -12916,11 +14097,13 @@ public class H5 implements java.io.Serializable {
* @return a valid normalization type if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_norm(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_norm sets the mantissa normalization of a floating-point datatype.
*
* @param type_id
@@ -12931,11 +14114,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tset_norm(long type_id, int norm) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_offset retrieves the bit offset of the first significant bit.
*
* @param type_id
@@ -12944,11 +14129,13 @@ public class H5 implements java.io.Serializable {
* @return a positive offset value if successful; otherwise 0.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_offset(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_offset sets the bit offset of the first significant bit.
*
* @param type_id
@@ -12959,7 +14146,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Tset_offset(long type_id, int offset) throws HDF5LibraryException
{
@@ -12968,6 +14155,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5T
+ *
* H5Tset_offset sets the bit offset of the first significant bit.
*
* @param type_id
@@ -12976,12 +14165,14 @@ public class H5 implements java.io.Serializable {
* IN: Offset of first significant bit.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Tset_offset(long type_id, long offset)
throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_order returns the byte order of an atomic datatype.
*
* @param type_id
@@ -12990,11 +14181,13 @@ public class H5 implements java.io.Serializable {
* @return a byte order constant if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_order(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_order sets the byte ordering of an atomic datatype.
*
* @param type_id
@@ -13005,11 +14198,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tset_order(long type_id, int order) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_pad retrieves the padding type of the least and most-significant bit padding.
*
* @param type_id
@@ -13025,7 +14220,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* pad is null.
**/
@@ -13033,6 +14228,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_pad sets the least and most-significant bits padding types.
*
* @param type_id
@@ -13045,12 +14242,14 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tset_pad(long type_id, int lsb, int msb)
throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_precision returns the precision of an atomic datatype.
*
* @param type_id
@@ -13059,11 +14258,13 @@ public class H5 implements java.io.Serializable {
* @return the number of significant bits if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_precision(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_precision sets the precision of an atomic datatype.
*
* @param type_id
@@ -13074,7 +14275,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static int H5Tset_precision(long type_id, int precision) throws HDF5LibraryException
{
@@ -13083,6 +14284,8 @@ public class H5 implements java.io.Serializable {
}
/**
+ * @ingroup JH5T
+ *
* H5Tget_precision returns the precision of an atomic datatype.
*
* @param type_id
@@ -13091,11 +14294,13 @@ public class H5 implements java.io.Serializable {
* @return the number of significant bits if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Tget_precision_long(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_precision sets the precision of an atomic datatype.
*
* @param type_id
@@ -13104,12 +14309,14 @@ public class H5 implements java.io.Serializable {
* IN: Number of bits of precision for datatype.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Tset_precision(long type_id, long precision)
throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_sign retrieves the sign type for an integer type.
*
* @param type_id
@@ -13118,11 +14325,13 @@ public class H5 implements java.io.Serializable {
* @return a valid sign type if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_sign(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_sign sets the sign proprety for an integer type.
*
* @param type_id
@@ -13133,11 +14342,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tset_sign(long type_id, int sign) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_size returns the size of a datatype in bytes.
*
* @param type_id
@@ -13146,11 +14357,13 @@ public class H5 implements java.io.Serializable {
* @return the size of the datatype in bytes
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native long H5Tget_size(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_size sets the total size in bytes, size, for an atomic datatype (this operation is not permitted
* on compound datatypes).
*
@@ -13162,11 +14375,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tset_size(long type_id, long size) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_strpad retrieves the string padding method for a string datatype.
*
* @param type_id
@@ -13175,11 +14390,13 @@ public class H5 implements java.io.Serializable {
* @return a valid string padding type if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tget_strpad(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_strpad defines the storage mechanism for the string.
*
* @param type_id
@@ -13190,11 +14407,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tset_strpad(long type_id, int strpad) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_super returns the type from which TYPE is derived.
*
* @param type
@@ -13203,7 +14422,7 @@ public class H5 implements java.io.Serializable {
* @return the parent type
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Tget_super(long type) throws HDF5LibraryException
{
@@ -13219,6 +14438,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Tget_super(long type) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tget_tag returns the tag associated with datatype type_id.
*
* @param type
@@ -13227,11 +14448,13 @@ public class H5 implements java.io.Serializable {
* @return the tag
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native String H5Tget_tag(long type) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tset_tag tags an opaque datatype type_id with a unique ASCII identifier tag.
*
* @param type
@@ -13242,11 +14465,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tset_tag(long type, String tag) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tinsert adds another member to the compound datatype type_id.
*
* @param type_id
@@ -13261,7 +14486,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -13269,6 +14494,8 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tis_variable_str determines whether the datatype identified in type_id is a variable-length string.
*
* @param type_id
@@ -13277,11 +14504,13 @@ public class H5 implements java.io.Serializable {
* @return true if type_id is a variable-length string.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native boolean H5Tis_variable_str(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tlock locks the datatype specified by the type_id identifier, making it read-only and
* non-destrucible.
*
@@ -13291,11 +14520,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tlock(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Topen opens a named datatype at the location specified by loc_id and return an identifier for the
* datatype.
*
@@ -13309,7 +14540,7 @@ public class H5 implements java.io.Serializable {
* @return a named datatype identifier if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
* @exception NullPointerException
* name is null.
**/
@@ -13329,8 +14560,10 @@ public class H5 implements java.io.Serializable {
throws HDF5LibraryException, NullPointerException;
/**
+ * @ingroup JH5T
+ *
* H5Tpack recursively removes padding from within a compound datatype to make it more efficient
- * (space-wise) to store that data. <P> <b>WARNING:</b> This call only affects the C-data, even if it
+ * (space-wise) to store that data. <p> <b>WARNING:</b> This call only affects the C-data, even if it
* succeeds, there may be no visible effect on Java objects.
*
* @param type_id
@@ -13339,11 +14572,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Tpack(long type_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tvlen_create creates a new variable-length (VL) dataype.
*
* @param base_id
@@ -13352,7 +14587,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public static long H5Tvlen_create(long base_id) throws HDF5LibraryException
{
@@ -13368,6 +14603,8 @@ public class H5 implements java.io.Serializable {
private synchronized static native long _H5Tvlen_create(long base_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Tflush causes all buffers associated with a committed datatype to be immediately flushed to disk
* without removing the data from the cache.
*
@@ -13375,11 +14612,13 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the committed datatype to be flushed.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Tflush(long dtype_id) throws HDF5LibraryException;
/**
+ * @ingroup JH5T
+ *
* H5Trefresh causes all buffers associated with a committed datatype to be cleared and immediately
* re-loaded with updated contents from disk. This function essentially closes the datatype, evicts
* all metadata associated with it from the cache, and then re-opens the datatype. The reopened datatype
@@ -13389,7 +14628,7 @@ public class H5 implements java.io.Serializable {
* IN: Identifier of the committed datatype to be refreshed.
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native void H5Trefresh(long dtype_id) throws HDF5LibraryException;
@@ -13409,8 +14648,13 @@ public class H5 implements java.io.Serializable {
// H5Z: Filter Interface Functions //
// //
// ////////////////////////////////////////////////////////////
+ /**
+ * @defgroup JH5Z Java Filter (H5Z) Interface
+ **/
/**
+ * @ingroup JH5Z
+ *
* H5Zfilter_avail checks if a filter is available.
*
* @param filter
@@ -13419,11 +14663,13 @@ public class H5 implements java.io.Serializable {
* @return a non-negative(TRUE/FALSE) value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Zfilter_avail(int filter) throws HDF5LibraryException;
/**
+ * @ingroup JH5Z
+ *
* H5Zget_filter_info gets information about a pipeline data filter.
*
* @param filter
@@ -13432,11 +14678,13 @@ public class H5 implements java.io.Serializable {
* @return the filter information flags
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Zget_filter_info(int filter) throws HDF5LibraryException;
/**
+ * @ingroup JH5Z
+ *
* H5Zunregister unregisters a filter.
*
* @param filter
@@ -13445,7 +14693,7 @@ public class H5 implements java.io.Serializable {
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
- * Error from the HDF-5 Library.
+ * Error from the HDF5 Library.
**/
public synchronized static native int H5Zunregister(int filter) throws HDF5LibraryException;
diff --git a/java/src/hdf/hdf5lib/HDF5Constants.java b/java/src/hdf/hdf5lib/HDF5Constants.java
index bcf3eab..67b9259 100644
--- a/java/src/hdf/hdf5lib/HDF5Constants.java
+++ b/java/src/hdf/hdf5lib/HDF5Constants.java
@@ -14,14 +14,15 @@
package hdf.hdf5lib;
/**
+ * @page HDF5CONST Constants and Enumerated Types
* This class contains C constants and enumerated types of HDF5 library. The
- * values of these constants are obtained from the library by calling J2C(int
- * jconstant), where jconstant is any of the private constants which start their
- * name with "JH5" need to be converted.
+ * values of these constants are obtained from the library by calling
+ * the JNI function jconstant, where jconstant is any of the private constants
+ * which start their name with "H5" need to be converted.
* <P>
* <B>Do not edit this file!</b>
*
- * <b>See also:</b> hdf.hdf5lib.HDF5Library
+ * @see @ref HDF5LIB
*/
public class HDF5Constants {
static { H5.loadH5Lib(); }
diff --git a/java/src/hdf/hdf5lib/HDF5GroupInfo.java b/java/src/hdf/hdf5lib/HDF5GroupInfo.java
deleted file mode 100644
index 880f003..0000000
--- a/java/src/hdf/hdf5lib/HDF5GroupInfo.java
+++ /dev/null
@@ -1,182 +0,0 @@
-/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
- * Copyright by The HDF Group. *
- * Copyright by the Board of Trustees of the University of Illinois. *
- * All rights reserved. *
- * *
- * This file is part of HDF5. The full HDF5 copyright notice, including *
- * terms governing use, modification, and redistribution, is contained in *
- * the COPYING file, which can be found at the root of the source code *
- * distribution tree, or in https://www.hdfgroup.org/licenses. *
- * If you do not have access to either file, you may request a copy from *
- * help@hdfgroup.org. *
- * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-
-package hdf.hdf5lib;
-
-/**
- * <p>
- * This class is a container for the information reported about an HDF5 Object
- * from the H5Gget_obj_info() method.
- * <p>
- * The fileno and objno fields contain four values which uniquely identify an
- * object among those HDF5 files which are open: if all four values are the same
- * between two objects, then the two objects are the same (provided both files
- * are still open). The nlink field is the number of hard links to the object or
- * zero when information is being returned about a symbolic link (symbolic links
- * do not have hard links but all other objects always have at least one). The
- * type field contains the type of the object, one of H5G_GROUP, H5G_DATASET, or
- * H5G_LINK. The mtime field contains the modification time. If information is
- * being returned about a symbolic link then linklen will be the length of the
- * link value (the name of the pointed-to object with the null terminator);
- * otherwise linklen will be zero. Other fields may be added to this structure
- * in the future.
- */
-
-public class HDF5GroupInfo {
- long[] fileno;
- long[] objno;
- int nlink;
- int type;
- long mtime;
- int linklen;
-
- /**
- * Container for the information reported about an HDF5 Object
- * from the H5Gget_obj_info() method
- */
- public HDF5GroupInfo()
- {
- fileno = new long[2];
- objno = new long[2];
- nlink = -1;
- type = -1;
- mtime = 0;
- linklen = 0;
- }
-
- /**
- * Sets the HDF5 group information. Used by the JHI5.
- *
- * @param fn
- * File id number
- * @param on
- * Object id number
- * @param nl
- * Number of links
- * @param t
- * Type of the object
- * @param mt
- * Modification time
- * @param len
- * Length of link
- **/
- public void setGroupInfo(long[] fn, long[] on, int nl, int t, long mt, int len)
- {
- fileno = fn;
- objno = on;
- nlink = nl;
- type = t;
- mtime = mt;
- linklen = len;
- }
-
- /** Resets all the group information to defaults. */
- public void reset()
- {
- fileno[0] = 0;
- fileno[1] = 0;
- objno[0] = 0;
- objno[1] = 0;
- nlink = -1;
- type = -1;
- mtime = 0;
- linklen = 0;
- }
-
- /**
- * fileno accessors
- * @return the file number if successful
- */
- public long[] getFileno() { return fileno; }
-
- /**
- * accessors
- * @return the object number if successful
- */
- public long[] getObjno() { return objno; }
-
- /**
- * accessors
- * @return type of group if successful
- */
- public int getType() { return type; }
-
- /**
- * accessors
- * @return the number of links in the group if successful
- */
- public int getNlink() { return nlink; }
-
- /**
- * accessors
- * @return the modified time value if successful
- */
- public long getMtime() { return mtime; }
-
- /**
- * accessors
- * @return a length of link name if successful
- */
- public int getLinklen() { return linklen; }
-
- /**
- * The fileno and objno fields contain four values which uniquely identify
- * an object among those HDF5 files.
- */
- @Override
- public boolean equals(Object obj)
- {
- if (!(obj instanceof HDF5GroupInfo)) {
- return false;
- }
-
- HDF5GroupInfo target = (HDF5GroupInfo)obj;
- if ((fileno[0] == target.fileno[0]) && (fileno[1] == target.fileno[1]) &&
- (objno[0] == target.objno[0]) && (objno[1] == target.objno[1])) {
- return true;
- }
- else {
- return false;
- }
- }
-
- /**
- * Returns the object id.
- *
- * @return the object id
- */
- public long getOID() { return objno[0]; }
-
- /**
- * Converts this object to a String representation.
- *
- * @return a string representation of this object
- */
- @Override
- public String toString()
- {
- String fileStr = "fileno=null";
- String objStr = "objno=null";
-
- if (fileno != null) {
- fileStr = "fileno[0]=" + fileno[0] + ",fileno[1]=" + fileno[1];
- }
-
- if (objno != null) {
- objStr = "objno[0]=" + objno[0] + ",objno[1]=" + objno[1];
- }
-
- return getClass().getName() + "[" + fileStr + "," + objStr + ",type=" + type + ",nlink=" + nlink +
- ",mtime=" + mtime + ",linklen=" + linklen + "]";
- }
-}
diff --git a/java/src/hdf/hdf5lib/HDFArray.java b/java/src/hdf/hdf5lib/HDFArray.java
index 8525fb0..9ea314d 100644
--- a/java/src/hdf/hdf5lib/HDFArray.java
+++ b/java/src/hdf/hdf5lib/HDFArray.java
@@ -19,14 +19,15 @@ import hdf.hdf5lib.exceptions.HDF5Exception;
import hdf.hdf5lib.exceptions.HDF5JavaException;
/**
+ * @page HDFARRAY Java Array Conversion
* This is a class for handling multidimensional arrays for HDF.
* <p>
* The purpose is to allow the storage and retrieval of arbitrary array types containing scientific data.
* <p>
* The methods support the conversion of an array to and from Java to a one-dimensional array of bytes
- * suitable for I/O by the C library. <p> This class heavily uses the <a
- * href="./hdf.hdf5lib.HDFNativeData.html">HDFNativeData</a> class to convert between Java and C
- * representations.
+ * suitable for I/O by the C library. <p> This class heavily uses the
+ * @ref HDFNATIVE
+ * class to convert between Java and C representations.
*/
public class HDFArray {
diff --git a/java/src/hdf/hdf5lib/HDFNativeData.java b/java/src/hdf/hdf5lib/HDFNativeData.java
index c497043..bc4e866 100644
--- a/java/src/hdf/hdf5lib/HDFNativeData.java
+++ b/java/src/hdf/hdf5lib/HDFNativeData.java
@@ -17,11 +17,12 @@ import hdf.hdf5lib.exceptions.HDF5Exception;
import hdf.hdf5lib.exceptions.HDF5JavaException;
/**
+ * @page HDFNATIVE Native Arrays of Numbers
* This class encapsulates native methods to deal with arrays of numbers,
* converting from numbers to bytes and bytes to numbers.
* <p>
- * These routines are used by class <b>HDFArray</b> to pass data to and from the
- * HDF-5 library.
+ * These routines are used by class @ref HDFARRAY to pass data to and from the
+ * HDF5 library.
* <p>
* Methods xxxToByte() convert a Java array of primitive numbers (int, short,
* ...) to a Java array of bytes. Methods byteToXxx() convert from a Java array
@@ -30,7 +31,7 @@ import hdf.hdf5lib.exceptions.HDF5JavaException;
* Variant interfaces convert a section of an array, and also can convert to
* sub-classes of Java <b>Number</b>.
* <P>
- * <b>See also:</b> hdf.hdf5lib.HDFArray.
+ * @see @ref HDFARRAY.
*/
public class HDFNativeData {
diff --git a/java/src/hdf/hdf5lib/callbacks/Callbacks.java b/java/src/hdf/hdf5lib/callbacks/Callbacks.java
index 86d6193..3d5fbd1 100644
--- a/java/src/hdf/hdf5lib/callbacks/Callbacks.java
+++ b/java/src/hdf/hdf5lib/callbacks/Callbacks.java
@@ -13,6 +13,7 @@
package hdf.hdf5lib.callbacks;
/**
+ * @page CALLBACKS HDF5 Java Callbacks Interface
* All callback definitions must derive from this interface. Any
* derived interfaces must define a single public method named "callback".
* You are responsible for deregistering your callback (if necessary)
@@ -20,11 +21,14 @@ package hdf.hdf5lib.callbacks;
* a callback which has been GC'd, you will likely crash the VM. If
* there is no method to deregister the callback (e.g. <code>atexit</code>
* in the C library), you must ensure that you always keep a live reference
- * to the callback object.<p>
+ * to the callback object.
+ *
* A callback should generally never throw an exception, since it doesn't
* necessarily have an encompassing Java environment to catch it. Any
* exceptions thrown will be passed to the default callback exception
* handler.
+ *
+ * @defgroup JCALL HDF5 Library Java Callbacks
*/
public interface Callbacks {
}
diff --git a/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java
index 6c68f36..9958b3b 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5A_iterate_cb.java
@@ -20,6 +20,8 @@ import hdf.hdf5lib.structs.H5A_info_t;
*/
public interface H5A_iterate_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each attribute
*
* @param loc_id the ID for the group or dataset being iterated over
diff --git a/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java b/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java
index cf7ada6..49323a2 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5D_append_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each dataset access property list
*
* @param dataset_id the ID for the dataset being iterated over
diff --git a/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java
index 54c12e3..5f77998 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5D_iterate_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each dataset element
*
* @param elem the pointer to the element in memory containing the current point
diff --git a/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java b/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java
index 5722195..a8ef5df 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5E_walk_cb.java
@@ -20,6 +20,8 @@ import hdf.hdf5lib.structs.H5E_error2_t;
*/
public interface H5E_walk_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each error stack element
*
* @param nidx the index of the current error stack element
diff --git a/java/src/hdf/hdf5lib/callbacks/H5L_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5L_iterate_cb.java
index 663d761..bccf79a 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5L_iterate_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5L_iterate_cb.java
@@ -20,6 +20,8 @@ import hdf.hdf5lib.structs.H5L_info_t;
*/
public interface H5L_iterate_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each group
*
* @param loc_id the ID for the group being iterated over
diff --git a/java/src/hdf/hdf5lib/callbacks/H5O_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5O_iterate_cb.java
index 054230f..1977cb2 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5O_iterate_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5O_iterate_cb.java
@@ -20,6 +20,8 @@ import hdf.hdf5lib.structs.H5O_info_t;
*/
public interface H5O_iterate_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each group
*
* @param loc_id the ID for the group or dataset being iterated over
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java
index 0a09a94..a235861 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5P_cls_close_func_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each property list
*
* @param prop_id the ID for the property list class being iterated over
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java
index 53f86be..b218e0c 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_copy_func_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5P_cls_copy_func_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each property list
*
* @param new_prop_id the ID for the property list copy
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java
index 8f4e782..3d407d0 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_create_func_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5P_cls_create_func_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each property list
*
* @param prop_id the ID for the property list class being iterated over
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java
index db98a67..51a5768 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_iterate_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5P_iterate_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each property list
*
* @param plist the ID for the property list being iterated over
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java
index 1aa7ce4..2ddc980 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_close_func_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5P_prp_close_func_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each property list
*
* @param name the name of the property being closed
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java
index 49cef7d..53caa94 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_compare_func_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5P_prp_compare_func_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each property list
*
* @param value1 the value of the first property being compared
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java
index f4924ee..0b2349e 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_copy_func_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5P_prp_copy_func_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each property list
*
* @param name the name of the property being copied
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java
index bce024b..6065ce0 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_create_func_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5P_prp_create_func_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each property list
*
* @param name the name of the property list being created
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java
index 8c5dccc..4384ca7 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_delete_func_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5P_prp_delete_func_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each property list
*
* @param prop_id the ID of the property list the property is deleted from
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java
index 0f3457f..999c7b0 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_get_func_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5P_prp_get_func_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each property list
*
* @param prop_id the ID for the property list being queried
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java
index a55ca3a..893344b 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_prp_set_func_cb.java
@@ -18,6 +18,8 @@ package hdf.hdf5lib.callbacks;
*/
public interface H5P_prp_set_func_cb extends Callbacks {
/**
+ * @ingroup JCALL
+ *
* application callback for each property list
*
* @param prop_id the ID for the property list being modified
diff --git a/java/src/hdf/hdf5lib/callbacks/package-info.java b/java/src/hdf/hdf5lib/callbacks/package-info.java
index 114045c..5ef3fab 100644
--- a/java/src/hdf/hdf5lib/callbacks/package-info.java
+++ b/java/src/hdf/hdf5lib/callbacks/package-info.java
@@ -12,6 +12,7 @@
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**
+ * @page CALLBACKS_UG HDF5 Java Callbacks Interface
* All callback definitions must derive from the Callbacks interface. Any
* derived interfaces must define a single public method named "callback".
* You are responsible for deregistering your callback (if necessary)
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5AtomException.java b/java/src/hdf/hdf5lib/exceptions/HDF5AtomException.java
index a1473c4..280db7d 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5AtomException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5AtomException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_ATOM</b>
+ * This sub-class represents HDF5 major error code <b>H5E_ATOM</b>
*/
public class HDF5AtomException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5AtomException</code> with no specified detail
* message.
*/
public HDF5AtomException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5AtomException</code> with the specified detail
* message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5AttributeException.java b/java/src/hdf/hdf5lib/exceptions/HDF5AttributeException.java
index 4cb7b1d..f8b526e 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5AttributeException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5AttributeException.java
@@ -16,16 +16,20 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_ATTR</b>
+ * This sub-class represents HDF5 major error code <b>H5E_ATTR</b>
*/
public class HDF5AttributeException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5AttributeException</code> with no specified
* detail message.
*/
public HDF5AttributeException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5AttributeException</code> with the specified
* detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5BtreeException.java b/java/src/hdf/hdf5lib/exceptions/HDF5BtreeException.java
index 9f70456..71b8e47 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5BtreeException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5BtreeException.java
@@ -16,16 +16,20 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_BTREE</b>
+ * This sub-class represents HDF5 major error code <b>H5E_BTREE</b>
*/
public class HDF5BtreeException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5BtreeException</code> with no specified detail
* message.
*/
public HDF5BtreeException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5BtreeException</code> with the specified detail
* message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5DataFiltersException.java b/java/src/hdf/hdf5lib/exceptions/HDF5DataFiltersException.java
index b4397b7..a837708 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5DataFiltersException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5DataFiltersException.java
@@ -16,16 +16,20 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_PLINE</b>
+ * This sub-class represents HDF5 major error code <b>H5E_PLINE</b>
*/
public class HDF5DataFiltersException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5DataFiltersException</code> with no specified
* detail message.
*/
public HDF5DataFiltersException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5DataFiltersException</code> with the specified
* detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5DataStorageException.java b/java/src/hdf/hdf5lib/exceptions/HDF5DataStorageException.java
index f6993a8..d9f49da 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5DataStorageException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5DataStorageException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_STORAGE</b>
+ * This sub-class represents HDF5 major error code <b>H5E_STORAGE</b>
*/
public class HDF5DataStorageException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5DataStorageExceptionn</code> with no specified
* detail message.
*/
public HDF5DataStorageException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5DataStorageException</code> with the specified
* detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5DatasetInterfaceException.java b/java/src/hdf/hdf5lib/exceptions/HDF5DatasetInterfaceException.java
index 8fd4ae9..fea1346 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5DatasetInterfaceException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5DatasetInterfaceException.java
@@ -16,16 +16,20 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_DATASET</b>
+ * This sub-class represents HDF5 major error code <b>H5E_DATASET</b>
*/
public class HDF5DatasetInterfaceException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5DatasetInterfaceException</code> with no
* specified detail message.
*/
public HDF5DatasetInterfaceException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5DatasetInterfaceException</code> with the
* specified detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5DataspaceInterfaceException.java b/java/src/hdf/hdf5lib/exceptions/HDF5DataspaceInterfaceException.java
index d0d2a09..e2d29d0 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5DataspaceInterfaceException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5DataspaceInterfaceException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_DATASPACE</b>
+ * This sub-class represents HDF5 major error code <b>H5E_DATASPACE</b>
*/
public class HDF5DataspaceInterfaceException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5DataspaceInterfaceException</code> with no
* specified detail message.
*/
public HDF5DataspaceInterfaceException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5DataspaceInterfaceException</code> with the
* specified detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5DatatypeInterfaceException.java b/java/src/hdf/hdf5lib/exceptions/HDF5DatatypeInterfaceException.java
index 2ab4ff9..d7e678b 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5DatatypeInterfaceException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5DatatypeInterfaceException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_DATATYPE</b>
+ * This sub-class represents HDF5 major error code <b>H5E_DATATYPE</b>
*/
public class HDF5DatatypeInterfaceException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5DatatypeInterfaceException</code> with no
* specified detail message.
*/
public HDF5DatatypeInterfaceException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5DatatypeInterfaceException</code> with the
* specified detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java b/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java
index b098a12..ad42644 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5Exception.java
@@ -14,21 +14,23 @@
package hdf.hdf5lib.exceptions;
/**
- * <p>
+ * @page ERRORS Errors and Exceptions
* The class HDF5Exception returns errors from the Java HDF5 Interface.
- * <p>
+ *
* Two sub-classes of HDF5Exception are defined:
* <ol>
* <li>
- * HDF5LibraryException -- errors raised the HDF5 library code
+ * HDF5LibraryException -- errors raised by the HDF5 library code
* <li>
- * HDF5JavaException -- errors raised the HDF5 Java wrapper code
+ * HDF5JavaException -- errors raised by the HDF5 Java wrapper code
* </ol>
- * <p>
+ *
* These exceptions are sub-classed to represent specific error conditions, as
* needed. In particular, HDF5LibraryException has a sub-class for each major
* error code returned by the HDF5 library.
*
+ * @defgroup JERR HDF5 Library Exception Interface
+ *
*/
public class HDF5Exception extends RuntimeException {
/**
@@ -37,12 +39,16 @@ public class HDF5Exception extends RuntimeException {
protected String detailMessage;
/**
+ * @ingroup JERR
+ *
* Constructs an <code>HDF5Exception</code> with no specified detail
* message.
*/
public HDF5Exception() { super(); }
/**
+ * @ingroup JERR
+ *
* Constructs an <code>HDF5Exception</code> with the specified detail
* message.
*
@@ -56,6 +62,8 @@ public class HDF5Exception extends RuntimeException {
}
/**
+ * @ingroup JERR
+ *
* Returns the detail message of this exception
*
* @return the detail message or <code>null</code> if this object does not
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5ExternalFileListException.java b/java/src/hdf/hdf5lib/exceptions/HDF5ExternalFileListException.java
index c8df3d0..f9f49a1 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5ExternalFileListException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5ExternalFileListException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_EFL</b>
+ * This sub-class represents HDF5 major error code <b>H5E_EFL</b>
*/
public class HDF5ExternalFileListException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5ExternalFileListException</code> with no
* specified detail message.
*/
public HDF5ExternalFileListException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5ExternalFileListException</code> with the
* specified detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5FileInterfaceException.java b/java/src/hdf/hdf5lib/exceptions/HDF5FileInterfaceException.java
index afd6d69..3ebe63a 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5FileInterfaceException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5FileInterfaceException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_FILE</b>
+ * This sub-class represents HDF5 major error code <b>H5E_FILE</b>
*/
public class HDF5FileInterfaceException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5FileInterfaceException</code> with no specified
* detail message.
*/
public HDF5FileInterfaceException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5FileInterfaceException</code> with the specified
* detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5FunctionArgumentException.java b/java/src/hdf/hdf5lib/exceptions/HDF5FunctionArgumentException.java
index 58e2980..3dc0c72 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5FunctionArgumentException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5FunctionArgumentException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_ARGS</b>
+ * This sub-class represents HDF5 major error code <b>H5E_ARGS</b>
*/
public class HDF5FunctionArgumentException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5FunctionArgumentException</code> with no
* specified detail message.
*/
public HDF5FunctionArgumentException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5FunctionArgumentException</code> with the
* specified detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5FunctionEntryExitException.java b/java/src/hdf/hdf5lib/exceptions/HDF5FunctionEntryExitException.java
index db46aae..aa9289c 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5FunctionEntryExitException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5FunctionEntryExitException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_FUNC</b>
+ * This sub-class represents HDF5 major error code <b>H5E_FUNC</b>
*/
public class HDF5FunctionEntryExitException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5FunctionEntryExitException</code> with no
* specified detail message.
*/
public HDF5FunctionEntryExitException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5FunctionEntryExitException</code> with the
* specified detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5HeapException.java b/java/src/hdf/hdf5lib/exceptions/HDF5HeapException.java
index 7f1691d..ba1b5ad 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5HeapException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5HeapException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_HEAP</b>
+ * This sub-class represents HDF5 major error code <b>H5E_HEAP</b>
*/
public class HDF5HeapException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5HeapException</code> with no specified detail
* message.
*/
public HDF5HeapException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5HeapException</code> with the specified detail
* message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5InternalErrorException.java b/java/src/hdf/hdf5lib/exceptions/HDF5InternalErrorException.java
index 4489486..31efe56 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5InternalErrorException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5InternalErrorException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_INTERNAL</b>
+ * This sub-class represents HDF5 major error code <b>H5E_INTERNAL</b>
*/
public class HDF5InternalErrorException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5InternalErrorException</code> with no specified
* detail message.
*/
public HDF5InternalErrorException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5InternalErrorException</code> with the specified
* detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5JavaException.java b/java/src/hdf/hdf5lib/exceptions/HDF5JavaException.java
index ae1cf85..9b38b87 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5JavaException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5JavaException.java
@@ -14,21 +14,27 @@
package hdf.hdf5lib.exceptions;
/**
- * <p>
+ * @page ERRORSJAVA Java Wrapper Errors and Exceptions
* The class HDF5JavaException returns errors from the Java wrapper of theHDF5
* library.
* <p>
* These errors include Java configuration errors, security violations, and
* resource exhaustion.
+ *
+ * @defgroup JERRJAVA HDF5 Library Java Exception Interface
*/
public class HDF5JavaException extends HDF5Exception {
/**
+ * @ingroup JERRJAVA
+ *
* Constructs an <code>HDF5JavaException</code> with no specified detail
* message.
*/
public HDF5JavaException() { super(); }
/**
+ * @ingroup JERRJAVA
+ *
* Constructs an <code>HDF5JavaException</code> with the specified detail
* message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5LibraryException.java b/java/src/hdf/hdf5lib/exceptions/HDF5LibraryException.java
index 2e3fdd6..677e57f 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5LibraryException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5LibraryException.java
@@ -17,14 +17,16 @@ import hdf.hdf5lib.H5;
import hdf.hdf5lib.HDF5Constants;
/**
- * <p>
+ * @page ERRORSLIB HDF5 Library Errors and Exceptions
* The class HDF5LibraryException returns errors raised by the HDF5 library.
- * <p>
- * Each major error code from the HDF-5 Library is represented by a sub-class of
+ *
+ * Each major error code from the HDF5 Library is represented by a sub-class of
* this class, and by default the 'detailedMessage' is set according to the
- * minor error code from the HDF-5 Library.
+ * minor error code from the HDF5 Library.
* <p>
- * For major and minor error codes, see <b>H5Epublic.h</b> in the HDF-5 library.
+ * For major and minor error codes, @see <b>@ref H5E</b> in the HDF5 library.
+ *
+ * @defgroup JERRLIB HDF5 Library JNI Exception Interface
*
*/
@@ -36,6 +38,8 @@ public class HDF5LibraryException extends HDF5Exception {
private final long minorErrorNumber;
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5LibraryException</code> with no specified detail
* message.
*/
@@ -43,7 +47,7 @@ public class HDF5LibraryException extends HDF5Exception {
{
super();
- // this code forces the loading of the HDF-5 library
+ // this code forces the loading of the HDF5 library
// to assure that the native methods are available
try {
H5.H5open();
@@ -57,6 +61,8 @@ public class HDF5LibraryException extends HDF5Exception {
}
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5LibraryException</code> with the specified detail
* message.
*
@@ -66,7 +72,7 @@ public class HDF5LibraryException extends HDF5Exception {
public HDF5LibraryException(String s)
{
super(s);
- // this code forces the loading of the HDF-5 library
+ // this code forces the loading of the HDF5 library
// to assure that the native methods are available
try {
H5.H5open();
@@ -78,6 +84,8 @@ public class HDF5LibraryException extends HDF5Exception {
}
/**
+ * @ingroup JERRLIB
+ *
* Get the major error number of the first error on the HDF5 library error
* stack.
*
@@ -87,6 +95,8 @@ public class HDF5LibraryException extends HDF5Exception {
private native long _getMajorErrorNumber();
/**
+ * @ingroup JERRLIB
+ *
* Get the minor error number of the first error on the HDF5 library error
* stack.
*
@@ -96,9 +106,11 @@ public class HDF5LibraryException extends HDF5Exception {
private native long _getMinorErrorNumber();
/**
+ * @ingroup JERRLIB
+ *
* Return a error message for the minor error number.
- * <p>
- * These messages come from <b>H5Epublic.h</b>.
+ *
+ * These messages come from <b>@ref H5E</b>.
*
* @param err_code
* the error code
@@ -346,19 +358,23 @@ public class HDF5LibraryException extends HDF5Exception {
}
/**
- * Prints this <code>HDF5LibraryException</code>, the HDF-5 Library error
+ * @ingroup JERRLIB
+ *
+ * Prints this <code>HDF5LibraryException</code>, the HDF5 Library error
* stack, and and the Java stack trace to the standard error stream.
*/
@Override
public void printStackTrace()
{
System.err.println(this);
- printStackTrace0(null); // the HDF-5 Library error stack
+ printStackTrace0(null); // the HDF5 Library error stack
super.printStackTrace(); // the Java stack trace
}
/**
- * Prints this <code>HDF5LibraryException</code> the HDF-5 Library error
+ * @ingroup JERRLIB
+ *
+ * Prints this <code>HDF5LibraryException</code> the HDF5 Library error
* stack, and and the Java stack trace to the specified print stream.
*
* @param f
@@ -379,14 +395,14 @@ public class HDF5LibraryException extends HDF5Exception {
catch (Exception ex) {
System.err.println(this);
};
- // the HDF-5 Library error stack
+ // the HDF5 Library error stack
printStackTrace0(f.getPath());
super.printStackTrace(); // the Java stack trace
}
}
/*
- * This private method calls the HDF-5 library to extract the error codes
+ * This private method calls the HDF5 library to extract the error codes
* and error stack.
*/
private native void printStackTrace0(String s);
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5LowLevelIOException.java b/java/src/hdf/hdf5lib/exceptions/HDF5LowLevelIOException.java
index fef5721..719748e 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5LowLevelIOException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5LowLevelIOException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_IO</b>
+ * This sub-class represents HDF5 major error code <b>H5E_IO</b>
*/
public class HDF5LowLevelIOException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5LowLevelIOException</code> with no specified
* detail message.
*/
public HDF5LowLevelIOException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5LowLevelIOException</code> with the specified
* detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5MetaDataCacheException.java b/java/src/hdf/hdf5lib/exceptions/HDF5MetaDataCacheException.java
index 4f00006..298d8b8 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5MetaDataCacheException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5MetaDataCacheException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_CACHE</b>
+ * This sub-class represents HDF5 major error code <b>H5E_CACHE</b>
*/
public class HDF5MetaDataCacheException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5MetaDataCacheException</code> with no specified
* detail message.
*/
public HDF5MetaDataCacheException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5MetaDataCacheException</code> with the specified
* detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5ObjectHeaderException.java b/java/src/hdf/hdf5lib/exceptions/HDF5ObjectHeaderException.java
index 9675354..b6e94be 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5ObjectHeaderException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5ObjectHeaderException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_OHDR</b>
+ * This sub-class represents HDF5 major error code <b>H5E_OHDR</b>
*/
public class HDF5ObjectHeaderException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5ObjectHeaderException</code> with no specified
* detail message.
*/
public HDF5ObjectHeaderException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5ObjectHeaderException</code> with the specified
* detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5PropertyListInterfaceException.java b/java/src/hdf/hdf5lib/exceptions/HDF5PropertyListInterfaceException.java
index 66f0bd1..68d581f 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5PropertyListInterfaceException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5PropertyListInterfaceException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_PLIST</b>
+ * This sub-class represents HDF5 major error code <b>H5E_PLIST</b>
*/
public class HDF5PropertyListInterfaceException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5PropertyListInterfaceException</code> with no
* specified detail message.
*/
public HDF5PropertyListInterfaceException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5PropertyListInterfaceException</code> with the
* specified detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5ReferenceException.java b/java/src/hdf/hdf5lib/exceptions/HDF5ReferenceException.java
index 4feaba7..4c96136 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5ReferenceException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5ReferenceException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_REFERENCE</b>
+ * This sub-class represents HDF5 major error code <b>H5E_REFERENCE</b>
*/
public class HDF5ReferenceException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5ReferenceException</code> with no specified
* detail message.
*/
public HDF5ReferenceException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5ReferenceException</code> with the specified
* detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5ResourceUnavailableException.java b/java/src/hdf/hdf5lib/exceptions/HDF5ResourceUnavailableException.java
index 1a007e7..f920c53 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5ResourceUnavailableException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5ResourceUnavailableException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_RESOURCE</b>
+ * This sub-class represents HDF5 major error code <b>H5E_RESOURCE</b>
*/
public class HDF5ResourceUnavailableException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5ResourceUnavailableException</code> with no
* specified detail message.
*/
public HDF5ResourceUnavailableException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5FunctionArgumentException</code> with the
* specified detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/HDF5SymbolTableException.java b/java/src/hdf/hdf5lib/exceptions/HDF5SymbolTableException.java
index 4fb8c2e..5d3aa90 100644
--- a/java/src/hdf/hdf5lib/exceptions/HDF5SymbolTableException.java
+++ b/java/src/hdf/hdf5lib/exceptions/HDF5SymbolTableException.java
@@ -16,17 +16,21 @@ package hdf.hdf5lib.exceptions;
/**
* The class HDF5LibraryException returns errors raised by the HDF5 library.
* <p>
- * This sub-class represents HDF-5 major error code <b>H5E_SYM</b>
+ * This sub-class represents HDF5 major error code <b>H5E_SYM</b>
*/
public class HDF5SymbolTableException extends HDF5LibraryException {
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5SymbolTableException</code> with no specified
* detail message.
*/
public HDF5SymbolTableException() { super(); }
/**
+ * @ingroup JERRLIB
+ *
* Constructs an <code>HDF5SymbolTableException</code> with the specified
* detail message.
*
diff --git a/java/src/hdf/hdf5lib/exceptions/package-info.java b/java/src/hdf/hdf5lib/exceptions/package-info.java
index 8640ccb..2ac7806 100644
--- a/java/src/hdf/hdf5lib/exceptions/package-info.java
+++ b/java/src/hdf/hdf5lib/exceptions/package-info.java
@@ -12,6 +12,7 @@
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**
+ * @page ERRORS_UG Errors and Exceptions
* <p>
* The package exceptions contains error classes for the Java HDF5 Interface.
* <p>
diff --git a/java/src/hdf/hdf5lib/package-info.java b/java/src/hdf/hdf5lib/package-info.java
index c04b862..7ae4df9 100644
--- a/java/src/hdf/hdf5lib/package-info.java
+++ b/java/src/hdf/hdf5lib/package-info.java
@@ -12,10 +12,11 @@
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**
+ @page HDF5LIB_UG HDF5 Java Package
* This package is the Java interface for the HDF5 library.
* <p>
- * This code is the called by Java programs to access the entry points of the HDF5 library. Each routine wraps
- a single
+ * This code is the called by Java programs to access the entry points of the HDF5 library.
+ * Each routine wraps a single
* HDF5 entry point, generally with the arguments and return codes analogous to the C interface.
* <p>
* For details of the HDF5 library, see the HDF5 Documentation at:
@@ -25,14 +26,13 @@
* <b>Mapping of arguments for Java</b>
*
* <p>
- * In general, arguments to the HDF Java API are straightforward translations from the 'C' API described in
- the HDF
- * Reference Manual.
+ * In general, arguments to the HDF Java API are straightforward translations from the 'C' API described
+ * in the HDF Reference Manual.
*
* <table border=1>
- * <caption><b>HDF-5 C types to Java types</b> </caption>
+ * <caption><b>HDF5 C types to Java types</b> </caption>
* <tr>
- * <td><b>HDF-5</b></td>
+ * <td><b>HDF5</b></td>
* <td><b>Java</b></td>
* </tr>
* <tr>
@@ -60,28 +60,27 @@
* <td>java.lang.String</td>
* </tr>
* <tr>
- * <td>void * <BR>
+ * <td>void * <br />
* (i.e., pointer to `Any')</td>
* <td>Special -- see HDFArray</td>
* </tr>
* </table>
* <b>General Rules for Passing Arguments and Results</b>
* <p>
- * In general, arguments passed <b>IN</b> to Java are the analogous basic types, as above. The exception is
- for arrays,
- * which are discussed below.
+ * In general, arguments passed <b>IN</b> to Java are the analogous basic types, as above. The exception
+ * is for arrays, which are discussed below.
* <p>
* The <i>return value</i> of Java methods is also the analogous type, as above. A major exception to that
- rule is that
+ * rule is that
* all HDF functions that return SUCCEED/FAIL are declared <i>boolean</i> in the Java version, rather than
- <i>int</i> as
+ * <i>int</i> as
* in the C. Functions that return a value or else FAIL are declared the equivalent to the C function.
- However, in most
+ * However, in most
* cases the Java method will raise an exception instead of returning an error code.
- * See <a href="#ERRORS">Errors and Exceptions</a> below.
+ * @see @ref ERRORS.
* <p>
* Java does not support pass by reference of arguments, so arguments that are returned through <b>OUT</b>
- parameters
+ * parameters
* must be wrapped in an object or array. The Java API for HDF consistently wraps arguments in arrays.
* <p>
* For instance, a function that returns two integers is declared:
@@ -104,12 +103,12 @@
*
* <p>
* All the routines where this convention is used will have specific documentation of the details, given
- below.
+ * below.
* <p>
* <b>Arrays</b>
* <p>
* HDF5 needs to read and write multi-dimensional arrays of any number type (and records). The HDF5 API
- describes the
+ * describes the
* layout of the source and destination, and the data for the array passed as a block of bytes, for instance,
*
* <pre>
@@ -118,52 +117,52 @@
*
* <p>
* where ``void *'' means that the data may be any valid numeric type, and is a contiguous block of bytes that
- is the
+ * is the
* data for a multi-dimensional array. The other parameters describe the dimensions, rank, and datatype of the
- array on
+ * array on
* disk (source) and in memory (destination).
* <p>
* For Java, this ``ANY'' is a problem, as the type of data must always be declared. Furthermore,
- multidimensional
+ * multidimensional
* arrays are definitely <i>not</i> laid out contiguously in memory. It would be infeasible to declare a
- separate
+ * separate
* routine for every combination of number type and dimensionality. For that reason, the
- * <a href="./hdf.hdf5lib.HDFArray.html"><b>HDFArray</b></a> class is used to discover the type, shape, and
- size of the
+ * <a href="./HDFArray.html"><b>HDFArray</b></a> class is used to discover the type, shape, and
+ * size of the
* data array at run time, and to convert to and from a contiguous array of bytes in synchronized static
- native C order.
+ * native C order.
* <p>
* The upshot is that any Java array of numbers (either primitive or sub-classes of type <b>Number</b>) can be
- passed as
+ * passed as
* an ``Object'', and the Java API will translate to and from the appropriate packed array of bytes needed by
- the C
+ * the C
* library. So the function above would be declared:
*
* <pre>
* public synchronized static native int H5Dread(long fid, long filetype, long memtype, long memspace, Object
- data);
+ * data);
* </pre>
* OPEN_IDS.addElement(id);
* and the parameter <i>data</i> can be any multi-dimensional array of numbers, such as float[][], or
- int[][][], or
+ * int[][][], or
* Double[][].
* <p>
- * <b>HDF-5 Constants</b>
+ * <b>HDF5 Constants</b>
* <p>
- * The HDF-5 API defines a set of constants and enumerated values. Most of these values are available to Java
- programs
- * via the class <a href="./hdf.hdf5lib.HDF5Constants.html"> <b>HDF5Constants</b></a>. For example, the
- parameters for
+ * The HDF5 API defines a set of constants and enumerated values. Most of these values are available to Java
+ * programs
+ * via the class <a href="./HDF5Constants.html"> <b>HDF5Constants</b></a>. For example, the
+ * parameters for
* the h5open() call include two numeric values, <b><i>HDFConstants.H5F_ACC_RDWR</i></b> and
* <b><i>HDF5Constants.H5P_DEFAULT</i></b>. As would be expected, these numbers correspond to the C constants
* <b><i>H5F_ACC_RDWR</i></b> and <b><i>H5P_DEFAULT</i></b>.
* <p>
- * 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
- * <a href="./hdf.hdf5lib.HDF5CDataTypes.html"> <b>HDF5CDataTypes</b></a> looks up the values when initiated.
- The values
+ * The HDF5 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 HDF5 C library. To support these parameters, the Java class
+ * <a href="./HDF5CDataTypes.html"> <b>HDF5CDataTypes</b></a> looks up the values when initiated.
+ * The values
* can be accessed as public variables of the Java class, such as:
*
* <pre>
@@ -175,31 +174,30 @@
* <p>
* <b>Error handling and Exceptions</b>
* <p>
- * The HDF5 error API (H5E) manages the behavior of the error stack in the HDF-5 library. This API is
- available from the
+ * The HDF5 error API (H5E) manages the behavior of the error stack in the HDF5 library. This API is
+ * available from the
* JHI5. Errors are converted into Java exceptions. This is totally different from the C interface, but is
- very natural
+ * very natural
* for Java programming.
* <p>
* The exceptions of the JHI5 are organized as sub-classes of the class
- * <a href="./hdf.hdf5lib.exceptions.HDF5Exception.html"> <b>HDF5Exception</b></a>. There are two subclasses
- of
- * <b>HDF5Exception</b>, <a href="./hdf.hdf5lib.exceptions.HDF5LibraryException.html">
- <b>HDF5LibraryException</b></a>
- * and <a href="./hdf.hdf5lib.exceptions.HDF5JavaException.html"> <b>HDF5JavaException</b></a>. 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.
- * <p>
- * The super-class <b><i>HDF5LibraryException</i></b> implements the method '<b><i>printStackTrace()</i></b>',
- which
- * prints out the HDF-5 error stack, as described in the HDF-5 C API <i><b>H5Eprint()</b>.</i> This may be
- used by Java
- * exception handlers to print out the HDF-5 error stack.
+ * <a href="./HDF5Exception.html"> <b>HDF5Exception</b></a>. There are two subclasses
+ * of
+ * <b>HDF5Exception</b>, @ref ERRORSLIB <b>HDF5LibraryException</b>
+ * and @ref ERRORSJAVA <b>HDF5JavaException</b>.
+ * The sub-classes of the former represent errors from the HDF5 C library,
+ * while sub-classes of the latter represent errors in the JHI5 wrapper and support code.
+ * <p>
+ * The super-class <b><i>HDF5LibraryException</i></b> implements the method
+ * '<b><i>printStackTrace()</i></b>', which prints out the HDF5 error stack, as described
+ * in the HDF5 C API <i><b>@ref H5Eprint()</b>.</i> This may be
+ * used by Java
+ * exception handlers to print out the HDF5 error stack.
* <hr>
*
- * <b>See also: <a href="http://hdfgroup.org/HDF5/"> http://hdfgroup.org/HDF5"</a></b>
+ * @ref HDF5LIB
+ *
+ * <b>@see: <a href="http://hdfgroup.org/HDF5/"> HDF5"</a></b>
*
*/
package hdf.hdf5lib;
diff --git a/java/src/hdf/overview.html b/java/src/hdf/overview.html
index e3a032b..4d40a0e 100644
--- a/java/src/hdf/overview.html
+++ b/java/src/hdf/overview.html
@@ -4,7 +4,7 @@
<h2><u>What it is</u></h2>
The <b>Java HD5 Interface (JHI5)</b> is a Java package
-(<a href="../../hdf-java-html/javadocs/hdf/hdf5lib/package-summary.html">hdf.hdf5lib</a>)
+(<a href="./hdf/hdf5lib/package-summary.html">hdf.hdf5lib</a>)
that ``wraps around'' the HDF5 library.
<p>There are a large number of functions in the HDF5
library (version 1.10). Some of the functions are not supported in JHI5. Most
@@ -32,7 +32,7 @@ library contains C functions which implement the native methods. The C
functions call the standard HDF5 library, which is linked as part of the
same library on most platforms.
<p>The central part of the JHI5 is the Java class <i>
-<a href="../../hdf-java-html/javadocs/hdf/hdf5lib/H5.html">hdf.hdf5lib.H5</a></i>.
+<a href="./hdf/hdf5lib/H5.html">hdf.hdf5lib.H5</a></i>.
The <i>H5 </i>class calls the standard (<i>i.e.</i>, `native' code) HDF5
library, with native methods for most of the HDF5 functions.
@@ -42,11 +42,11 @@ The JHI5 is used by Java classes to call the HDF5 library, in order to
create HDF5 files, and read and write data in existing HDF5 files.
<p>For example, the HDF5 library has the function <b>H5Fopen</b> to open
an HDF5 file. The Java interface is the class <i>
-<a href="../../hdf-java-html/javadocs/hdf/hdf5lib/H5.html">hdf.hdf5lib.H5</a></i>,
+<a href="./hdf/hdf5lib/H5.html">hdf.hdf5lib.H5</a></i>,
which has a method:
<pre><b>static native int H5Fopen(String filename, int flags, int access );</b></pre>
The native method is implemented in C using the
-<a href="http://java.sun.com/javase/6/docs/technotes/guides/jni/index.html">Java
+<a href="https://docs.oracle.com/en/java/javase/18/docs/specs/jni/index.html">Java
Native Method Interface </a>(JNI). This is written something like the following:
<pre><b>JNIEXPORT jlong
JNICALL Java_hdf_hdf5lib_H5_H5Fopen