From ec51828b763d250dbe1c6de466baa52cc87e8a3e Mon Sep 17 00:00:00 2001 From: Elena Pourmal Date: Wed, 19 Mar 2003 11:09:07 -0500 Subject: [svn-r6491] 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: --- doc/html/fortran/h5d_FORTRAN.html | 55 ++++++++++++++++++++- doc/html/fortran/h5i_FORTRAN.html | 28 ++++++++++- doc/html/fortran/h5p_FORTRAN.html | 100 ++++++++++++++++++++++++++++++++++++-- doc/html/fortran/h5s_FORTRAN.html | 2 +- doc/html/fortran/h5t_FORTRAN.html | 32 +++++++++--- doc/html/fortran/h5z_FORTRAN.html | 85 ++++++++++++++++++++++++++++++++ 6 files changed, 289 insertions(+), 13 deletions(-) create mode 100644 doc/html/fortran/h5z_FORTRAN.html diff --git a/doc/html/fortran/h5d_FORTRAN.html b/doc/html/fortran/h5d_FORTRAN.html index 4134198..93713b6 100644 --- a/doc/html/fortran/h5d_FORTRAN.html +++ b/doc/html/fortran/h5d_FORTRAN.html @@ -390,6 +390,58 @@ FORTRAN Dataset API -- h5d END SUBROUTINE h5dvlen_get_max_len_f + + +

  +

  +


+

  + +

  + + + +

FORTRAN interface:   h5dfill_f +
+          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
+
+ + +

  +

  +


+

  + +

  + + + +

FORTRAN interface:   h5dget_space_status_f +
+          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
+
+ +

  @@ -399,11 +451,12 @@ FORTRAN Dataset API -- h5d

HDF Help Desk +
Describes HDF5 Release 1.5, Unreleased Development Branch
-Last modified: 5 March 2003 +Last modified: 19 March 2003 diff --git a/doc/html/fortran/h5i_FORTRAN.html b/doc/html/fortran/h5i_FORTRAN.html index 0c7a5e6..09f63e8 100644 --- a/doc/html/fortran/h5i_FORTRAN.html +++ b/doc/html/fortran/h5i_FORTRAN.html @@ -42,11 +42,37 @@ FORTRAN Identifier API -- h5i !H5I_ATTR_F(6) !H5I_BADID_F(-1) INTEGER, INTENT(OUT) :: hdferr ! Error code + ! 0 on success, and -1 on failure END SUBROUTINE h5iget_type_f +

  +

  +


+

  + +

  + + + +

