1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
!****h* ROBODoc/H5O
!
! NAME
! MODULE H5O
!
! FILE
! fortran/src/H5Off.f90
!
! PURPOSE
! This file contains Fortran interfaces for H5O functions. It includes
! all the functions that are independent on whether the Fortran 2003 functions
! are enabled or disabled.
!
!
! COPYRIGHT
! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
! Copyright by The HDF Group. *
! Copyright by the Board of Trustees of the University of Illinois. *
! All rights reserved. *
! *
! This file is part of HDF5. The full HDF5 copyright notice, including *
! terms governing use, modification, and redistribution, is contained in *
! the files COPYING and Copyright.html. COPYING can be found at the root *
! of the source code distribution tree; Copyright.html can be found at the *
! root level of an installed copy of the electronic HDF5 document set and *
! 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. *
! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
!
! NOTES
! *** IMPORTANT ***
! If you add a new H5O function you must add the function name to the
! Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
! This is needed for Windows based operating systems.
!
!*****
MODULE H5O
USE H5GLOBAL
CONTAINS
!****s* H5O/h5olink_f
!
! NAME
! h5olink_f
!
! PURPOSE
! Creates a hard link to an object in an HDF5 file.
! INPUTS
! object_id - Object to be linked.
! new_loc_id - File or group identifier specifying location at which object is to be linked.
! new_link_name - Name of link to be created, relative to new_loc_id.
! OUTPUTS
! hdferr: - error code
! Success: 0
! Failure: -1
! OPTIONAL PARAMETERS
! lcpl_id - Link creation property list identifier.
! lapl_id - Link access property list identifier.
! AUTHOR
! M. Scot Breitenfeld
! April 21, 2008
!
! SOURCE
SUBROUTINE h5olink_f(object_id, new_loc_id, new_link_name, hdferr, lcpl_id, lapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: object_id ! Object to be linked
INTEGER(HID_T), INTENT(IN) :: new_loc_id ! File or group identifier specifying
! location at which object is to be linked.
CHARACTER(LEN=*), INTENT(IN) :: new_link_name ! Name of link to be created, relative to new_loc_id.
INTEGER, INTENT(OUT) :: hdferr ! Error code
! Success: 0
! Failure: -1
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id ! Link creation property list identifier.
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Link creation property list identifier.
!*****
INTEGER(HID_T) :: lapl_id_default
INTEGER(HID_T) :: lcpl_id_default
INTEGER(SIZE_T) :: new_link_namelen
INTERFACE
INTEGER FUNCTION h5olink_c(object_id, new_loc_id, new_link_name, new_link_namelen, &
lcpl_id_default, lapl_id_default)
USE H5GLOBAL
!DEC$IF DEFINED(HDF5F90_WINDOWS)
!DEC$ATTRIBUTES C,reference,decorate,alias:'H5OLINK_C'::h5olink_c
!DEC$ENDIF
!DEC$ATTRIBUTES reference :: new_link_name
INTEGER(HID_T), INTENT(IN) :: object_id
INTEGER(HID_T), INTENT(IN) :: new_loc_id
CHARACTER(LEN=*), INTENT(IN) :: new_link_name
INTEGER(SIZE_T) :: new_link_namelen
INTEGER(HID_T) :: lapl_id_default
INTEGER(HID_T) :: lcpl_id_default
END FUNCTION h5olink_c
END INTERFACE
new_link_namelen = LEN(new_link_name)
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
lcpl_id_default = H5P_DEFAULT_F
IF(PRESENT(lcpl_id)) lcpl_id_default = lcpl_id
hdferr = h5olink_c(object_id, new_loc_id, new_link_name, new_link_namelen, &
lcpl_id_default, lapl_id_default)
END SUBROUTINE h5olink_f
!****s* H5O/h5oopen_f
!
! NAME
! h5oopen_f
! PURPOSE
! Opens an object in an HDF5 file by location identifier and path name.
!
! INPUTS
! loc_id - File or group identifier
! name - Path to the object, relative to loc_id.
! OUTPUTS
! obj_id - Object identifier for the opened object
! hdferr: - error code
! Success: 0
! Failure: -1
! OPTIONAL PARAMETERS
! lapl_id - Access property list identifier for the link pointing to the object
!
! AUTHOR
! M. Scot Breitenfeld
! April 18, 2008
! SOURCE
SUBROUTINE h5oopen_f(loc_id, name, obj_id, hdferr, lapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
CHARACTER(LEN=*), INTENT(IN) :: name ! Path to the object, relative to loc_id
INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier for the opened object
INTEGER, INTENT(OUT) :: hdferr ! Error code
! Success: 0
! Failure: -1
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id ! Attribute access property list
!*****
INTEGER(HID_T) :: lapl_id_default
INTEGER(SIZE_T) :: namelen
INTERFACE
INTEGER FUNCTION h5oopen_c(loc_id, name, namelen, lapl_id_default, obj_id)
USE H5GLOBAL
!DEC$IF DEFINED(HDF5F90_WINDOWS)
!DEC$ATTRIBUTES C,reference,decorate,alias:'H5OOPEN_C'::h5oopen_c
!DEC$ENDIF
!DEC$ATTRIBUTES reference :: name
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER(HID_T) :: lapl_id_default
INTEGER(SIZE_T) :: namelen
INTEGER(HID_T), INTENT(OUT) :: obj_id
END FUNCTION h5oopen_c
END INTERFACE
namelen = LEN(name)
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
hdferr = h5oopen_c(loc_id, name, namelen, lapl_id_default, obj_id)
END SUBROUTINE h5oopen_f
!
!****s* H5O/h5oclose_f
!
! NAME
! h5oclose_f
!
! PURPOSE
! Closes an object in an HDF5 file.
!
! INPUTS
! object_id - Object identifier
! OUTPUTS
! hdferr - Returns 0 if successful and -1 if fails
!
! AUTHOR
! M. Scot Breitenfeld
! December 17, 2008
!
! SOURCE
SUBROUTINE h5oclose_f(object_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: object_id
INTEGER, INTENT(OUT) :: hdferr
!*****
INTERFACE
INTEGER FUNCTION h5oclose_c(object_id)
USE H5GLOBAL
!DEC$IF DEFINED(HDF5F90_WINDOWS)
!DEC$ATTRIBUTES C,reference,decorate,alias:'H5OCLOSE_C'::h5oclose_c
!DEC$ENDIF
INTEGER(HID_T), INTENT(IN) :: object_id
END FUNCTION h5oclose_c
END INTERFACE
hdferr = h5oclose_c(object_id)
END SUBROUTINE h5oclose_f
!
!****s* H5O/h5open_by_addr_f
! NAME
! h5oopen_by_addr_f
!
! PURPOSE
! Opens an object using its address within an HDF5 file.
!
! INPUTS
! loc_id - File or group identifier
! addr - Object’s address in the file
! OUTPUTS:
! obj_id - Object identifier for the opened object
! hdferr - Returns 0 if successful and -1 if fails
!
! AUTHOR
! M. Scot Breitenfeld
! September 14, 2009
!
! SOURCE
SUBROUTINE h5oopen_by_addr_f(loc_id, addr, obj_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
INTEGER(HADDR_T), INTENT(IN) :: addr ! Object’s address in the file
INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier for the opened object
INTEGER, INTENT(OUT) :: hdferr ! Error code:
! 0 on success and -1 on failure
!*****
INTERFACE
INTEGER FUNCTION h5oopen_by_addr_c(loc_id, addr, obj_id)
USE H5GLOBAL
!DEC$IF DEFINED(HDF5F90_WINDOWS)
!DEC$ATTRIBUTES C,reference,decorate,alias:'H5OOPEN_BY_ADDR_C'::h5oopen_by_addr_c
!DEC$ENDIF
INTEGER(HID_T), INTENT(IN) :: loc_id
INTEGER(HADDR_T), INTENT(IN) :: addr
INTEGER(HID_T), INTENT(OUT) :: obj_id
END FUNCTION h5oopen_by_addr_c
END INTERFACE
hdferr = h5oopen_by_addr_c(loc_id, addr, obj_id)
END SUBROUTINE h5oopen_by_addr_f
END MODULE H5O
|
