HDF5 1.14.5
API Reference
|
Functions | |
static synchronized byte[] | H5Rcreate (long loc_id, String name, int ref_type, long space_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static long | H5Rdereference (long dataset, long access_list, int ref_type, byte[] ref) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native long | H5Rget_name (long loc_id, int ref_type, byte[] ref, String[] name, long size) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native String | H5Rget_name_string (long loc_id, int ref_type, byte[] ref) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native int | H5Rget_obj_type (long loc_id, int ref_type, byte ref[]) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static long | H5Rget_region (long loc_id, int ref_type, byte[] ref) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native byte[] | H5Rcreate_object (long loc_id, String name, long access_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native byte[] | H5Rcreate_region (long loc_id, String name, long space_id, long access_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native byte[] | H5Rcreate_attr (long loc_id, String name, String attr_name, long access_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native void | H5Rdestroy (byte[] ref_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native int | H5Rget_type (byte[] ref_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native boolean | H5Requal (byte[] ref1_ptr, byte[] ref2_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native byte[] | H5Rcopy (byte[] src_ref_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static long | H5Ropen_object (byte[] ref_ptr, long rapl_id, long oapl_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static long | H5Ropen_region (byte[] ref_ptr, long rapl_id, long oapl_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static long | H5Ropen_attr (byte[] ref_ptr, long rapl_id, long aapl_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native int | H5Rget_obj_type3 (byte[] ref_ptr, long rapl_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native String | H5Rget_file_name (byte[] ref_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native String | H5Rget_obj_name (byte[] ref_ptr, long rapl_id) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
static synchronized native String | H5Rget_attr_name (byte[] ref_ptr) throws HDF5LibraryException, NullPointerException, IllegalArgumentException |
|
static |
H5Rcopy creates a copy of an existing reference.
src_ref_ptr | IN: Reference to an object, region or attribute attached to an object. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
H5Rcreate creates the reference, ref, of the type specified in ref_type, pointing to the object name located at loc_id.
loc_id | IN: Location identifier used to locate the object being pointed to. |
name | IN: Name of object at location loc_id. |
ref_type | IN: Type of reference. |
space_id | IN: Dataspace identifier with selection. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
H5Rcreate_attr creates the reference, pointing to the attribute named attr name and attached to the object named name located at loc id.
loc_id | IN: Location identifier used to locate the object being pointed to. |
name | IN: Name of object at location loc_id. |
attr_name | IN: Name of the attribute within the object. |
access_id | IN: Object access identifier to the object being pointed to. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
H5Rcreate_object creates a reference pointing to the object named name located at loc id.
loc_id | IN: Location identifier used to locate the object being pointed to. |
name | IN: Name of object at location loc_id. |
access_id | IN: Object access identifier to the object being pointed to. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
H5Rcreate_region creates the reference, pointing to the region represented by space id within the object named name located at loc id.
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. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
Given a reference to some object, H5Rdereference opens that object and return an identifier.
dataset | IN: Dataset containing reference object. |
access_list | IN: Property list of the object being referenced. |
ref_type | IN: The reference type of ref. |
ref | IN: reference to an object |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | output array is null. |
IllegalArgumentException | output array is invalid. |
|
static |
H5Rdestroy destroys a reference and releases resources.
ref_ptr | IN: Reference to an object, region or attribute attached to an object. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
H5Requal determines whether two references point to the same object, region or attribute.
ref1_ptr | IN: Reference to an object, region or attribute attached to an object. |
ref2_ptr | IN: Reference to an object, region or attribute attached to an object. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
H5Rget_attr_name retrieves the attribute name for the object, region or attribute reference pointed to.
ref_ptr | IN: Reference to an object, region or attribute attached to an object. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | array is null. |
IllegalArgumentException | array is invalid. |
|
static |
H5Rget_file_name retrieves the file name for the object, region or attribute reference pointed to.
ref_ptr | IN: Reference to an object, region or attribute attached to an object. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | array is null. |
IllegalArgumentException | array is invalid. |
|
static |
H5Rget_name retrieves a name for the object identified by ref.
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. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | size is null. |
IllegalArgumentException | Argument is illegal. |
|
static |
H5Rget_name_string retrieves a name for the object identified by ref.
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. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | size is null. |
IllegalArgumentException | Argument is illegal. |
|
static |
H5Rget_obj_name retrieves the object name for the object, region or attribute reference pointed to.
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). |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | array is null. |
IllegalArgumentException | array is invalid. |
|
static |
H5Rget_obj_type Given a reference to an object ref, H5Rget_obj_type returns the type of the object pointed to.
loc_id | IN: loc_id of the reference object. |
ref_type | IN: Type of reference to query. |
ref | IN: the reference |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
H5Rget obj type3 retrieves the type of the referenced object pointed to.
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). |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | array is null. |
IllegalArgumentException | array is invalid. |
|
static |
Given a reference to an object ref, H5Rget_region creates a copy of the dataspace of the dataset pointed to and defines a selection in the copy which is the region pointed to.
loc_id | IN: loc_id of the reference object. |
ref_type | IN: The reference type of ref. |
ref | OUT: the reference to the object and region |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
H5Rget_type retrieves the type of a reference.
ref_ptr | IN: Reference to an object, region or attribute attached to an object. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
H5Ropen_attr opens the attribute attached to the object and returns an identifier. The attribute opened with this function should be closed with H5Aclose when it is no longer needed so that resource leaks will not develop.
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. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
H5Ropen_object opens that object and returns an identifier. The object opened with this function should be closed when it is no longer needed so that resource leaks will not develop. Use the appropriate close function such as H5Oclose or H5Dclose for datasets.
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. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |
|
static |
H5Ropen region creates a copy of the dataspace of the dataset pointed to by a region reference, ref ptr, and defines a selection matching the selection pointed to by ref ptr within the dataspace copy. Use H5Sclose to release the dataspace identifier returned by this function when the identifier is no longer needed.
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. |
HDF5LibraryException | Error from the HDF5 Library. |
NullPointerException | an input array is null. |
IllegalArgumentException | an input array is invalid. |