FORTRAN interface:   h5iget_name_f + +
+          SUBROUTINE h5iget_name_f(obj_id, buf, buf_size, hdferr) 
+            IMPLICIT NONE
+            INTEGER(HID_T), INTENT(IN)    :: obj_id     ! Object identifier 
+            CHARACTER(LEN=*), INTENT(OUT) :: buf        ! Buffer to hold object name 
+            INTEGER(SIZE_T), INTENT(IN)   :: buf_size   ! Buffer size
+            INTEGER(SIZE_T), INTENT(OUT)  :: name_size  ! Name size
+            INTEGER, INTENT(OUT) :: hdferr              ! Error code
+                                                        ! 0 on success, and -1 on failure
+                                                     
+          END SUBROUTINE h5iget_name_f
+
+ +

  @@ -60,7 +86,7 @@ FORTRAN Identifier API -- h5i Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 14 July 2000 +Last modified: 19 March 2003 diff --git a/doc/html/fortran/h5p_FORTRAN.html b/doc/html/fortran/h5p_FORTRAN.html index 296be3d..efe23c6 100644 --- a/doc/html/fortran/h5p_FORTRAN.html +++ b/doc/html/fortran/h5p_FORTRAN.html @@ -219,8 +219,8 @@ FORTRAN Property List API -- h5p SUBROUTINE h5pset_deflate_f(prp_id, level, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: prp_id ! Property list identifier - INTEGER, INTENT(IN) :: leveli ! Compression level - INTEGER, INTENT(OUT) :: hdferr ! Error code + INTEGER, INTENT(IN) :: level ! Compression level + INTEGER, INTENT(OUT) :: hdferr ! Error code ! 0 on success and -1 on failure END SUBROUTINE h5pset_deflate_f @@ -2234,6 +2234,100 @@ FORTRAN Property List API -- h5p ! Failure: -1 END SUBROUTINE h5pget_class_name_f + + +

  +

  +


+

  + +

  + + + +

FORTRAN interface:   h5pset_shuffle_f +
+
+          SUBROUTINE h5pset_shuffle_f(prp_id, type_size, hdferr) 
+            IMPLICIT NONE
+            INTEGER(HID_T), INTENT(IN) :: prp_id      ! Property list identifier 
+            INTEGER, INTENT(IN)        :: type_size   ! Datatype size in bytes
+            INTEGER, INTENT(OUT)       :: hdferr      ! Error code
+                                                      ! 0 on success and -1 on failure
+ 
+          END SUBROUTINE h5pset_shuffle_f
+
+ + +

  +

  +


+

  + +

  + + + +

FORTRAN interface:   h5pset_edc_check_f +
+
+          SUBROUTINE h5pset_edc_check_f(prp_id, flag, hdferr) 
+            IMPLICIT NONE
+            INTEGER(HID_T), INTENT(IN) :: prp_id      ! Dataset transfer property list identifier 
+            INTEGER, INTENT(IN)        :: flag        ! EDC flag; possible values
+                                                      ! H5Z_DISABLE_EDC_F 
+                                                      ! H5Z_ENABLE_EDC_F 
+            INTEGER, INTENT(OUT)       :: hdferr      ! Error code
+                                                      ! 0 on success and -1 on failure
+ 
+          END SUBROUTINE h5pset_edc_check_f
+
+ + +

  +

  +


+

  + +

  + + + +

FORTRAN interface:   h5pget_edc_check_f +
+
+          SUBROUTINE h5pget_edc_check_f(prp_id, hdferr) 
+            IMPLICIT NONE
+            INTEGER(HID_T), INTENT(IN) :: prp_id      ! Dataset transfer property list identifier 
+            INTEGER, INTENT(OUT)       :: flag        ! EDC flag; possible values
+                                                      ! H5Z_DISABLE_EDC_F 
+                                                      ! H5Z_ENABLE_EDC_F 
+            INTEGER, INTENT(OUT)       :: hdferr      ! Error code
+                                                      ! 0 on success and -1 on failure
+ 
+          END SUBROUTINE h5pget_edc_check_f
+
+ + +

  +

  +


+

  + +

  + + + +

FORTRAN interface:   h5pset_fletcher32_f +
+
+          SUBROUTINE h5pset_fletcher32_f(prp_id, hdferr) 
+            IMPLICIT NONE
+            INTEGER(HID_T), INTENT(IN) :: prp_id      ! Dataset creation property list identifier 
+            INTEGER, INTENT(OUT)       :: hdferr      ! Error code
+                                                      ! 0 on success and -1 on failure
+ 
+          END SUBROUTINE h5pset_fletcher32_f
 

 

 


@@ -2246,7 +2340,7 @@ FORTRAN Property List API -- h5p Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 14 March 2003 +Last modified: 19 March 2003 diff --git a/doc/html/fortran/h5s_FORTRAN.html b/doc/html/fortran/h5s_FORTRAN.html index 5dcb30c..109369d 100644 --- a/doc/html/fortran/h5s_FORTRAN.html +++ b/doc/html/fortran/h5s_FORTRAN.html @@ -193,7 +193,7 @@ FORTRAN Dataspace API -- h5s ! Array to store max dimension ! sizes INTEGER, INTENT(OUT) :: hdferr ! Error code - ! 0 on success and -1 on failure + ! Dataspace rank on success and -1 on failure END SUBROUTINE h5sget_simple_extent_dims_f
diff --git a/doc/html/fortran/h5t_FORTRAN.html b/doc/html/fortran/h5t_FORTRAN.html index c7b1733..488ced1 100644 --- a/doc/html/fortran/h5t_FORTRAN.html +++ b/doc/html/fortran/h5t_FORTRAN.html @@ -1259,6 +1259,30 @@ FORTRAN Datatype API -- h5t

 


  + +

  + + + +

FORTRAN interface:   h5tis_variable_str_f +
+
+          SUBROUTINE h5tis_variable_str_f(type_id, status, hdferr) 
+            IMPLICIT NONE
+            INTEGER(HID_T), INTENT(IN) :: type_id   ! Datatype identifier 
+            LOGICAL, INTENT(OUT)       :: status    ! Logical flag:
+                                                    ! .TRUE. is datatype is a varibale string
+                                                    ! .FALSE. otherwise 
+            INTEGER, INTENT(OUT) :: hdferr          ! Error code
+
+          END SUBROUTINE h5tis_variable_str_f
+
+ + +

  +

  +


+

 

  @@ -1276,12 +1300,6 @@ FORTRAN Datatype API -- h5t - - - - - -

  @@ -1295,7 +1313,7 @@ FORTRAN Datatype API -- h5t Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 14 March 2003 +Last modified: 19 March 2003 diff --git a/doc/html/fortran/h5z_FORTRAN.html b/doc/html/fortran/h5z_FORTRAN.html new file mode 100644 index 0000000..6a473ea --- /dev/null +++ b/doc/html/fortran/h5z_FORTRAN.html @@ -0,0 +1,85 @@ + + +FORTRAN Identifier API -- h5i + + + + + + +

+

The FORTRAN 90 API to HDF5
h5i: Filters

+
+ + +
+ + +

  +

  +


+

  + +

  + + + +

FORTRAN interface:   h5zunregister_f + +
+          SUBROUTINE h5zunregister_f(filter, hdferr) 
+            IMPLICIT NONE
+            INTEGER, INTENT(IN)  :: filter  ! Filter; one of the possible values:
+                                            ! H5Z_FILTER_DEFLATE_F
+                                            ! H5Z_FILTER_SHUFFLE_F
+                                            ! H5Z_FILTER_FLETCHER32_F
+            INTEGER, INTENT(OUT) :: hdferr  ! Error code
+                                            ! 0 on success, and -1 on failure
+
+          END SUBROUTINE h5zunregister_f
+
+ + +

  +

  +


+

  + +

  + + + +

FORTRAN interface:   h5zfilter_avail_f + +
+               SUBROUTINE h5zfilter_avail_f(filter, status, hdferr)
+                 IMPLICIT NONE
+                 INTEGER, INTENT(IN)  :: filter  ! Filter; one of the possible values:
+                                                 ! H5Z_FILTER_DEFLATE_F
+                                                 ! H5Z_FILTER_SHUFFLE_F
+                                                 ! H5Z_FILTER_FLETCHER32_F
+                 LOGICAL, INTENT(OUT) :: status  ! Flag, idicates if filter
+                                                 ! is availble ( .TRUE. or .FALSE.)
+
+                END SUBROUTINE h5zfilter_avail_f
+
+
+ + +
+ +

  +

  +


+ + +
+HDF Help Desk +
+Describes HDF5 Release 1.5, Unreleased Development Branch +
+ +Last modified: 19 March 2003 + + + -- cgit v0.12