diff options
Diffstat (limited to 'fortran/src/H5Gff.f90')
| -rw-r--r-- | fortran/src/H5Gff.f90 | 608 |
1 files changed, 304 insertions, 304 deletions
diff --git a/fortran/src/H5Gff.f90 b/fortran/src/H5Gff.f90 index ae120bb..2e769ad 100644 --- a/fortran/src/H5Gff.f90 +++ b/fortran/src/H5Gff.f90 @@ -1,4 +1,4 @@ -! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * ! Copyright by The HDF Group. * ! Copyright by the Board of Trustees of the University of Illinois. * ! All rights reserved. * @@ -11,11 +11,11 @@ ! is linked from the top-level documents page. It can also be found at * ! http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have * ! access to either file, you may request a copy from help@hdfgroup.org. * -! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * ! ! ! This file contains Fortran90 interfaces for H5F functions. -! +! MODULE H5G USE H5GLOBAL @@ -28,53 +28,53 @@ MODULE H5G ! END INTERFACE CONTAINS - + !---------------------------------------------------------------------- -! Name: h5gcreate_f +! Name: h5gcreate_f ! -! Purpose: Creates a new group. +! Purpose: Creates a new group. ! -! Inputs: +! Inputs: ! loc_id - location identifier ! name - group name at the specified location -! Outputs: +! Outputs: ! grp_id - group identifier -! hdferr: - error code +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: -! size_hint - a parameter indicating the number of bytes -! to reserve for the names that will appear +! size_hint - a parameter indicating the number of bytes +! to reserve for the names that will appear ! in the group ! lcpl_id - Property list for link creation ! gcpl_id - Property list for group creation ! gapl_id - Property list for group access ! ! Programmer: Elena Pourmal -! August 12, 1999 +! August 12, 1999 ! -! Modifications: Explicit Fortran interfaces were added for +! Modifications: Explicit Fortran interfaces were added for ! called C functions (it is needed for Windows -! port). March 5, 2001 +! port). March 5, 2001 ! ! Added additional optional paramaters in 1.8 ! MSB - February 27, 2008 ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5gcreate_f(loc_id, name, grp_id, hdferr, size_hint, lcpl_id, gcpl_id, gapl_id) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group - INTEGER(HID_T), INTENT(OUT) :: grp_id ! Group identifier - INTEGER, INTENT(OUT) :: hdferr ! Error code - INTEGER(SIZE_T), OPTIONAL, INTENT(IN) :: size_hint + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group + INTEGER(HID_T), INTENT(OUT) :: grp_id ! Group identifier + INTEGER, INTENT(OUT) :: hdferr ! Error code + INTEGER(SIZE_T), OPTIONAL, INTENT(IN) :: size_hint ! Parameter indicating ! the number of bytes ! to reserve for the ! names that will appear ! in the group. Set to OBJECT_NAMELEN_DEFAULT_F - ! if using any of the optional + ! if using any of the optional ! parameters lcpl_id, gcpl_id, and/or gapl_id when not ! using keywords in specifying the optional parameters INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Property list for link creation @@ -86,7 +86,7 @@ CONTAINS INTEGER(HID_T) :: gapl_id_default INTEGER :: namelen ! Length of the name character string - INTEGER(SIZE_T) :: size_hint_default + INTEGER(SIZE_T) :: size_hint_default ! MS FORTRAN needs explicit interface for C functions called here. ! @@ -109,7 +109,7 @@ CONTAINS END FUNCTION h5gcreate_c END INTERFACE - size_hint_default = OBJECT_NAMELEN_DEFAULT_F + size_hint_default = OBJECT_NAMELEN_DEFAULT_F IF (PRESENT(size_hint)) size_hint_default = size_hint lcpl_id_default = H5P_DEFAULT_F IF(PRESENT(lcpl_id)) lcpl_id_default = lcpl_id @@ -126,18 +126,18 @@ CONTAINS END SUBROUTINE h5gcreate_f !!$!---------------------------------------------------------------------- -!!$! Name: h5gcreate2_f +!!$! Name: h5gcreate2_f !!$! -!!$! Purpose: Creates a new group. +!!$! Purpose: Creates a new group. !!$! -!!$! Inputs: +!!$! Inputs: !!$! loc_id - location identifier !!$! name - group name at the specified location -!!$! Outputs: +!!$! Outputs: !!$! grp_id - group identifier -!!$! hdferr: - error code +!!$! hdferr: - error code !!$! Success: 0 -!!$! Failure: -1 +!!$! Failure: -1 !!$! Optional parameters: !!$! !!$! lcpl_id - Property list for link creation @@ -147,19 +147,19 @@ CONTAINS !!$! Programmer: M.S. BREITENFELD !!$! February 27, 2008 !!$! -!!$! Modifications: +!!$! Modifications: !!$! !!$! Comment: Needed to switch the first 2 arguments to avoid conflect -!!$! with h5gcreate1_f +!!$! with h5gcreate1_f !!$!---------------------------------------------------------------------- !!$ -!!$ SUBROUTINE h5gcreate2_f(name, loc_id, grp_id, hdferr, & +!!$ SUBROUTINE h5gcreate2_f(name, loc_id, grp_id, hdferr, & !!$ lcpl_id, gcpl_id, gapl_id) -!!$ IMPLICIT NONE +!!$ IMPLICIT NONE !!$ CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group !!$ INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier !!$ INTEGER, INTENT(OUT) :: hdferr ! Error code -!!$ INTEGER(HID_T), INTENT(OUT) :: grp_id ! Group identifier +!!$ INTEGER(HID_T), INTENT(OUT) :: grp_id ! Group identifier !!$ !!$ INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Property list for link creation !!$ INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gcpl_id ! Property list for group creation @@ -211,44 +211,44 @@ CONTAINS !---------------------------------------------------------------------- -! Name: h5gopen_f +! Name: h5gopen_f ! -! Purpose: Opens an existing group. +! Purpose: Opens an existing group. ! -! Inputs: +! Inputs: ! loc_id - location identifier ! name - name of the group to open -! Outputs: +! Outputs: ! grp_id - group identifier -! hdferr: - error code +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! gapl_id - Group access property list identifier ! ! Programmer: Elena Pourmal -! August 12, 1999 +! August 12, 1999 ! -! Modifications: Explicit Fortran interfaces were added for +! Modifications: Explicit Fortran interfaces were added for ! called C functions (it is needed for Windows ! port). March 5, 2001 -! +! ! Added 1.8 (optional) parameter gapl_id ! February, 2008 M.S. Breitenfeld ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5gopen_f(loc_id, name, grp_id, hdferr, gapl_id) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group - INTEGER(HID_T), INTENT(OUT) :: grp_id ! File identifier - INTEGER, INTENT(OUT) :: hdferr ! Error code - INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gapl_id ! Group access property list identifier - + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group + INTEGER(HID_T), INTENT(OUT) :: grp_id ! File identifier + INTEGER, INTENT(OUT) :: hdferr ! Error code + INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gapl_id ! Group access property list identifier + INTEGER(HID_T) :: gapl_id_default INTEGER :: namelen ! Length of the name character string - + ! INTEGER, EXTERNAL :: h5gopen_c ! MS FORTRAN needs explicit interface for C functions called here. ! @@ -261,7 +261,7 @@ CONTAINS !DEC$ATTRIBUTES reference :: name INTEGER(HID_T), INTENT(IN) :: loc_id CHARACTER(LEN=*), INTENT(IN) :: name - INTEGER :: namelen + INTEGER :: namelen INTEGER(HID_T), INTENT(IN) :: gapl_id_default INTEGER(HID_T), INTENT(OUT) :: grp_id END FUNCTION h5gopen_c @@ -269,34 +269,34 @@ CONTAINS gapl_id_default = H5P_DEFAULT_F IF(PRESENT(gapl_id)) gapl_id_default = gapl_id - + namelen = LEN(name) - hdferr = h5gopen_c(loc_id, name, namelen, gapl_id_default, grp_id) - + hdferr = h5gopen_c(loc_id, name, namelen, gapl_id_default, grp_id) + END SUBROUTINE h5gopen_f !---------------------------------------------------------------------- -! Name: h5gclose_f +! Name: h5gclose_f ! -! Purpose: Closes the specified group. +! Purpose: Closes the specified group. ! -! Inputs: +! Inputs: ! grp_id - group identifier -! Outputs: -! hdferr: - error code +! Outputs: +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! NONE ! ! Programmer: Elena Pourmal -! August 12, 1999 +! August 12, 1999 ! -! Modifications: Explicit Fortran interfaces were added for +! Modifications: Explicit Fortran interfaces were added for ! called C functions (it is needed for Windows -! port). March 5, 2001 +! port). March 5, 2001 ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5gclose_f(grp_id, hdferr) IMPLICIT NONE @@ -322,42 +322,42 @@ CONTAINS !---------------------------------------------------------------------- -! Name: h5gget_obj_info_idx_f +! Name: h5gget_obj_info_idx_f ! -! Purpose: Returns name and type of the group member identified by -! its index. +! Purpose: Returns name and type of the group member identified by +! its index. ! -! Inputs: +! Inputs: ! loc_id - location identifier ! name - name of the group at the specified location ! idx - object index (zero-based) -! Outputs: +! Outputs: ! obj_name - object name ! obj_type - object type -! hdferr: - error code +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! NONE ! ! Programmer: Elena Pourmal -! August 12, 1999 +! August 12, 1999 ! -! Modifications: Explicit Fortran interfaces were added for +! Modifications: Explicit Fortran interfaces were added for ! called C functions (it is needed for Windows -! port). March 5, 2001 +! port). March 5, 2001 ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5gget_obj_info_idx_f(loc_id, name, idx, & obj_name, obj_type, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group - INTEGER, INTENT(IN) :: idx ! Index of member object - CHARACTER(LEN=*), INTENT(OUT) :: obj_name ! Name of the object - INTEGER, INTENT(OUT) :: obj_type ! Object type - INTEGER, INTENT(OUT) :: hdferr ! Error code + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group + INTEGER, INTENT(IN) :: idx ! Index of member object + CHARACTER(LEN=*), INTENT(OUT) :: obj_name ! Name of the object + INTEGER, INTENT(OUT) :: obj_type ! Object type + INTEGER, INTENT(OUT) :: hdferr ! Error code INTEGER :: namelen ! Length of the name character string INTEGER :: obj_namelen ! Length of the obj_name character string @@ -388,46 +388,46 @@ CONTAINS namelen = LEN(name) obj_namelen = LEN(obj_name) hdferr = h5gget_obj_info_idx_c(loc_id, name, namelen, idx, & - obj_name, obj_namelen, obj_type) + obj_name, obj_namelen, obj_type) END SUBROUTINE h5gget_obj_info_idx_f !---------------------------------------------------------------------- -! Name: h5gn_members_f +! Name: h5gn_members_f ! -! Purpose: Returns the number of group members. +! Purpose: Returns the number of group members. ! -! Inputs: +! Inputs: ! loc_id - location identifier ! name - name of the group at the specified location -! Outputs: +! Outputs: ! nmembers - number of group members -! hdferr: - error code +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! NONE ! ! Programmer: Elena Pourmal -! August 12, 1999 +! August 12, 1999 ! -! Modifications: Explicit Fortran interfaces were added for +! Modifications: Explicit Fortran interfaces were added for ! called C functions (it is needed for Windows -! port). March 5, 2001 +! port). March 5, 2001 ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5gn_members_f(loc_id, name, nmembers, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the group INTEGER, INTENT(OUT) :: nmembers ! Number of members in the - ! group - INTEGER, INTENT(OUT) :: hdferr ! Error code + ! group + INTEGER, INTENT(OUT) :: hdferr ! Error code INTEGER :: namelen ! Length of the name character string - + ! INTEGER, EXTERNAL :: h5gn_members_c ! MS FORTRAN needs explicit interface for C functions called here. ! @@ -446,56 +446,56 @@ CONTAINS END INTERFACE namelen = LEN(name) - hdferr = h5gn_members_c(loc_id, name, namelen, nmembers) + hdferr = h5gn_members_c(loc_id, name, namelen, nmembers) END SUBROUTINE h5gn_members_f !---------------------------------------------------------------------- -! Name: h5glink_f +! Name: h5glink_f ! -! Purpose: Creates a link of the specified type from new_name -! to current_name. +! Purpose: Creates a link of the specified type from new_name +! to current_name. ! -! Inputs: +! Inputs: ! loc_id - location identifier ! link_type - link type ! Possible values are: ! H5G_LINK_HARD_F (0) or -! H5G_LINK_SOFT_F (1) -! current_name - name of the existing object if link is a -! hard link. Can be anything for the soft link. +! H5G_LINK_SOFT_F (1) +! current_name - name of the existing object if link is a +! hard link. Can be anything for the soft link. ! new_name - new name for the object -! Outputs: -! hdferr: - error code +! Outputs: +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! NONE ! ! Programmer: Elena Pourmal -! August 12, 1999 +! August 12, 1999 ! -! Modifications: Explicit Fortran interfaces were added for +! Modifications: Explicit Fortran interfaces were added for ! called C functions (it is needed for Windows -! port). March 5, 2001 +! port). March 5, 2001 ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5glink_f(loc_id, link_type, current_name, & new_name, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier INTEGER, INTENT(IN) :: link_type ! link type ! Possible values are: ! H5G_LINK_HARD_F (0) or - ! H5G_LINK_SOFT_F (1) - - CHARACTER(LEN=*), INTENT(IN) :: current_name - ! Current name of an object + ! H5G_LINK_SOFT_F (1) + + CHARACTER(LEN=*), INTENT(IN) :: current_name + ! Current name of an object CHARACTER(LEN=*), INTENT(IN) :: new_name ! New name of an object INTEGER, INTENT(OUT) :: hdferr ! Error code - + INTEGER :: current_namelen ! Lenghth of the current_name string INTEGER :: new_namelen ! Lenghth of the new_name string @@ -505,14 +505,14 @@ CONTAINS INTERFACE INTEGER FUNCTION h5glink_c(loc_id, link_type, current_name, & current_namelen, new_name, new_namelen) - + USE H5GLOBAL !DEC$IF DEFINED(HDF5F90_WINDOWS) !DEC$ATTRIBUTES C,reference,decorate,alias:'H5GLINK_C'::h5glink_c !DEC$ENDIF !DEC$ATTRIBUTES reference :: current_name !DEC$ATTRIBUTES reference :: new_name - INTEGER(HID_T), INTENT(IN) :: loc_id + INTEGER(HID_T), INTENT(IN) :: loc_id INTEGER, INTENT(IN) :: link_type CHARACTER(LEN=*), INTENT(IN) :: current_name INTEGER :: current_namelen @@ -520,7 +520,7 @@ CONTAINS INTEGER :: new_namelen END FUNCTION h5glink_c END INTERFACE - + current_namelen = LEN(current_name) new_namelen = LEN(new_name) hdferr = h5glink_c(loc_id, link_type, current_name, & @@ -528,50 +528,50 @@ CONTAINS END SUBROUTINE h5glink_f !---------------------------------------------------------------------- -! Name: h5glink2_f +! Name: h5glink2_f ! -! Purpose: Creates a link of the specified type from new_name +! Purpose: Creates a link of the specified type from new_name ! to current_name. current_name and new_name are interpreted -! releative to current and new location identifiers. +! releative to current and new location identifiers. ! -! Inputs: +! Inputs: ! cur_loc_id - location identifier -! cur_name - name of the existing object if link is a -! hard link. Can be anything for the soft link. +! cur_name - name of the existing object if link is a +! hard link. Can be anything for the soft link. ! link_type - link type ! Possible values are: ! H5G_LINK_HARD_F (0) or -! H5G_LINK_SOFT_F (1) +! H5G_LINK_SOFT_F (1) ! new_loc_id - new location identifier ! new_name - new name for the object -! Outputs: -! hdferr: - error code +! Outputs: +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! NONE ! ! Programmer: Elena Pourmal ! September 25, 2002 ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5glink2_f(cur_loc_id, cur_name, link_type, new_loc_id, & new_name, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: cur_loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: cur_name - ! Current name of an object + INTEGER(HID_T), INTENT(IN) :: cur_loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: cur_name + ! Current name of an object INTEGER, INTENT(IN) :: link_type ! link type ! Possible values are: ! H5G_LINK_HARD_F (0) or - ! H5G_LINK_SOFT_F (1) - - INTEGER(HID_T), INTENT(IN) :: new_loc_id ! File or group identifier + ! H5G_LINK_SOFT_F (1) + + INTEGER(HID_T), INTENT(IN) :: new_loc_id ! File or group identifier CHARACTER(LEN=*), INTENT(IN) :: new_name ! New name of an object INTEGER, INTENT(OUT) :: hdferr ! Error code - + INTEGER :: cur_namelen ! Lenghth of the current_name string INTEGER :: new_namelen ! Lenghth of the new_name string @@ -579,15 +579,15 @@ CONTAINS INTEGER FUNCTION h5glink2_c(cur_loc_id, cur_name, cur_namelen, & link_type, new_loc_id, & new_name, new_namelen) - + USE H5GLOBAL !DEC$IF DEFINED(HDF5F90_WINDOWS) !DEC$ATTRIBUTES C,reference,decorate,alias:'H5GLINK2_C'::h5glink2_c !DEC$ENDIF !DEC$ATTRIBUTES reference :: cur_name !DEC$ATTRIBUTES reference :: new_name - INTEGER(HID_T), INTENT(IN) :: cur_loc_id - INTEGER(HID_T), INTENT(IN) :: new_loc_id + INTEGER(HID_T), INTENT(IN) :: cur_loc_id + INTEGER(HID_T), INTENT(IN) :: new_loc_id INTEGER, INTENT(IN) :: link_type CHARACTER(LEN=*), INTENT(IN) :: cur_name CHARACTER(LEN=*), INTENT(IN) :: new_name @@ -595,7 +595,7 @@ CONTAINS INTEGER :: new_namelen END FUNCTION h5glink2_c END INTERFACE - + cur_namelen = LEN(cur_name) new_namelen = LEN(new_name) hdferr = h5glink2_c(cur_loc_id, cur_name, cur_namelen, link_type, & @@ -603,40 +603,40 @@ CONTAINS END SUBROUTINE h5glink2_f !---------------------------------------------------------------------- -! Name: h5gunlink_f +! Name: h5gunlink_f ! -! Purpose: Removes the specified name from the group graph and -! decrements the link count for the object to which name -! points +! Purpose: Removes the specified name from the group graph and +! decrements the link count for the object to which name +! points ! -! Inputs: +! Inputs: ! loc_id - location identifier ! name - name of the object to unlink -! Outputs: -! hdferr: - error code +! Outputs: +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! NONE ! ! Programmer: Elena Pourmal -! August 12, 1999 +! August 12, 1999 ! -! Modifications: Explicit Fortran interfaces were added for +! Modifications: Explicit Fortran interfaces were added for ! called C functions (it is needed for Windows -! port). March 5, 2001 +! port). March 5, 2001 ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5gunlink_f(loc_id, name, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: name ! Name of an object + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Name of an object INTEGER, INTENT(OUT) :: hdferr ! Error code - + INTEGER :: namelen ! Lenghth of the name character string - + ! INTEGER, EXTERNAL :: h5gunlink_c ! MS FORTRAN needs explicit interface for C functions called here. ! @@ -652,45 +652,45 @@ CONTAINS INTEGER :: namelen END FUNCTION h5gunlink_c END INTERFACE - + namelen = LEN(name) hdferr = h5gunlink_c(loc_id, name, namelen) END SUBROUTINE h5gunlink_f !---------------------------------------------------------------------- -! Name: h5gmove_f +! Name: h5gmove_f ! -! Purpose: Renames an object within an HDF5 file. +! Purpose: Renames an object within an HDF5 file. ! -! Inputs: +! Inputs: ! loc_id - location identifier ! name - object's name at specified location ! new_name - object's new name -! Outputs: -! hdferr: - error code +! Outputs: +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! NONE ! ! Programmer: Elena Pourmal -! August 12, 1999 +! August 12, 1999 ! -! Modifications: Explicit Fortran interfaces were added for +! Modifications: Explicit Fortran interfaces were added for ! called C functions (it is needed for Windows -! port). March 5, 2001 +! port). March 5, 2001 ! -! Comment: +! Comment: !---------------------------------------------------------------------- - + SUBROUTINE h5gmove_f(loc_id, name, new_name, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: name ! Current name of an object + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Current name of an object CHARACTER(LEN=*), INTENT(IN) :: new_name ! New name of an object INTEGER, INTENT(OUT) :: hdferr ! Error code - + INTEGER :: namelen ! Lenghth of the current_name string INTEGER :: new_namelen ! Lenghth of the new_name string @@ -712,44 +712,44 @@ CONTAINS INTEGER :: new_namelen END FUNCTION h5gmove_c END INTERFACE - + namelen = LEN(name) new_namelen = LEN(new_name) hdferr = h5gmove_c(loc_id, name, namelen, new_name, new_namelen) END SUBROUTINE h5gmove_f !---------------------------------------------------------------------- -! Name: h5gmove2_f +! Name: h5gmove2_f ! -! Purpose: Renames an object within an HDF5 file. +! Purpose: Renames an object within an HDF5 file. ! -! Inputs: +! Inputs: ! src_loc_id - original location identifier ! src_name - object's name at specified original location ! dst_loc_id - original location identifier ! dst_name - object's new name -! Outputs: -! hdferr: - error code +! Outputs: +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! NONE ! ! Programmer: Elena Pourmal ! September 25, 2002 ! -! Comment: +! Comment: !---------------------------------------------------------------------- - + SUBROUTINE h5gmove2_f(src_loc_id, src_name, dst_loc_id, dst_name, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: src_loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: src_name ! Original name of an object - INTEGER(HID_T), INTENT(IN) :: dst_loc_id ! File or group identifier + INTEGER(HID_T), INTENT(IN) :: src_loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: src_name ! Original name of an object + INTEGER(HID_T), INTENT(IN) :: dst_loc_id ! File or group identifier CHARACTER(LEN=*), INTENT(IN) :: dst_name ! New name of an object INTEGER, INTENT(OUT) :: hdferr ! Error code - + INTEGER :: src_namelen ! Length of the current_name string INTEGER :: dst_namelen ! Lenghth of the new_name string @@ -773,7 +773,7 @@ CONTAINS INTEGER :: dst_namelen END FUNCTION h5gmove2_c END INTERFACE - + src_namelen = LEN(src_name) dst_namelen = LEN(dst_name) hdferr = h5gmove2_c(src_loc_id, src_name, src_namelen,& @@ -781,46 +781,46 @@ CONTAINS END SUBROUTINE h5gmove2_f !---------------------------------------------------------------------- -! Name: h5gget_linkval_f +! Name: h5gget_linkval_f ! -! Purpose: Returns the name of the object that the symbolic link -! points to. +! Purpose: Returns the name of the object that the symbolic link +! points to. ! -! Inputs: +! Inputs: ! loc_id - location identifier -! name - symbolic link to the object whose name -! is to be returned. +! name - symbolic link to the object whose name +! is to be returned. ! size - maximum number of characters to be returned -! Outputs: -! buffer - a buffer to hold the name of the object -! being sought -! hdferr: - error code +! Outputs: +! buffer - a buffer to hold the name of the object +! being sought +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! NONE ! ! Programmer: Elena Pourmal -! August 12, 1999 +! August 12, 1999 ! -! Modifications: Explicit Fortran interfaces were added for +! Modifications: Explicit Fortran interfaces were added for ! called C functions (it is needed for Windows -! port). March 5, 2001 +! port). March 5, 2001 ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5gget_linkval_f(loc_id, name, size, buffer, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: name ! Current name of an object + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Current name of an object INTEGER(SIZE_T), INTENT(IN) :: size ! Maximum number of buffer - CHARACTER(LEN=size), INTENT(OUT) :: buffer + CHARACTER(LEN=size), INTENT(OUT) :: buffer ! Buffer to hold a name of ! the object symbolic link ! points to INTEGER, INTENT(OUT) :: hdferr ! Error code - + INTEGER :: namelen ! Lenghth of the current_name string ! INTEGER, EXTERNAL :: h5gget_linkval_c @@ -833,52 +833,52 @@ CONTAINS !DEC$ATTRIBUTES C,reference,decorate,alias:'H5GGET_LINKVAL_C'::h5gget_linkval_c !DEC$ENDIF !DEC$ATTRIBUTES reference :: name - !DEC$ATTRIBUTES reference :: buffer + !DEC$ATTRIBUTES reference :: buffer INTEGER(HID_T), INTENT(IN) :: loc_id - CHARACTER(LEN=*), INTENT(IN) :: name + CHARACTER(LEN=*), INTENT(IN) :: name INTEGER :: namelen INTEGER(SIZE_T), INTENT(IN) :: size CHARACTER(LEN=*), INTENT(OUT) :: buffer END FUNCTION h5gget_linkval_c END INTERFACE - + namelen = LEN(name) hdferr = h5gget_linkval_c(loc_id, name, namelen, size, buffer) END SUBROUTINE h5gget_linkval_f !---------------------------------------------------------------------- -! Name: h5gset_comment_f +! Name: h5gset_comment_f ! -! Purpose: Sets comment for specified object. +! Purpose: Sets comment for specified object. ! -! Inputs: +! Inputs: ! loc_id - location identifier ! name - name of the object ! comment - comment to set for the object -! Outputs: -! hdferr: - error code +! Outputs: +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! NONE ! ! Programmer: Elena Pourmal -! August 12, 1999 +! August 12, 1999 ! -! Modifications: Explicit Fortran interfaces were added for +! Modifications: Explicit Fortran interfaces were added for ! called C functions (it is needed for Windows -! port). March 5, 2001 +! port). March 5, 2001 ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5gset_comment_f(loc_id, name, comment, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: name ! Current name of an object + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Current name of an object CHARACTER(LEN=*), INTENT(IN) :: comment ! New name of an object INTEGER, INTENT(OUT) :: hdferr ! Error code - + INTEGER :: namelen ! Lenghth of the current_name string INTEGER :: commentlen ! Lenghth of the comment string @@ -892,8 +892,8 @@ CONTAINS !DEC$IF DEFINED(HDF5F90_WINDOWS) !DEC$ATTRIBUTES C,reference,decorate,alias:'H5GSET_COMMENT_C'::h5gset_comment_c !DEC$ENDIF - !DEC$ATTRIBUTES reference :: name - !DEC$ATTRIBUTES reference :: comment + !DEC$ATTRIBUTES reference :: name + !DEC$ATTRIBUTES reference :: comment INTEGER(HID_T), INTENT(IN) :: loc_id CHARACTER(LEN=*), INTENT(IN) :: name INTEGER :: namelen @@ -901,48 +901,48 @@ CONTAINS INTEGER :: commentlen END FUNCTION h5gset_comment_c END INTERFACE - + namelen = LEN(name) commentlen = LEN(comment) hdferr = h5gset_comment_c(loc_id, name, namelen, comment, commentlen) END SUBROUTINE h5gset_comment_f !---------------------------------------------------------------------- -! Name: h5gget_comment_f +! Name: h5gget_comment_f ! -! Purpose: Retrieves comment for specified object. +! Purpose: Retrieves comment for specified object. ! -! Inputs: +! Inputs: ! loc_id - location identifier ! name - name of the object at specified location ! size - size of the buffer required to hold comment -! Outputs: +! Outputs: ! buffer - buffer to hold object's comment -! hdferr: - error code +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! NONE ! ! Programmer: Elena Pourmal -! August 12, 1999 +! August 12, 1999 ! -! Modifications: Explicit Fortran interfaces were added for +! Modifications: Explicit Fortran interfaces were added for ! called C functions (it is needed for Windows -! port). March 5, 2001 +! port). March 5, 2001 ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5gget_comment_f(loc_id, name, size, buffer, hdferr) IMPLICIT NONE - INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - CHARACTER(LEN=*), INTENT(IN) :: name ! Current name of an object + INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier + CHARACTER(LEN=*), INTENT(IN) :: name ! Current name of an object INTEGER(SIZE_T), INTENT(IN) :: size ! Maximum number of buffer - CHARACTER(LEN=size), INTENT(OUT) :: buffer + CHARACTER(LEN=size), INTENT(OUT) :: buffer ! Buffer to hold a comment INTEGER, INTENT(OUT) :: hdferr ! Error code - + INTEGER :: namelen ! Lenghth of the current_name string ! INTEGER, EXTERNAL :: h5gget_comment_c @@ -963,7 +963,7 @@ CONTAINS CHARACTER(LEN=*), INTENT(OUT) :: buffer END FUNCTION h5gget_comment_c END INTERFACE - + namelen = LEN(name) hdferr = h5gget_comment_c(loc_id, name, namelen, size, buffer) END SUBROUTINE h5gget_comment_f @@ -971,37 +971,37 @@ CONTAINS !---------------------------------------------------------------------- ! Name: H5Gcreate_anon_f ! -! Purpose: Creates a new empty group without linking it into the file structure. +! Purpose: Creates a new empty group without linking it into the file structure. ! -! Inputs: +! Inputs: ! loc_id - Location identifier -! Outputs: +! Outputs: ! grp_id - group identifier -! hdferr: - error code +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! gcpl_id - Group creation property list identifier ! gapl_id - Group access property list identifier ! ! Programmer: M.S. Breitenfeld -! February 15, 2008 +! February 15, 2008 ! -! Modifications: +! Modifications: ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5Gcreate_anon_f(loc_id, grp_id, hdferr, gcpl_id, gapl_id) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier - INTEGER(HID_T), INTENT(OUT) :: grp_id ! Group identifier + INTEGER(HID_T), INTENT(OUT) :: grp_id ! Group identifier INTEGER, INTENT(OUT) :: hdferr ! Error code INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gcpl_id ! Property list for group creation INTEGER(HID_T), OPTIONAL, INTENT(IN) :: gapl_id ! Property list for group access INTEGER(HID_T) :: gcpl_id_default INTEGER(HID_T) :: gapl_id_default - + INTERFACE INTEGER FUNCTION h5gcreate_anon_c(loc_id, gcpl_id_default, gapl_id_default, grp_id) USE H5GLOBAL @@ -1015,43 +1015,43 @@ CONTAINS END FUNCTION h5gcreate_anon_c END INTERFACE - gcpl_id_default = H5P_DEFAULT_F - gapl_id_default = H5P_DEFAULT_F + gcpl_id_default = H5P_DEFAULT_F + gapl_id_default = H5P_DEFAULT_F IF(PRESENT(gcpl_id)) gcpl_id_default = gcpl_id IF(PRESENT(gapl_id)) gapl_id_default = gapl_id - + hdferr = h5gcreate_anon_c(loc_id, gcpl_id_default, gapl_id_default, grp_id) - + END SUBROUTINE h5Gcreate_anon_f !---------------------------------------------------------------------- ! Name: H5Gget_create_plist_f ! -! Purpose: Gets a group creation property list identifier. +! Purpose: Gets a group creation property list identifier. ! -! Inputs: +! Inputs: ! grp_id - group identifier -! Outputs: +! Outputs: ! gcpl_id - Group creation property list identifier -! hdferr: - error code +! hdferr: - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! ! Programmer: M.S. Breitenfeld -! February 15, 2008 +! February 15, 2008 ! -! Modifications: +! Modifications: ! -! Comment: +! Comment: !---------------------------------------------------------------------- SUBROUTINE h5gget_create_plist_f(grp_id, gcpl_id, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: grp_id ! Group identifier INTEGER(HID_T), INTENT(OUT) :: gcpl_id ! Property list for group creation INTEGER, INTENT(OUT) :: hdferr ! Error code - + ! MS FORTRAN needs explicit interface for C functions called here. ! INTERFACE @@ -1064,17 +1064,17 @@ CONTAINS INTEGER(HID_T), INTENT(OUT) :: gcpl_id END FUNCTION h5gget_create_plist_c END INTERFACE - + hdferr = h5gget_create_plist_c(grp_id, gcpl_id ) - + END SUBROUTINE h5gget_create_plist_f !---------------------------------------------------------------------- ! Name: h5gget_info_f ! ! Purpose: Retrieves information about a group -! -! Inputs: +! +! Inputs: ! group_id - Group identifier ! ! Outputs: NOTE: In C it is defined as a structure: H5G_info_t @@ -1085,16 +1085,16 @@ CONTAINS ! H5G_STORAGE_TYPE_SYMBOL_TABLE: Symbol tables, the original HDF5 structure ! nlinks - Number of links in group ! max_corder - Current maximum creation order value for group -! hdferr - error code +! hdferr - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: -! mounted - Whether group has a file mounted on it +! mounted - Whether group has a file mounted on it ! ! Programmer: M. S. Breitenfeld -! February 15, 2008 +! February 15, 2008 ! -! Modifications: +! Modifications: ! - Added 'mounted' paramater ! M.S. Breitenfeld ! July 16, 2008 @@ -1104,7 +1104,7 @@ CONTAINS SUBROUTINE h5gget_info_f(group_id, storage_type, nlinks, max_corder, hdferr, mounted) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: group_id ! Group identifier - + INTEGER, INTENT(OUT) :: storage_type ! Type of storage for links in group: ! H5G_STORAGE_TYPE_COMPACT_F: Compact storage ! H5G_STORAGE_TYPE_DENSE_F: Indexed storage @@ -1136,20 +1136,20 @@ CONTAINS hdferr = h5gget_info_c(group_id, storage_type, nlinks, max_corder, mounted_c) IF(PRESENT(mounted))THEN - IF(mounted_c.EQ.0) THEN + IF(mounted_c.EQ.0) THEN mounted = .FALSE. - ELSE + ELSE mounted = .TRUE. ENDIF ENDIF - + END SUBROUTINE h5gget_info_f !---------------------------------------------------------------------- ! Name: h5gget_info_by_idx_f ! ! Purpose: Retrieves information about a group, according to the group’s position within an index. -! +! ! Inputs: ! loc_id - File or group identifier ! group_name - Name of group containing group for which information is to be retrieved @@ -1165,17 +1165,17 @@ CONTAINS ! H5G_STORAGE_TYPE_SYMBOL_TABLE: Symbol tables, the original HDF5 structure ! nlinks - Number of links in group ! max_corder - Current maximum creation order value for group -! hdferr - error code +! hdferr - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! lapl_id - Link access property list -! mounted - Whether group has a file mounted on it +! mounted - Whether group has a file mounted on it ! ! Programmer: M. S. Breitenfeld -! February 18, 2008 +! February 18, 2008 ! -! Modifications: +! Modifications: ! - Added 'mounted' paramater ! M.S. Breitenfeld ! July 16, 2008 @@ -1215,7 +1215,7 @@ CONTAINS !DEC$IF DEFINED(HDF5F90_WINDOWS) !DEC$ATTRIBUTES C,reference,decorate,alias:'H5GGET_INFO_BY_IDX_C'::h5gget_info_by_idx_c !DEC$ENDIF - + !DEC$ATTRIBUTES reference :: group_name INTEGER(HID_T), INTENT(IN) :: loc_id CHARACTER(LEN=*), INTENT(IN) :: group_name @@ -1224,7 +1224,7 @@ CONTAINS INTEGER(HSIZE_T), INTENT(IN) :: n INTEGER(HID_T) :: lapl_id_default INTEGER, INTENT(OUT) :: storage_type - INTEGER, INTENT(OUT) :: nlinks + INTEGER, INTENT(OUT) :: nlinks INTEGER, INTENT(OUT) :: max_corder INTEGER(SIZE_T) :: group_name_len @@ -1243,20 +1243,20 @@ CONTAINS storage_type, nlinks, max_corder, mounted_c) IF(PRESENT(mounted))THEN - IF(mounted_c.EQ.0) THEN + IF(mounted_c.EQ.0) THEN mounted = .FALSE. - ELSE + ELSE mounted = .TRUE. ENDIF ENDIF - + END SUBROUTINE h5gget_info_by_idx_f - + !---------------------------------------------------------------------- ! Name: h5gget_info_by_name_f ! -! Purpose: Retrieves information about a group. -! +! Purpose: Retrieves information about a group. +! ! Inputs: ! loc_id - File or group identifier ! group_name - Name of group containing group for which information is to be retrieved @@ -1269,17 +1269,17 @@ CONTAINS ! H5G_STORAGE_TYPE_SYMBOL_TABLE: Symbol tables, the original HDF5 structure ! nlinks - Number of links in group ! max_corder - Current maximum creation order value for group -! hdferr - error code +! hdferr - error code ! Success: 0 -! Failure: -1 +! Failure: -1 ! Optional parameters: ! lapl_id - Link access property list -! mounted - Whether group has a file mounted on it +! mounted - Whether group has a file mounted on it ! ! Programmer: M. S. Breitenfeld -! February 18, 2008 +! February 18, 2008 ! -! Modifications: +! Modifications: ! - Added 'mounted' paramater ! M.S. Breitenfeld ! July 16, 2008 @@ -1303,7 +1303,7 @@ CONTAINS LOGICAL, INTENT(OUT), OPTIONAL :: mounted ! Whether group has a file mounted on it INTEGER :: mounted_c - INTEGER(HID_T) :: lapl_id_default + INTEGER(HID_T) :: lapl_id_default INTEGER(SIZE_T) :: group_name_len ! length of group name ! MS FORTRAN needs explicit interface for C functions called here. @@ -1320,7 +1320,7 @@ CONTAINS CHARACTER(LEN=*), INTENT(IN) :: group_name INTEGER(HID_T), INTENT(IN) :: lapl_id_default INTEGER, INTENT(OUT) :: storage_type - INTEGER, INTENT(OUT) :: nlinks + INTEGER, INTENT(OUT) :: nlinks INTEGER, INTENT(OUT) :: max_corder INTEGER(SIZE_T) :: group_name_len @@ -1330,7 +1330,7 @@ CONTAINS END INTERFACE group_name_len = LEN(group_name) - + lapl_id_default = H5P_DEFAULT_F IF(PRESENT(lapl_id)) lapl_id_default = lapl_id @@ -1338,13 +1338,13 @@ CONTAINS storage_type, nlinks, max_corder, mounted_c) IF(PRESENT(mounted))THEN - IF(mounted_c.EQ.0) THEN + IF(mounted_c.EQ.0) THEN mounted = .FALSE. - ELSE + ELSE mounted = .TRUE. ENDIF ENDIF - + END SUBROUTINE h5gget_info_by_name_f END MODULE H5G |