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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
|
!> @defgroup FH5F Fortran File (H5F) Interface
!!
!! @see H5F, C-API
!!
!! @see @ref H5F_UG, User Guide
!!
!> @ingroup FH5F
!!
!! @brief This module contains Fortran interfaces for H5F functions.
!
! COPYRIGHT
! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
! Copyright by The HDF Group. *
! 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 COPYING file, which can be found at the root of the source code *
! distribution tree, or in https://www.hdfgroup.org/licenses. *
! If you do not have access to either file, you may request a copy from *
! help@hdfgroup.org. *
! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
!
! NOTES
! _____ __ __ _____ ____ _____ _______ _ _ _______
! |_ _| \/ | __ \ / __ \| __ \__ __|/\ | \ | |__ __|
! **** | | | \ / | |__) | | | | |__) | | | / \ | \| | | | ****
! **** | | | |\/| | ___/| | | | _ / | | / /\ \ | . ` | | | ****
! **** _| |_| | | | | | |__| | | \ \ | |/ ____ \| |\ | | | ****
! |_____|_| |_|_| \____/|_| \_\ |_/_/ \_\_| \_| |_|
!
! If you add a new H5F function you must add the function name to the
! Windows dll file 'hdf5_fortrandll.def.in' in the fortran/src directory.
! This is needed for Windows based operating systems.
!
MODULE H5F
USE, INTRINSIC :: ISO_C_BINDING, ONLY : C_PTR, C_CHAR, C_NULL_PTR
USE H5GLOBAL
IMPLICIT NONE
! Number of objects opened in H5open_f
INTEGER(SIZE_T) :: H5OPEN_NUM_OBJ
#ifndef H5_DOXYGEN
INTERFACE
INTEGER(C_INT) FUNCTION h5fis_accessible(name, &
access_prp_default) BIND(C,NAME='H5Fis_accessible')
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPORT :: C_INT
IMPLICIT NONE
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: name
INTEGER(HID_T), INTENT(IN), VALUE :: access_prp_default
END FUNCTION h5fis_accessible
END INTERFACE
#endif
CONTAINS
!>
!! \ingroup FH5F
!!
!! \brief Creates HDF5 files.
!!
!! \param name Name of the file to create.
!! \param access_flags File access flags. Allowable values are:
!! \li H5F_ACC_TRUNC_F
!! \li H5F_ACC_EXCL_F
!! \param file_id File identifier.
!! \param hdferr \fortran_error
!! \param creation_prp File creation property list identifier.
!! \param access_prp File access property list identifier.
!!
!! See C API: @ref H5Fcreate()
!!
SUBROUTINE h5fcreate_f(name, access_flags, file_id, hdferr, &
creation_prp, access_prp)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER, INTENT(IN) :: access_flags
INTEGER(HID_T), INTENT(OUT) :: file_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: creation_prp
INTEGER(HID_T), INTENT(IN), OPTIONAL :: access_prp
INTEGER(HID_T) :: creation_prp_default
INTEGER(HID_T) :: access_prp_default
CHARACTER(LEN=LEN_TRIM(name)+1,KIND=C_CHAR) :: c_name
INTERFACE
INTEGER(HID_T) FUNCTION H5Fcreate(name, access_flags, &
creation_prp_default, access_prp_default) BIND(C,NAME='H5Fcreate')
IMPORT :: C_CHAR
IMPORT :: HID_T
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: name
INTEGER, VALUE :: access_flags
INTEGER(HID_T), VALUE :: creation_prp_default
INTEGER(HID_T), VALUE :: access_prp_default
END FUNCTION H5Fcreate
END INTERFACE
c_name = TRIM(name)//C_NULL_CHAR
creation_prp_default = H5P_DEFAULT_F
access_prp_default = H5P_DEFAULT_F
IF (PRESENT(creation_prp)) creation_prp_default = creation_prp
IF (PRESENT(access_prp)) access_prp_default = access_prp
file_id = h5fcreate(c_name, access_flags, &
creation_prp_default, access_prp_default)
hdferr = 0
IF(file_id.LT.0) hdferr = -1
END SUBROUTINE h5fcreate_f
!>
!! \ingroup FH5F
!!
!! \brief Asynchronously creates HDF5 files.
!!
!! \param name Name of the file to create
!! \param access_flags File access flags. Allowable values are:
!! \li H5F_ACC_TRUNC_F
!! \li H5F_ACC_EXCL_F
!! \param file_id File identifier
!! \param es_id \es_id
!! \param hdferr \fortran_error
!! \param creation_prp File creation property list identifier
!! \param access_prp File access property list identifier
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Fcreate_async()
!!
SUBROUTINE h5fcreate_async_f(name, access_flags, file_id, es_id, hdferr, &
creation_prp, access_prp, file, func, line)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER, INTENT(IN) :: access_flags
INTEGER(HID_T), INTENT(OUT) :: file_id
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: creation_prp
INTEGER(HID_T), INTENT(IN), OPTIONAL :: access_prp
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , INTENT(IN), OPTIONAL :: line
INTEGER(HID_T) :: creation_prp_default
INTEGER(HID_T) :: access_prp_default
CHARACTER(LEN=LEN_TRIM(name)+1,KIND=C_CHAR) :: c_name
TYPE(C_PTR) :: file_default = C_NULL_PTR
TYPE(C_PTR) :: func_default = C_NULL_PTR
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER(HID_T) FUNCTION H5Fcreate_async(file, func, line, name, access_flags, &
creation_prp_default, access_prp_default, es_id) BIND(C,NAME='H5Fcreate_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
TYPE(C_PTR), VALUE :: file
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: name
INTEGER, VALUE :: access_flags
INTEGER(HID_T), VALUE :: creation_prp_default
INTEGER(HID_T), VALUE :: access_prp_default
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Fcreate_async
END INTERFACE
c_name = TRIM(name)//C_NULL_CHAR
creation_prp_default = H5P_DEFAULT_F
access_prp_default = H5P_DEFAULT_F
IF(PRESENT(creation_prp)) creation_prp_default = creation_prp
IF(PRESENT(access_prp)) access_prp_default = access_prp
IF(PRESENT(file)) file_default = file
IF(PRESENT(func)) func_default = func
IF(PRESENT(line)) line_default = INT(line, C_INT)
file_id = H5Fcreate_async(file_default, func_default, line_default, &
c_name, access_flags, creation_prp_default, access_prp_default, es_id)
hdferr = 0
IF(file_id.LT.0) hdferr = -1
END SUBROUTINE h5fcreate_async_f
!>
!! \ingroup FH5F
!!
!! \brief Flushes all buffers associated with a file to disk.
!!
!! \param object_id Identifier of object used to identify the file.
!! \param scope Specifies the scope of the flushing action. Possible values are:
!! \li H5F_SCOPE_GLOBAL_F
!! \li H5F_SCOPE_LOCAL_F
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fflush()
!!
SUBROUTINE h5fflush_f(object_id, scope, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: object_id
INTEGER, INTENT(IN) :: scope
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION H5Fflush(object_id, scope) BIND(C,NAME='H5Fflush')
IMPORT :: C_INT
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), VALUE :: object_id
INTEGER(C_INT), VALUE :: scope
END FUNCTION H5Fflush
END INTERFACE
hdferr = H5Fflush(object_id, INT(scope, C_INT))
END SUBROUTINE h5fflush_f
!>
!! \ingroup FH5F
!!
!! \brief Asynchronously flushes all buffers associated with a file to disk.
!!
!! \param object_id Identifier of object used to identify the file.
!! \param scope Specifies the scope of the flushing action. Possible values are:
!! \li H5F_SCOPE_GLOBAL_F
!! \li H5F_SCOPE_LOCAL_F
!! \param es_id \es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Fflush_async()
!!
SUBROUTINE h5fflush_async_f(object_id, scope, es_id, hdferr, file, func, line)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: object_id
INTEGER, INTENT(IN) :: scope
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER, INTENT(OUT) :: hdferr
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , INTENT(IN), OPTIONAL :: line
TYPE(C_PTR) :: file_default = C_NULL_PTR
TYPE(C_PTR) :: func_default = C_NULL_PTR
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER FUNCTION H5Fflush_async(file, func, line, object_id, scope, es_id) &
BIND(C,NAME='H5Fflush_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
TYPE(C_PTR), VALUE :: file
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
INTEGER(HID_T), VALUE :: object_id
INTEGER(C_INT), VALUE :: scope
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Fflush_async
END INTERFACE
IF(PRESENT(file)) file_default = file
IF(PRESENT(func)) func_default = func
IF(PRESENT(line)) line_default = INT(line, C_INT)
hdferr = H5Fflush_async(file_default, func_default, line_default, &
object_id, INT(scope, C_INT), es_id)
END SUBROUTINE h5fflush_async_f
!>
!! \ingroup FH5F
!!
!! \brief Mounts a file.
!!
!! \param loc_id The identifier for of file or group in which name is defined.
!! \param name The name of the group onto which the file specified by child_id is to be mounted.
!! \param child_id The identifier of the file to be mounted.
!! \param hdferr \fortran_error
!! \param access_prp The identifier of the property list to be used.
!!
!! See C API: @ref H5Fmount()
!!
SUBROUTINE h5fmount_f(loc_id, name, child_id, hdferr, access_prp)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER(HID_T), INTENT(IN) :: child_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: access_prp
INTEGER(HID_T) :: access_prp_default
INTEGER :: namelen ! Length of the name character string
INTERFACE
INTEGER FUNCTION h5fmount_c(loc_id, name, namelen, &
child_id, access_prp_default) BIND(C,NAME='h5fmount_c')
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: name
INTEGER(HID_T), INTENT(IN) :: child_id
INTEGER(HID_T), INTENT(IN) :: access_prp_default
INTEGER :: namelen
END FUNCTION h5fmount_c
END INTERFACE
access_prp_default = H5P_DEFAULT_F
IF (PRESENT(access_prp)) access_prp_default = access_prp
namelen = LEN_TRIM(name)
hdferr = h5fmount_c(loc_id, name, namelen, child_id, access_prp_default)
END SUBROUTINE h5fmount_f
!>
!! \ingroup FH5F
!!
!! \brief Unmounts a file.
!!
!! \param loc_id The identifier for of file or group in which name is defined.
!! \param name The name of the mount point.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Funmount()
!!
SUBROUTINE h5funmount_f(loc_id, name, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER, INTENT(OUT) :: hdferr
INTEGER :: namelen ! Length of the name character string
INTERFACE
INTEGER FUNCTION h5funmount_c(loc_id, name, namelen) BIND(C,NAME='h5funmount_c')
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: name
INTEGER :: namelen
END FUNCTION h5funmount_c
END INTERFACE
namelen = LEN_TRIM(name)
hdferr = h5funmount_c(loc_id, name, namelen)
END SUBROUTINE h5funmount_f
!>
!! \ingroup FH5F
!!
!! \brief Opens HDF5 file.
!!
!! \param name Name of the file to acecss.
!! \param access_flags File access flags. Allowable values are:
!! \li H5F_ACC_RDWR_F
!! \li H5F_ACC_RDONLY_F
!! \param file_id File identifier.
!! \param hdferr \fortran_error
!! \param access_prp File access property list identifier.
!!
!! See C API: @ref H5Fopen()
!!
SUBROUTINE h5fopen_f(name, access_flags, file_id, hdferr, access_prp)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER, INTENT(IN) :: access_flags
INTEGER(HID_T), INTENT(OUT) :: file_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: access_prp
INTEGER(HID_T) :: access_prp_default
CHARACTER(LEN=LEN_TRIM(name)+1,KIND=C_CHAR) :: c_name
INTERFACE
INTEGER(HID_T) FUNCTION H5Fopen(name, access_flags, access_prp_default) &
BIND(C,NAME='H5Fopen')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: name
INTEGER(C_INT), VALUE :: access_flags
INTEGER(HID_T), VALUE :: access_prp_default
END FUNCTION H5Fopen
END INTERFACE
c_name = TRIM(name)//C_NULL_CHAR
access_prp_default = H5P_DEFAULT_F
IF(PRESENT(access_prp)) access_prp_default = access_prp
file_id = H5Fopen(c_name, INT(access_flags, C_INT), access_prp_default)
hdferr = 0
IF(file_id.LT.0) hdferr = -1
END SUBROUTINE h5fopen_f
!>
!! \ingroup FH5F
!!
!! \brief Asynchronously opens HDF5 file.
!!
!! \param name Name of the file to acecss.
!! \param access_flags File access flags. Allowable values are:
!! \li H5F_ACC_RDWR_F
!! \li H5F_ACC_RDONLY_F
!! \param file_id File identifier
!! \param es_id \es_id
!! \param hdferr \fortran_error
!! \param access_prp File access property list identifier
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Fopen_async()
!!
SUBROUTINE h5fopen_async_f(name, access_flags, file_id, es_id, hdferr, &
access_prp, file, func, line)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER, INTENT(IN) :: access_flags
INTEGER(HID_T), INTENT(OUT) :: file_id
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: access_prp
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , INTENT(IN), OPTIONAL :: line
INTEGER(HID_T) :: access_prp_default
CHARACTER(LEN=LEN_TRIM(name)+1,KIND=C_CHAR) :: c_name
TYPE(C_PTR) :: file_default = C_NULL_PTR
TYPE(C_PTR) :: func_default = C_NULL_PTR
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER(HID_T) FUNCTION H5Fopen_async(file, func, line, name, access_flags, access_prp_default, es_id) &
BIND(C,NAME='H5Fopen_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
TYPE(C_PTR), VALUE :: file
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: name
INTEGER(C_INT), VALUE :: access_flags
INTEGER(HID_T), VALUE :: access_prp_default
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Fopen_async
END INTERFACE
c_name = TRIM(name)//C_NULL_CHAR
access_prp_default = H5P_DEFAULT_F
IF(PRESENT(access_prp)) access_prp_default = access_prp
IF(PRESENT(file)) file_default = file
IF(PRESENT(func)) func_default = func
IF(PRESENT(line)) line_default = INT(line, C_INT)
file_id = H5Fopen_async(file_default, func_default, line_default, &
c_name, INT(access_flags, C_INT), access_prp_default, es_id)
hdferr = 0
IF(file_id.LT.0) hdferr = -1
END SUBROUTINE h5fopen_async_f
!>
!! \ingroup FH5F
!!
!! \brief Reopens HDF5 file.
!!
!! \param file_id Identifier of a file for which an additional identifier is required.
!! \param ret_file_id New file identifier.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Freopen()
!!
SUBROUTINE h5freopen_f(file_id, ret_file_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER(HID_T), INTENT(OUT) :: ret_file_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER(HID_T) FUNCTION H5Freopen(file_id) BIND(C,NAME='H5Freopen')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), VALUE :: file_id
END FUNCTION H5Freopen
END INTERFACE
ret_file_id = h5freopen(file_id)
hdferr = 0
IF(ret_file_id.LT.0) hdferr = -1
END SUBROUTINE h5freopen_f
!>
!! \ingroup FH5F
!!
!! \brief Asynchronously reopens HDF5 file.
!!
!! \param file_id Identifier of a file for which an additional identifier is required.
!! \param ret_file_id New file identifier.
!! \param es_id \es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Freopen_async()
!!
SUBROUTINE h5freopen_async_f(file_id, ret_file_id, es_id, hdferr, file, func, line)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER(HID_T), INTENT(OUT) :: ret_file_id
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER, INTENT(OUT) :: hdferr
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , INTENT(IN), OPTIONAL :: line
TYPE(C_PTR) :: file_default = C_NULL_PTR
TYPE(C_PTR) :: func_default = C_NULL_PTR
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER(HID_T) FUNCTION H5Freopen_async(file, func, line, file_id, es_id) &
BIND(C,NAME='H5Freopen_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
TYPE(C_PTR), VALUE :: file
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
INTEGER(HID_T), VALUE :: file_id
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Freopen_async
END INTERFACE
IF(PRESENT(file)) file_default = file
IF(PRESENT(func)) func_default = func
IF(PRESENT(line)) line_default = INT(line, C_INT)
ret_file_id = h5freopen_async(file_default, func_default, line_default, file_id, es_id)
hdferr = 0
IF(ret_file_id.LT.0) hdferr = -1
END SUBROUTINE h5freopen_async_f
!>
!! \ingroup FH5F
!!
!! \brief Returns a file creation property list identifier.
!!
!! \param file_id Identifier of a file to creation property list of.
!! \param prop_id Creation property list identifier.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fget_create_plist()
!!
SUBROUTINE h5fget_create_plist_f(file_id, prop_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER(HID_T), INTENT(OUT) :: prop_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5fget_create_plist_c(file_id, prop_id) BIND(C,NAME='h5fget_create_plist_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER(HID_T), INTENT(OUT) :: prop_id
END FUNCTION h5fget_create_plist_c
END INTERFACE
hdferr = h5fget_create_plist_c(file_id, prop_id)
END SUBROUTINE h5fget_create_plist_f
!>
!! \ingroup FH5F
!!
!! \brief Returns a file access property list identifier.
!!
!! \param file_id Identifier of a file to creation property list of.
!! \param access_id Access property list identifier.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fget_access_plist()
!!
SUBROUTINE h5fget_access_plist_f(file_id, access_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER(HID_T), INTENT(OUT) :: access_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5fget_access_plist_c(file_id, access_id) BIND(C,NAME='h5fget_access_plist_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER(HID_T), INTENT(OUT) :: access_id
END FUNCTION h5fget_access_plist_c
END INTERFACE
hdferr = h5fget_access_plist_c(file_id, access_id)
END SUBROUTINE h5fget_access_plist_f
!>
!! \ingroup FH5F
!!
!! \brief Determines whether a file can be accessed as HDF5.
!!
!! \param name Name of the file to check.
!! \param status Indicates if file is and HDF5 file.
!! \param hdferr \fortran_error
!! \param access_prp File access property list identifier.
!!
!! See C API: @ref H5Fis_accessible()
!!
SUBROUTINE h5fis_accessible_f(name, status, hdferr, access_prp)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: name
LOGICAL, INTENT(OUT) :: status
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: access_prp
INTEGER(HID_T) :: access_prp_default
CHARACTER(LEN=LEN_TRIM(name)+1,KIND=C_CHAR) :: c_name
INTEGER(C_INT) :: flag ! "TRUE/FALSE/ERROR" flag from C routine
access_prp_default = H5P_DEFAULT_F
IF (PRESENT(access_prp)) access_prp_default = access_prp
c_name = TRIM(name)//C_NULL_CHAR
flag = H5Fis_accessible(c_name, access_prp_default)
hdferr = 0
IF(flag.LT.0) hdferr = -1
status = .TRUE.
IF (flag .EQ. 0) status = .FALSE.
END SUBROUTINE h5fis_accessible_f
! XXX (VOL_MERGE): This function should probably be marked as
! deprecated since H5Fis_hdf5() is deprecated.
!>
!! \ingroup FH5F
!!
!! \brief Determines whether a file is in the HDF5 format.
!!
!! \param name Name of the file to check.
!! \param status Indicates if file is and HDF5 file.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fis_hdf5()
!!
SUBROUTINE h5fis_hdf5_f(name, status, hdferr)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: name
LOGICAL, INTENT(OUT) :: status
INTEGER, INTENT(OUT) :: hdferr
CHARACTER(LEN=LEN_TRIM(name)+1,KIND=C_CHAR) :: c_name
INTEGER(C_INT) :: flag ! "TRUE/FALSE/ERROR" flag from C routine
! to define status value.
c_name = TRIM(name)//C_NULL_CHAR
flag = H5Fis_accessible(c_name, H5P_DEFAULT_F)
hdferr = 0
IF(flag.LT.0) hdferr = -1
status = .TRUE.
IF (flag .EQ. 0) status = .FALSE.
END SUBROUTINE h5fis_hdf5_f
!>
!! \ingroup FH5F
!!
!! \brief Closes HDF5 file.
!!
!! \param file_id File identifier.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fclose()
!!
SUBROUTINE h5fclose_f(file_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER(C_INT) FUNCTION H5Fclose(file_id) BIND(C,NAME='H5Fclose')
IMPORT :: C_INT
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), VALUE :: file_id
END FUNCTION H5Fclose
END INTERFACE
hdferr = INT(H5Fclose(file_id))
END SUBROUTINE h5fclose_f
!>
!! \ingroup FH5F
!!
!! \brief Asynchronously closes HDF5 file.
!!
!! \param file_id File identifier
!! \param es_id \es_id
!! \param hdferr \fortran_error
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Fclose_async()
!!
SUBROUTINE h5fclose_async_f(file_id, es_id, hdferr, file, func, line)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER, INTENT(OUT) :: hdferr
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , INTENT(IN), OPTIONAL :: line
TYPE(C_PTR) :: file_default = C_NULL_PTR
TYPE(C_PTR) :: func_default = C_NULL_PTR
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER(C_INT) FUNCTION H5Fclose_async(file, func, line, file_id, es_id) &
BIND(C,NAME='H5Fclose_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
TYPE(C_PTR), VALUE :: file
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
INTEGER(HID_T), VALUE :: file_id
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Fclose_async
END INTERFACE
IF(PRESENT(file)) file_default = file
IF(PRESENT(func)) func_default = func
IF(PRESENT(line)) line_default = INT(line, C_INT)
hdferr = INT(H5Fclose_async(file_default, func_default, line_default, file_id, es_id))
END SUBROUTINE h5fclose_async_f
!>
!! \ingroup FH5F
!!
!! \brief Gets number of the objects open within a file
!!
!! \param file_id File identifier.
!! \param obj_type Type of the object; possible values are:
!! \li H5F_OBJ_FILE_F
!! \li H5F_OBJ_DATASET_F
!! \li H5F_OBJ_GROUP_F
!! \li H5F_OBJ_DATATYPE_F
!! \li H5F_OBJ_ALL_F
!! \param obj_count Number of open objects.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fget_obj_count()
!!
SUBROUTINE h5fget_obj_count_f(file_id, obj_type, obj_count, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER, INTENT(IN) :: obj_type
INTEGER(SIZE_T), INTENT(OUT) :: obj_count
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5fget_obj_count_c(file_id, obj_type, obj_count) BIND(C,NAME='h5fget_obj_count_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER, INTENT(IN) :: obj_type
INTEGER(SIZE_T), INTENT(OUT) :: obj_count
END FUNCTION h5fget_obj_count_c
END INTERFACE
hdferr = h5fget_obj_count_c(file_id, obj_type, obj_count)
! Don't include objects created by H5open in the H5F_OBJ_ALL_F count
IF(file_id.EQ.INT(H5F_OBJ_ALL_F,HID_T))THEN
obj_count = obj_count - H5OPEN_NUM_OBJ
ENDIF
END SUBROUTINE h5fget_obj_count_f
!>
!! \ingroup FH5F
!!
!! \brief Get list of open objects identifiers within a file
!!
!! \param file_id File identifier.
!! \param obj_type Type of the object; possible values are:
!! \li H5F_OBJ_FILE_F
!! \li H5F_OBJ_DATASET_F
!! \li H5F_OBJ_GROUP_F
!! \li H5F_OBJ_DATATYPE_F
!! \li H5F_OBJ_ALL_F
!! \param max_objs Maximum # of objects to retrieve.
!! \param obj_ids Array of open object identifiers.
!! \param hdferr \fortran_error
!! \param num_objs Number of open objects.
!!
!! See C API: @ref H5Fget_obj_ids()
!!
SUBROUTINE h5fget_obj_ids_f(file_id, obj_type, max_objs, obj_ids, hdferr, num_objs)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER, INTENT(IN) :: obj_type
INTEGER(SIZE_T), INTENT(IN) :: max_objs
INTEGER(HID_T), DIMENSION(*), INTENT(INOUT) :: obj_ids
INTEGER, INTENT(OUT) :: hdferr
INTEGER(SIZE_T), INTENT(OUT), OPTIONAL :: num_objs
INTEGER(SIZE_T) :: c_num_objs ! Number of open objects of the specified type
INTERFACE
INTEGER FUNCTION h5fget_obj_ids_c(file_id, obj_type, max_objs, obj_ids, c_num_objs) &
BIND(C,NAME='h5fget_obj_ids_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER, INTENT(IN) :: obj_type
INTEGER(SIZE_T), INTENT(IN) :: max_objs
INTEGER(HID_T), DIMENSION(*), INTENT(INOUT) :: obj_ids
INTEGER(SIZE_T), INTENT(OUT) :: c_num_objs
END FUNCTION h5fget_obj_ids_c
END INTERFACE
hdferr = h5fget_obj_ids_c(file_id, obj_type, max_objs, obj_ids, c_num_objs)
IF (PRESENT(num_objs)) num_objs= c_num_objs
END SUBROUTINE h5fget_obj_ids_f
!>
!! \ingroup FH5F
!!
!! \brief Get amount of free space within a file.
!!
!! \param file_id File identifier.
!! \param free_space Amount of free space in file.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fget_freespace()
!!
SUBROUTINE h5fget_freespace_f(file_id, free_space, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER(HSSIZE_T), INTENT(OUT) :: free_space
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5fget_freespace_c(file_id, free_space) &
BIND(C,NAME='h5fget_freespace_c')
IMPORT :: HID_T, HSSIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER(HSSIZE_T), INTENT(OUT) :: free_space
END FUNCTION h5fget_freespace_c
END INTERFACE
hdferr = h5fget_freespace_c(file_id, free_space)
END SUBROUTINE h5fget_freespace_f
!>
!! \ingroup FH5F
!!
!! \brief Gets the name of the file from the object identifier.
!!
!! \param obj_id Object identifier.
!! \param buf Buffer to store the read name.
!! \param size Actual size of the name.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fget_name()
!!
SUBROUTINE h5fget_name_f(obj_id, buf, size, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: obj_id
CHARACTER(LEN=*), INTENT(OUT) :: buf
INTEGER(SIZE_T), INTENT(OUT) :: size
INTEGER, INTENT(OUT) :: hdferr
INTEGER(SIZE_T) :: buflen
INTERFACE
INTEGER FUNCTION h5fget_name_c(obj_id, size, buf, buflen) &
BIND(C,NAME='h5fget_name_c')
IMPORT :: C_CHAR
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: obj_id
INTEGER(SIZE_T), INTENT(OUT) :: size
INTEGER(SIZE_T) :: buflen
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(OUT) :: buf
END FUNCTION h5fget_name_c
END INTERFACE
buflen = LEN(buf)
hdferr = h5fget_name_c(obj_id, size, buf, buflen)
END SUBROUTINE h5fget_name_f
!>
!! \ingroup FH5F
!!
!! \brief Retrieves the file size of the HDF5 file.
!!
!! \param file_id File identifier.
!! \param size File size.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fget_filesize()
!!
SUBROUTINE h5fget_filesize_f(file_id, size, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER(HSIZE_T), INTENT(OUT) :: size
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5fget_filesize_c(file_id, size) &
BIND(C,NAME='h5fget_filesize_c')
IMPORT :: HID_T, HSIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER(HSIZE_T), INTENT(OUT) :: size
END FUNCTION h5fget_filesize_c
END INTERFACE
hdferr = h5fget_filesize_c(file_id, size)
END SUBROUTINE h5fget_filesize_f
!>
!! \ingroup FH5F
!!
!! \brief Retrieves the file number of the HDF5 file.
!!
!! \param file_id File identifier.
!! \param fileno File number.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fget_fileno()
!!
SUBROUTINE h5fget_fileno_f(file_id, fileno, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER, INTENT(OUT) :: fileno
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5fget_fileno_c(file_id, fileno) &
BIND(C,NAME='h5fget_fileno_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id
INTEGER, INTENT(OUT) :: fileno
END FUNCTION h5fget_fileno_c
END INTERFACE
hdferr = h5fget_fileno_c(file_id, fileno)
END SUBROUTINE h5fget_fileno_f
!>
!! \ingroup FH5F
!!
!! \brief Retrieves a copy of the image of an existing, open file.
!!
!! \param file_id Target file identifier.
!! \param buf_ptr Pointer to the buffer into which the image of the HDF5 file is to be copied.
!! \param buf_len Size of the supplied buffer.
!! \param hdferr \fortran_error
!! \param buf_size Returns the size in bytes of the buffer required to store the file image, no data will be copied.
!!
!! See C API: @ref H5Fget_file_image()
!!
SUBROUTINE h5fget_file_image_f(file_id, buf_ptr, buf_len, hdferr, buf_size)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: file_id
TYPE(C_PTR) , INTENT(INOUT) :: buf_ptr
INTEGER(SIZE_T), INTENT(IN) :: buf_len
INTEGER , INTENT(OUT) :: hdferr
INTEGER(SIZE_T), INTENT(OUT) , OPTIONAL :: buf_size
INTEGER(SIZE_T) :: buf_size_default
INTERFACE
INTEGER FUNCTION h5fget_file_image_c(file_id, buf_ptr, buf_len, buf_size) BIND(C, NAME='h5fget_file_image_c')
IMPORT :: C_PTR
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: file_id
TYPE(C_PTR) , VALUE :: buf_ptr
INTEGER(SIZE_T), INTENT(IN) :: buf_len
INTEGER(SIZE_T), INTENT(OUT) :: buf_size
END FUNCTION h5fget_file_image_c
END INTERFACE
IF(PRESENT(buf_size))THEN
buf_ptr = C_NULL_PTR
ENDIF
hdferr = h5fget_file_image_c(file_id, buf_ptr, buf_len, buf_size_default)
IF(PRESENT(buf_size))THEN
buf_size = buf_size_default
ENDIF
END SUBROUTINE h5fget_file_image_f
!>
!! \ingroup FH5F
!!
!! \brief Gets the value of the "minimize dataset headers" value which creates
!! smaller dataset object headers when its set and no attributes are present.
!!
!! \param file_id Target file identifier.
!! \param minimize Value of the setting.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fget_dset_no_attrs_hint()
!!
SUBROUTINE h5fget_dset_no_attrs_hint_f(file_id, minimize, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: file_id
LOGICAL , INTENT(OUT) :: minimize
INTEGER , INTENT(OUT) :: hdferr
LOGICAL(C_BOOL) :: c_minimize
INTERFACE
INTEGER FUNCTION h5fget_dset_no_attrs_hint_c(file_id, minimize) BIND(C, NAME='H5Fget_dset_no_attrs_hint')
IMPORT :: HID_T, C_BOOL
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN), VALUE :: file_id
LOGICAL(C_BOOL), INTENT(OUT) :: minimize
END FUNCTION h5fget_dset_no_attrs_hint_c
END INTERFACE
hdferr = INT(h5fget_dset_no_attrs_hint_c(file_id, c_minimize))
! Transfer value of C C_BOOL type to Fortran LOGICAL
minimize = c_minimize
END SUBROUTINE h5fget_dset_no_attrs_hint_f
!>
!! \ingroup FH5F
!!
!! \brief Sets the value of the "minimize dataset headers" value which creates
!! smaller dataset object headers when its set and no attributes are present.
!!
!! \param file_id Target file identifier.
!! \param minimize Value of the setting.
!! \param hdferr \fortran_error
!!
!! See C API: @ref H5Fset_dset_no_attrs_hint()
!!
SUBROUTINE h5fset_dset_no_attrs_hint_f(file_id, minimize, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: file_id
LOGICAL , INTENT(IN) :: minimize
INTEGER , INTENT(OUT) :: hdferr
LOGICAL(C_BOOL) :: c_minimize
INTERFACE
INTEGER FUNCTION h5fset_dset_no_attrs_hint_c(file_id, minimize) BIND(C, NAME='H5Fset_dset_no_attrs_hint')
IMPORT :: HID_T, C_BOOL
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN), VALUE :: file_id
LOGICAL(C_BOOL), INTENT(IN), VALUE :: minimize
END FUNCTION h5fset_dset_no_attrs_hint_c
END INTERFACE
! Transfer value of Fortran LOGICAL to C C_BOOL type
c_minimize = minimize
hdferr = INT(h5fset_dset_no_attrs_hint_c(file_id, c_minimize))
END SUBROUTINE h5fset_dset_no_attrs_hint_f
END MODULE H5F
|