![]() |
HDF5
1.15.0.fbf77a8
API Reference
|
Functions | |
static synchronized native long | H5Iget_file_id (long obj_id) throws HDF5LibraryException |
static synchronized native long | H5Iget_name_long (long obj_id, String[] name, long size) throws HDF5LibraryException, NullPointerException |
static synchronized native String | H5Iget_name (long obj_id) throws HDF5LibraryException |
static synchronized native int | H5Iget_ref (long obj_id) throws HDF5LibraryException, NullPointerException |
static synchronized native int | H5Idec_ref (long obj_id) throws HDF5LibraryException, NullPointerException |
static synchronized native int | H5Iinc_ref (long obj_id) throws HDF5LibraryException, NullPointerException |
static synchronized native int | H5Iget_type (long obj_id) throws HDF5LibraryException |
static synchronized native int | H5Iget_type_ref (long type_id) throws HDF5LibraryException |
static synchronized native int | H5Idec_type_ref (long type_id) throws HDF5LibraryException |
static synchronized native int | H5Iinc_type_ref (long type_id) throws HDF5LibraryException |
static synchronized native int | H5Inmembers (long type_id) throws HDF5LibraryException |
static synchronized native boolean | H5Iis_valid (long obj_id) throws HDF5LibraryException |
static synchronized native boolean | H5Itype_exists (int type_id) throws HDF5LibraryException |
static synchronized native void | H5Iclear_type (int type_id, boolean force) throws HDF5LibraryException |
static synchronized native void | H5Idestroy_type (int type_id) throws HDF5LibraryException |
|
static |
H5Iclear_type deletes all identifiers of the type identified by the argument type.
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 |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Idec_ref decrements the reference count specified by the identifier, obj_id. If the reference count for an ID reaches zero, the object will be closed.
obj_id | IN: Identifier of the object. |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Idec_type_ref decrements the reference count on an identifier type. The reference count is used by the library to indicate when an identifier type can be destroyed. If the reference count reaches zero, this function will destroy it.
type_id | IN: The identifier of the type whose reference count is to be decremented |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Idestroy_type deletes an entire identifier type. All identifiers of this type are destroyed and no new identifiers of this type can be registered.
type_id | IN: Identifier of identifier type which is to be destroyed |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Iget_file_id obtains the file ID specified by the identifier, obj_id.
obj_id | IN: Identifier of the object. |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Iget_name retrieves the name of an object specified by the identifier, obj_id.
obj_id | IN: Identifier of the object. |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Iget_name_long retrieves the name of an object specified by the identifier, obj_id.
obj_id | IN: Identifier of the object. |
name | OUT: Attribute name buffer. |
size | IN: Maximum length of the name to retrieve. |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Iget_ref obtains the number of references outstanding specified by the identifier, obj_id.
obj_id | IN: Identifier of the object. |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Iget_type retrieves the type of the object identified by obj_id.
obj_id | IN: Object identifier whose type is to be determined. |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Iget_type_ref retrieves the reference count on an ID type. The reference count is used by the library to indicate when an ID type can be destroyed.
type_id | IN: The identifier of the type whose reference count is to be retrieved |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Iinc_ref increments the reference count specified by the identifier, obj_id.
obj_id | IN: Identifier of the object. |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Iinc_type_ref increments the reference count on an ID type. The reference count is used by the library to indicate when an ID type can be destroyed.
type_id | IN: The identifier of the type whose reference count is to be incremented |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Iis_valid indicates if the identifier type specified in obj_id is valid.
obj_id | IN: Identifier to be checked |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Inmembers returns the number of identifiers of the identifier type specified in type.
type_id | IN: Identifier for the identifier type whose member count will be retrieved |
HDF5LibraryException | Error from the HDF5 Library. |
|
static |
H5Itype_exists indicates if the identifier type specified in type exists.
type_id | IN: the identifier type to be checked |
HDF5LibraryException | Error from the HDF5 Library. |