Package hdf.hdf5lib

Class H5

    • Constructor Detail

      • H5

        public H5()
    • Method Detail

      • loadH5Lib

        public static void loadH5Lib()
      • getOpenIDCount

        public static final int getOpenIDCount()
        Returns:
        Returns a count of open IDs
      • getOpenIDs

        public static final Collection<Long> getOpenIDs()
        Returns:
        Returns a collection of open IDs
      • H5check_version

        public static int H5check_version​(int majnum,
                                          int minnum,
                                          int relnum)
        Parameters:
        majnum - The major version of the library.
        minnum - The minor version of the library.
        relnum - The release number of the library.
        Returns:
        a non-negative value if successful. Upon failure (when the versions do not match), this function causes the application to abort (i.e., crash) See C API function: @ref herr_t H5check_version(unsigned majnum, unsigned minnum, unsigned relnum)
      • H5error_off

        public static int H5error_off()
        Returns:
        a non-negative value if successful
      • H5error_on

        public static void H5error_on()
      • H5get_libversion

        public static int H5get_libversion​(int[] libversion)
                                    throws HDF5LibraryException
        Parameters:
        libversion - The version information of the HDF library.
              libversion[0] = The major version of the library.
              libversion[1] = The minor version of the library.
              libversion[2] = The release number of the library.
         
        Returns:
        a non-negative value if successful, along with the version information.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5set_free_list_limits

        public static int H5set_free_list_limits​(int reg_global_lim,
                                                 int reg_list_lim,
                                                 int arr_global_lim,
                                                 int arr_list_lim,
                                                 int blk_global_lim,
                                                 int blk_list_lim)
                                          throws HDF5LibraryException
        Parameters:
        reg_global_lim - The limit on all "regular" free list memory used
        reg_list_lim - The limit on memory used in each "regular" free list
        arr_global_lim - The limit on all "array" free list memory used
        arr_list_lim - The limit on memory used in each "array" free list
        blk_global_lim - The limit on all "block" free list memory used
        blk_list_lim - The limit on memory used in each "block" free list
        Returns:
        a non-negative value if successful, along with the version information.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5export_dataset

        public static void H5export_dataset​(String file_export_name,
                                            long file_id,
                                            String object_path,
                                            int binary_order)
                                     throws HDF5LibraryException
        Parameters:
        file_export_name - The file name to export data into.
        file_id - The identifier of the HDF5 file containing the dataset.
        object_path - The full path of the dataset to be exported.
        binary_order - 99 - export data as text. 1 - export data as binary Native Order. 2 - export data as binary Little Endian. 3 - export data as binary Big Endian.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5export_attribute

        public static void H5export_attribute​(String file_export_name,
                                              long dataset_id,
                                              String attribute_name,
                                              int binary_order)
                                       throws HDF5LibraryException
        Parameters:
        file_export_name - The file name to export data into.
        dataset_id - The identifier of the dataset containing the attribute.
        attribute_name - The attribute to be exported.
        binary_order - 99 - export data as text. 1 - export data as binary Native Order. 2 - export data as binary Little Endian. 3 - export data as binary Big Endian.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Aclose

        public static int H5Aclose​(long attr_id)
                            throws HDF5LibraryException
        Parameters:
        attr_id - IN: Attribute to release access to.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Acopy

        public static int H5Acopy​(long src_aid,
                                  long dst_aid)
                           throws HDF5LibraryException
        Parameters:
        src_aid - the identifier of the source attribute
        dst_aid - the identifier of the destination attribute
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Acreate

        public static long H5Acreate​(long loc_id,
                                     String attr_name,
                                     long type_id,
                                     long space_id,
                                     long acpl_id,
                                     long aapl_id)
                              throws HDF5LibraryException,
                                     NullPointerException
        Parameters:
        loc_id - IN: Location or object identifier; may be dataset or group
        attr_name - IN: Attribute name
        type_id - IN: Attribute datatype identifier
        space_id - IN: Attribute dataspace identifier
        acpl_id - IN: Attribute creation property list identifier
        aapl_id - IN: Attribute access property list identifier
        Returns:
        An attribute identifier if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - Name is null.
      • H5Acreate_by_name

        public static long H5Acreate_by_name​(long loc_id,
                                             String obj_name,
                                             String attr_name,
                                             long type_id,
                                             long space_id,
                                             long acpl_id,
                                             long aapl_id,
                                             long lapl_id)
                                      throws HDF5LibraryException,
                                             NullPointerException
        Parameters:
        loc_id - IN: Location or object identifier; may be dataset or group
        obj_name - IN: Name, relative to loc_id, of object that attribute is to be attached to
        attr_name - IN: Attribute name
        type_id - IN: Attribute datatype identifier
        space_id - IN: Attribute dataspace identifier
        acpl_id - IN: Attribute creation property list identifier (currently not used).
        aapl_id - IN: Attribute access property list identifier (currently not used).
        lapl_id - IN: Link access property list
        Returns:
        An attribute identifier if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Adelete_by_idx

        public static void H5Adelete_by_idx​(long loc_id,
                                            String obj_name,
                                            int idx_type,
                                            int order,
                                            long n,
                                            long lapl_id)
                                     throws HDF5LibraryException,
                                            NullPointerException
        Parameters:
        loc_id - IN: Location or object identifier; may be dataset or group
        obj_name - IN: Name of object, relative to location, from which attribute is to be removed
        idx_type - IN: Type of index
        order - IN: Order in which to iterate over index
        n - IN: Offset within index
        lapl_id - IN: Link access property list identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - obj_name is null.
      • H5Adelete_by_name

        public static int H5Adelete_by_name​(long loc_id,
                                            String obj_name,
                                            String attr_name,
                                            long lapl_id)
                                     throws HDF5LibraryException,
                                            NullPointerException
        Parameters:
        loc_id - IN: Location or object identifier; may be dataset or group
        obj_name - IN: Name of object, relative to location, from which attribute is to be removed
        attr_name - IN: Name of attribute to delete
        lapl_id - IN: Link access property list identifier.
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Aexists_by_name

        public static boolean H5Aexists_by_name​(long loc_id,
                                                String obj_name,
                                                String attr_name,
                                                long lapl_id)
                                         throws HDF5LibraryException,
                                                NullPointerException
        Parameters:
        loc_id - IN: Location of object to which attribute is attached .
        obj_name - IN: Name, relative to loc_id, of object that attribute is attached to.
        attr_name - IN: Name of attribute.
        lapl_id - IN: Link access property list identifier.
        Returns:
        boolean true if an attribute with a given name exists, otherwise returns false.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Aget_info

        public static H5A_info_t H5Aget_info​(long attr_id)
                                      throws HDF5LibraryException
        Parameters:
        attr_id - IN: Attribute identifier
        Returns:
        A buffer(H5A_info_t) for Attribute information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Aget_info_by_idx

        public static H5A_info_t H5Aget_info_by_idx​(long loc_id,
                                                    String obj_name,
                                                    int idx_type,
                                                    int order,
                                                    long n,
                                                    long lapl_id)
                                             throws HDF5LibraryException,
                                                    NullPointerException
        Parameters:
        loc_id - IN: Location of object to which attribute is attached
        obj_name - IN: Name of object to which attribute is attached, relative to location
        idx_type - IN: Type of index
        order - IN: Index traversal order
        n - IN: Attribute's position in index
        lapl_id - IN: Link access property list
        Returns:
        A buffer(H5A_info_t) for Attribute information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - obj_name is null.
      • H5Aget_info_by_name

        public static H5A_info_t H5Aget_info_by_name​(long loc_id,
                                                     String obj_name,
                                                     String attr_name,
                                                     long lapl_id)
                                              throws HDF5LibraryException,
                                                     NullPointerException
        Parameters:
        loc_id - IN: Location of object to which attribute is attached
        obj_name - IN: Name of object to which attribute is attached, relative to location
        attr_name - IN: Attribute name
        lapl_id - IN: Link access property list
        Returns:
        A buffer(H5A_info_t) for Attribute information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - obj_name is null.
      • H5Aget_name

        public static String H5Aget_name​(long attr_id)
                                  throws HDF5LibraryException
        Parameters:
        attr_id - IN: Identifier of the attribute.
        Returns:
        String for Attribute name.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Aget_name_by_idx

        public static String H5Aget_name_by_idx​(long attr_id,
                                                String obj_name,
                                                int idx_type,
                                                int order,
                                                long n,
                                                long lapl_id)
                                         throws HDF5LibraryException,
                                                NullPointerException
        Parameters:
        attr_id - IN: Attribute identifier
        obj_name - IN: Name of object to which attribute is attached, relative to location
        idx_type - IN: Type of index
        order - IN: Index traversal order
        n - IN: Attribute's position in index
        lapl_id - IN: Link access property list
        Returns:
        String for Attribute name.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - obj_name is null.
      • H5Aget_space

        public static long H5Aget_space​(long attr_id)
                                 throws HDF5LibraryException
        Parameters:
        attr_id - IN: Identifier of an attribute.
        Returns:
        attribute dataspace identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Aget_storage_size

        public static long H5Aget_storage_size​(long attr_id)
                                        throws HDF5LibraryException
        Parameters:
        attr_id - IN: Identifier of the attribute to query.
        Returns:
        the amount of storage size allocated for the attribute; otherwise returns 0 (zero)
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Aget_type

        public static long H5Aget_type​(long attr_id)
                                throws HDF5LibraryException
        Parameters:
        attr_id - IN: Identifier of an attribute.
        Returns:
        a datatype identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Aopen

        public static long H5Aopen​(long obj_id,
                                   String attr_name,
                                   long aapl_id)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        obj_id - IN: Identifier for object to which attribute is attached
        attr_name - IN: Name of attribute to open
        aapl_id - IN: Attribute access property list identifier
        Returns:
        An attribute identifier if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - Name is null.
      • H5Aopen_by_idx

        public static long H5Aopen_by_idx​(long loc_id,
                                          String obj_name,
                                          int idx_type,
                                          int order,
                                          long n,
                                          long aapl_id,
                                          long lapl_id)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        loc_id - IN: Location of object to which attribute is attached
        obj_name - IN: Name of object to which attribute is attached, relative to location
        idx_type - IN: Type of index
        order - IN: Index traversal order
        n - IN: Attribute's position in index
        aapl_id - IN: Attribute access property list
        lapl_id - IN: Link access property list
        Returns:
        An attribute identifier if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - Name is null.
      • H5Aopen_by_name

        public static long H5Aopen_by_name​(long loc_id,
                                           String obj_name,
                                           String attr_name,
                                           long aapl_id,
                                           long lapl_id)
                                    throws HDF5LibraryException,
                                           NullPointerException
        Parameters:
        loc_id - IN: Location from which to find object to which attribute is attached
        obj_name - IN: Name of object to which attribute is attached, relative to loc_id
        attr_name - IN: Name of attribute to open
        aapl_id - IN: Attribute access property list
        lapl_id - IN: Link access property list identifier
        Returns:
        Returns an attribute identifier if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - obj_name is null.
      • H5Aread

        public static int H5Aread​(long attr_id,
                                  long mem_type_id,
                                  byte[] obj,
                                  boolean isCriticalPinning)
                           throws HDF5LibraryException,
                                  NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        obj - Buffer to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread

        public static int H5Aread​(long attr_id,
                                  long mem_type_id,
                                  byte[] buf)
                           throws HDF5LibraryException,
                                  NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread

        public static int H5Aread​(long attr_id,
                                  long mem_type_id,
                                  Object obj,
                                  boolean isCriticalPinning)
                           throws HDF5Exception,
                                  HDF5LibraryException,
                                  NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        obj - IN: Object for data to be read.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5Exception - Failure in the data conversion.
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null. See public synchronized static native int H5Aread( )
      • H5Aread_double

        public static int H5Aread_double​(long attr_id,
                                         long mem_type_id,
                                         double[] buf,
                                         boolean isCriticalPinning)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of double to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_double

        public static int H5Aread_double​(long attr_id,
                                         long mem_type_id,
                                         double[] buf)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of double to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_float

        public static int H5Aread_float​(long attr_id,
                                        long mem_type_id,
                                        float[] buf,
                                        boolean isCriticalPinning)
                                 throws HDF5LibraryException,
                                        NullPointerException
        H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with mem_type_id. The entire attribute is read into buffer of float from the file.
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of float to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_float

        public static int H5Aread_float​(long attr_id,
                                        long mem_type_id,
                                        float[] buf)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of float to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_int

        public static int H5Aread_int​(long attr_id,
                                      long mem_type_id,
                                      int[] buf,
                                      boolean isCriticalPinning)
                               throws HDF5LibraryException,
                                      NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of int to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_int

        public static int H5Aread_int​(long attr_id,
                                      long mem_type_id,
                                      int[] buf)
                               throws HDF5LibraryException,
                                      NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of int to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_long

        public static int H5Aread_long​(long attr_id,
                                       long mem_type_id,
                                       long[] buf,
                                       boolean isCriticalPinning)
                                throws HDF5LibraryException,
                                       NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of long to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_long

        public static int H5Aread_long​(long attr_id,
                                       long mem_type_id,
                                       long[] buf)
                                throws HDF5LibraryException,
                                       NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of long to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_reg_ref

        public static int H5Aread_reg_ref​(long attr_id,
                                          long mem_type_id,
                                          String[] buf)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of String to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_short

        public static int H5Aread_short​(long attr_id,
                                        long mem_type_id,
                                        short[] buf,
                                        boolean isCriticalPinning)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of short to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_short

        public static int H5Aread_short​(long attr_id,
                                        long mem_type_id,
                                        short[] buf)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of short to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5AreadVL

        public static int H5AreadVL​(long attr_id,
                                    long mem_type_id,
                                    Object[] buf)
                             throws HDF5LibraryException,
                                    NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of variable-lenght to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_string

        public static int H5Aread_string​(long attr_id,
                                         long mem_type_id,
                                         String[] buf)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of String to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Aread_VLStrings

        public static int H5Aread_VLStrings​(long attr_id,
                                            long mem_type_id,
                                            Object[] buf)
                                     throws HDF5LibraryException,
                                            NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of variable-lenght strings to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5AreadComplex

        public static int H5AreadComplex​(long attr_id,
                                         long mem_type_id,
                                         String[] buf)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to read.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - Buffer of string to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Arename

        public static int H5Arename​(long loc_id,
                                    String old_attr_name,
                                    String new_attr_name)
                             throws HDF5LibraryException,
                                    NullPointerException
        Parameters:
        loc_id - IN: Location or object identifier; may be dataset or group
        old_attr_name - IN: Prior attribute name
        new_attr_name - IN: New attribute name
        Returns:
        A non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - Name is null.
      • H5Arename_by_name

        public static int H5Arename_by_name​(long loc_id,
                                            String obj_name,
                                            String old_attr_name,
                                            String new_attr_name,
                                            long lapl_id)
                                     throws HDF5LibraryException,
                                            NullPointerException
        Parameters:
        loc_id - IN: Location or object identifier; may be dataset or group
        obj_name - IN: Name of object, relative to location, whose attribute is to be renamed
        old_attr_name - IN: Prior attribute name
        new_attr_name - IN: New attribute name
        lapl_id - IN: Link access property list
        Returns:
        A non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - Name is null.
      • H5Awrite

        public static int H5Awrite​(long attr_id,
                                   long mem_type_id,
                                   byte[] buf,
                                   boolean isCriticalPinning)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer with data to be written to the file.
        isCriticalPinning - IN: request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite

        public static int H5Awrite​(long attr_id,
                                   long mem_type_id,
                                   byte[] buf)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite

        public static int H5Awrite​(long attr_id,
                                   long mem_type_id,
                                   Object obj,
                                   boolean isCriticalPinning)
                            throws HDF5Exception,
                                   HDF5LibraryException,
                                   NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        obj - IN: Data object to be written.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5Exception - Failure in the data conversion.
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data object is null
      • H5Awrite_double

        public static int H5Awrite_double​(long attr_id,
                                          long mem_type_id,
                                          double[] buf,
                                          boolean isCriticalPinning)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of double with data to be written to the file.
        isCriticalPinning - IN: request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite_double

        public static int H5Awrite_double​(long attr_id,
                                          long mem_type_id,
                                          double[] buf)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of double with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite_float

        public static int H5Awrite_float​(long attr_id,
                                         long mem_type_id,
                                         float[] buf,
                                         boolean isCriticalPinning)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of float with data to be written to the file.
        isCriticalPinning - IN: request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite_float

        public static int H5Awrite_float​(long attr_id,
                                         long mem_type_id,
                                         float[] buf)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of float with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite_int

        public static int H5Awrite_int​(long attr_id,
                                       long mem_type_id,
                                       int[] buf,
                                       boolean isCriticalPinning)
                                throws HDF5LibraryException,
                                       NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of int with data to be written to the file.
        isCriticalPinning - IN: request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite_int

        public static int H5Awrite_int​(long attr_id,
                                       long mem_type_id,
                                       int[] buf)
                                throws HDF5LibraryException,
                                       NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of int with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite_long

        public static int H5Awrite_long​(long attr_id,
                                        long mem_type_id,
                                        long[] buf,
                                        boolean isCriticalPinning)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of long with data to be written to the file.
        isCriticalPinning - IN: request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite_long

        public static int H5Awrite_long​(long attr_id,
                                        long mem_type_id,
                                        long[] buf)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of long with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite_short

        public static int H5Awrite_short​(long attr_id,
                                         long mem_type_id,
                                         short[] buf,
                                         boolean isCriticalPinning)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of short with data to be written to the file.
        isCriticalPinning - IN: request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite_short

        public static int H5Awrite_short​(long attr_id,
                                         long mem_type_id,
                                         short[] buf)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of short with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite_string

        public static int H5Awrite_string​(long attr_id,
                                          long mem_type_id,
                                          String[] buf)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of string with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5AwriteVL

        public static int H5AwriteVL​(long attr_id,
                                     long mem_type_id,
                                     Object[] buf)
                              throws HDF5LibraryException,
                                     NullPointerException
        Parameters:
        attr_id - IN: Identifier of an attribute to write.
        mem_type_id - IN: Identifier of the attribute datatype (in memory).
        buf - IN: Buffer of variable-lenght with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data is null.
      • H5Awrite_VLStrings

        public static int H5Awrite_VLStrings​(long attr_id,
                                             long mem_type_id,
                                             Object[] buf)
                                      throws HDF5LibraryException,
                                             NullPointerException
        Parameters:
        attr_id - Identifier of the attribute read from.
        mem_type_id - Identifier of the memory datatype.
        buf - Buffer of variable-lenght strings with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Aget_create_plist

        public static long H5Aget_create_plist​(long attr_id)
                                        throws HDF5LibraryException
        Parameters:
        attr_id - IN: Identifier of an attribute.
        Returns:
        identifier for the attribute's creation property list if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Aiterate

        public static int H5Aiterate​(long loc_id,
                                     int idx_type,
                                     int order,
                                     long idx,
                                     H5A_iterate_cb op,
                                     H5A_iterate_t op_data)
                              throws HDF5LibraryException,
                                     NullPointerException
        Parameters:
        loc_id - IN: Identifier for object to which attributes are attached; may be group, dataset, or named datatype.
        idx_type - IN: The type of index specified by idx_type can be one of the following: H5_INDEX_NAME An alphanumeric index by attribute name. H5_INDEX_CRT_ORDER An index by creation order.
        order - IN: The order in which the index is to be traversed, as specified by order, can be one of the following: H5_ITER_INC Iteration is from beginning to end, i.e., a top-down iteration incrementing the index position at each step. H5_ITER_DEC Iteration starts at the end of the index, i.e., a bottom-up iteration decrementing the index position at each step. H5_ITER_NATIVE HDF5 iterates in the fastest-available order. No information is provided as to the order, but HDF5 ensures that each element in the index will be visited if the iteration completes successfully.
        idx - IN/OUT: Initial and returned offset within index.
        op - IN: Callback function to operate on each value.
        op_data - IN/OUT: Pointer to any user-efined data for use by operator function.
        Returns:
        returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - buf is null.
      • H5Aiterate_by_name

        public static int H5Aiterate_by_name​(long loc_id,
                                             String obj_name,
                                             int idx_type,
                                             int order,
                                             long idx,
                                             H5A_iterate_cb op,
                                             H5A_iterate_t op_data,
                                             long lapl_id)
                                      throws HDF5LibraryException,
                                             NullPointerException
        Parameters:
        loc_id - IN: Identifier for object to which attributes are attached; may be group, dataset, or named datatype.
        obj_name - IN: Name of object, relative to location.
        idx_type - IN: The type of index specified by idx_type can be one of the following: H5_INDEX_NAME An alphanumeric index by attribute name. H5_INDEX_CRT_ORDER An index by creation order.
        order - IN: The order in which the index is to be traversed, as specified by order, can be one of the following: H5_ITER_INC Iteration is from beginning to end, i.e., a top-down iteration incrementing the index position at each step. H5_ITER_DEC Iteration starts at the end of the index, i.e., a bottom-up iteration decrementing the index position at each step. H5_ITER_NATIVE HDF5 iterates in the fastest-available order. No information is provided as to the order, but HDF5 ensures that each element in the index will be visited if the iteration completes successfully.
        idx - IN/OUT: Initial and returned offset within index.
        op - IN: Callback function to operate on each value.
        op_data - IN/OUT: Pointer to any user-efined data for use by operator function.
        lapl_id - IN: Link access property list
        Returns:
        returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - buf is null.
      • H5Dcopy

        public static int H5Dcopy​(long src_did,
                                  long dst_did)
                           throws HDF5LibraryException
        Parameters:
        src_did - the identifier of the source dataset
        dst_did - the identifier of the destination dataset
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Dclose

        public static int H5Dclose​(long dataset_id)
                            throws HDF5LibraryException
        Parameters:
        dataset_id - Identifier of the dataset to finish access to.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Dcreate

        public static long H5Dcreate​(long loc_id,
                                     String name,
                                     long type_id,
                                     long space_id,
                                     long lcpl_id,
                                     long dcpl_id,
                                     long dapl_id)
                              throws HDF5LibraryException,
                                     NullPointerException
        Parameters:
        loc_id - IN: Location identifier
        name - IN: Dataset name
        type_id - IN: Datatype identifier
        space_id - IN: Dataspace identifier
        lcpl_id - IN: Identifier of link creation property list.
        dcpl_id - IN: Identifier of dataset creation property list.
        dapl_id - IN: Identifier of dataset access property list.
        Returns:
        a dataset identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dcreate_anon

        public static long H5Dcreate_anon​(long loc_id,
                                          long type_id,
                                          long space_id,
                                          long dcpl_id,
                                          long dapl_id)
                                   throws HDF5LibraryException
        Parameters:
        loc_id - IN: Location identifier
        type_id - IN: Datatype identifier
        space_id - IN: Dataspace identifier
        dcpl_id - IN: Identifier of dataset creation property list.
        dapl_id - IN: Identifier of dataset access property list.
        Returns:
        a dataset identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Dfill

        public static void H5Dfill​(byte[] fill,
                                   long fill_type,
                                   byte[] buf,
                                   long buf_type,
                                   long space_id)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        fill - IN: Pointer to the fill value to be used.
        fill_type - IN: Fill value datatype identifier.
        buf - IN/OUT: Pointer to the memory buffer containing the selection to be filled.
        buf_type - IN: Datatype of dataspace elements to be filled.
        space_id - IN: Dataspace describing memory buffer and containing the selection to be filled.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - buf is null.
      • H5Dget_access_plist

        public static long H5Dget_access_plist​(long dset_id)
                                        throws HDF5LibraryException
        Parameters:
        dset_id - IN: Identifier of the dataset to query.
        Returns:
        a dataset access property list identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Dget_create_plist

        public static long H5Dget_create_plist​(long dataset_id)
                                        throws HDF5LibraryException
        Parameters:
        dataset_id - Identifier of the dataset to query.
        Returns:
        a dataset creation property list identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Dget_offset

        public static long H5Dget_offset​(long dset_id)
                                  throws HDF5LibraryException
        Parameters:
        dset_id - IN: Identifier of the dataset in question
        Returns:
        the offset in bytes.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Dget_space

        public static long H5Dget_space​(long dataset_id)
                                 throws HDF5LibraryException
        Parameters:
        dataset_id - Identifier of the dataset to query.
        Returns:
        a dataspace identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Dget_space_status

        public static int H5Dget_space_status​(long dset_id)
                                       throws HDF5LibraryException
        Parameters:
        dset_id - IN: Identifier of the dataset to query.
        Returns:
        the space allocation status
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Dget_type

        public static long H5Dget_type​(long dataset_id)
                                throws HDF5LibraryException
        Parameters:
        dataset_id - Identifier of the dataset to query.
        Returns:
        a datatype identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Diterate

        public static int H5Diterate​(byte[] buf,
                                     long buf_type,
                                     long space_id,
                                     H5D_iterate_cb op,
                                     H5D_iterate_t op_data)
                              throws HDF5LibraryException,
                                     NullPointerException
        Parameters:
        buf - IN/OUT: Pointer to the memory containing the elements to iterate over.
        buf_type - IN: Buffer datatype identifier.
        space_id - IN: Dataspace describing memory buffer.
        op - IN: Callback function to operate on each value.
        op_data - IN/OUT: Pointer to any user-efined data for use by operator function.
        Returns:
        returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - buf is null.
      • H5Dread

        public static int H5Dread​(long dataset_id,
                                  long mem_type_id,
                                  long mem_space_id,
                                  long file_space_id,
                                  long xfer_plist_id,
                                  byte[] obj,
                                  boolean isCriticalPinning)
                           throws HDF5LibraryException,
                                  NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        obj - Buffer to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread

        public static int H5Dread​(long dataset_id,
                                  long mem_type_id,
                                  long mem_space_id,
                                  long file_space_id,
                                  long xfer_plist_id,
                                  byte[] buf)
                           throws HDF5LibraryException,
                                  NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread

        public static int H5Dread​(long dataset_id,
                                  long mem_type_id,
                                  long mem_space_id,
                                  long file_space_id,
                                  long xfer_plist_id,
                                  Object obj)
                           throws HDF5Exception,
                                  HDF5LibraryException,
                                  NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        obj - Buffer to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
        HDF5Exception
      • H5Dread

        public 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
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        obj - Object to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5Exception - Failure in the data conversion.
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data object is null.
      • H5Dread_double

        public static int H5Dread_double​(long dataset_id,
                                         long mem_type_id,
                                         long mem_space_id,
                                         long file_space_id,
                                         long xfer_plist_id,
                                         double[] buf,
                                         boolean isCriticalPinning)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of type double to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_double

        public static int H5Dread_double​(long dataset_id,
                                         long mem_type_id,
                                         long mem_space_id,
                                         long file_space_id,
                                         long xfer_plist_id,
                                         double[] buf)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of double to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_float

        public static int H5Dread_float​(long dataset_id,
                                        long mem_type_id,
                                        long mem_space_id,
                                        long file_space_id,
                                        long xfer_plist_id,
                                        float[] buf,
                                        boolean isCriticalPinning)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of float to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_float

        public static int H5Dread_float​(long dataset_id,
                                        long mem_type_id,
                                        long mem_space_id,
                                        long file_space_id,
                                        long xfer_plist_id,
                                        float[] buf)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of float to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_int

        public static int H5Dread_int​(long dataset_id,
                                      long mem_type_id,
                                      long mem_space_id,
                                      long file_space_id,
                                      long xfer_plist_id,
                                      int[] buf,
                                      boolean isCriticalPinning)
                               throws HDF5LibraryException,
                                      NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of int to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_int

        public static int H5Dread_int​(long dataset_id,
                                      long mem_type_id,
                                      long mem_space_id,
                                      long file_space_id,
                                      long xfer_plist_id,
                                      int[] buf)
                               throws HDF5LibraryException,
                                      NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of int to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_long

        public static int H5Dread_long​(long dataset_id,
                                       long mem_type_id,
                                       long mem_space_id,
                                       long file_space_id,
                                       long xfer_plist_id,
                                       long[] buf,
                                       boolean isCriticalPinning)
                                throws HDF5LibraryException,
                                       NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of long to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_long

        public static int H5Dread_long​(long dataset_id,
                                       long mem_type_id,
                                       long mem_space_id,
                                       long file_space_id,
                                       long xfer_plist_id,
                                       long[] buf)
                                throws HDF5LibraryException,
                                       NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of long to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_reg_ref

        public static int H5Dread_reg_ref​(long dataset_id,
                                          long mem_type_id,
                                          long mem_space_id,
                                          long file_space_id,
                                          long xfer_plist_id,
                                          String[] buf)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of string to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_short

        public static int H5Dread_short​(long dataset_id,
                                        long mem_type_id,
                                        long mem_space_id,
                                        long file_space_id,
                                        long xfer_plist_id,
                                        short[] buf,
                                        boolean isCriticalPinning)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of short to store data read from the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_short

        public static int H5Dread_short​(long dataset_id,
                                        long mem_type_id,
                                        long mem_space_id,
                                        long file_space_id,
                                        long xfer_plist_id,
                                        short[] buf)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of short to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5DreadVL

        public static int H5DreadVL​(long dataset_id,
                                    long mem_type_id,
                                    long mem_space_id,
                                    long file_space_id,
                                    long xfer_plist_id,
                                    Object[] buf)
                             throws HDF5LibraryException,
                                    NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of variable-lenght to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_string

        public static int H5Dread_string​(long dataset_id,
                                         long mem_type_id,
                                         long mem_space_id,
                                         long file_space_id,
                                         long xfer_plist_id,
                                         String[] buf)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of string to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dread_VLStrings

        public static int H5Dread_VLStrings​(long dataset_id,
                                            long mem_type_id,
                                            long mem_space_id,
                                            long file_space_id,
                                            long xfer_plist_id,
                                            Object[] buf)
                                     throws HDF5LibraryException,
                                            NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of variable-lenght strings to store data read from the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data buffer is null.
      • H5Dvlen_get_buf_size

        public static long H5Dvlen_get_buf_size​(long dset_id,
                                                long type_id,
                                                long space_id)
                                         throws HDF5LibraryException
        Parameters:
        dset_id - IN: Identifier of the dataset read from.
        type_id - IN: Identifier of the datatype.
        space_id - IN: Identifier of the dataspace.
        Returns:
        the size in bytes of the memory buffer required to store the VL data.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - buf is null.
      • H5Dvlen_reclaim

        @Deprecated
        public static int H5Dvlen_reclaim​(long type_id,
                                          long space_id,
                                          long xfer_plist_id,
                                          byte[] buf)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Deprecated.
        As of HDF5 1.12.0 in favor of H5Treclaim
        Parameters:
        type_id - Identifier of the datatype.
        space_id - Identifier of the dataspace.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer with data to be reclaimed.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - buf is null.
      • H5Dwrite

        public static int H5Dwrite​(long dataset_id,
                                   long mem_type_id,
                                   long mem_space_id,
                                   long file_space_id,
                                   long xfer_plist_id,
                                   byte[] buf,
                                   boolean isCriticalPinning)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer with data to be written to the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite

        public static int H5Dwrite​(long dataset_id,
                                   long mem_type_id,
                                   long mem_space_id,
                                   long file_space_id,
                                   long xfer_plist_id,
                                   byte[] buf)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite

        public static int H5Dwrite​(long dataset_id,
                                   long mem_type_id,
                                   long mem_space_id,
                                   long file_space_id,
                                   long xfer_plist_id,
                                   Object obj)
                            throws HDF5Exception,
                                   HDF5LibraryException,
                                   NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        obj - Buffer with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
        HDF5Exception
      • H5Dwrite

        public static int H5Dwrite​(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
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        obj - Object with data to be written to the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5Exception - Failure in the data conversion.
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - data object is null.
      • H5Dwrite_double

        public static int H5Dwrite_double​(long dataset_id,
                                          long mem_type_id,
                                          long mem_space_id,
                                          long file_space_id,
                                          long xfer_plist_id,
                                          double[] buf,
                                          boolean isCriticalPinning)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of double with data to be written to the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite_double

        public static int H5Dwrite_double​(long dataset_id,
                                          long mem_type_id,
                                          long mem_space_id,
                                          long file_space_id,
                                          long xfer_plist_id,
                                          double[] buf)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of double with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite_float

        public static int H5Dwrite_float​(long dataset_id,
                                         long mem_type_id,
                                         long mem_space_id,
                                         long file_space_id,
                                         long xfer_plist_id,
                                         float[] buf,
                                         boolean isCriticalPinning)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of float with data to be written to the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite_float

        public static int H5Dwrite_float​(long dataset_id,
                                         long mem_type_id,
                                         long mem_space_id,
                                         long file_space_id,
                                         long xfer_plist_id,
                                         float[] buf)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of float with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite_int

        public static int H5Dwrite_int​(long dataset_id,
                                       long mem_type_id,
                                       long mem_space_id,
                                       long file_space_id,
                                       long xfer_plist_id,
                                       int[] buf,
                                       boolean isCriticalPinning)
                                throws HDF5LibraryException,
                                       NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of int with data to be written to the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite_int

        public static int H5Dwrite_int​(long dataset_id,
                                       long mem_type_id,
                                       long mem_space_id,
                                       long file_space_id,
                                       long xfer_plist_id,
                                       int[] buf)
                                throws HDF5LibraryException,
                                       NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of int with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite_long

        public static int H5Dwrite_long​(long dataset_id,
                                        long mem_type_id,
                                        long mem_space_id,
                                        long file_space_id,
                                        long xfer_plist_id,
                                        long[] buf,
                                        boolean isCriticalPinning)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of long with data to be written to the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite_long

        public static int H5Dwrite_long​(long dataset_id,
                                        long mem_type_id,
                                        long mem_space_id,
                                        long file_space_id,
                                        long xfer_plist_id,
                                        long[] buf)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of long with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite_short

        public static int H5Dwrite_short​(long dataset_id,
                                         long mem_type_id,
                                         long mem_space_id,
                                         long file_space_id,
                                         long xfer_plist_id,
                                         short[] buf,
                                         boolean isCriticalPinning)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of short with data to be written to the file.
        isCriticalPinning - request lock on data reference.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite_short

        public static int H5Dwrite_short​(long dataset_id,
                                         long mem_type_id,
                                         long mem_space_id,
                                         long file_space_id,
                                         long xfer_plist_id,
                                         short[] buf)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of short with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite_string

        public static int H5Dwrite_string​(long dataset_id,
                                          long mem_type_id,
                                          long mem_space_id,
                                          long file_space_id,
                                          long xfer_plist_id,
                                          String[] buf)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of string with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5DwriteVL

        public static int H5DwriteVL​(long dataset_id,
                                     long mem_type_id,
                                     long mem_space_id,
                                     long file_space_id,
                                     long xfer_plist_id,
                                     Object[] buf)
                              throws HDF5LibraryException,
                                     NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer of variable-length with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dwrite_VLStrings

        public static int H5Dwrite_VLStrings​(long dataset_id,
                                             long mem_type_id,
                                             long mem_space_id,
                                             long file_space_id,
                                             long xfer_plist_id,
                                             Object[] buf)
                                      throws HDF5LibraryException,
                                             NullPointerException
        Parameters:
        dataset_id - Identifier of the dataset read from.
        mem_type_id - Identifier of the memory datatype.
        mem_space_id - Identifier of the memory dataspace.
        file_space_id - Identifier of the dataset's dataspace in the file.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer with data to be written to the file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Dflush

        public static void H5Dflush​(long dset_id)
                             throws HDF5LibraryException
        Parameters:
        dset_id - IN: Identifier of the dataset to be flushed.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Drefresh

        public static void H5Drefresh​(long dset_id)
                               throws HDF5LibraryException
        Parameters:
        dset_id - IN: Identifier of the dataset to be refreshed.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Eauto_is_v2

        public static boolean H5Eauto_is_v2​(long stack_id)
                                     throws HDF5LibraryException
        Parameters:
        stack_id - IN: Error stack identifier.
        Returns:
        boolean true if the error stack conforms to H5E_auto2_t and false if it conforms to H5E_auto1_t.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Eclear2

        public static void H5Eclear2​(long stack_id)
                              throws HDF5LibraryException
        Parameters:
        stack_id - IN: Error stack identifier.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Eclose_msg

        public static void H5Eclose_msg​(long err_id)
                                 throws HDF5LibraryException
        Parameters:
        err_id - IN: Error message identifier.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Eclose_stack

        public static void H5Eclose_stack​(long stack_id)
                                   throws HDF5LibraryException
        Parameters:
        stack_id - IN: Error stack identifier.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Eset_current_stack

        public static void H5Eset_current_stack​(long stack_id)
                                         throws HDF5LibraryException
        Parameters:
        stack_id - IN: Error stack identifier.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Eget_msg

        public static String H5Eget_msg​(long msg_id,
                                        int[] type_list)
                                 throws HDF5LibraryException
        Parameters:
        msg_id - IN: Name of the error class.
        type_list - OUT: The type of the error message. Valid values are H5E_MAJOR and H5E_MINOR.
        Returns:
        the error message
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Eprint2

        public static void H5Eprint2​(long stack_id,
                                     Object stream)
                              throws HDF5LibraryException
        Parameters:
        stack_id - IN: Error stack identifier.If the identifier is H5E_DEFAULT, the current error stack will be printed.
        stream - IN: File pointer, or stderr if null.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Epop

        public static void H5Epop​(long stack_id,
                                  long count)
                           throws HDF5LibraryException
        Parameters:
        stack_id - IN: Error stack identifier.
        count - IN: Version of the client library or application to which the error class belongs.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Epush

        public static void H5Epush​(long stack_id,
                                   String file,
                                   String func,
                                   int line,
                                   long cls_id,
                                   long maj_id,
                                   long min_id,
                                   String msg)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        stack_id - IN: Error stack identifier.
        file - IN: Name of the file in which the error was detected.
        func - IN: Name of the function in which the error was detected.
        line - IN: Line number within the file at which the error was detected.
        cls_id - IN: Error class identifier.
        maj_id - IN: Major error identifier.
        min_id - IN: Minor error identifier.
        msg - IN: Error description string.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - file, func, or msg is null.
      • H5Epush2

        public static void H5Epush2​(long stack_id,
                                    String file,
                                    String func,
                                    int line,
                                    long cls_id,
                                    long maj_id,
                                    long min_id,
                                    String msg)
                             throws HDF5LibraryException,
                                    NullPointerException
        Parameters:
        stack_id - IN: Error stack identifier.
        file - IN: Name of the file in which the error was detected.
        func - IN: Name of the function in which the error was detected.
        line - IN: Line number within the file at which the error was detected.
        cls_id - IN: Error class identifier.
        maj_id - IN: Major error identifier.
        min_id - IN: Minor error identifier.
        msg - IN: Error description string.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - file, func, or msg is null.
      • H5Eregister_class

        public static long H5Eregister_class​(String cls_name,
                                             String lib_name,
                                             String version)
                                      throws HDF5LibraryException,
                                             NullPointerException
        Parameters:
        cls_name - IN: Name of the error class.
        lib_name - IN: Name of the client library or application to which the error class belongs.
        version - IN: Version of the client library or application to which the error class belongs.
        Returns:
        a class identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Eunregister_class

        public static void H5Eunregister_class​(long class_id)
                                        throws HDF5LibraryException
        Parameters:
        class_id - IN: Error class identifier.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fclose

        public static int H5Fclose​(long file_id)
                            throws HDF5LibraryException
        Parameters:
        file_id - Identifier of a file to terminate access to.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Freopen

        public static long H5Freopen​(long file_id)
                              throws HDF5LibraryException
        Parameters:
        file_id - Identifier of a file to terminate and reopen access to.
        Returns:
        a new file identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fcreate

        public static long H5Fcreate​(String name,
                                     int flags,
                                     long create_id,
                                     long access_id)
                              throws HDF5LibraryException,
                                     NullPointerException
        Parameters:
        name - Name of the file to access.
        flags - File access flags. Possible values include:
        create_id - File creation property list identifier, used when modifying default file meta-data. Use H5P_DEFAULT for default access properties.
        access_id - File access property list identifier. If parallel file access is desired, this is a collective call according to the communicator stored in the access_id (not supported in Java). Use H5P_DEFAULT for default access properties.
        Returns:
        a file identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Fflush

        public static int H5Fflush​(long object_id,
                                   int scope)
                            throws HDF5LibraryException
        Parameters:
        object_id - Identifier of object used to identify the file. object_id can be any object associated with the file, including the file itself, a dataset, a group, an attribute, or a named data type.
        scope - specifies the scope of the flushing action, in the case that the HDF5 file is not a single physical file.

        Valid values are:

        • H5F_SCOPE_GLOBAL Flushes the entire virtual file.
        • H5F_SCOPE_LOCAL Flushes only the specified file.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_access_plist

        public static long H5Fget_access_plist​(long file_id)
                                        throws HDF5LibraryException
        Parameters:
        file_id - Identifier of file to get access property list of
        Returns:
        a file access property list identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_create_plist

        public static long H5Fget_create_plist​(long file_id)
                                        throws HDF5LibraryException
        Parameters:
        file_id - Identifier of the file to get creation property list
        Returns:
        a file creation property list identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_filesize

        public static long H5Fget_filesize​(long file_id)
                                    throws HDF5LibraryException
        Parameters:
        file_id - IN: File identifier for a currently-open HDF5 file
        Returns:
        the file size of the HDF5 file
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_freespace

        public static long H5Fget_freespace​(long file_id)
                                     throws HDF5LibraryException
        Parameters:
        file_id - IN: File identifier for a currently-open HDF5 file
        Returns:
        the amount of free space in the file
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_intent

        public static int H5Fget_intent​(long file_id)
                                 throws HDF5LibraryException
        Parameters:
        file_id - IN: File identifier for a currently-open HDF5 file
        Returns:
        the intended access mode flag, as originally passed with H5Fopen.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_fileno

        public static long H5Fget_fileno​(long file_id)
                                  throws HDF5LibraryException
        Parameters:
        file_id - IN: File identifier for a currently-open HDF5 file
        Returns:
        the unique file number for the file.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_mdc_hit_rate

        public static double H5Fget_mdc_hit_rate​(long file_id)
                                          throws HDF5LibraryException
        Parameters:
        file_id - IN: Identifier of the target file.
        Returns:
        the double in which the hit rate is returned.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_mdc_size

        public static int H5Fget_mdc_size​(long file_id,
                                          long[] metadata_cache)
                                   throws HDF5LibraryException,
                                          NullPointerException,
                                          IllegalArgumentException
        Parameters:
        file_id - IN: Identifier of the target file.
        metadata_cache - OUT: Current metadata cache information
        • metadata_cache[0] = max_size_ptr // current cache maximum size
        • metadata_cache[1] = min_clean_size_ptr // current cache minimum clean size
        • metadata_cache[2] = cur_size_ptr // current cache size
        Returns:
        current number of entries in the cache
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - metadata_cache is null.
        IllegalArgumentException
      • H5Fget_name

        public static String H5Fget_name​(long obj_id)
                                  throws HDF5LibraryException
        Parameters:
        obj_id - IN: Identifier of the object for which the associated filename is sought.
        Returns:
        the filename.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_obj_count

        public static long H5Fget_obj_count​(long file_id,
                                            int types)
                                     throws HDF5LibraryException
        Parameters:
        file_id - IN: File identifier for a currently-open HDF5 file
        types - IN: Type of object for which identifiers are to be returned.
        • H5F_OBJ_FILE Files only
        • H5F_OBJ_DATASET Datasets only
        • H5F_OBJ_GROUP Groups only
        • H5F_OBJ_DATATYPE Named datatypes only
        • H5F_OBJ_ATTR Attributes only
        • H5F_OBJ_ALL All of the above
        • H5F_OBJ_LOCAL Restrict search to objects opened through current file identifier.
        Returns:
        the number of open objects.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_obj_ids

        public static long H5Fget_obj_ids​(long file_id,
                                          int types,
                                          long max_objs,
                                          long[] obj_id_list)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        file_id - IN: File identifier for a currently-open HDF5 file
        types - IN: Type of object for which identifiers are to be returned.
        max_objs - IN: Maximum number of object identifiers to place into obj_id_list.
        obj_id_list - OUT: Pointer to the returned list of open object identifiers.
        Returns:
        the number of objects placed into obj_id_list.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - obj_id_list is null.
      • H5Fmount

        public static int H5Fmount​(long loc_id,
                                   String name,
                                   long child_id,
                                   long plist_id)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        loc_id - The identifier for the group onto which the file specified by child_id is to be mounted.
        name - The name of the group onto which the file specified by child_id is to be mounted.
        child_id - The identifier of the file to be mounted.
        plist_id - The identifier of the property list to be used.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Freset_mdc_hit_rate_stats

        public static void H5Freset_mdc_hit_rate_stats​(long file_id)
                                                throws HDF5LibraryException
        Parameters:
        file_id - IN: Identifier of the target file.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_info

        public static H5F_info2_t H5Fget_info​(long obj_id)
                                       throws HDF5LibraryException
        Parameters:
        obj_id - IN: Object identifier for any object in the file.
        Returns:
        A buffer(H5F_info2_t) for current "global" information about file
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fclear_elink_file_cache

        public static void H5Fclear_elink_file_cache​(long file_id)
                                              throws HDF5LibraryException
        Parameters:
        file_id - IN: Identifier of the target file.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fstart_swmr_write

        public static void H5Fstart_swmr_write​(long file_id)
                                        throws HDF5LibraryException
        Parameters:
        file_id - IN: Identifier of the target file.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fstart_mdc_logging

        public static void H5Fstart_mdc_logging​(long file_id)
                                         throws HDF5LibraryException
        Parameters:
        file_id - IN: Identifier of the target file.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fstop_mdc_logging

        public static void H5Fstop_mdc_logging​(long file_id)
                                        throws HDF5LibraryException
        Parameters:
        file_id - IN: Identifier of the target file.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fget_mdc_logging_status

        public static void H5Fget_mdc_logging_status​(long file_id,
                                                     boolean[] mdc_logging_status)
                                              throws HDF5LibraryException,
                                                     NullPointerException
        Parameters:
        file_id - IN: Identifier of the target file.
        mdc_logging_status - the status mdc_logging_status[0] = is_enabled, whether logging is enabled mdc_logging_status[1] = is_currently_logging, whether events are currently being logged
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - mdc_logging_status is null.
      • H5Fget_dset_no_attrs_hint

        public static boolean H5Fget_dset_no_attrs_hint​(long file_id)
                                                 throws HDF5LibraryException
        Parameters:
        file_id - IN: Identifier of the target file.
        Returns:
        true if the file-level is set to create minimized dataset object headers, false if not.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fset_dset_no_attrs_hint

        public static void H5Fset_dset_no_attrs_hint​(long file_id,
                                                     boolean minimize)
                                              throws HDF5LibraryException
        Parameters:
        file_id - IN: Identifier of the target file.
        minimize - the minimize hint setting
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Fset_libver_bounds

        public static void H5Fset_libver_bounds​(long file_id,
                                                int low,
                                                int high)
                                         throws HDF5LibraryException
        Parameters:
        file_id - IN: Identifier of the target file.
        low - IN: The earliest version of the library that will be used for writing objects
        high - IN: The latest version of the library that will be used for writing objects.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Gclose

        public static int H5Gclose​(long group_id)
                            throws HDF5LibraryException
        Parameters:
        group_id - Group identifier to release.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Gcreate

        public static long H5Gcreate​(long loc_id,
                                     String name,
                                     long lcpl_id,
                                     long gcpl_id,
                                     long gapl_id)
                              throws HDF5LibraryException,
                                     NullPointerException
        Parameters:
        loc_id - IN: The file or group identifier.
        name - IN: The absolute or relative name of the new group.
        lcpl_id - IN: Identifier of link creation property list.
        gcpl_id - IN: Identifier of group creation property list.
        gapl_id - IN: Identifier of group access property list. (No group access properties have been implemented at this time; use H5P_DEFAULT.)
        Returns:
        a valid group identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Gcreate_anon

        public static long H5Gcreate_anon​(long loc_id,
                                          long gcpl_id,
                                          long gapl_id)
                                   throws HDF5LibraryException
        Parameters:
        loc_id - IN: File or group identifier specifying the file in which the new group is to be created.
        gcpl_id - IN: Identifier of group creation property list.
        gapl_id - IN: Identifier of group access property list. (No group access properties have been implemented at this time; use H5P_DEFAULT.)
        Returns:
        a valid group identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Gget_create_plist

        public static long H5Gget_create_plist​(long group_id)
                                        throws HDF5LibraryException
        Parameters:
        group_id - IN: Identifier of the group.
        Returns:
        an identifier for the group's creation property list
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Gget_info

        public static H5G_info_t H5Gget_info​(long group_id)
                                      throws HDF5LibraryException
        Parameters:
        group_id - IN: Identifier of the group.
        Returns:
        a structure in which group information is returned
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Gget_info_by_idx

        public static H5G_info_t H5Gget_info_by_idx​(long group_id,
                                                    String group_name,
                                                    int idx_type,
                                                    int order,
                                                    long n,
                                                    long lapl_id)
                                             throws HDF5LibraryException,
                                                    NullPointerException
        Parameters:
        group_id - IN: File or group identifier.
        group_name - IN: Name of group for which information is to be retrieved.
        idx_type - IN: Type of index by which objects are ordered
        order - IN: Order of iteration within index
        n - IN: Attribute's position in index
        lapl_id - IN: Link access property list.
        Returns:
        a structure in which group information is returned
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Gget_info_by_name

        public static H5G_info_t H5Gget_info_by_name​(long group_id,
                                                     String name,
                                                     long lapl_id)
                                              throws HDF5LibraryException,
                                                     NullPointerException
        Parameters:
        group_id - IN: File or group identifier.
        name - IN: Name of group for which information is to be retrieved.
        lapl_id - IN: Link access property list.
        Returns:
        a structure in which group information is returned
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Gget_obj_info_all

        public static int H5Gget_obj_info_all​(long loc_id,
                                              String name,
                                              String[] objNames,
                                              int[] objTypes,
                                              H5O_token_t[] tokens)
                                       throws HDF5LibraryException,
                                              NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        name - IN: Name of group for which information is to be retrieved
        objNames - OUT: Names of all objects under the group, name.
        objTypes - OUT: Types of all objects under the group, name.
        tokens - OUT: Object token of all objects under the group, name.
        Returns:
        the number of items found
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Gget_obj_info_all

        public static int H5Gget_obj_info_all​(long loc_id,
                                              String name,
                                              String[] objNames,
                                              int[] objTypes,
                                              int[] ltype,
                                              H5O_token_t[] tokens,
                                              int indx_type)
                                       throws HDF5LibraryException,
                                              NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        name - IN: Name of group for which information is to be retrieved
        objNames - OUT: Names of all objects under the group, name.
        objTypes - OUT: Types of all objects under the group, name.
        ltype - OUT: Link type
        tokens - OUT: Object token of all objects under the group, name.
        indx_type - IN: Index type for iterate
        Returns:
        the number of items found
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Gget_obj_info_all

        public static int H5Gget_obj_info_all​(long loc_id,
                                              String name,
                                              String[] objNames,
                                              int[] objTypes,
                                              int[] ltype,
                                              long[] fno,
                                              H5O_token_t[] tokens,
                                              int indx_type)
                                       throws HDF5LibraryException,
                                              NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        name - IN: Name of group for which information is to be retrieved
        objNames - OUT: Names of all objects under the group, name.
        objTypes - OUT: Types of all objects under the group, name.
        ltype - OUT: Link type
        fno - OUT: File number
        tokens - OUT: Object token of all objects under the group, name.
        indx_type - IN: Index type for iterate
        Returns:
        the number of items found
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Gget_obj_info_full

        public static int H5Gget_obj_info_full​(long loc_id,
                                               String name,
                                               String[] objNames,
                                               int[] objTypes,
                                               int[] ltype,
                                               long[] fno,
                                               H5O_token_t[] tokens,
                                               int indx_type,
                                               int indx_order)
                                        throws HDF5LibraryException,
                                               NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        name - IN: Name of group for which information is to be retrieved
        objNames - OUT: Names of all objects under the group, name.
        objTypes - OUT: Types of all objects under the group, name.
        ltype - OUT: Link type
        fno - OUT: File number
        tokens - OUT: Object token of all objects under the group, name.
        indx_type - IN: Index type for iterate
        indx_order - IN: Index order for iterate
        Returns:
        the number of items found
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Gget_obj_info_idx

        public static int H5Gget_obj_info_idx​(long loc_id,
                                              String name,
                                              int idx,
                                              String[] oname,
                                              int[] type)
                                       throws HDF5LibraryException,
                                              NullPointerException
        Parameters:
        loc_id - IN: file or group ID.
        name - IN: name of the group to iterate, relative to the loc_id
        idx - IN: the index of the object to iterate.
        oname - OUT: the name of the object
        type - OUT: the type of the object
        Returns:
        non-negative if successful, -1 if not.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Gget_obj_info_max

        public static int H5Gget_obj_info_max​(long loc_id,
                                              String[] objNames,
                                              int[] objTypes,
                                              int[] lnkTypes,
                                              H5O_token_t[] objToken,
                                              long objMax)
                                       throws HDF5LibraryException,
                                              NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        objNames - OUT: Names of all objects under the group, name.
        objTypes - OUT: Types of all objects under the group, name.
        lnkTypes - OUT: Types of all links under the group, name.
        objToken - OUT: Object token of all objects under the group, name.
        objMax - IN: Maximum number of all objects under the group, name.
        Returns:
        the number of items found
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Gopen

        public static long H5Gopen​(long loc_id,
                                   String name,
                                   long gapl_id)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        loc_id - IN: File or group identifier specifying the location of the group to be opened.
        name - IN: Name of group to open.
        gapl_id - IN: Identifier of group access property list.
        Returns:
        a valid group identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Gflush

        public static void H5Gflush​(long group_id)
                             throws HDF5LibraryException
        Parameters:
        group_id - IN: Identifier of the group to be flushed.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Grefresh

        public static void H5Grefresh​(long group_id)
                               throws HDF5LibraryException
        Parameters:
        group_id - IN: Identifier of the group to be refreshed.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Iget_file_id

        public static long H5Iget_file_id​(long obj_id)
                                   throws HDF5LibraryException
        Parameters:
        obj_id - IN: Identifier of the object.
        Returns:
        the file ID.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Iget_name

        public static String H5Iget_name​(long obj_id)
                                  throws HDF5LibraryException
        Parameters:
        obj_id - IN: Identifier of the object.
        Returns:
        String for Attribute name.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Iget_type

        public static int H5Iget_type​(long obj_id)
                               throws HDF5LibraryException
        Parameters:
        obj_id - IN: Object identifier whose type is to be determined.
        Returns:
        the object type if successful; otherwise H5I_BADID.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Iget_type_ref

        public static int H5Iget_type_ref​(long type_id)
                                   throws HDF5LibraryException
        Parameters:
        type_id - IN: The identifier of the type whose reference count is to be retrieved
        Returns:
        The current reference count on success, negative on failure.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Idec_type_ref

        public static int H5Idec_type_ref​(long type_id)
                                   throws HDF5LibraryException
        Parameters:
        type_id - IN: The identifier of the type whose reference count is to be decremented
        Returns:
        The current reference count on success, negative on failure.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Iinc_type_ref

        public static int H5Iinc_type_ref​(long type_id)
                                   throws HDF5LibraryException
        Parameters:
        type_id - IN: The identifier of the type whose reference count is to be incremented
        Returns:
        The current reference count on success, negative on failure.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Inmembers

        public static int H5Inmembers​(long type_id)
                               throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier for the identifier type whose member count will be retrieved
        Returns:
        Number of identifiers of the specified identifier type
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Iis_valid

        public static boolean H5Iis_valid​(long obj_id)
                                   throws HDF5LibraryException
        Parameters:
        obj_id - IN: Identifier to be checked
        Returns:
        a boolean, true if the specified identifier id is valid
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Itype_exists

        public static boolean H5Itype_exists​(int type_id)
                                      throws HDF5LibraryException
        Parameters:
        type_id - IN: the identifier type to be checked
        Returns:
        a boolean, true if the specified identifier type exists
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Iclear_type

        public static void H5Iclear_type​(int type_id,
                                         boolean force)
                                  throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of identifier type which is to be cleared of identifiers
        force - IN: Whether or not to force deletion of all identifiers
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Idestroy_type

        public static void H5Idestroy_type​(int type_id)
                                    throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of identifier type which is to be destroyed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Lcopy

        public static void H5Lcopy​(long src_loc,
                                   String src_name,
                                   long dst_loc,
                                   String dst_name,
                                   long lcpl_id,
                                   long lapl_id)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        src_loc - IN: Location identifier of the source link
        src_name - IN: Name of the link to be copied
        dst_loc - IN: Location identifier specifying the destination of the copy
        dst_name - IN: Name to be assigned to the new copy
        lcpl_id - IN: Link creation property list identifier
        lapl_id - IN: Link access property list identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Lcreate_external

        public static void H5Lcreate_external​(String file_name,
                                              String obj_name,
                                              long link_loc_id,
                                              String link_name,
                                              long lcpl_id,
                                              long lapl_id)
                                       throws HDF5LibraryException,
                                              NullPointerException
        Parameters:
        file_name - IN: Name of the target file containing the target object.
        obj_name - IN: Path within the target file to the target object.
        link_loc_id - IN: The file or group identifier for the new link.
        link_name - IN: The name of the new link.
        lcpl_id - IN: Link creation property list identifier
        lapl_id - IN: Link access property list identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Lcreate_hard

        public static void H5Lcreate_hard​(long cur_loc,
                                          String cur_name,
                                          long dst_loc,
                                          String dst_name,
                                          long lcpl_id,
                                          long lapl_id)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        cur_loc - IN: The file or group identifier for the target object.
        cur_name - IN: Name of the target object, which must already exist.
        dst_loc - IN: The file or group identifier for the new link.
        dst_name - IN: The name of the new link.
        lcpl_id - IN: Link creation property list identifier
        lapl_id - IN: Link access property list identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - cur_name or dst_name is null.
      • H5Lcreate_soft

        public static void H5Lcreate_soft​(String link_target,
                                          long link_loc_id,
                                          String link_name,
                                          long lcpl_id,
                                          long lapl_id)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        link_target - IN: Path to the target object, which is not required to exist.
        link_loc_id - IN: The file or group identifier for the new link.
        link_name - IN: The name of the new link.
        lcpl_id - IN: Link creation property list identifier
        lapl_id - IN: Link access property list identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - link_name is null.
      • H5Ldelete_by_idx

        public static void H5Ldelete_by_idx​(long loc_id,
                                            String group_name,
                                            int idx_type,
                                            int order,
                                            long n,
                                            long lapl_id)
                                     throws HDF5LibraryException,
                                            NullPointerException
        Parameters:
        loc_id - IN: File or group identifier specifying location of subject group
        group_name - IN: Name of subject group
        idx_type - IN: Index or field which determines the order
        order - IN: Order within field or index
        n - IN: Link for which to retrieve information
        lapl_id - IN: Link access property list identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - group_name is null.
      • H5Lexists

        public static boolean H5Lexists​(long loc_id,
                                        String name,
                                        long lapl_id)
                                 throws HDF5LibraryException,
                                        NullPointerException
        Parameters:
        loc_id - IN: Identifier of the file or group to query.
        name - IN: The name of the link to check.
        lapl_id - IN: Link access property list identifier
        Returns:
        a boolean, true if the name exists, otherwise false.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Lget_info_by_idx

        public static H5L_info_t H5Lget_info_by_idx​(long loc_id,
                                                    String group_name,
                                                    int idx_type,
                                                    int order,
                                                    long n,
                                                    long lapl_id)
                                             throws HDF5LibraryException,
                                                    NullPointerException
        Parameters:
        loc_id - IN: File or group identifier specifying location of subject group
        group_name - IN: Name of subject group
        idx_type - IN: Type of index
        order - IN: Order within field or index
        n - IN: Link for which to retrieve information
        lapl_id - IN: Link access property list identifier
        Returns:
        a buffer(H5L_info_t) for the link information.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - group_name is null.
      • H5Lget_name_by_idx

        public static String H5Lget_name_by_idx​(long loc_id,
                                                String group_name,
                                                int idx_type,
                                                int order,
                                                long n,
                                                long lapl_id)
                                         throws HDF5LibraryException,
                                                NullPointerException
        Parameters:
        loc_id - IN: File or group identifier specifying location of subject group
        group_name - IN: Name of subject group
        idx_type - IN: Type of index
        order - IN: Order within field or index
        n - IN: Link for which to retrieve information
        lapl_id - IN: Link access property list identifier
        Returns:
        a String for the link name.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - group_name is null.
      • H5Lget_value

        public static int H5Lget_value​(long loc_id,
                                       String name,
                                       String[] link_value,
                                       long lapl_id)
                                throws HDF5LibraryException,
                                       NullPointerException
        Parameters:
        loc_id - IN: Identifier of the file or group containing the object.
        name - IN: Name of the symbolic link.
        link_value - OUT: Path of the symbolic link, or the file_name and path of an external file.
        lapl_id - IN: Link access property list identifier
        Returns:
        the link type
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Lget_value_by_idx

        public static int H5Lget_value_by_idx​(long loc_id,
                                              String group_name,
                                              int idx_type,
                                              int order,
                                              long n,
                                              String[] link_value,
                                              long lapl_id)
                                       throws HDF5LibraryException,
                                              NullPointerException
        Parameters:
        loc_id - IN: File or group identifier specifying location of subject group
        group_name - IN: Name of subject group
        idx_type - IN: Type of index
        order - IN: Order within field or index
        n - IN: Link for which to retrieve information
        link_value - OUT: Path of the symbolic link, or the file_name and path of an external file.
        lapl_id - IN: Link access property list identifier
        Returns:
        the link type
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - group_name is null.
      • H5Literate

        public static int H5Literate​(long grp_id,
                                     int idx_type,
                                     int order,
                                     long idx,
                                     H5L_iterate_t op,
                                     H5L_iterate_opdata_t op_data)
                              throws HDF5LibraryException
        Parameters:
        grp_id - IN: Identifier specifying subject group
        idx_type - IN: Type of index
        order - IN: Order of iteration within index
        idx - IN: Iteration position at which to start
        op - IN: Callback function passing data regarding the link to the calling application
        op_data - IN: User-defined pointer to data required by the application for its processing of the link
        Returns:
        returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Literate_by_name

        public static int H5Literate_by_name​(long grp_id,
                                             String group_name,
                                             int idx_type,
                                             int order,
                                             long idx,
                                             H5L_iterate_t op,
                                             H5L_iterate_opdata_t op_data,
                                             long lapl_id)
                                      throws HDF5LibraryException,
                                             NullPointerException
        Parameters:
        grp_id - IN: Identifier specifying subject group
        group_name - IN: Name of subject group
        idx_type - IN: Type of index
        order - IN: Order of iteration within index
        idx - IN: Iteration position at which to start
        op - IN: Callback function passing data regarding the link to the calling application
        op_data - IN: User-defined pointer to data required by the application for its processing of the link
        lapl_id - IN: Link access property list identifier
        Returns:
        returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - group_name is null.
      • H5Lmove

        public static void H5Lmove​(long src_loc,
                                   String src_name,
                                   long dst_loc,
                                   String dst_name,
                                   long lcpl_id,
                                   long lapl_id)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        src_loc - IN: Original file or group identifier.
        src_name - IN: Original link name.
        dst_loc - IN: Destination file or group identifier.
        dst_name - IN: New link name.
        lcpl_id - IN: Link creation property list identifier to be associated with the new link.
        lapl_id - IN: Link access property list identifier to be associated with the new link.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Lvisit

        public static int H5Lvisit​(long grp_id,
                                   int idx_type,
                                   int order,
                                   H5L_iterate_t op,
                                   H5L_iterate_opdata_t op_data)
                            throws HDF5LibraryException
        Parameters:
        grp_id - IN: Identifier specifying subject group
        idx_type - IN: Type of index
        order - IN: Order of iteration within index
        op - IN: Callback function passing data regarding the link to the calling application
        op_data - IN: User-defined pointer to data required by the application for its processing of the link
        Returns:
        returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Lvisit_by_name

        public static int H5Lvisit_by_name​(long loc_id,
                                           String group_name,
                                           int idx_type,
                                           int order,
                                           H5L_iterate_t op,
                                           H5L_iterate_opdata_t op_data,
                                           long lapl_id)
                                    throws HDF5LibraryException,
                                           NullPointerException
        Parameters:
        loc_id - IN: Identifier specifying subject group
        group_name - IN: Name of subject group
        idx_type - IN: Type of index
        order - IN: Order of iteration within index
        op - IN: Callback function passing data regarding the link to the calling application
        op_data - IN: User-defined pointer to data required by the application for its processing of the link
        lapl_id - IN: link access property
        Returns:
        returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - group_name is null.
      • H5Lis_registered

        public static int H5Lis_registered​(int link_cls_id)
                                    throws HDF5LibraryException
        Parameters:
        link_cls_id - IN: User-defined link class identifier
        Returns:
        Returns a positive value if the link class has been registered and zero if it is unregistered. Otherwise returns a negative value; this may mean that the identifier is not a valid user-defined class identifier.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Lunregister

        public static void H5Lunregister​(int link_cls_id)
                                  throws HDF5LibraryException
        Parameters:
        link_cls_id - IN: User-defined link class identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Oclose

        public static int H5Oclose​(long object_id)
                            throws HDF5LibraryException
        Parameters:
        object_id - IN: Object identifier
        Returns:
        non-negative on success
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Ocopy

        public static void H5Ocopy​(long src_loc_id,
                                   String src_name,
                                   long dst_loc_id,
                                   String dst_name,
                                   long ocpypl_id,
                                   long lcpl_id)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        src_loc_id - IN: Object identifier indicating the location of the source object to be copied
        src_name - IN: Name of the source object to be copied
        dst_loc_id - IN: Location identifier specifying the destination
        dst_name - IN: Name to be assigned to the new copy
        ocpypl_id - IN: Object copy property list
        lcpl_id - IN: Link creation property list for the new hard link
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Oset_comment

        @Deprecated
        public static void H5Oset_comment​(long obj_id,
                                          String comment)
                                   throws HDF5LibraryException
        Deprecated.
        As of HDF5 1.8 in favor of object attributes.
        Parameters:
        obj_id - IN: Identifier of the target object
        comment - IN: The new comment.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Oset_comment_by_name

        @Deprecated
        public static void H5Oset_comment_by_name​(long loc_id,
                                                  String name,
                                                  String comment,
                                                  long lapl_id)
                                           throws HDF5LibraryException,
                                                  NullPointerException
        Deprecated.
        As of HDF5 1.8 in favor of object attributes.
        Parameters:
        loc_id - IN: Identifier of a file, group, dataset, or named datatype.
        name - IN: Relative name of the object whose comment is to be set or reset.
        comment - IN: The new comment.
        lapl_id - IN: Link access property list identifier.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Oget_info_by_idx

        public static H5O_info_t H5Oget_info_by_idx​(long loc_id,
                                                    String group_name,
                                                    int idx_type,
                                                    int order,
                                                    long n,
                                                    long lapl_id)
                                             throws HDF5LibraryException,
                                                    NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        group_name - IN: Name of group, relative to loc_id, in which object is located
        idx_type - IN: Type of index by which objects are ordered
        order - IN: Order of iteration within index
        n - IN: Object to open
        lapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)
        Returns:
        object information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Oget_info_by_idx

        public static H5O_info_t H5Oget_info_by_idx​(long loc_id,
                                                    String group_name,
                                                    int idx_type,
                                                    int order,
                                                    long n,
                                                    int fields,
                                                    long lapl_id)
                                             throws HDF5LibraryException,
                                                    NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        group_name - IN: Name of group, relative to loc_id, in which object is located
        idx_type - IN: Type of index by which objects are ordered
        order - IN: Order of iteration within index
        n - IN: Object to open
        fields - IN: Object fields to select
        lapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)
        Returns:
        object information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Oget_info_by_name

        public static H5O_info_t H5Oget_info_by_name​(long loc_id,
                                                     String name,
                                                     long lapl_id)
                                              throws HDF5LibraryException,
                                                     NullPointerException
        Parameters:
        loc_id - IN: File or group identifier specifying location of group in which object is located
        name - IN: Relative name of group
        lapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)
        Returns:
        object information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Oget_info_by_name

        public static H5O_info_t H5Oget_info_by_name​(long loc_id,
                                                     String name,
                                                     int fields,
                                                     long lapl_id)
                                              throws HDF5LibraryException,
                                                     NullPointerException
        Parameters:
        loc_id - IN: File or group identifier specifying location of group in which object is located
        name - IN: Relative name of group
        fields - IN: Object fields to select
        lapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)
        Returns:
        object information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Olink

        public static void H5Olink​(long obj_id,
                                   long new_loc_id,
                                   String new_name,
                                   long lcpl_id,
                                   long lapl_id)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        obj_id - IN: Object to be linked.
        new_loc_id - IN: File or group identifier specifying location at which object is to be linked.
        new_name - IN: Relative name of link to be created.
        lcpl_id - IN: Link creation property list identifier.
        lapl_id - IN: Access property list identifier.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Oopen

        public static long H5Oopen​(long loc_id,
                                   String name,
                                   long lapl_id)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        name - IN: Relative path to the object
        lapl_id - IN: Access property list identifier for the link pointing to the object
        Returns:
        an object identifier for the opened object
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Ovisit

        public static int H5Ovisit​(long obj_id,
                                   int idx_type,
                                   int order,
                                   H5O_iterate_t op,
                                   H5O_iterate_opdata_t op_data)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        obj_id - IN: Identifier of the object at which the recursive iteration begins.
        idx_type - IN: Type of index
        order - IN: Order of iteration within index
        op - IN: Callback function passing data regarding the object to the calling application
        op_data - IN: User-defined pointer to data required by the application for its processing of the object
        Returns:
        returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Ovisit

        public static int H5Ovisit​(long obj_id,
                                   int idx_type,
                                   int order,
                                   H5O_iterate_t op,
                                   H5O_iterate_opdata_t op_data,
                                   int fields)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        obj_id - IN: Identifier of the object at which the recursive iteration begins.
        idx_type - IN: Type of index
        order - IN: Order of iteration within index
        op - IN: Callback function passing data regarding the object to the calling application
        op_data - IN: User-defined pointer to data required by the application for its processing of the object
        fields - IN: Object fields to select
        Returns:
        returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Ovisit_by_name

        public static int H5Ovisit_by_name​(long loc_id,
                                           String obj_name,
                                           int idx_type,
                                           int order,
                                           H5O_iterate_t op,
                                           H5O_iterate_opdata_t op_data,
                                           long lapl_id)
                                    throws HDF5LibraryException,
                                           NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        obj_name - IN: Relative path to the object
        idx_type - IN: Type of index
        order - IN: Order of iteration within index
        op - IN: Callback function passing data regarding the object to the calling application
        op_data - IN: User-defined pointer to data required by the application for its processing of the object
        lapl_id - IN: Link access property list identifier
        Returns:
        returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Ovisit_by_name

        public static int H5Ovisit_by_name​(long loc_id,
                                           String obj_name,
                                           int idx_type,
                                           int order,
                                           H5O_iterate_t op,
                                           H5O_iterate_opdata_t op_data,
                                           int fields,
                                           long lapl_id)
                                    throws HDF5LibraryException,
                                           NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        obj_name - IN: Relative path to the object
        idx_type - IN: Type of index
        order - IN: Order of iteration within index
        op - IN: Callback function passing data regarding the object to the calling application
        op_data - IN: User-defined pointer to data required by the application for its processing of the object
        fields - IN: Object fields to select
        lapl_id - IN: Link access property list identifier
        Returns:
        returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Oexists_by_name

        public static boolean H5Oexists_by_name​(long loc_id,
                                                String obj_name,
                                                long lapl_id)
                                         throws HDF5LibraryException,
                                                NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        obj_name - IN: Relative path to the object
        lapl_id - IN: Link access property list identifier
        Returns:
        Returns TRUE or FALSE if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Odecr_refcount

        public static void H5Odecr_refcount​(long object_id)
                                     throws HDF5LibraryException
        Parameters:
        object_id - IN: Object identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Oincr_refcount

        public static void H5Oincr_refcount​(long object_id)
                                     throws HDF5LibraryException
        Parameters:
        object_id - IN: Object identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Oopen_by_token

        public static long H5Oopen_by_token​(long loc_id,
                                            H5O_token_t token)
                                     throws HDF5LibraryException
        Parameters:
        loc_id - IN: File or group identifier
        token - IN: Object's token in the file
        Returns:
        an object identifier for the opened object
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Oopen_by_idx

        public static long H5Oopen_by_idx​(long loc_id,
                                          String group_name,
                                          int idx_type,
                                          int order,
                                          long n,
                                          long lapl_id)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        group_name - IN: Name of group, relative to loc_id, in which object is located
        idx_type - IN: Type of index by which objects are ordered
        order - IN: Order of iteration within index
        n - IN: Object to open
        lapl_id - IN: Access property list identifier for the link pointing to the object
        Returns:
        an object identifier for the opened object
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - group_name is null.
      • H5Oflush

        public static void H5Oflush​(long object_id)
                             throws HDF5LibraryException
        Parameters:
        object_id - IN: Identifier of the object to be flushed.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Orefresh

        public static void H5Orefresh​(long object_id)
                               throws HDF5LibraryException
        Parameters:
        object_id - IN: Identifier of the object to be refreshed.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Odisable_mdc_flushes

        public static void H5Odisable_mdc_flushes​(long object_id)
        Parameters:
        object_id - IN: Identifier of the object to be corked.
      • H5Oenable_mdc_flushes

        public static void H5Oenable_mdc_flushes​(long object_id)
        Parameters:
        object_id - IN: Identifier of the object to be uncorked.
      • H5Oare_mdc_flushes_disabled

        public static boolean H5Oare_mdc_flushes_disabled​(long object_id)
        Parameters:
        object_id - IN: Identifier of the object to be flushed.
        Returns:
        the cork status TRUE if mdc flushes for the object is disabled FALSE if mdc flushes for the object is not disabled
      • H5Oget_native_info_by_idx

        public static H5O_native_info_t H5Oget_native_info_by_idx​(long loc_id,
                                                                  String group_name,
                                                                  int idx_type,
                                                                  int order,
                                                                  long n,
                                                                  long lapl_id)
                                                           throws HDF5LibraryException,
                                                                  NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        group_name - IN: Name of group, relative to loc_id, in which object is located
        idx_type - IN: Type of index by which objects are ordered
        order - IN: Order of iteration within index
        n - IN: Object to open
        lapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)
        Returns:
        object information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Oget_native_info_by_idx

        public static H5O_native_info_t H5Oget_native_info_by_idx​(long loc_id,
                                                                  String group_name,
                                                                  int idx_type,
                                                                  int order,
                                                                  long n,
                                                                  int fields,
                                                                  long lapl_id)
                                                           throws HDF5LibraryException,
                                                                  NullPointerException
        Parameters:
        loc_id - IN: File or group identifier
        group_name - IN: Name of group, relative to loc_id, in which object is located
        idx_type - IN: Type of index by which objects are ordered
        order - IN: Order of iteration within index
        n - IN: Object to open
        fields - IN: Object fields to select
        lapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)
        Returns:
        object information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Oget_native_info_by_name

        public static H5O_native_info_t H5Oget_native_info_by_name​(long loc_id,
                                                                   String name,
                                                                   long lapl_id)
                                                            throws HDF5LibraryException,
                                                                   NullPointerException
        Parameters:
        loc_id - IN: File or group identifier specifying location of group in which object is located
        name - IN: Relative name of group
        lapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)
        Returns:
        object information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Oget_native_info_by_name

        public static H5O_native_info_t H5Oget_native_info_by_name​(long loc_id,
                                                                   String name,
                                                                   int fields,
                                                                   long lapl_id)
                                                            throws HDF5LibraryException,
                                                                   NullPointerException
        Parameters:
        loc_id - IN: File or group identifier specifying location of group in which object is located
        name - IN: Relative name of group
        fields - IN: Object fields to select
        lapl_id - IN: Access property list identifier for the link pointing to the object (Not currently used; pass as H5P_DEFAULT.)
        Returns:
        object information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Pget_class_name

        public static String H5Pget_class_name​(long plid)
                                        throws HDF5LibraryException
        Parameters:
        plid - IN: Identifier of property object to query
        Returns:
        name of a property list if successful; null if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pcreate

        public static long H5Pcreate​(long type)
                              throws HDF5LibraryException
        Parameters:
        type - IN: The type of property list to create.
        Returns:
        a property list identifier (plist) if successful; otherwise Fail (-1).
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget

        public static int H5Pget​(long plid,
                                 String name)
                          throws HDF5LibraryException
        Parameters:
        plid - IN: Identifier of property object to query
        name - IN: Name of property to query
        Returns:
        value for a property if successful; a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset

        public static int H5Pset​(long plid,
                                 String name,
                                 int value)
                          throws HDF5LibraryException
        Parameters:
        plid - IN: Property list identifier to modify
        name - IN: Name of property to modify
        value - IN: value to set the property to
        Returns:
        a non-negative value if successful; a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pexist

        public static boolean H5Pexist​(long plid,
                                       String name)
                                throws HDF5LibraryException
        Parameters:
        plid - IN: Identifier for the property to query
        name - IN: Name of property to check for
        Returns:
        a true value if the property exists in the property object; false if the property does not exist;
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_size

        public static long H5Pget_size​(long plid,
                                       String name)
                                throws HDF5LibraryException
        Parameters:
        plid - IN: Identifier of property object to query
        name - IN: Name of property to query
        Returns:
        size of a property's value if successful; a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_nprops

        public static long H5Pget_nprops​(long plid)
                                  throws HDF5LibraryException
        Parameters:
        plid - IN: Identifier of property object to query
        Returns:
        number of properties if successful; a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_class

        public static long H5Pget_class​(long plist)
                                 throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of property list to query.
        Returns:
        a property list class if successful. Otherwise returns H5P_ROOT (-1).
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_class_parent

        public static long H5Pget_class_parent​(long plid)
                                        throws HDF5LibraryException
        Parameters:
        plid - IN: Identifier of the property class to query
        Returns:
        a valid parent class object identifier if successful; a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pequal

        public static int H5Pequal​(long plid1,
                                   long plid2)
                            throws HDF5LibraryException
        Parameters:
        plid1 - IN: First property object to be compared
        plid2 - IN: Second property object to be compared
        Returns:
        positive value if equal; zero if unequal, a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5P_equal

        public static boolean H5P_equal​(long plid1,
                                        long plid2)
                                 throws HDF5LibraryException
        Parameters:
        plid1 - IN: First property object to be compared
        plid2 - IN: Second property object to be compared
        Returns:
        TRUE if equal, FALSE if unequal
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pisa_class

        public static int H5Pisa_class​(long plist,
                                       long pclass)
                                throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of the property list
        pclass - IN: Identifier of the property class
        Returns:
        a positive value if equal; zero if unequal; a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pcopy_prop

        public static int H5Pcopy_prop​(long dst_id,
                                       long src_id,
                                       String name)
                                throws HDF5LibraryException
        Parameters:
        dst_id - IN: Identifier of the destination property list or class
        src_id - IN: Identifier of the source property list or class
        name - IN: Name of the property to copy
        Returns:
        a non-negative value if successful; a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Premove

        public static int H5Premove​(long plid,
                                    String name)
                             throws HDF5LibraryException
        Parameters:
        plid - IN: Identifier of the property list to modify
        name - IN: Name of property to remove
        Returns:
        a non-negative value if successful; a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Punregister

        public static int H5Punregister​(long plid,
                                        String name)
                                 throws HDF5LibraryException
        Parameters:
        plid - IN: Property list class from which to remove permanent property
        name - IN: Name of property to remove
        Returns:
        a non-negative value if successful; a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pclose_class

        public static int H5Pclose_class​(long plid)
                                  throws HDF5LibraryException
        Parameters:
        plid - IN: Property list class to close
        Returns:
        a non-negative value if successful; a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pclose

        public static int H5Pclose​(long plist)
                            throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of the property list to terminate access to.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pcopy

        public static long H5Pcopy​(long plist)
                            throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of property list to duplicate.
        Returns:
        a property list identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pcreate_class_nocb

        public static long H5Pcreate_class_nocb​(long parent_class,
                                                String name)
                                         throws HDF5LibraryException
        Parameters:
        parent_class - IN: Identifier of the parent property class.
        name - IN: Name of the property class.
        Returns:
        a property list identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pregister2_nocb

        public static void H5Pregister2_nocb​(long plist_class,
                                             String name,
                                             long size,
                                             byte[] def_value)
                                      throws HDF5LibraryException
        Parameters:
        plist_class - IN: Identifier of the property list.
        name - IN: Name of the property.
        size - IN: Size the property value.
        def_value - IN: Default value of the property
        Throws:
        HDF5LibraryException - - Error from the HDF5 Library.
      • H5Pinsert2_nocb

        public static void H5Pinsert2_nocb​(long plist,
                                           String name,
                                           long size,
                                           byte[] value)
                                    throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of the property list.
        name - IN: Name of the property.
        size - IN: Size the property value.
        value - IN: Default value of the property
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Piterate

        public static int H5Piterate​(long plist,
                                     int[] idx,
                                     H5P_iterate_cb op,
                                     H5P_iterate_t op_data)
                              throws HDF5LibraryException
        Parameters:
        plist - IN: ID of property object to iterate over
        idx - IN/OUT: index of the property to begin with
        op - IN: function to be called with each property iterated over.
        op_data - IN: iteration data from user
        Returns:
        the return value of the last call to op if it was non-zero, zero if all properties have been processed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - size is null.
      • H5Pget_attr_phase_change

        public static int H5Pget_attr_phase_change​(long ocpl_id,
                                                   int[] attributes)
                                            throws HDF5LibraryException,
                                                   NullPointerException
        Parameters:
        ocpl_id - IN: Object (dataset or group) creation property list identifier
        attributes - The maximum and minimum no. of attributes to be stored.
              attributes[0] =  The maximum number of attributes to be stored in compact storage
              attributes[1] =  The minimum number of attributes to be stored in dense storage
         
        Returns:
        Returns a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - size is null.
      • H5Pset_attr_phase_change

        public static void H5Pset_attr_phase_change​(long ocpl_id,
                                                    int max_compact,
                                                    int min_dense)
                                             throws HDF5LibraryException
        Parameters:
        ocpl_id - IN: : Object (dataset or group) creation property list identifier
        max_compact - IN: Maximum number of attributes to be stored in compact storage (Default: 8)
        min_dense - IN: Minimum number of attributes to be stored in dense storage (Default: 6)
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_attr_creation_order

        public static int H5Pget_attr_creation_order​(long ocpl_id)
                                              throws HDF5LibraryException
        Parameters:
        ocpl_id - IN: Object (group or dataset) creation property list identifier
        Returns:
        Flags specifying whether to track and index attribute creation order
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_attr_creation_order

        public static int H5Pset_attr_creation_order​(long ocpl_id,
                                                     int crt_order_flags)
                                              throws HDF5LibraryException
        Parameters:
        ocpl_id - IN: Object creation property list identifier
        crt_order_flags - IN: Flags specifying whether to track and index attribute creation order
        Returns:
        Returns a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_obj_track_times

        public static boolean H5Pget_obj_track_times​(long ocpl_id)
                                              throws HDF5LibraryException
        Parameters:
        ocpl_id - IN: Object creation property list identifier
        Returns:
        TRUE or FALSE, specifying whether object times are being recorded
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_obj_track_times

        public static void H5Pset_obj_track_times​(long ocpl_id,
                                                  boolean track_times)
                                           throws HDF5LibraryException
        Parameters:
        ocpl_id - IN: Object creation property list identifier
        track_times - IN: TRUE or FALSE, specifying whether object times are to be tracked
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pmodify_filter

        public static int H5Pmodify_filter​(long plist,
                                           long filter,
                                           int flags,
                                           long cd_nelmts,
                                           int[] cd_values)
                                    throws HDF5LibraryException,
                                           NullPointerException
        Parameters:
        plist - IN: Property list identifier.
        filter - IN: Filter to be modified to the pipeline.
        flags - IN: Bit vector specifying certain general properties of the filter.
        cd_nelmts - IN: Number of elements in cd_values
        cd_values - IN: Auxiliary data for the filter.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name or an array is null.
      • H5Pset_filter

        public static int H5Pset_filter​(long plist,
                                        int filter,
                                        int flags,
                                        long cd_nelmts,
                                        int[] cd_values)
                                 throws HDF5LibraryException
        Parameters:
        plist - IN: Property list identifier.
        filter - IN: Filter to be added to the pipeline.
        flags - IN: Bit vector specifying certain general properties of the filter.
        cd_nelmts - IN: Number of elements in cd_values
        cd_values - IN: Auxiliary data for the filter.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_nfilters

        public static int H5Pget_nfilters​(long plist)
                                   throws HDF5LibraryException
        Parameters:
        plist - IN: Property list identifier.
        Returns:
        the number of filters in the pipeline if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_filter

        public static int H5Pget_filter​(long plist,
                                        int filter_number,
                                        int[] flags,
                                        long[] cd_nelmts,
                                        int[] cd_values,
                                        long namelen,
                                        String[] name,
                                        int[] filter_config)
                                 throws ArrayIndexOutOfBoundsException,
                                        ArrayStoreException,
                                        HDF5LibraryException,
                                        NullPointerException
        Parameters:
        plist - IN: Property list identifier.
        filter_number - IN: Sequence number within the filter pipeline of the filter for which information is sought.
        flags - OUT: Bit vector specifying certain general properties of the filter.
        cd_nelmts - IN/OUT: Number of elements in cd_values
        cd_values - OUT: Auxiliary data for the filter.
        namelen - IN: Anticipated number of characters in name.
        name - OUT: Name of the filter.
        filter_config - OUT:A bit field encoding the returned filter information
        Returns:
        the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).
        Throws:
        ArrayIndexOutOfBoundsException - Fatal error on Copyback
        ArrayStoreException - Fatal error on Copyback
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name or an array is null.
      • H5Pget_filter_by_id

        public static int H5Pget_filter_by_id​(long plist_id,
                                              long filter_id,
                                              int[] flags,
                                              long[] cd_nelmts,
                                              int[] cd_values,
                                              long namelen,
                                              String[] name,
                                              int[] filter_config)
                                       throws ArrayIndexOutOfBoundsException,
                                              ArrayStoreException,
                                              HDF5LibraryException,
                                              NullPointerException
        Parameters:
        plist_id - IN: Property list identifier.
        filter_id - IN: Filter identifier.
        flags - OUT: Bit vector specifying certain general properties of the filter.
        cd_nelmts - N/OUT: Number of elements in cd_values
        cd_values - OUT: Auxiliary data for the filter.
        namelen - IN: Anticipated number of characters in name.
        name - OUT: Name of the filter.
        filter_config - OUT: A bit field encoding the returned filter information
        Returns:
        the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        ArrayIndexOutOfBoundsException - Fatal error on Copyback
        ArrayStoreException - Fatal error on Copyback
        NullPointerException - name or an array is null.
      • H5Pget_filter_by_id2

        public static int H5Pget_filter_by_id2​(long plist_id,
                                               long filter_id,
                                               int[] flags,
                                               long[] cd_nelmts,
                                               int[] cd_values,
                                               long namelen,
                                               String[] name,
                                               int[] filter_config)
                                        throws HDF5LibraryException,
                                               NullPointerException
        Parameters:
        plist_id - IN: Property list identifier.
        filter_id - IN: Filter identifier.
        flags - OUT: Bit vector specifying certain general properties of the filter.
        cd_nelmts - N/OUT: Number of elements in cd_values
        cd_values - OUT: Auxiliary data for the filter.
        namelen - IN: Anticipated number of characters in name.
        name - OUT: Name of the filter.
        filter_config - OUT: A bit field encoding the returned filter information
        Returns:
        the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name or an array is null.
      • H5Premove_filter

        public static int H5Premove_filter​(long obj_id,
                                           long filter)
                                    throws HDF5LibraryException
        Parameters:
        obj_id - IN: Property list identifier.
        filter - IN: Filter identifier.
        Returns:
        a non-negative value and the size of the user block; if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_deflate

        public static int H5Pset_deflate​(long plist,
                                         int level)
                                  throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier for the dataset creation property list.
        level - IN: Compression level.
        Returns:
        non-negative if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_userblock

        public static int H5Pget_userblock​(long plist,
                                           long[] size)
                                    throws HDF5LibraryException,
                                           NullPointerException
        Parameters:
        plist - IN: Identifier for property list to query.
        size - OUT: Pointer to location to return user-block size.
        Returns:
        a non-negative value and the size of the user block; if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - size is null.
      • H5Pset_userblock

        public static int H5Pset_userblock​(long plist,
                                           long size)
                                    throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of property list to modify.
        size - IN: Size of the user-block in bytes.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_sizes

        public static int H5Pset_sizes​(long plist,
                                       int sizeof_addr,
                                       int sizeof_size)
                                throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of property list to modify.
        sizeof_addr - IN: Size of an object offset in bytes.
        sizeof_size - IN: Size of an object length in bytes.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_sym_k

        public static int H5Pset_sym_k​(long plist,
                                       int ik,
                                       int lk)
                                throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier for property list to query.
        ik - IN: Symbol table tree rank.
        lk - IN: Symbol table node size.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_istore_k

        public static int H5Pget_istore_k​(long plist,
                                          int[] ik)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        plist - IN: Identifier of property list to query.
        ik - OUT: Pointer to location to return the chunked storage B-tree 1/2 rank.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - ik array is null.
      • H5Pset_istore_k

        public static int H5Pset_istore_k​(long plist,
                                          int ik)
                                   throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of property list to query.
        ik - IN: 1/2 rank of chunked storage B-tree.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_shared_mesg_nindexes

        public static int H5Pget_shared_mesg_nindexes​(long fcpl_id)
                                               throws HDF5LibraryException
        Parameters:
        fcpl_id - IN: : File creation property list identifier
        Returns:
        nindexes, the number of shared object header message indexes available in files created with this property list
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_shared_mesg_nindexes

        public static int H5Pset_shared_mesg_nindexes​(long plist_id,
                                                      int nindexes)
                                               throws HDF5LibraryException,
                                                      IllegalArgumentException
        Parameters:
        plist_id - IN: File creation property list
        nindexes - IN: Number of shared object header message indexes to be available in files created with this property list
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Invalid value of nindexes
      • H5Pget_shared_mesg_index

        public static int H5Pget_shared_mesg_index​(long fcpl_id,
                                                   int index_num,
                                                   int[] mesg_info)
                                            throws HDF5LibraryException,
                                                   NullPointerException,
                                                   IllegalArgumentException
        Parameters:
        fcpl_id - IN: File creation property list identifier
        index_num - IN: Index being configured.
        mesg_info - The message type and minimum message size
              mesg_info[0] =  Types of messages that may be stored in this index.
              mesg_info[1] =  Minimum message size.
         
        Returns:
        Returns a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - mesg_info is null.
        IllegalArgumentException - Invalid value of nindexes
      • H5Pset_shared_mesg_index

        public static int H5Pset_shared_mesg_index​(long fcpl_id,
                                                   int index_num,
                                                   int mesg_type_flags,
                                                   int min_mesg_size)
                                            throws HDF5LibraryException,
                                                   IllegalArgumentException
        Parameters:
        fcpl_id - IN: File creation property list identifier.
        index_num - IN: Index being configured.
        mesg_type_flags - IN: Types of messages that should be stored in this index.
        min_mesg_size - IN: Minimum message size.
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Invalid value of nindexes
      • H5Pget_shared_mesg_phase_change

        public static int H5Pget_shared_mesg_phase_change​(long fcpl_id,
                                                          int[] size)
                                                   throws HDF5LibraryException,
                                                          NullPointerException
        Parameters:
        fcpl_id - IN: : File creation property list identifier
        size - The threshold values for storage of shared object header message indexes in a file.
              size[0] =  Threshold above which storage of a shared object header message index shifts from list
              to B-tree size[1] =  Threshold below which storage of a shared object header message index reverts
              to list format
         
        Returns:
        Returns a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - size is null.
      • H5Pset_shared_mesg_phase_change

        public static int H5Pset_shared_mesg_phase_change​(long fcpl_id,
                                                          int max_list,
                                                          int min_btree)
                                                   throws HDF5LibraryException,
                                                          IllegalArgumentException
        Parameters:
        fcpl_id - IN: File creation property list identifier
        max_list - IN: Threshold above which storage of a shared object header message index shifts from list to B-tree
        min_btree - IN: Threshold below which storage of a shared object header message index reverts to list format
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Invalid values of max_list and min_btree.
      • H5Pset_file_space_strategy

        public static void H5Pset_file_space_strategy​(long fcpl_id,
                                                      int strategy,
                                                      boolean persist,
                                                      long threshold)
                                               throws HDF5LibraryException,
                                                      IllegalArgumentException
        Parameters:
        fcpl_id - IN: File creation property list identifier
        strategy - IN: The strategy for file space management. H5F_FSPACE_STRATEGY_FSM_AGGR Mechanisms: free-space managers, aggregators, and virtual file drivers This is the library default when not set. H5F_FSPACE_STRATEGY_PAGE Mechanisms: free-space managers with embedded paged aggregation and virtual file drivers H5F_FSPACE_STRATEGY_AGGR Mechanisms: aggregators and virtual file drivers H5F_FSPACE_STRATEGY_NONE Mechanisms: virtual file drivers
        persist - IN: True to persist free-space.
        threshold - IN: The free-space section threshold. The library default is 1, which is to track all free-space sections. Passing a value of zero (0) indicates that the value of threshold is not to be modified.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Invalid values of max_list and min_btree.
      • H5Pget_file_space_strategy

        public static int H5Pget_file_space_strategy​(long fcpl_id,
                                                     boolean[] persist,
                                                     long[] threshold)
                                              throws HDF5LibraryException,
                                                     IllegalArgumentException
        Parameters:
        fcpl_id - IN: File creation property list identifier
        persist - IN/OUT: The current free-space persistence. NULL, persist not queried.
        threshold - IN/OUT: The current free-space section threshold. NULL, threshold not queried.
        Returns:
        the current free-space strategy.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Invalid values of max_list and min_btree.
      • H5Pset_alignment

        public static int H5Pset_alignment​(long plist,
                                           long threshold,
                                           long alignment)
                                    throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier for a file access property list.
        threshold - IN: Threshold value.
        alignment - IN: Alignment value.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_driver

        public static long H5Pget_driver​(long plid)
                                  throws HDF5LibraryException
        Parameters:
        plid - IN: File access or data transfer property list identifier.
        Returns:
        a valid low-level driver identifier if successful; a negative value if failed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_family_offset

        public static long H5Pget_family_offset​(long fapl_id)
                                         throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        Returns:
        the offset.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_family_offset

        public static int H5Pset_family_offset​(long fapl_id,
                                               long offset)
                                        throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        offset - IN: the offset value
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_cache

        public static int H5Pget_cache​(long plist,
                                       int[] mdc_nelmts,
                                       long[] rdcc_nelmts,
                                       long[] rdcc_nbytes,
                                       double[] rdcc_w0)
                                throws HDF5LibraryException,
                                       NullPointerException
        Parameters:
        plist - IN: Identifier of the file access property list.
        mdc_nelmts - IN/OUT: No longer used, will be ignored.
        rdcc_nelmts - IN/OUT: Number of elements (objects) in the raw data chunk cache.
        rdcc_nbytes - IN/OUT: Total size of the raw data chunk cache, in bytes.
        rdcc_w0 - IN/OUT: Preemption policy.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an array is null.
      • H5Pset_cache

        public static int H5Pset_cache​(long plist,
                                       int mdc_nelmts,
                                       long rdcc_nelmts,
                                       long rdcc_nbytes,
                                       double rdcc_w0)
                                throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of the file access property list.
        mdc_nelmts - IN: No longer used, will be ignored.
        rdcc_nelmts - IN: Number of elements (objects) in the raw data chunk cache.
        rdcc_nbytes - IN: Total size of the raw data chunk cache, in bytes.
        rdcc_w0 - IN: Preemption policy.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_mdc_config

        public static H5AC_cache_config_t H5Pget_mdc_config​(long plist_id)
                                                     throws HDF5LibraryException
        Parameters:
        plist_id - IN: Identifier of the file access property list.
        Returns:
        A buffer(H5AC_cache_config_t) for the current metadata cache configuration information
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_mdc_config

        public static void H5Pset_mdc_config​(long plist_id,
                                             H5AC_cache_config_t config_ptr)
                                      throws HDF5LibraryException
        Parameters:
        plist_id - IN: Identifier of the file access property list.
        config_ptr - IN: H5AC_cache_config_t, the initial metadata cache configuration.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_gc_references

        public static boolean H5Pget_gc_references​(long fapl_id)
                                            throws HDF5LibraryException
        Parameters:
        fapl_id - IN File access property list
        Returns:
        GC is on (true) or off (false)
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_gc_references

        public static int H5Pset_gc_references​(long fapl_id,
                                               boolean gc_ref)
                                        throws HDF5LibraryException
        Parameters:
        fapl_id - IN File access property list
        gc_ref - IN set GC on (true) or off (false)
        Returns:
        non-negative if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_meta_block_size

        public static long H5Pget_meta_block_size​(long fapl_id)
                                           throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        Returns:
        the minimum size, in bytes, of metadata block allocations.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_meta_block_size

        public static void H5Pset_meta_block_size​(long fapl_id,
                                                  long size)
                                           throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        size - IN: Minimum size, in bytes, of metadata block allocations.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_sieve_buf_size

        public static long H5Pget_sieve_buf_size​(long fapl_id)
                                          throws HDF5LibraryException
        Parameters:
        fapl_id - IN: Identifier for property list to query.
        Returns:
        a non-negative value and the size of the user block; if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_sieve_buf_size

        public static void H5Pset_sieve_buf_size​(long fapl_id,
                                                 long size)
                                          throws HDF5LibraryException
        Parameters:
        fapl_id - IN: Identifier of property list to modify.
        size - IN: maximum size of the data seive buffer.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_small_data_block_size

        public static long H5Pget_small_data_block_size​(long plist)
                                                 throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier for property list to query.
        Returns:
        a non-negative value and the size of the user block; if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_small_data_block_size

        public static int H5Pset_small_data_block_size​(long plist,
                                                       long size)
                                                throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of property list to modify.
        size - IN: Size of the blocks in bytes.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_libver_bounds

        public static int H5Pget_libver_bounds​(long fapl_id,
                                               int[] libver)
                                        throws HDF5LibraryException,
                                               NullPointerException
        Parameters:
        fapl_id - IN: File access property list identifier
        libver - The earliest/latest version of the library that will be used for writing objects.
              libver[0] =  The earliest version of the library that will be used for writing objects
              libver[1] =  The latest version of the library that will be used for writing objects.
         
        Returns:
        Returns a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - size is null.
      • H5Pset_libver_bounds

        public static int H5Pset_libver_bounds​(long fapl_id,
                                               int low,
                                               int high)
                                        throws HDF5LibraryException,
                                               IllegalArgumentException
        Parameters:
        fapl_id - IN: File access property list identifier
        low - IN: The earliest version of the library that will be used for writing objects
        high - IN: The latest version of the library that will be used for writing objects.
        Returns:
        Returns a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Argument is Illegal
      • H5Pget_elink_file_cache_size

        public static int H5Pget_elink_file_cache_size​(long fapl_id)
                                                throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        Returns:
        External link open file cache size in number of files.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_elink_file_cache_size

        public static void H5Pset_elink_file_cache_size​(long fapl_id,
                                                        int efc_size)
                                                 throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        efc_size - IN: External link open file cache size in number of files.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_mdc_log_options

        public static void H5Pset_mdc_log_options​(long fapl_id,
                                                  boolean is_enabled,
                                                  String location,
                                                  boolean start_on_access)
                                           throws HDF5LibraryException,
                                                  NullPointerException
        Parameters:
        fapl_id - IN: File access property list identifier
        is_enabled - IN: Whether logging is enabled.
        location - IN: Location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII).
        start_on_access - IN: Whether the logging begins as soon as the file is opened or created.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - location is null.
      • H5Pget_mdc_log_options

        public static String H5Pget_mdc_log_options​(long fapl_id,
                                                    boolean[] mdc_log_options)
                                             throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        mdc_log_options - the options mdc_logging_options[0] = is_enabled, whether logging is enabled mdc_logging_options[1] = start_on_access, whether the logging begins as soon as the file is opened or created
        Returns:
        the location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII).
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_metadata_read_attempts

        public static long H5Pget_metadata_read_attempts​(long plist_id)
                                                  throws HDF5LibraryException
        Parameters:
        plist_id - IN: File access property list identifier
        Returns:
        The number of read attempts.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_metadata_read_attempts

        public static void H5Pset_metadata_read_attempts​(long plist_id,
                                                         long attempts)
                                                  throws HDF5LibraryException
        Parameters:
        plist_id - IN: File access property list identifier
        attempts - IN: The number of read attempts which is a value greater than 0.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_evict_on_close

        public static boolean H5Pget_evict_on_close​(long fapl_id)
                                             throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        Returns:
        indication if the object will be evicted on close.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_evict_on_close

        public static void H5Pset_evict_on_close​(long fapl_id,
                                                 boolean evict_on_close)
                                          throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        evict_on_close - IN: Whether the HDF5 object should be evicted on close.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_use_file_locking

        public static boolean H5Pget_use_file_locking​(long fapl_id)
                                               throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        Returns:
        indication if file locking is used.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_ignore_disabled_file_locking

        public static boolean H5Pget_ignore_disabled_file_locking​(long fapl_id)
                                                           throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        Returns:
        indication if file locking is ignored.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_file_locking

        public static void H5Pset_file_locking​(long fapl_id,
                                               boolean use_file_locking,
                                               boolean ignore_when_disabled)
                                        throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        use_file_locking - IN: Whether the library will use file locking when opening files (mainly for SWMR semantics).
        ignore_when_disabled - IN: Whether file locking will be ignored when disabled on a file system (useful for Lustre).
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_layout

        public static int H5Pget_layout​(long plist)
                                 throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier for property list to query.
        Returns:
        the layout type of a dataset creation property list if successful. Otherwise returns H5D_LAYOUT_ERROR (-1).
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_layout

        public static int H5Pset_layout​(long plist,
                                        int layout)
                                 throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of property list to query.
        layout - IN: Type of storage layout for raw data.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_virtual

        public static void H5Pset_virtual​(long dcpl_id,
                                          long vspace_id,
                                          String src_file_name,
                                          String src_dset_name,
                                          long src_space_id)
                                   throws HDF5LibraryException,
                                          NullPointerException,
                                          IllegalArgumentException
        Parameters:
        dcpl_id - IN: The identifier of the dataset creation property list that will be used when creating the virtual dataset.
        vspace_id - IN: The dataspace identifier with the selection within the virtual dataset applied, possibly an unlimited selection.
        src_file_name - IN: The name of the HDF5 file where the source dataset is located. The file might not exist yet. The name can be specified using a C-style printf statement.
        src_dset_name - IN: The path to the HDF5 dataset in the file specified by src_file_name. The dataset might not exist yet. The dataset name can be specified using a C-style printf statement.
        src_space_id - IN: The source dataset dataspace identifier with a selection applied, possibly an unlimited selection.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an name string is null.
        IllegalArgumentException - an id is <=0
      • H5Pset_external

        public static int H5Pset_external​(long plist,
                                          String name,
                                          long offset,
                                          long size)
                                   throws HDF5LibraryException,
                                          NullPointerException
        Parameters:
        plist - IN: Identifier of a dataset creation property list.
        name - IN: Name of an external file.
        offset - IN: Offset, in bytes, from the beginning of the file to the location in the file where the data starts.
        size - IN: Number of bytes reserved in the file for the data.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Pget_external_count

        public static int H5Pget_external_count​(long plist)
                                         throws HDF5LibraryException
        Parameters:
        plist - IN: Identifier of a dataset creation property list.
        Returns:
        the number of external files if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_szip

        public static int H5Pset_szip​(long plist,
                                      int options_mask,
                                      int pixels_per_block)
                               throws HDF5LibraryException,
                                      NullPointerException
        Parameters:
        plist - IN: Dataset creation property list identifier.
        options_mask - IN: Bit vector specifying certain general properties of the filter.
        pixels_per_block - IN: Number of pixels in blocks
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5Pset_nbit

        public static int H5Pset_nbit​(long plist_id)
                               throws HDF5LibraryException
        Parameters:
        plist_id - IN: Dataset creation property list identifier.
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_scaleoffset

        public static int H5Pset_scaleoffset​(long plist_id,
                                             int scale_type,
                                             int scale_factor)
                                      throws HDF5LibraryException,
                                             IllegalArgumentException
        Parameters:
        plist_id - IN: Dataset creation property list identifier.
        scale_type - IN: Flag indicating compression method.
        scale_factor - IN: Parameter related to scale.
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Invalid arguments
      • H5Pget_fill_value

        public static int H5Pget_fill_value​(long plist_id,
                                            long type_id,
                                            byte[] value)
                                     throws HDF5Exception
        Parameters:
        plist_id - IN: Property list identifier.
        type_id - IN: The datatype identifier of value.
        value - IN: The fill value.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5Exception - Error converting data array.
      • H5Pget_fill_value

        public static int H5Pget_fill_value​(long plist_id,
                                            long type_id,
                                            Object obj)
                                     throws HDF5Exception
        Parameters:
        plist_id - IN: Property list identifier.
        type_id - IN: The datatype identifier of value.
        obj - IN: The fill value.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5Exception - Error converting data array.
      • H5Pset_fill_value

        public static int H5Pset_fill_value​(long plist_id,
                                            long type_id,
                                            byte[] value)
                                     throws HDF5Exception
        Parameters:
        plist_id - IN: Property list identifier.
        type_id - IN: The datatype identifier of value.
        value - IN: The fill value.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5Exception - Error converting data array
      • H5Pset_fill_value

        public static int H5Pset_fill_value​(long plist_id,
                                            long type_id,
                                            Object obj)
                                     throws HDF5Exception
        Parameters:
        plist_id - IN: Property list identifier.
        type_id - IN: The datatype identifier of value.
        obj - IN: The fill value.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5Exception - Error converting data array
      • H5Pfill_value_defined

        public static int H5Pfill_value_defined​(long plist_id,
                                                int[] status)
                                         throws HDF5LibraryException,
                                                NullPointerException
        Parameters:
        plist_id - IN: Property list identifier.
        status - IN: The fill value setting: H5D_FILL_VALUE_UNDEFINED H5D_FILL_VALUE_DEFAULT H5D_FILL_VALUE_USER_DEFINED H5D_FILL_VALUE_ERROR
        Returns:
        a non-negative value if successful
        Throws:
        HDF5Exception - Error converting data array
        HDF5LibraryException
        NullPointerException
      • H5Pget_alloc_time

        public static int H5Pget_alloc_time​(long plist_id,
                                            int[] alloc_time)
                                     throws HDF5LibraryException,
                                            NullPointerException
        Parameters:
        plist_id - IN: Dataset creation property list identifier.
        alloc_time - OUT: allocation time.
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5Pset_alloc_time

        public static int H5Pset_alloc_time​(long plist_id,
                                            int alloc_time)
                                     throws HDF5LibraryException,
                                            NullPointerException
        Parameters:
        plist_id - IN: Dataset creation property list identifier.
        alloc_time - IN: allocation time.
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5Pget_fill_time

        public static int H5Pget_fill_time​(long plist_id,
                                           int[] fill_time)
                                    throws HDF5LibraryException
        Parameters:
        plist_id - IN: Dataset creation property list identifier.
        fill_time - OUT: fill time.
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_fill_time

        public static int H5Pset_fill_time​(long plist_id,
                                           int fill_time)
                                    throws HDF5LibraryException
        Parameters:
        plist_id - IN: Dataset creation property list identifier.
        fill_time - IN: fill time.
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_chunk_opts

        public static void H5Pset_chunk_opts​(long dcpl_id,
                                             int opts)
                                      throws HDF5LibraryException
        Parameters:
        dcpl_id - IN: Dataset creation property list identifier
        opts - IN: Edge chunk option flag. Valid values are: H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS - filters are not applied to partial edge chunks. 0 - Disables option; partial edge chunks will be compressed.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library
      • H5Pget_chunk_opts

        public static int H5Pget_chunk_opts​(long dcpl_id)
                                     throws HDF5LibraryException
        Parameters:
        dcpl_id - IN: Dataset creation property list
        Returns:
        The edge chunk option setting.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library
      • H5Pget_dset_no_attrs_hint

        public static boolean H5Pget_dset_no_attrs_hint​(long dcpl_id)
                                                 throws HDF5LibraryException
        Parameters:
        dcpl_id - IN: Dataset creation property list
        Returns:
        true if the given dcpl is set to create minimized dataset object headers, false if not.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_dset_no_attrs_hint

        public static void H5Pset_dset_no_attrs_hint​(long dcpl_id,
                                                     boolean minimize)
                                              throws HDF5LibraryException
        Parameters:
        dcpl_id - IN: Dataset creation property list
        minimize - IN: the minimize hint setting
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_chunk_cache

        public static void H5Pget_chunk_cache​(long dapl_id,
                                              long[] rdcc_nslots,
                                              long[] rdcc_nbytes,
                                              double[] rdcc_w0)
                                       throws HDF5LibraryException,
                                              NullPointerException
        Parameters:
        dapl_id - IN: Identifier of the dataset access property list.
        rdcc_nslots - IN/OUT: Number of elements (objects) in the raw data chunk cache.
        rdcc_nbytes - IN/OUT: Total size of the raw data chunk cache, in bytes.
        rdcc_w0 - IN/OUT: Preemption policy.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an array is null.
      • H5Pset_chunk_cache

        public static void H5Pset_chunk_cache​(long dapl_id,
                                              long rdcc_nslots,
                                              long rdcc_nbytes,
                                              double rdcc_w0)
                                       throws HDF5LibraryException
        Parameters:
        dapl_id - IN: Identifier of the dataset access property list.
        rdcc_nslots - IN: Number of elements (objects) in the raw data chunk cache.
        rdcc_nbytes - IN: Total size of the raw data chunk cache, in bytes.
        rdcc_w0 - IN: Preemption policy.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_virtual_view

        public static void H5Pset_virtual_view​(long dapl_id,
                                               int view)
                                        throws HDF5LibraryException
        Parameters:
        dapl_id - IN: Dataset access property list identifier for the virtual dataset
        view - IN: Flag specifying the extent of the data to be included in the view.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library
      • H5Pget_virtual_view

        public static int H5Pget_virtual_view​(long dapl_id)
                                       throws HDF5LibraryException
        Parameters:
        dapl_id - IN: Dataset access property list identifier for the virtual dataset
        Returns:
        The flag specifying the view of the virtual dataset.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library
      • H5Pset_virtual_printf_gap

        public static void H5Pset_virtual_printf_gap​(long dapl_id,
                                                     long gap_size)
                                              throws HDF5LibraryException
        Parameters:
        dapl_id - IN: Dataset access property list identifier for the virtual dataset
        gap_size - IN: Maximum number of files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library
      • H5Pget_virtual_printf_gap

        public static long H5Pget_virtual_printf_gap​(long dapl_id)
                                              throws HDF5LibraryException
        Parameters:
        dapl_id - IN: Dataset access property list identifier for the virtual dataset
        Returns:
        Maximum number of files and/or datasets allowed to be missing for determining the extent of an unlimited virtual dataset with printf-style mappings.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library
      • H5Pget_virtual_prefix

        public static String H5Pget_virtual_prefix​(long dapl_id)
                                            throws HDF5LibraryException
        Parameters:
        dapl_id - IN: Link access property list identifier
        Returns:
        the prefix to be applied to virtual file paths.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_efile_prefix

        public static String H5Pget_efile_prefix​(long dapl_id)
                                          throws HDF5LibraryException
        Parameters:
        dapl_id - IN: Link access property list identifier
        Returns:
        the prefix to be applied to external file paths.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_data_transform

        public static long H5Pget_data_transform​(long plist_id,
                                                 String[] expression,
                                                 long size)
                                          throws HDF5LibraryException,
                                                 IllegalArgumentException
        Parameters:
        plist_id - IN: Identifier of the property list or class
        size - IN: Number of bytes of the transform expression to copy to
        expression - OUT: A data transform expression
        Returns:
        The size of the transform expression if successful; 0(zero) if no transform expression exists. Otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Size is <= 0.
      • H5Pset_data_transform

        public static int H5Pset_data_transform​(long plist_id,
                                                String expression)
                                         throws HDF5LibraryException,
                                                NullPointerException
        Parameters:
        plist_id - IN: Identifier of the property list or class
        expression - IN: Pointer to the null-terminated data transform expression
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - expression is null.
      • H5Pget_buffer

        public static int H5Pget_buffer​(long plist,
                                        byte[] tconv,
                                        byte[] bkg)
                                 throws HDF5LibraryException,
                                        IllegalArgumentException
        Parameters:
        plist - Identifier for the dataset transfer property list.
        tconv - byte array of application-allocated type conversion buffer.
        bkg - byte array of application-allocated background buffer.
        Returns:
        buffer size, in bytes, if successful; otherwise 0 on failure
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - plist is invalid.
      • H5Pget_edc_check

        public static int H5Pget_edc_check​(long plist)
                                    throws HDF5LibraryException
        Parameters:
        plist - Identifier for the dataset transfer property list.
        Returns:
        the error-detecting algorithm
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_edc_check

        public static int H5Pset_edc_check​(long plist,
                                           int check)
                                    throws HDF5LibraryException
        Parameters:
        plist - Identifier for the dataset transfer property list.
        check - the error-detecting algorithm to use.
        Returns:
        non-negative if succeed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_btree_ratios

        public static int H5Pget_btree_ratios​(long plist_id,
                                              double[] left,
                                              double[] middle,
                                              double[] right)
                                       throws HDF5LibraryException,
                                              NullPointerException
        Parameters:
        plist_id - IN Dataset transfer property list
        left - OUT split ratio for leftmost nodes
        right - OUT split ratio for righttmost nodes
        middle - OUT split ratio for all other nodes
        Returns:
        non-negative if succeed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an input array is null.
      • H5Pset_btree_ratios

        public static int H5Pset_btree_ratios​(long plist_id,
                                              double left,
                                              double middle,
                                              double right)
                                       throws HDF5LibraryException
        Parameters:
        plist_id - IN Dataset transfer property list
        left - IN split ratio for leftmost nodes
        right - IN split ratio for righttmost nodes
        middle - IN split ratio for all other nodes
        Returns:
        non-negative if succeed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_hyper_vector_size

        public static int H5Pget_hyper_vector_size​(long dxpl_id,
                                                   long[] vector_size)
                                            throws HDF5LibraryException,
                                                   NullPointerException
        Parameters:
        dxpl_id - IN: Dataset transfer property list identifier.
        vector_size - OUT: hyper vector size.
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5Pset_hyper_vector_size

        public static int H5Pset_hyper_vector_size​(long dxpl_id,
                                                   long vector_size)
                                            throws HDF5LibraryException,
                                                   NullPointerException
        Parameters:
        dxpl_id - IN: Dataset transfer property list identifier.
        vector_size - IN: hyper vestor size.
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5Pget_create_intermediate_group

        public static boolean H5Pget_create_intermediate_group​(long lcpl_id)
                                                        throws HDF5LibraryException
        Parameters:
        lcpl_id - IN: Link creation property list identifier
        Returns:
        Boolean true or false
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_create_intermediate_group

        public static int H5Pset_create_intermediate_group​(long lcpl_id,
                                                           boolean crt_intermed_group)
                                                    throws HDF5LibraryException
        Parameters:
        lcpl_id - IN: Link creation property list identifier
        crt_intermed_group - IN: Flag specifying whether to create intermediate groups upon the creation of an object
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_local_heap_size_hint

        public static long H5Pget_local_heap_size_hint​(long gcpl_id)
                                                throws HDF5LibraryException
        Parameters:
        gcpl_id - IN: Group creation property list identifier
        Returns:
        size_hint, the anticipated size of local heap
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_local_heap_size_hint

        public static int H5Pset_local_heap_size_hint​(long gcpl_id,
                                                      long size_hint)
                                               throws HDF5LibraryException
        Parameters:
        gcpl_id - IN: Group creation property list identifier
        size_hint - IN: Anticipated maximum size in bytes of local heap
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_link_phase_change

        public static int H5Pget_link_phase_change​(long gcpl_id,
                                                   int[] links)
                                            throws HDF5LibraryException,
                                                   NullPointerException
        Parameters:
        gcpl_id - IN: Group creation property list identifier
        links - The max. no. of compact links & the min. no. of dense links, which are used for storing groups
              links[0] =  The maximum number of links for compact storage
              links[1] =  The minimum number of links for dense storage
         
        Returns:
        Returns a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - size is null.
      • H5Pset_link_phase_change

        public static int H5Pset_link_phase_change​(long gcpl_id,
                                                   int max_compact,
                                                   int min_dense)
                                            throws HDF5LibraryException,
                                                   IllegalArgumentException
        Parameters:
        gcpl_id - IN: Group creation property list identifier
        max_compact - IN: Maximum number of links for compact storage(Default: 8)
        min_dense - IN: Minimum number of links for dense storage(Default: 6)
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Invalid values of max_compact and min_dense.
      • H5Pget_est_link_info

        public static int H5Pget_est_link_info​(long gcpl_id,
                                               int[] link_info)
                                        throws HDF5LibraryException,
                                               NullPointerException
        Parameters:
        gcpl_id - IN: Group creation property list identifier
        link_info - Estimated number of links to be inserted into group And the estimated average length of link names
              link_info[0] =  Estimated number of links to be inserted into group
              link_info[1] =  Estimated average length of link names
         
        Returns:
        Returns a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - link_info is null.
      • H5Pset_est_link_info

        public static int H5Pset_est_link_info​(long gcpl_id,
                                               int est_num_entries,
                                               int est_name_len)
                                        throws HDF5LibraryException,
                                               IllegalArgumentException
        Parameters:
        gcpl_id - IN: Group creation property list identifier
        est_num_entries - IN: Estimated number of links to be inserted into group
        est_name_len - IN: Estimated average length of link names
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Invalid values to est_num_entries and est_name_len.
      • H5Pget_link_creation_order

        public static int H5Pget_link_creation_order​(long gcpl_id)
                                              throws HDF5LibraryException
        Parameters:
        gcpl_id - IN: Group creation property list identifier
        Returns:
        crt_order_flags -Creation order flag(s)
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_link_creation_order

        public static int H5Pset_link_creation_order​(long gcpl_id,
                                                     int crt_order_flags)
                                              throws HDF5LibraryException
        Parameters:
        gcpl_id - IN: Group creation property list identifier
        crt_order_flags - IN: Creation order flag(s)
        Returns:
        Returns a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_char_encoding

        public static int H5Pget_char_encoding​(long plist_id)
                                        throws HDF5LibraryException
        Parameters:
        plist_id - IN: the property list identifier
        Returns:
        Returns the character encoding of the string.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_char_encoding

        public static void H5Pset_char_encoding​(long plist_id,
                                                int encoding)
                                         throws HDF5LibraryException
        Parameters:
        plist_id - IN: the property list identifier
        encoding - IN: the character encoding of the string
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_nlinks

        public static long H5Pget_nlinks​(long lapl_id)
                                  throws HDF5LibraryException
        Parameters:
        lapl_id - IN: File access property list identifier
        Returns:
        Returns a Maximum number of links to traverse.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_nlinks

        public static int H5Pset_nlinks​(long lapl_id,
                                        long nlinks)
                                 throws HDF5LibraryException,
                                        IllegalArgumentException
        Parameters:
        lapl_id - IN: File access property list identifier
        nlinks - IN: Maximum number of links to traverse
        Returns:
        Returns a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Argument is Illegal
      • H5Pget_elink_prefix

        public static long H5Pget_elink_prefix​(long lapl_id,
                                               String[] prefix)
                                        throws HDF5LibraryException,
                                               NullPointerException
        Parameters:
        lapl_id - IN: Link access property list identifier
        prefix - OUT: Prefix applied to external link paths
        Returns:
        If successful, returns a non-negative value specifying the size in bytes of the prefix without the NULL terminator; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - prefix is null.
      • H5Pset_elink_prefix

        public static int H5Pset_elink_prefix​(long lapl_id,
                                              String prefix)
                                       throws HDF5LibraryException,
                                              NullPointerException
        Parameters:
        lapl_id - IN: Link access property list identifier
        prefix - IN: Prefix to be applied to external link paths
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - prefix is null.
      • H5Pget_elink_fapl

        public static long H5Pget_elink_fapl​(long lapl_id)
                                      throws HDF5LibraryException
        Parameters:
        lapl_id - IN: Link access property list identifier
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_elink_fapl

        public static int H5Pset_elink_fapl​(long lapl_id,
                                            long fapl_id)
                                     throws HDF5LibraryException
        Parameters:
        lapl_id - IN: Link access property list identifier
        fapl_id - IN: File access property list identifier
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_elink_acc_flags

        public static int H5Pget_elink_acc_flags​(long lapl_id)
                                          throws HDF5LibraryException
        Parameters:
        lapl_id - IN: Link access property list identifier
        Returns:
        File access flag for link traversal.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_elink_acc_flags

        public static int H5Pset_elink_acc_flags​(long lapl_id,
                                                 int flags)
                                          throws HDF5LibraryException,
                                                 IllegalArgumentException
        Parameters:
        lapl_id - IN: Link access property list identifier
        flags - IN: The access flag for external link traversal.
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        IllegalArgumentException - Invalid Flag values.
      • H5Pget_copy_object

        public static int H5Pget_copy_object​(long ocp_plist_id)
                                      throws HDF5LibraryException
        Parameters:
        ocp_plist_id - IN: Object copy property list identifier
        Returns:
        Copy option(s) set in the object copy property list
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_copy_object

        public static void H5Pset_copy_object​(long ocp_plist_id,
                                              int copy_options)
                                       throws HDF5LibraryException
        Parameters:
        ocp_plist_id - IN: Object copy property list identifier
        copy_options - IN: Copy option(s) to be set
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_fapl_core

        public static void H5Pget_fapl_core​(long fapl_id,
                                            long[] increment,
                                            boolean[] backing_store)
                                     throws HDF5LibraryException,
                                            NullPointerException
        Parameters:
        fapl_id - IN: File access property list identifier
        increment - OUT: how much to grow the memory each time
        backing_store - OUT: write to file name on flush setting
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5Pset_fapl_core

        public static int H5Pset_fapl_core​(long fapl_id,
                                           long increment,
                                           boolean backing_store)
                                    throws HDF5LibraryException,
                                           NullPointerException
        Parameters:
        fapl_id - IN: File access property list identifier
        increment - IN: how much to grow the memory each time
        backing_store - IN: write to file name on flush setting
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5Pget_fapl_direct

        public static int H5Pget_fapl_direct​(long fapl_id,
                                             long[] info)
                                      throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        info - OUT: Returned property list information info[0] = increment -how much to grow the memory each time info[1] = backing_store - write to file name on flush setting
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pset_fapl_direct

        public static int H5Pset_fapl_direct​(long fapl_id,
                                             long alignment,
                                             long block_size,
                                             long cbuf_size)
                                      throws HDF5LibraryException
        Parameters:
        fapl_id - IN: File access property list identifier
        alignment - IN: Required memory alignment boundary
        block_size - IN: File system block size
        cbuf_size - IN: Copy buffer size
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Pget_fapl_family

        public static int H5Pget_fapl_family​(long fapl_id,
                                             long[] memb_size,
                                             long[] memb_fapl_id)
                                      throws HDF5LibraryException,
                                             NullPointerException
        Parameters:
        fapl_id - IN: File access property list identifier
        memb_size - OUT: the size in bytes of each file member (used only when creating a new file)
        memb_fapl_id - OUT: the file access property list to be used for each family member
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5Pset_fapl_family

        public static int H5Pset_fapl_family​(long fapl_id,
                                             long memb_size,
                                             long memb_fapl_id)
                                      throws HDF5LibraryException,
                                             NullPointerException
        Parameters:
        fapl_id - IN: File access property list identifier
        memb_size - IN: the size in bytes of each file member (used only when creating a new file)
        memb_fapl_id - IN: the file access property list to be used for each family member
        Returns:
        a non-negative value if successful; otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5Pget_fapl_multi

        public static boolean H5Pget_fapl_multi​(long fapl_id,
                                                int[] memb_map,
                                                long[] memb_fapl,
                                                String[] memb_name,
                                                long[] memb_addr)
                                         throws HDF5LibraryException,
                                                NullPointerException
        Parameters:
        fapl_id - IN: File access property list identifier
        memb_map - IN: Maps memory usage types to other memory usage types.
        memb_fapl - IN: Property list for each memory usage type.
        memb_name - IN: Name generator for names of member files.
        memb_addr - IN: The offsets within the virtual address space, from 0 (zero) to HADDR_MAX, at which each type of data storage begins.
        Returns:
        a boolean value; Allows read-only access to incomplete file sets when TRUE.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an array is null.
      • H5Pset_fapl_multi

        public static void H5Pset_fapl_multi​(long fapl_id,
                                             int[] memb_map,
                                             long[] memb_fapl,
                                             String[] memb_name,
                                             long[] memb_addr,
                                             boolean relax)
                                      throws HDF5LibraryException,
                                             NullPointerException
        Parameters:
        fapl_id - IN: File access property list identifier
        memb_map - IN: Maps memory usage types to other memory usage types.
        memb_fapl - IN: Property list for each memory usage type.
        memb_name - IN: Name generator for names of member files.
        memb_addr - IN: The offsets within the virtual address space, from 0 (zero) to HADDR_MAX, at which each type of data storage begins.
        relax - IN: Allows read-only access to incomplete file sets when TRUE.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an array is null.
      • H5Pset_fapl_log

        public static void H5Pset_fapl_log​(long fapl_id,
                                           String logfile,
                                           long flags,
                                           long buf_size)
                                    throws HDF5LibraryException,
                                           NullPointerException
        Parameters:
        fapl_id - IN: File access property list identifier.
        logfile - IN: logfile is the name of the file in which the logging entries are to be recorded.
        flags - IN: Flags specifying the types of logging activity.
        buf_size - IN: The size of the logging buffers, in bytes.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - logfile is null.
      • H5Pset_fapl_split

        public static void H5Pset_fapl_split​(long fapl_id,
                                             String meta_ext,
                                             long meta_plist_id,
                                             String raw_ext,
                                             long raw_plist_id)
                                      throws HDF5LibraryException,
                                             NullPointerException
        Parameters:
        fapl_id - IN: File access property list identifier
        meta_ext - IN: meta filename extension
        meta_plist_id - IN: File access property list identifier for metadata
        raw_ext - IN: raw data filename extension
        raw_plist_id - IN: File access property list identifier raw data
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5PLset_loading_state

        public static void H5PLset_loading_state​(int plugin_flags)
                                          throws HDF5LibraryException
        Parameters:
        plugin_flags - IN: The list of dynamic plugin types to enable or disable. A plugin bit set to 0 (zero) prevents use of that dynamic plugin. A plugin bit set to 1 (one) enables use of that dynamic plugin. Setting plugin_flags to a negative value enables all dynamic plugins. Setting plugin_flags to 0 (zero) disables all dynamic plugins.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5PLget_loading_state

        public static int H5PLget_loading_state()
                                         throws HDF5LibraryException
        Returns:
        the list of dynamic plugin types that are enabled or disabled. A plugin bit set to 0 (zero) indicates that that dynamic plugin is disabled. A plugin bit set to 1 (one) indicates that that dynamic plugin is enabled. If the value of plugin_flags is negative, all dynamic plugins are enabled. If the value of plugin_flags is 0 (zero), all dynamic plugins are disabled.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5PLappend

        public static void H5PLappend​(String plugin_path)
                               throws HDF5LibraryException
        Parameters:
        plugin_path - IN: Path for location of filter plugin libraries.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5PLprepend

        public static void H5PLprepend​(String plugin_path)
                                throws HDF5LibraryException
        Parameters:
        plugin_path - IN: Path for location of filter plugin libraries.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5PLreplace

        public static void H5PLreplace​(String plugin_path,
                                       int index)
                                throws HDF5LibraryException
        Parameters:
        plugin_path - IN: Path for location of filter plugin libraries.
        index - IN: The table index (0-based).
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5PLinsert

        public static void H5PLinsert​(String plugin_path,
                                      int index)
                               throws HDF5LibraryException
        Parameters:
        plugin_path - IN: Path for location of filter plugin libraries.
        index - IN: The table index (0-based).
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5PLget

        public static String H5PLget​(int index)
                              throws HDF5LibraryException
        Parameters:
        index - IN: The table index (0-based).
        Returns:
        the current path at the index in plugin path table
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Rget_name

        public static long H5Rget_name​(long loc_id,
                                       int ref_type,
                                       byte[] ref,
                                       String[] name,
                                       long size)
                                throws HDF5LibraryException,
                                       NullPointerException,
                                       IllegalArgumentException
        Parameters:
        loc_id - IN: Identifier for the dataset containing the reference or for the group that dataset is in.
        ref_type - IN: Type of reference.
        ref - IN: An object or dataset region reference.
        name - OUT: A name associated with the referenced object or dataset region.
        size - IN: The size of the name buffer.
        Returns:
        Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - size is null.
        IllegalArgumentException - Argument is illegal.
      • H5Rcreate_region

        public static byte[] H5Rcreate_region​(long loc_id,
                                              String name,
                                              long space_id,
                                              long access_id)
                                       throws HDF5LibraryException,
                                              NullPointerException,
                                              IllegalArgumentException
        Parameters:
        loc_id - IN: Location identifier used to locate the object being pointed to.
        name - IN: Name of object at location loc_id.
        space_id - IN: Identifies the dataset region that a dataset region reference points to.
        access_id - IN: Object access identifier to the object being pointed to.
        Returns:
        the reference (byte[]) if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an input array is null.
        IllegalArgumentException - an input array is invalid.
      • H5Ropen_object

        public static long H5Ropen_object​(byte[] ref_ptr,
                                          long rapl_id,
                                          long oapl_id)
                                   throws HDF5LibraryException,
                                          NullPointerException,
                                          IllegalArgumentException
        Parameters:
        ref_ptr - IN: Reference to an object, region or attribute attached to an object.
        rapl_id - IN: A reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).
        oapl_id - IN: An object access property list identifier for the reference. The access property property list must be of the same type as the object being referenced, that is a group or dataset property list.
        Returns:
        a valid identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an input array is null.
        IllegalArgumentException - an input array is invalid.
      • H5Ropen_region

        public static long H5Ropen_region​(byte[] ref_ptr,
                                          long rapl_id,
                                          long oapl_id)
                                   throws HDF5LibraryException,
                                          NullPointerException,
                                          IllegalArgumentException
        Parameters:
        ref_ptr - IN: Reference to an object, region or attribute attached to an object.
        rapl_id - IN: A reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).
        oapl_id - IN: An object access property list identifier for the reference. The access property property list must be of the same type as the object being referenced, that is a group or dataset property list.
        Returns:
        a valid dataspace identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an input array is null.
        IllegalArgumentException - an input array is invalid.
      • H5Ropen_attr

        public static long H5Ropen_attr​(byte[] ref_ptr,
                                        long rapl_id,
                                        long aapl_id)
                                 throws HDF5LibraryException,
                                        NullPointerException,
                                        IllegalArgumentException
        Parameters:
        ref_ptr - IN: Reference to an object, region or attribute attached to an object.
        rapl_id - IN: A reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).
        aapl_id - IN: An attribute access property list identifier for the reference. The access property property list must be of the same type as the object being referenced, that is a group or dataset property list.
        Returns:
        a valid attribute identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an input array is null.
        IllegalArgumentException - an input array is invalid.
      • H5Rget_obj_type3

        public static int H5Rget_obj_type3​(byte[] ref_ptr,
                                           long rapl_id)
                                    throws HDF5LibraryException,
                                           NullPointerException,
                                           IllegalArgumentException
        Parameters:
        ref_ptr - IN: Reference to an object, region or attribute attached to an object.
        rapl_id - IN: A reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).
        Returns:
        Returns the object type
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - array is null.
        IllegalArgumentException - array is invalid.
      • H5Screate

        public static long H5Screate​(int type)
                              throws HDF5LibraryException
        Parameters:
        type - IN: The type of dataspace to be created.
        Returns:
        a dataspace identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Screate_simple

        public static long H5Screate_simple​(int rank,
                                            long[] dims,
                                            long[] maxdims)
                                     throws HDF5Exception,
                                            NullPointerException
        Parameters:
        rank - IN: Number of dimensions of dataspace.
        dims - IN: An array of the size of each dimension.
        maxdims - IN: An array of the maximum size of each dimension.
        Returns:
        a dataspace identifier
        Throws:
        HDF5Exception - Error from the HDF5 Library.
        NullPointerException - dims or maxdims is null.
      • H5Sset_extent_simple

        public static long H5Sset_extent_simple​(long space_id,
                                                int rank,
                                                long[] current_size,
                                                long[] maximum_size)
                                         throws HDF5LibraryException,
                                                NullPointerException
        Parameters:
        space_id - Dataspace identifier.
        rank - Rank, or dimensionality, of the dataspace.
        current_size - Array containing current size of dataspace.
        maximum_size - Array containing maximum size of dataspace.
        Returns:
        a dataspace identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5Sset_extent_simple

        public static long H5Sset_extent_simple​(long space_id,
                                                int rank,
                                                byte[] current_size,
                                                byte[] maximum_size)
                                         throws HDF5LibraryException,
                                                NullPointerException
        Parameters:
        space_id - Dataspace identifier.
        rank - Rank, or dimensionality, of the dataspace.
        current_size - Array containing current size of dataspace.
        maximum_size - Array containing maximum size of dataspace.
        Returns:
        a dataspace identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException
      • H5Scopy

        public static long H5Scopy​(long space_id)
                            throws HDF5LibraryException
        Parameters:
        space_id - Identifier of dataspace to copy.
        Returns:
        a dataspace identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sclose

        public static int H5Sclose​(long space_id)
                            throws HDF5LibraryException
        Parameters:
        space_id - Identifier of dataspace to release.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sget_simple_extent_npoints

        public static long H5Sget_simple_extent_npoints​(long space_id)
                                                 throws HDF5LibraryException
        Parameters:
        space_id - ID of the dataspace object to query
        Returns:
        the number of elements in the dataspace if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sget_simple_extent_ndims

        public static int H5Sget_simple_extent_ndims​(long space_id)
                                              throws HDF5LibraryException
        Parameters:
        space_id - IN: Identifier of the dataspace
        Returns:
        the number of dimensions in the dataspace if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sget_simple_extent_dims

        public static int H5Sget_simple_extent_dims​(long space_id,
                                                    long[] dims,
                                                    long[] maxdims)
                                             throws HDF5LibraryException,
                                                    NullPointerException
        Parameters:
        space_id - IN: Identifier of the dataspace object to query
        dims - OUT: Pointer to array to store the size of each dimension.
        maxdims - OUT: Pointer to array to store the maximum size of each dimension.
        Returns:
        the number of dimensions in the dataspace if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - dims or maxdims is null.
      • H5Sis_simple

        public static boolean H5Sis_simple​(long space_id)
                                    throws HDF5LibraryException
        Parameters:
        space_id - Identifier of the dataspace to query
        Returns:
        true if is a simple dataspace
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sget_simple_extent_type

        public static int H5Sget_simple_extent_type​(long space_id)
                                             throws HDF5LibraryException
        Parameters:
        space_id - Dataspace identifier.
        Returns:
        a dataspace class name if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sset_extent_none

        public static int H5Sset_extent_none​(long space_id)
                                      throws HDF5LibraryException
        Parameters:
        space_id - The identifier for the dataspace from which the extent is to be removed.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sextent_copy

        public static int H5Sextent_copy​(long dest_space_id,
                                         long source_space_id)
                                  throws HDF5LibraryException
        Parameters:
        dest_space_id - IN: The identifier for the dataspace from which the extent is copied.
        source_space_id - IN: The identifier for the dataspace to which the extent is copied.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sextent_equal

        public static boolean H5Sextent_equal​(long first_space_id,
                                              long second_space_id)
                                       throws HDF5LibraryException
        Parameters:
        first_space_id - IN: The identifier for the first dataspace.
        second_space_id - IN: The identifier for the seconddataspace.
        Returns:
        true if successful, else false
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sget_select_type

        public static int H5Sget_select_type​(long space_id)
                                      throws HDF5LibraryException
        Parameters:
        space_id - IN: Identifier of the dataspace object to query
        Returns:
        the dataspace selection type if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sget_select_npoints

        public static long H5Sget_select_npoints​(long space_id)
                                          throws HDF5LibraryException
        Parameters:
        space_id - IN: Identifier of the dataspace object to query
        Returns:
        the number of elements in the selection if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sselect_copy

        public static void H5Sselect_copy​(long dst_id,
                                          long src_id)
                                   throws HDF5LibraryException
        Parameters:
        dst_id - ID of the destination dataspace
        src_id - ID of the source dataspace
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sselect_valid

        public static boolean H5Sselect_valid​(long space_id)
                                       throws HDF5LibraryException
        Parameters:
        space_id - The identifier for the dataspace in which the selection is being reset.
        Returns:
        true if the selection is contained within the extent and FALSE if it is not or is an error.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sget_select_bounds

        public static int H5Sget_select_bounds​(long space_id,
                                               long[] start,
                                               long[] end)
                                        throws HDF5LibraryException,
                                               NullPointerException
        Parameters:
        space_id - Identifier of dataspace to release.
        start - coordinates of lowest corner of bounding box.
        end - coordinates of highest corner of bounding box.
        Returns:
        a non-negative value if successful,with start and end initialized.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - start or end is null.
      • H5Sselect_shape_same

        public static boolean H5Sselect_shape_same​(long space1_id,
                                                   long space2_id)
                                            throws HDF5LibraryException
        Parameters:
        space1_id - ID of 1st Dataspace pointer to compare
        space2_id - ID of 2nd Dataspace pointer to compare
        Returns:
        true if the selection is the same dimensionality and shape; false otherwise
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sselect_intersect_block

        public static boolean H5Sselect_intersect_block​(long space_id,
                                                        long[] start,
                                                        long[] end)
                                                 throws HDF5LibraryException,
                                                        NullPointerException
        Parameters:
        space_id - ID of dataspace pointer to compare
        start - Starting coordinate of block
        end - Opposite ("ending") coordinate of block
        Returns:
        a TRUE if the current selection in the dataspace intersects with the block given FALSE otherwise
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - offset is null.
      • H5Soffset_simple

        public static int H5Soffset_simple​(long space_id,
                                           byte[] offset)
                                    throws HDF5LibraryException,
                                           NullPointerException
        Parameters:
        space_id - IN: The identifier for the dataspace object to reset.
        offset - IN: The offset at which to position the selection.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - offset array is null.
      • H5Soffset_simple

        public static int H5Soffset_simple​(long space_id,
                                           long[] offset)
                                    throws HDF5Exception,
                                           NullPointerException
        Parameters:
        space_id - IN: The identifier for the dataspace object to reset.
        offset - IN: The offset at which to position the selection.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - offset array is null.
        HDF5Exception
      • H5Sselect_all

        public static int H5Sselect_all​(long space_id)
                                 throws HDF5LibraryException
        Parameters:
        space_id - IN: The identifier of the dataspace to be selected.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sselect_none

        public static int H5Sselect_none​(long space_id)
                                  throws HDF5LibraryException
        Parameters:
        space_id - IN: The identifier of the dataspace to be reset.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sselect_elements

        public static int H5Sselect_elements​(long space_id,
                                             int op,
                                             int num_elements,
                                             long[][] coord2D)
                                      throws HDF5Exception,
                                             HDF5LibraryException,
                                             NullPointerException
        Parameters:
        space_id - Identifier of the dataspace.
        op - operator specifying how the new selection is combined.
        num_elements - Number of elements to be selected.
        coord2D - A 2-dimensional array specifying the coordinates of the elements.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5Exception - Error in the data conversion
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - cord array is
      • H5Sget_select_elem_npoints

        public static long H5Sget_select_elem_npoints​(long spaceid)
                                               throws HDF5LibraryException
        Parameters:
        spaceid - Identifier of dataspace to release.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sget_select_elem_pointlist

        public static int H5Sget_select_elem_pointlist​(long spaceid,
                                                       long startpoint,
                                                       long numpoints,
                                                       long[] buf)
                                                throws HDF5LibraryException,
                                                       NullPointerException
        Parameters:
        spaceid - Identifier of dataspace to release.
        startpoint - first point to retrieve
        numpoints - number of points to retrieve
        buf - returns points startblock to startblock+num-1, each points is rank longs.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - buf is null.
      • H5Sselect_hyperslab

        public static int H5Sselect_hyperslab​(long space_id,
                                              int op,
                                              byte[] start,
                                              byte[] stride,
                                              byte[] count,
                                              byte[] block)
                                       throws HDF5LibraryException,
                                              NullPointerException,
                                              IllegalArgumentException
        Parameters:
        space_id - IN: Identifier of dataspace selection to modify
        op - IN: Operation to perform on current selection.
        start - IN: Offset of start of hyperslab
        stride - IN: Hyperslab stride.
        count - IN: Number of blocks included in hyperslab.
        block - IN: Size of block in hyperslab.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an input array is null.
        IllegalArgumentException - an input array is invalid.
      • H5Sselect_hyperslab

        public static int H5Sselect_hyperslab​(long space_id,
                                              int op,
                                              long[] start,
                                              long[] stride,
                                              long[] count,
                                              long[] block)
                                       throws HDF5LibraryException,
                                              NullPointerException,
                                              IllegalArgumentException
        Parameters:
        space_id - IN: Identifier of dataspace selection to modify
        op - IN: Operation to perform on current selection.
        start - IN: Offset of start of hyperslab
        stride - IN: Hyperslab stride.
        count - IN: Number of blocks included in hyperslab.
        block - IN: Size of block in hyperslab.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an input array is null.
        IllegalArgumentException - an input array is invalid.
      • H5Scombine_hyperslab

        public static long H5Scombine_hyperslab​(long space_id,
                                                int op,
                                                long[] start,
                                                long[] stride,
                                                long[] count,
                                                long[] block)
                                         throws HDF5LibraryException,
                                                NullPointerException,
                                                IllegalArgumentException
        Parameters:
        space_id - IN: Dataspace ID of selection to use
        op - IN: Operation to perform on current selection.
        start - IN: Offset of start of hyperslab
        stride - IN: Hyperslab stride.
        count - IN: Number of blocks included in hyperslab.
        block - IN: Size of block in hyperslab.
        Returns:
        a dataspace ID on success / H5I_INVALID_HID on failure
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - an input array is null.
        IllegalArgumentException - an input array is invalid.
      • H5Smodify_select

        public static void H5Smodify_select​(long space1_id,
                                            int op,
                                            long space2_id)
                                     throws HDF5LibraryException
        Parameters:
        space1_id - ID of the destination dataspace
        op - Operation to perform on current selection.
        space2_id - ID of the source dataspace
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Scombine_select

        public static long H5Scombine_select​(long space1_id,
                                             int op,
                                             long space2_id)
                                      throws HDF5LibraryException
        Parameters:
        space1_id - ID of the first dataspace
        op - Operation to perform on current selection.
        space2_id - ID of the second dataspace
        Returns:
        a dataspace ID on success / H5I_INVALID_HID on failure
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sis_regular_hyperslab

        public static boolean H5Sis_regular_hyperslab​(long space_id)
                                               throws HDF5LibraryException
        Parameters:
        space_id - IN: Identifier of dataspace selection to query
        Returns:
        a TRUE/FALSE for hyperslab selection if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sget_select_hyper_nblocks

        public static long H5Sget_select_hyper_nblocks​(long spaceid)
                                                throws HDF5LibraryException
        Parameters:
        spaceid - Identifier of dataspace to release.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Sget_select_hyper_blocklist

        public static int H5Sget_select_hyper_blocklist​(long spaceid,
                                                        long startblock,
                                                        long numblocks,
                                                        long[] buf)
                                                 throws HDF5LibraryException,
                                                        NullPointerException
        Parameters:
        spaceid - Identifier of dataspace to release.
        startblock - first block to retrieve
        numblocks - number of blocks to retrieve
        buf - returns blocks startblock to startblock+num-1, each block is rank * 2 (corners) longs.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - buf is null.
      • H5Sselect_project_intersection

        public static long H5Sselect_project_intersection​(long src_space_id,
                                                          long dst_space_id,
                                                          long src_intersect_space_id)
                                                   throws HDF5LibraryException
        Parameters:
        src_space_id - Selection that is mapped to dst_space_id, and intersected with src_intersect_space_id
        dst_space_id - Selection that is mapped to src_space_id
        src_intersect_space_id - Selection whose intersection with src_space_id is projected to dst_space_id to obtain the result
        Returns:
        a dataspace with a selection equal to the intersection of src_intersect_space_id and src_space_id projected from src_space to dst_space on success
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tarray_create

        public static long H5Tarray_create​(long base_id,
                                           int ndims,
                                           long[] dim)
                                    throws HDF5LibraryException,
                                           NullPointerException
        Parameters:
        base_id - IN: Datatype identifier for the array base datatype.
        ndims - IN: Rank of the array.
        dim - IN: Size of each array dimension.
        Returns:
        a valid datatype identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - dim is null.
      • H5Tclose

        public static int H5Tclose​(long type_id)
                            throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to release.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tcommit

        public static void H5Tcommit​(long loc_id,
                                     String name,
                                     long type_id,
                                     long lcpl_id,
                                     long tcpl_id,
                                     long tapl_id)
                              throws HDF5LibraryException,
                                     NullPointerException
        Parameters:
        loc_id - IN: Location identifier.
        name - IN: Name given to committed datatype.
        type_id - IN: Identifier of datatype to be committed.
        lcpl_id - IN: Link creation property list.
        tcpl_id - IN: Datatype creation property list.
        tapl_id - IN: Datatype access property list.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Tcommit_anon

        public static void H5Tcommit_anon​(long loc_id,
                                          long type_id,
                                          long tcpl_id,
                                          long tapl_id)
                                   throws HDF5LibraryException
        Parameters:
        loc_id - IN: Location identifier.
        type_id - IN: Identifier of datatype to be committed.
        tcpl_id - IN: Datatype creation property list.
        tapl_id - IN: Datatype access property list.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tcommitted

        public static boolean H5Tcommitted​(long type_id)
                                    throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype.
        Returns:
        true the datatype has been committed
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tcompiler_conv

        public static void H5Tcompiler_conv​(long src_id,
                                            long dst_id)
                                     throws HDF5LibraryException
        Parameters:
        src_id - IN: Identifier of source datatype.
        dst_id - IN: Identifier of destination datatype.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tconvert

        public static void H5Tconvert​(long src_id,
                                      long dst_id,
                                      long nelmts,
                                      byte[] buf,
                                      byte[] background,
                                      long plist_id)
                               throws HDF5LibraryException,
                                      NullPointerException
        Parameters:
        src_id - IN: Identifier of source datatype.
        dst_id - IN: Identifier of destination datatype.
        nelmts - IN: Size of array buf.
        buf - IN: Array containing pre- and post-conversion values.
        background - IN: Optional background buffer.
        plist_id - IN: Dataset transfer property list identifier.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - buf is null.
      • H5Tcopy

        public static long H5Tcopy​(long type_id)
                            throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to copy. Can be a datatype identifier, a predefined datatype (defined in H5Tpublic.h), or a dataset Identifier.
        Returns:
        a datatype identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tcreate

        public static long H5Tcreate​(int tclass,
                                     long size)
                              throws HDF5LibraryException
        Parameters:
        tclass - IN: Class of datatype to create.
        size - IN: The number of bytes in the datatype to create.
        Returns:
        datatype identifier
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tdetect_class

        public static boolean H5Tdetect_class​(long type_id,
                                              int cls)
                                       throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        cls - IN: Identifier of datatype cls.
        Returns:
        true if the datatype specified in dtype_id contains any datatypes of the datatype class
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tencode

        public static int H5Tencode​(long obj_id,
                                    byte[] buf,
                                    long nalloc)
                             throws HDF5LibraryException,
                                    NullPointerException
        Parameters:
        obj_id - IN: Identifier of the object to be encoded.
        buf - OUT: Buffer for the object to be encoded into. If the provided buffer is NULL, only the size of buffer needed is returned.
        nalloc - IN: The size of the allocated buffer.
        Returns:
        the size needed for the allocated buffer.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - buf is null.
      • H5Tenum_create

        public static long H5Tenum_create​(long base_id)
                                   throws HDF5LibraryException
        Parameters:
        base_id - IN: Identifier of the parent datatype to release.
        Returns:
        the datatype identifier for the new enumeration datatype
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tenum_nameof

        public static int H5Tenum_nameof​(long type,
                                         int[] value,
                                         String[] name,
                                         int size)
                                  throws HDF5LibraryException,
                                         NullPointerException
        Parameters:
        type - IN: Identifier of datatype.
        value - IN: The value of the member, data of the correct
        name - OUT: The name of the member
        size - IN: The max length of the name
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Tequal

        public static boolean H5Tequal​(long type_id1,
                                       long type_id2)
                                throws HDF5LibraryException
        Parameters:
        type_id1 - IN: Identifier of datatype to compare.
        type_id2 - IN: Identifier of datatype to compare.
        Returns:
        true if the datatype identifiers refer to the same datatype, else false.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_array_dims

        public static int H5Tget_array_dims​(long type_id,
                                            long[] dims)
                                     throws HDF5LibraryException,
                                            NullPointerException
        Parameters:
        type_id - IN: Datatype identifier of array object.
        dims - OUT: Sizes of array dimensions.
        Returns:
        the non-negative number of dimensions of the array type
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - dims is null.
      • H5Tget_array_dims2

        public static int H5Tget_array_dims2​(long type_id,
                                             long[] dims)
                                      throws HDF5LibraryException,
                                             NullPointerException
        Parameters:
        type_id - IN: Datatype identifier of array object.
        dims - OUT: Sizes of array dimensions.
        Returns:
        the non-negative number of dimensions of the array type
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - dims is null.
      • H5Tget_array_ndims

        public static int H5Tget_array_ndims​(long type_id)
                                      throws HDF5LibraryException
        Parameters:
        type_id - IN: Datatype identifier of array object.
        Returns:
        the rank of the array
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_class

        public static int H5Tget_class​(long type_id)
                                throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        datatype class identifier if successful; otherwise H5T_NO_CLASS(-1).
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_class_name

        public static String H5Tget_class_name​(long class_id)
        Parameters:
        class_id - IN: Identifier of class from H5Tget_class.
        Returns:
        class name if successful; otherwise H5T_NO_CLASS.
      • H5Tget_create_plist

        public static long H5Tget_create_plist​(long type_id)
                                        throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype.
        Returns:
        a datatype property list identifier.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_cset

        public static int H5Tget_cset​(long type_id)
                               throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        a valid character set type if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_cset

        public static int H5Tset_cset​(long type_id,
                                      int cset)
                               throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to modify.
        cset - IN: Character set type.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_ebias

        public static int H5Tget_ebias​(long type_id)
                                throws HDF5LibraryException
        Parameters:
        type_id - Identifier of datatype to query.
        Returns:
        the bias if successful; otherwise 0.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_ebias

        public static int H5Tset_ebias​(long type_id,
                                       int ebias)
                                throws HDF5LibraryException
        Parameters:
        type_id - Identifier of datatype to set.
        ebias - Exponent bias value.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_ebias_long

        public static long H5Tget_ebias_long​(long type_id)
                                      throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        the bias
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_ebias

        public static void H5Tset_ebias​(long type_id,
                                        long ebias)
                                 throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to set.
        ebias - IN: Exponent bias value.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_fields

        public static void H5Tget_fields​(long type_id,
                                         long[] fields)
                                  throws HDF5LibraryException,
                                         NullPointerException,
                                         IllegalArgumentException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        fields - OUT: location of size and bit-position.
        • fields[0] = spos OUT: location to return size of in bits.
        • fields[1] = epos OUT: location to return exponent bit-position.
        • fields[2] = esize OUT: location to return size of exponent in bits.
        • fields[3] = mpos OUT: location to return mantissa bit-position.
        • fields[4] = msize OUT: location to return size of mantissa in bits.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - fields is null.
        IllegalArgumentException - fields array is invalid.
      • H5Tget_fields

        public static int H5Tget_fields​(long type_id,
                                        int[] fields)
                                 throws HDF5LibraryException,
                                        NullPointerException,
                                        IllegalArgumentException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        fields - OUT: location of size and bit-position.
              fields[0] = spos  OUT: location to return size of in bits.
              fields[1] = epos  OUT: location to return exponent bit-position.
              fields[2] = esize OUT: location to return size of exponent in bits.
              fields[3] = mpos  OUT: location to return mantissa bit-position.
              fields[4] = msize OUT: location to return size of mantissa in bits.
         
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - fields is null.
        IllegalArgumentException - fields array is invalid.
      • H5Tset_fields

        public static void H5Tset_fields​(long type_id,
                                         long spos,
                                         long epos,
                                         long esize,
                                         long mpos,
                                         long msize)
                                  throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to set.
        spos - IN: Size position.
        epos - IN: Exponent bit position.
        esize - IN: Size of exponent in bits.
        mpos - IN: Mantissa bit position.
        msize - IN: Size of mantissa in bits.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_fields

        public static int H5Tset_fields​(long type_id,
                                        int spos,
                                        int epos,
                                        int esize,
                                        int mpos,
                                        int msize)
                                 throws HDF5LibraryException
        Parameters:
        type_id - Identifier of datatype to set.
        spos - Size position.
        epos - Exponent bit position.
        esize - Size of exponent in bits.
        mpos - Mantissa bit position.
        msize - Size of mantissa in bits.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_inpad

        public static int H5Tget_inpad​(long type_id)
                                throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        a valid padding type if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_inpad

        public static int H5Tset_inpad​(long type_id,
                                       int inpad)
                                throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to modify.
        inpad - IN: Padding type.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_member_class

        public static int H5Tget_member_class​(long type_id,
                                              int membno)
                                       throws HDF5LibraryException
        Parameters:
        type_id - IN: Datatype identifier of compound object.
        membno - IN: Compound object member number.
        Returns:
        the class of the datatype of the field if successful;
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_member_index

        public static int H5Tget_member_index​(long type_id,
                                              String field_name)
                                       throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        field_name - IN: Field name of the field index to retrieve.
        Returns:
        if field is defined, the index; else negative.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_member_name

        public static String H5Tget_member_name​(long type_id,
                                                int field_idx)
                                         throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        field_idx - IN: Field index (0-based) of the field name to retrieve.
        Returns:
        a valid pointer to the name if successful; otherwise null.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_member_offset

        public static long H5Tget_member_offset​(long type_id,
                                                int membno)
        Parameters:
        type_id - IN: Identifier of datatype to query.
        membno - IN: Field index (0-based) of the field type to retrieve.
        Returns:
        the offset of the member.
      • H5Tget_member_type

        public static long H5Tget_member_type​(long type_id,
                                              int field_idx)
                                       throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        field_idx - IN: Field index (0-based) of the field type to retrieve.
        Returns:
        the identifier of a copy of the datatype of the field if successful;
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_member_value

        public static void H5Tget_member_value​(long type_id,
                                               int membno,
                                               byte[] value)
                                        throws HDF5LibraryException,
                                               NullPointerException
        Parameters:
        type_id - IN: Datatype identifier for the enumeration datatype.
        membno - IN: Number of the enumeration datatype member.
        value - OUT: The value of the member
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - value is null.
      • H5Tget_member_value

        public static int H5Tget_member_value​(long type_id,
                                              int membno,
                                              int[] value)
                                       throws HDF5LibraryException,
                                              NullPointerException
        Parameters:
        type_id - IN: Identifier of datatype.
        membno - IN: The name of the member
        value - OUT: The value of the member
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - value is null.
      • H5Tget_native_type

        public static long H5Tget_native_type​(long type_id)
                                       throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query. Direction of search is assumed to be in ascending order.
        Returns:
        the native datatype identifier for the specified dataset datatype.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_native_type

        public static long H5Tget_native_type​(long type_id,
                                              int direction)
                                       throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        direction - IN: Direction of search.
        Returns:
        the native datatype identifier for the specified dataset datatype.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_nmembers

        public static int H5Tget_nmembers​(long type_id)
                                   throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        number of members datatype has if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_norm

        public static int H5Tget_norm​(long type_id)
                               throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        a valid normalization type if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_norm

        public static int H5Tset_norm​(long type_id,
                                      int norm)
                               throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to set.
        norm - IN: Mantissa normalization type.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_offset

        public static int H5Tget_offset​(long type_id)
                                 throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        a positive offset value if successful; otherwise 0.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_offset

        public static int H5Tset_offset​(long type_id,
                                        int offset)
                                 throws HDF5LibraryException
        Parameters:
        type_id - Identifier of datatype to set.
        offset - Offset of first significant bit.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_offset

        public static void H5Tset_offset​(long type_id,
                                         long offset)
                                  throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to set.
        offset - IN: Offset of first significant bit.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_order

        public static int H5Tget_order​(long type_id)
                                throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        a byte order constant if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_order

        public static int H5Tset_order​(long type_id,
                                       int order)
                                throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to set.
        order - IN: Byte ordering constant.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_pad

        public static int H5Tget_pad​(long type_id,
                                     int[] pad)
                              throws HDF5LibraryException,
                                     NullPointerException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        pad - OUT: locations to return least-significant and most-significant bit padding type.
              pad[0] = lsb // least-significant bit padding type
              pad[1] = msb // most-significant bit padding type
         
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - pad is null.
      • H5Tset_pad

        public static int H5Tset_pad​(long type_id,
                                     int lsb,
                                     int msb)
                              throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to set.
        lsb - IN: Padding type for least-significant bits.
        msb - IN: Padding type for most-significant bits.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_precision

        public static int H5Tget_precision​(long type_id)
                                    throws HDF5LibraryException
        Parameters:
        type_id - Identifier of datatype to query.
        Returns:
        the number of significant bits if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_precision

        public static int H5Tset_precision​(long type_id,
                                           int precision)
                                    throws HDF5LibraryException
        Parameters:
        type_id - Identifier of datatype to set.
        precision - Number of bits of precision for datatype.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_precision_long

        public static long H5Tget_precision_long​(long type_id)
                                          throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        the number of significant bits if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_precision

        public static void H5Tset_precision​(long type_id,
                                            long precision)
                                     throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to set.
        precision - IN: Number of bits of precision for datatype.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_sign

        public static int H5Tget_sign​(long type_id)
                               throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        a valid sign type if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_sign

        public static int H5Tset_sign​(long type_id,
                                      int sign)
                               throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to set.
        sign - IN: Sign type.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_size

        public static long H5Tget_size​(long type_id)
                                throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        the size of the datatype in bytes
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_size

        public static int H5Tset_size​(long type_id,
                                      long size)
                               throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to change size.
        size - IN: Size in bytes to modify datatype.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_strpad

        public static int H5Tget_strpad​(long type_id)
                                 throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        a valid string padding type if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_strpad

        public static int H5Tset_strpad​(long type_id,
                                        int strpad)
                                 throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to modify.
        strpad - IN: String padding type.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tget_super

        public static long H5Tget_super​(long type)
                                 throws HDF5LibraryException
        Parameters:
        type - IN: Identifier of datatype.
        Returns:
        the parent type
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tset_tag

        public static int H5Tset_tag​(long type,
                                     String tag)
                              throws HDF5LibraryException
        Parameters:
        type - IN: Datatype identifier for the opaque datatype to be tagged.
        tag - IN: Descriptive ASCII string with which the opaque datatype is to be tagged.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tinsert

        public static int H5Tinsert​(long type_id,
                                    String name,
                                    long offset,
                                    long field_id)
                             throws HDF5LibraryException,
                                    NullPointerException
        Parameters:
        type_id - IN: Identifier of compound datatype to modify.
        name - IN: Name of the field to insert.
        offset - IN: Offset in memory structure of the field to insert.
        field_id - IN: Datatype identifier of the field to insert.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Tis_variable_str

        public static boolean H5Tis_variable_str​(long type_id)
                                          throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to query.
        Returns:
        true if type_id is a variable-length string.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tlock

        public static int H5Tlock​(long type_id)
                           throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to lock.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Topen

        public static long H5Topen​(long loc_id,
                                   String name,
                                   long tapl_id)
                            throws HDF5LibraryException,
                                   NullPointerException
        Parameters:
        loc_id - IN: A file, group, or datatype identifier.
        name - IN: A datatype name, defined within the file or group identified by loc_id.
        tapl_id - IN: Datatype access property list.
        Returns:
        a named datatype identifier if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - name is null.
      • H5Tpack

        public static int H5Tpack​(long type_id)
                           throws HDF5LibraryException
        Parameters:
        type_id - IN: Identifier of datatype to modify.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Treclaim

        public static void H5Treclaim​(long type_id,
                                      long space_id,
                                      long xfer_plist_id,
                                      byte[] buf)
                               throws HDF5LibraryException,
                                      NullPointerException
        Parameters:
        type_id - Identifier of the datatype.
        space_id - Identifier of the dataspace.
        xfer_plist_id - Identifier of a transfer property list for this I/O operation.
        buf - Buffer with data to be reclaimed.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
        NullPointerException - buf is null.
      • H5Tvlen_create

        public static long H5Tvlen_create​(long base_id)
                                   throws HDF5LibraryException
        Parameters:
        base_id - IN: Identifier of parent datatype.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Tflush

        public static void H5Tflush​(long dtype_id)
                             throws HDF5LibraryException
        Parameters:
        dtype_id - IN: Identifier of the committed datatype to be flushed.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Trefresh

        public static void H5Trefresh​(long dtype_id)
                               throws HDF5LibraryException
        Parameters:
        dtype_id - IN: Identifier of the committed datatype to be refreshed.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5VLregister_connector_by_name

        public static long H5VLregister_connector_by_name​(String connector_name,
                                                          long vipl_id)
                                                   throws HDF5LibraryException
        Parameters:
        connector_name - IN: name of the connector.
        vipl_id - IN: VOL initialization property list which must be created with H5Pcreate(H5P_VOL_INITIALIZE) (or H5P_DEFAULT).
        Returns:
        a VOL connector ID
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5VLregister_connector_by_value

        public static long H5VLregister_connector_by_value​(int connector_value,
                                                           long vipl_id)
                                                    throws HDF5LibraryException
        Parameters:
        connector_value - IN: value of the connector.
        vipl_id - IN: VOL initialization property list which must be created with H5Pcreate(H5P_VOL_INITIALIZE) (or H5P_DEFAULT).
        Returns:
        a VOL connector ID
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5VLis_connector_registered_by_name

        public static boolean H5VLis_connector_registered_by_name​(String name)
                                                           throws HDF5LibraryException
        Parameters:
        name - IN: name of the connector.
        Returns:
        true if a VOL connector with that name has been registered
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5VLis_connector_registered_by_value

        public static boolean H5VLis_connector_registered_by_value​(int connector_value)
                                                            throws HDF5LibraryException
        Parameters:
        connector_value - IN: value of the connector.
        Returns:
        true if a VOL connector with that value has been registered
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5VLget_connector_id

        public static long H5VLget_connector_id​(long object_id)
                                         throws HDF5LibraryException
        Parameters:
        object_id - IN: Identifier of the object.
        Returns:
        a VOL connector ID
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5VLget_connector_id_by_name

        public static long H5VLget_connector_id_by_name​(String name)
                                                 throws HDF5LibraryException
        Parameters:
        name - IN: name of the connector.
        Returns:
        a VOL connector ID
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5VLget_connector_id_by_value

        public static long H5VLget_connector_id_by_value​(int connector_value)
                                                  throws HDF5LibraryException
        Parameters:
        connector_value - IN: value of the connector.
        Returns:
        a VOL connector ID
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5VLget_connector_name

        public static String H5VLget_connector_name​(long object_id)
                                             throws HDF5LibraryException
        Parameters:
        object_id - IN: Identifier of the object.
        Returns:
        the connector name
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5VLclose

        public static void H5VLclose​(long connector_id)
                              throws HDF5LibraryException
        Parameters:
        connector_id - IN: Identifier of the connector.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5VLunregister_connector

        public static void H5VLunregister_connector​(long connector_id)
                                             throws HDF5LibraryException
        Parameters:
        connector_id - IN: Identifier of the connector.
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Zfilter_avail

        public static int H5Zfilter_avail​(int filter)
                                   throws HDF5LibraryException
        Parameters:
        filter - IN: filter number.
        Returns:
        a non-negative(TRUE/FALSE) value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Zget_filter_info

        public static int H5Zget_filter_info​(int filter)
                                      throws HDF5LibraryException
        Parameters:
        filter - IN: filter number.
        Returns:
        the filter information flags
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.
      • H5Zunregister

        public static int H5Zunregister​(int filter)
                                 throws HDF5LibraryException
        Parameters:
        filter - IN: filter number.
        Returns:
        a non-negative value if successful
        Throws:
        HDF5LibraryException - Error from the HDF5 Library.