ec51828b76
Purpose: Catching up with the C library
Description: Updated documentation files to include information on the following functions
h5iget_name_f
h5tis_variavle_str_f
h5zunregister_f
h5zfilter_avail_f
h5pset_shuffle_f
h5pset_fletcher32
h5pset_edc_check_f
h5pget_edc_check_f
h5dfill_f
Solution:
Platforms tested: arabica(C and F90), burrwhite (pgcc and pgf90), modi4 (F90 and parallel)
Misc. update:
463 lines
18 KiB
HTML
463 lines
18 KiB
HTML
<html>
|
|
<head><title>
|
|
FORTRAN Dataset API -- h5d
|
|
</title>
|
|
|
|
<!-- #BeginLibraryItem "/ed_libs/styles_RM.lbi" --><link href="../ed_styles/RMelect.css" rel="stylesheet" type="text/css"><!-- #EndLibraryItem --></head>
|
|
|
|
<body bgcolor="#FFFFFF">
|
|
|
|
|
|
|
|
<center>
|
|
<h1>The FORTRAN 90 API to HDF5<br>h5d: Datasets</h1>
|
|
</center>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dclose_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dclose_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5dclose_f(dset_id, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5dclose_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dcreate_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dcreate_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5dcreate_f(loc_id, name, type_id, space_id, dset_id, &
|
|
hdferr, creation_prp)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the dataset
|
|
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
|
|
INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
|
|
INTEGER(HID_T), INTENT(OUT) :: dset_id ! Dataset identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: creation_prp
|
|
! Dataset creation propertly
|
|
! list identifier , default
|
|
! value is H5P_DEFAULT_F (6)
|
|
END SUBROUTINE h5dcreate_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dextend_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dextend_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5dextend_f(dataset_id, size, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dataset_id ! Dataset identifier
|
|
INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: size
|
|
! Array containing
|
|
! dimensions' sizes
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5dextend_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dget_create_plist_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dget_create_plist_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5dget_create_plist_f(dataset_id, creation_prp, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dataset_id ! Dataset identifier
|
|
INTEGER(HID_T), INTENT(OUT) :: creation_id ! Dataset creation
|
|
! property list identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5dget_create_plist_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dget_space_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dget_space_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5dget_space_f(dataset_id, dataspace_id, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dataset_id ! Dataset identifier
|
|
INTEGER(HID_T), INTENT(OUT) :: dataspace_id ! Dataspace identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5dget_space_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dget_type_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dget_type_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5dget_type_f(dataset_id, datatype_id, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dataset_id ! Dataset identifier
|
|
INTEGER(HID_T), INTENT(OUT) :: datatype_id ! Datatype identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5dget_type_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dopen_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dopen_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5dopen_f(loc_id, name, dset_id, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
|
|
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the dataset
|
|
INTEGER(HID_T), INTENT(OUT) :: dset_id ! Dataset identifier
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5dopen_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dread_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dread_f</strong>
|
|
(for all datatypes except object and dataset region references)
|
|
<pre>
|
|
|
|
SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, dims, hdferr, &
|
|
mem_space_id, file_space_id, xfer_prp)
|
|
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
|
|
INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier
|
|
TYPE, INTENT(INOUT) :: buf ! Data buffer; may be a scalar or an array
|
|
DIMENSION(*), INTEGER(HSIZE_T), INTENT(IN) :: dims
|
|
! Array to hold corresponding dimension
|
|
! sizes of data buffer buf; dim(k) has
|
|
! value of the k-th dimension of buffer buf;
|
|
! values are ignored if buf is a scalar
|
|
!
|
|
! Deprecated type, will be removed in
|
|
! Release 1.6:
|
|
! INTEGER, INTENT(IN) :: dims(7)
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id
|
|
! Memory dataspace identfier
|
|
! Default value is H5S_ALL_F
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: file_space_id
|
|
! File dataspace identfier
|
|
! Default value is H5S_ALL_F
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: xfer_prp
|
|
! Transfer property list identifier
|
|
! Default value is H5P_DEFAULT_F
|
|
|
|
END SUBROUTINE h5dread_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dread_f</strong>
|
|
(for object reference and dataset region reference datatypes)
|
|
<pre>
|
|
|
|
SUBROUTINE h5dread_f(dset_id, mem_type_id, buf, n, hdferr, &
|
|
mem_space_id, file_space_id, xfer_prp)
|
|
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
|
|
INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier
|
|
DIMENSION(*), INTEGER(HSIZE_T), INTENT(IN) :: dims
|
|
! Array to hold corresponding dimension
|
|
! sizes of data buffer buf; dim(k) has
|
|
! value of the k-th dimension of buffer buf;
|
|
! values are ignored if buf is a scalar
|
|
!
|
|
! Deprecated type, will be removed in
|
|
! Release 1.6:
|
|
! INTEGER, DIMENSION(7), INTENT(IN) :: dims
|
|
TYPE(hobj_ref_t_f), DIMENSION(dims(1)), INTENT(INOUT) :: buf
|
|
! Data buffer of rank 1
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id
|
|
! Memory dataspace identfier
|
|
! Default value is H5S_ALL_F
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: file_space_id
|
|
! File dataspace identfier
|
|
! Default value is H5S_ALL_F
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: xfer_prp
|
|
! Transfer property list identifier
|
|
! Default value is H5P_DEFAULT_F
|
|
|
|
END SUBROUTINE h5dread_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dwrite_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dwrite_f</strong>
|
|
(for all datatypes except object and dataset region references)
|
|
<pre>
|
|
|
|
SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, dims, hdferr, &
|
|
mem_space_id, file_space_id, xfer_prp)
|
|
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
|
|
INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier
|
|
TYPE, INTENT(IN) :: buf ! Data buffer; may be a scalar or an array
|
|
DIMENSION(*), INTEGER(HSIZE_T), INTENT(IN) :: dims
|
|
! Array to hold corresponding dimension
|
|
! sizes of data buffer buf; dim(k) has
|
|
! value of the k-th dimension of buffer buf;
|
|
! values are ignored if buf is a scalar
|
|
!
|
|
! Deprecated type, will be removed in
|
|
! Release 1.6:
|
|
! INTEGER, INTENT(IN) :: dims(7)
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id
|
|
! Memory dataspace identfier
|
|
! Default value is H5S_ALL_F
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: file_space_id
|
|
! File dataspace identfier
|
|
! Default value is H5S_ALL_F
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: xfer_prp
|
|
! Transfer property list identifier
|
|
! Default value is H5P_DEFAULT_F
|
|
|
|
END SUBROUTINE h5dwrite_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dwrite_f</strong>
|
|
(for object reference and dataset region reference datatypes)
|
|
<pre>
|
|
|
|
SUBROUTINE h5dwrite_f(dset_id, mem_type_id, buf, n, hdferr, &
|
|
mem_space_id, file_space_id, xfer_prp)
|
|
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
|
|
INTEGER(HID_T), INTENT(IN) :: mem_type_id ! Memory datatype identifier
|
|
DIMENSION(*), INTEGER(HSIZE_T), INTENT(IN) :: dims
|
|
! Array to hold corresponding dimension
|
|
! sizes of data buffer buf; dim(k) has
|
|
! value of the k-th dimension of buffer buf;
|
|
! values are ignored if buf is a scalar
|
|
!
|
|
! Deprecated type, will be removed in
|
|
! Release 1.6:
|
|
! INTEGER, DIMENSION(7), INTENT(IN) :: dims
|
|
TYPE(hobj_ref_t_f), DIMENSION(dims(1)), INTENT(INOUT) :: buf
|
|
! Data buffer of rank 1
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: mem_space_id
|
|
! Memory dataspace identfier
|
|
! Default value is H5S_ALL_F
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: file_space_id
|
|
! File dataspace identfier
|
|
! Default value is H5S_ALL_F
|
|
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: xfer_prp
|
|
! Transfer property list identifier
|
|
! Default value is H5P_DEFAULT_F
|
|
|
|
END SUBROUTINE h5dwrite_f
|
|
</pre>
|
|
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dget_storage_size_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dget_storage_size_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5dget_storage_size_f(dset_id, size, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
|
|
INTEGER(HSIZE_T), INTENT(OUT) :: size ! Amount of storage required for dataset
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5dget_storage_size_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dvlen_get_max_len_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dvlen_get_max_len_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5dvlen_get_max_len_f(dset_id, size, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
|
|
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
|
|
INTEGER(HID_T), INTENT(IN) :: space_id ! Dataspace identifier
|
|
|
|
INTEGER(SIZE_T), INTENT(OUT) :: elem_len ! Maximum length of the element
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5dvlen_get_max_len_f
|
|
</pre>
|
|
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dfill_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dfill_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5dfill_f(fill_value, space_id, buf, hdferr)
|
|
IMPLICIT NONE
|
|
TYPE, INTENET(IN) :: fill_value ! Fill value; may be have one of the
|
|
! following types:
|
|
! INTEGER, REAL, DOUBLE PRECISION, CHARACTER
|
|
INTEGER(HID_T), INTENT(IN) :: space_id ! Memory dataspace selection identifier
|
|
TYPE, DIMENSION(*) :: buf ! Memory buffer to fill in; must have
|
|
! the same datatype as fill value
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5dfill_f
|
|
</pre>
|
|
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
<p>
|
|
<a name="h5dget_space_status_f">
|
|
<p>
|
|
</a>
|
|
|
|
|
|
<dt><strong>FORTRAN interface:</strong>   <strong>h5dget_space_status_f</strong>
|
|
<pre>
|
|
SUBROUTINE h5dget_space_status_f(dset_id, flag, hdferr)
|
|
IMPLICIT NONE
|
|
INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier
|
|
INTEGER, INTENET(OUT) :: flag ! Status flag ; possible values:
|
|
! H5D_SPACE_STS_ERROR_F
|
|
! H5D_SPACE_STS_NOT_ALLOCATED_F
|
|
! H5D_SPACE_STS_PART_ALLOCATED_F
|
|
! H5D_SPACE_STS_ALLOCATED_F
|
|
INTEGER, INTENT(OUT) :: hdferr ! Error code
|
|
! 0 on success and -1 on failure
|
|
END SUBROUTINE h5dget_space_status_f
|
|
</pre>
|
|
|
|
|
|
</dl>
|
|
|
|
<p>
|
|
<p>
|
|
<hr>
|
|
|
|
|
|
<!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address>
|
|
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
|
|
|
|
<br>
|
|
Describes HDF5 Release 1.5, Unreleased Development Branch
|
|
</address><!-- #EndLibraryItem -->
|
|
|
|
Last modified: 19 March 2003
|
|
|
|
</body>
|
|
</html>
|