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
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
|
!> @defgroup FH5T Fortran Datatype (H5T) Interface
!!
!! @see H5T, C-API
!!
!! @see @ref H5T_UG, User Guide
!!
!> @ingroup FH5T
!!
!! @brief This module contains Fortran interfaces for H5T functions.
!
! 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 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 function here then 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 H5T
USE, INTRINSIC :: ISO_C_BINDING, ONLY : C_PTR, C_CHAR, C_NULL_PTR
USE H5GLOBAL
IMPLICIT NONE
PRIVATE h5tenum_insert_f03, h5tenum_insert_f90
! Fortran2003 Derived Type:
TYPE hvl_t
INTEGER(size_t) :: len !< Length of VL data (in base type units)
TYPE(C_PTR) :: p !< Pointer to VL data
END TYPE hvl_t
#ifndef H5_DOXYGEN_FORTRAN
INTERFACE h5tenum_insert_f
MODULE PROCEDURE h5tenum_insert_f03
MODULE PROCEDURE h5tenum_insert_f90
END INTERFACE
#endif
CONTAINS
!>
!! \ingroup FH5T
!!
!! \brief Opens named datatype.
!!
!! \param loc_id Location identifier.
!! \param name A datatype name.
!! \param type_id Datatype identifier.
!! \param hdferr \fortran_error
!! \param tapl_id Datatype access property list identifier.
!!
SUBROUTINE h5topen_f(loc_id, name, type_id, hdferr, tapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER(HID_T), INTENT(OUT) :: type_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id
INTEGER :: namelen ! Name length
INTEGER(HID_T) :: tapl_id_default
INTERFACE
INTEGER FUNCTION h5topen_c(loc_id, name, namelen, type_id, tapl_id_default) BIND(C,NAME='h5topen_c')
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(KIND=C_CHAR), INTENT(IN) :: name
INTEGER :: namelen
INTEGER(HID_T), INTENT(OUT) :: type_id
INTEGER(HID_T) :: tapl_id_default
END FUNCTION h5topen_c
END INTERFACE
namelen = LEN(name)
tapl_id_default = H5P_DEFAULT_F
IF(PRESENT(tapl_id)) tapl_id_default = tapl_id
hdferr = h5topen_c(loc_id, name, namelen, type_id, tapl_id_default)
END SUBROUTINE h5topen_f
!>
!! \ingroup FH5T
!!
!! \brief Commits a transient datatype to a file, creating a new named datatype.
!!
!! \param loc_id Location identifier.
!! \param name Name of the datatype to be stored at the specified location
!! \param type_id Identifier of a datatype to be stored.
!! \param hdferr \fortran_error
!! \param lcpl_id Link creation property list.
!! \param tcpl_id Datatype creation property list.
!! \param tapl_id Datatype access property list.
!!
SUBROUTINE h5tcommit_f(loc_id, name, type_id, hdferr, &
lcpl_id, tcpl_id, tapl_id )
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tcpl_id
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id
INTEGER :: namelen ! Name length
INTEGER(HID_T) :: lcpl_id_default
INTEGER(HID_T) :: tcpl_id_default
INTEGER(HID_T) :: tapl_id_default
INTERFACE
INTEGER FUNCTION h5tcommit_c(loc_id, name, namelen, type_id, &
lcpl_id_default, tcpl_id_default, tapl_id_default ) BIND(C,NAME='h5tcommit_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
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HID_T) :: lcpl_id_default
INTEGER(HID_T) :: tcpl_id_default
INTEGER(HID_T) :: tapl_id_default
END FUNCTION h5tcommit_c
END INTERFACE
lcpl_id_default = H5P_DEFAULT_F
tcpl_id_default = H5P_DEFAULT_F
tapl_id_default = H5P_DEFAULT_F
IF (PRESENT(lcpl_id)) lcpl_id_default = lcpl_id
IF (PRESENT(tcpl_id)) tcpl_id_default = tcpl_id
IF (PRESENT(tapl_id)) tapl_id_default = tapl_id
namelen = LEN(name)
hdferr = h5tcommit_c(loc_id, name, namelen, type_id, &
lcpl_id_default, tcpl_id_default, tapl_id_default )
END SUBROUTINE h5tcommit_f
!>
!! \ingroup FH5T
!!
!! \brief Creates a copy of existing datatype.
!!
!! \param type_id Datatype identifier.
!! \param new_type_id Identifier of datatype's copy.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tcopy_f(type_id, new_type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HID_T), INTENT(OUT) :: new_type_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tcopy_c(type_id, new_type_id) BIND(C,NAME='h5tcopy_c')
IMPORT :: HID_T
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HID_T), INTENT(OUT) :: new_type_id
END FUNCTION h5tcopy_c
END INTERFACE
hdferr = h5tcopy_c(type_id, new_type_id)
END SUBROUTINE h5tcopy_f
!>
!! \ingroup FH5T
!!
!! \brief Determines whether two datatype identifiers refer to the same datatype.
!!
!! \param type1_id Datatype identifier.
!! \param type2_id Datatype identifier.
!! \param flag TRUE/FALSE flag to indicate if two datatypes are equal.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tequal_f(type1_id, type2_id, flag, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type1_id
INTEGER(HID_T), INTENT(IN) :: type2_id
LOGICAL, INTENT(OUT) :: flag
INTEGER, INTENT(OUT) :: hdferr
INTEGER :: c_flag
INTERFACE
INTEGER FUNCTION h5tequal_c(type1_id, type2_id, c_flag) BIND(C,NAME='h5tequal_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type1_id
INTEGER(HID_T), INTENT(IN) :: type2_id
INTEGER :: c_flag
END FUNCTION h5tequal_c
END INTERFACE
flag = .FALSE.
hdferr = h5tequal_c(type1_id, type2_id, c_flag)
IF(c_flag .GT. 0) flag = .TRUE.
END SUBROUTINE h5tequal_f
!>
!! \ingroup FH5T
!!
!! \brief Releases a datatype.
!!
!! \param type_id Datatype identifier.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tclose_f(type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tclose_c(type_id) BIND(C,NAME='h5tclose_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
END FUNCTION h5tclose_c
END INTERFACE
hdferr = h5tclose_c(type_id)
END SUBROUTINE h5tclose_f
!>
!! \ingroup FH5T
!!
!! \brief Returns the datatype class identifier.
!!
!! \param type_id Datatype identifier.
!! \param class Class, possible values are:
!! \li H5T_NO_CLASS_F
!! \li H5T_INTEGER_F
!! \li H5T_FLOAT_F
!! \li H5T_TIME_F
!! \li H5T_STRING_F
!! \li H5T_BITFIELD_F
!! \li H5T_OPAQUE_F
!! \li H5T_COMPOUND_F
!! \li H5T_REFERENCE_F
!! \li H5T_ENUM_F
!! \li H5T_VLEN_F
!! \li H5T_ARRAY_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_class_f(type_id, class, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: class
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_class_c(type_id, class) BIND(C,NAME='h5tget_class_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: class
END FUNCTION h5tget_class_c
END INTERFACE
hdferr = h5tget_class_c(type_id, class)
END SUBROUTINE h5tget_class_f
!>
!! \ingroup FH5T
!!
!! \brief Returns the size of a datatype.
!!
!! \param type_id Datatype identifier.
!! \param size Datatype size.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_size_f(type_id, size, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: size
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_size_c(type_id, size) BIND(C,NAME='h5tget_size_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: size
END FUNCTION h5tget_size_c
END INTERFACE
hdferr = h5tget_size_c(type_id, size)
END SUBROUTINE h5tget_size_f
!>
!! \ingroup FH5T
!!
!! \brief Sets the total size for an atomic datatype.
!!
!! \param type_id Datatype identifier.
!! \param size Size of the datatype.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_size_f(type_id, size, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: size
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_size_c(type_id, size) BIND(C,NAME='h5tset_size_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: size
END FUNCTION h5tset_size_c
END INTERFACE
hdferr = h5tset_size_c(type_id, size)
END SUBROUTINE h5tset_size_f
!>
!! \ingroup FH5T
!!
!! \brief Returns the byte order of an atomic datatype.
!!
!! \param type_id Datatype identifier.
!! \param order Byte order for the datatype, possible values are:
!! \li H5T_ORDER_LE_F
!! \li H5T_ORDER_BE_F
!! \li H5T_ORDER_VAX_F (not implemented yet)
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_order_f(type_id, order, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: order
! H5T_ORDER_VAX_F
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_order_c(type_id, order) BIND(C,NAME='h5tget_order_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: order
END FUNCTION h5tget_order_c
END INTERFACE
hdferr = h5tget_order_c(type_id, order)
END SUBROUTINE h5tget_order_f
!>
!! \ingroup FH5T
!!
!! \brief Sets the byte ordering of an atomic datatype.
!!
!! \param type_id Datatype identifier.
!! \param order Datatype byte order Possible values are:
!! \li H5T_ORDER_LE_F
!! \li H5T_ORDER_BE_F
!! \li H5T_ORDER_VAX_F (not implemented yet)
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_order_f(type_id, order, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: order
! H5T_ORDER_VAX_F
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_order_c(type_id, order) BIND(C,NAME='h5tset_order_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: order
END FUNCTION h5tset_order_c
END INTERFACE
hdferr = h5tset_order_c(type_id, order)
END SUBROUTINE h5tset_order_f
!>
!! \ingroup FH5T
!!
!! \brief Returns the precision of an atomic datatype.
!!
!! \param type_id Datatype identifier.
!! \param precision Precision of the datatype.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_precision_f(type_id, PRECISION, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: precision
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_precision_c(type_id, PRECISION) BIND(C,NAME='h5tget_precision_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: PRECISION
END FUNCTION h5tget_precision_c
END INTERFACE
hdferr = h5tget_precision_c(type_id, PRECISION)
END SUBROUTINE h5tget_precision_f
!>
!! \ingroup FH5T
!!
!! \brief Sets the precision of an atomic datatype.
!!
!! \param type_id Datatype identifier.
!! \param precision Datatype precision.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_precision_f(type_id, PRECISION, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: PRECISION
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_precision_c (type_id, PRECISION) BIND(C,NAME='h5tset_precision_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: PRECISION
END FUNCTION h5tset_precision_c
END INTERFACE
hdferr = h5tset_precision_c(type_id, PRECISION)
END SUBROUTINE h5tset_precision_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves the bit offset of the first significant bit.
!!
!! \param type_id Datatype identifier.
!! \param offset Offset value.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_offset_f(type_id, offset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: offset
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_offset_c(type_id, offset) BIND(C,NAME='h5tget_offset_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: offset
END FUNCTION h5tget_offset_c
END INTERFACE
hdferr = h5tget_offset_c(type_id, offset)
END SUBROUTINE h5tget_offset_f
!>
!! \ingroup FH5T
!!
!! \brief Sets the bit offset of the first significant bit.
!!
!! \param type_id Datatype identifier.
!! \param offset Offset value.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_offset_f(type_id, offset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: offset
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_offset_c(type_id, offset) BIND(C,NAME='h5tset_offset_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: offset
END FUNCTION h5tset_offset_c
END INTERFACE
hdferr = h5tset_offset_c(type_id, offset)
END SUBROUTINE h5tset_offset_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves the padding type of the least and most-significant bit padding.
!!
!! \param type_id Datatype identifier.
!! \param lsbpad Least-significant bit padding type.
!! \param msbpad Most-significant bit padding type. Possible values are:
!! \li H5T_PAD_ERROR_F
!! \li H5T_PAD_ZERO_F
!! \li H5T_PAD_ONE_F
!! \li H5T_PAD_BACKGROUND_F
!! \li H5T_PAD_NPAD_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_pad_f(type_id, lsbpad, msbpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: lsbpad
INTEGER, INTENT(OUT) :: msbpad
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_pad_c(type_id, lsbpad, msbpad) BIND(C,NAME='h5tget_pad_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: lsbpad
INTEGER, INTENT(OUT) :: msbpad
END FUNCTION h5tget_pad_c
END INTERFACE
hdferr = h5tget_pad_c(type_id, lsbpad, msbpad)
END SUBROUTINE h5tget_pad_f
!>
!! \ingroup FH5T
!!
!! \brief Sets the least and most-significant bits padding types.
!!
!! \param type_id Datatype identifier.
!! \param lsbpad Least-significant bit padding type.
!! \param msbpad Most-significant bit padding type. Possible values are:
!! \li H5T_PAD_ERROR_F
!! \li H5T_PAD_ZERO_F
!! \li H5T_PAD_ONE_F
!! \li H5T_PAD_BACKGROUND_F
!! \li H5T_PAD_NPAD_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_pad_f(type_id, lsbpad, msbpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: lsbpad
INTEGER, INTENT(IN) :: msbpad
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_pad_c(type_id, lsbpad, msbpad) BIND(C,NAME='h5tset_pad_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: lsbpad
INTEGER, INTENT(IN) :: msbpad
END FUNCTION h5tset_pad_c
END INTERFACE
hdferr = h5tset_pad_c(type_id, lsbpad, msbpad)
END SUBROUTINE h5tset_pad_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves the sign type for an integer type.
!!
!! \param type_id Datatype identifier.
!! \param sign Sign type. Possible values are:
!! \li Unsigned integer type
!! H5T_SGN_NONE_F = 0
!! \li Two's complement signed integer type
!! H5T_SGN_2_F = 1
!! \li Error value
!! H5T_SGN_ERROR_F = -1
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_sign_f(type_id, sign, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: sign
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_sign_c(type_id, sign) BIND(C,NAME='h5tget_sign_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: sign
END FUNCTION h5tget_sign_c
END INTERFACE
hdferr = h5tget_sign_c(type_id, sign)
END SUBROUTINE h5tget_sign_f
!>
!! \ingroup FH5T
!!
!! \brief Sets the sign property for an integer type.
!!
!! \param type_id Datatype identifier.
!! \param sign Sign type. Possible values are:
!! \li Unsigned integer type
!! H5T_SGN_NONE_F = 0
!! \li Two's complement signed integer type
!! H5T_SGN_2_F = 1
!! \li Error value
!! H5T_SGN_ERROR_F = -1
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_sign_f(type_id, sign, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: sign
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_sign_c(type_id, sign) BIND(C,NAME='h5tset_sign_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: sign
END FUNCTION h5tset_sign_c
END INTERFACE
hdferr = h5tset_sign_c(type_id, sign)
END SUBROUTINE h5tset_sign_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves floating point datatype bit field information.
!!
!! \param type_id Datatype identifier.
!! \param spos Sign bit-position.
!! \param epos Exponent bit-position.
!! \param esize Size of exponent in bits.
!! \param mpos Mantissa position.
!! \param msize Size of mantissa in bits.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_fields_f(type_id, spos, epos, esize, mpos, msize, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: spos
INTEGER(SIZE_T), INTENT(OUT) :: epos
INTEGER(SIZE_T), INTENT(OUT) :: esize
INTEGER(SIZE_T), INTENT(OUT) :: mpos
INTEGER(SIZE_T), INTENT(OUT) :: msize
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_fields_c(type_id, spos, epos, esize, mpos, msize) &
BIND(C,NAME='h5tget_fields_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: spos
INTEGER(SIZE_T), INTENT(OUT) :: epos
INTEGER(SIZE_T), INTENT(OUT) :: esize
INTEGER(SIZE_T), INTENT(OUT) :: mpos
INTEGER(SIZE_T), INTENT(OUT) :: msize
END FUNCTION h5tget_fields_c
END INTERFACE
hdferr = h5tget_fields_c(type_id, spos, epos, esize, mpos, msize)
END SUBROUTINE h5tget_fields_f
!>
!! \ingroup FH5T
!!
!! \brief Sets locations and sizes of floating point bit fields.
!!
!! \param type_id Datatype identifier.
!! \param spos Sign bit-position.
!! \param epos Exponent bit-position.
!! \param esize Size of exponent in bits.
!! \param mpos Mantissa position.
!! \param msize Size of mantissa in bits.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_fields_f(type_id, spos, epos, esize, mpos, msize, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: spos
INTEGER(SIZE_T), INTENT(IN) :: epos
INTEGER(SIZE_T), INTENT(IN) :: esize
INTEGER(SIZE_T), INTENT(IN) :: mpos
INTEGER(SIZE_T), INTENT(IN) :: msize
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_fields_c(type_id, spos, epos, esize, mpos, msize) &
BIND(C,NAME='h5tset_fields_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: spos
INTEGER(SIZE_T), INTENT(IN) :: epos
INTEGER(SIZE_T), INTENT(IN) :: esize
INTEGER(SIZE_T), INTENT(IN) :: mpos
INTEGER(SIZE_T), INTENT(IN) :: msize
END FUNCTION h5tset_fields_c
END INTERFACE
hdferr = h5tset_fields_c(type_id, spos, epos, esize, mpos, msize)
END SUBROUTINE h5tset_fields_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves the exponent bias of a floating-point type.
!!
!! \param type_id Datatype identifier.
!! \param ebias Datatype exponent bias.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_ebias_f(type_id, ebias, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: ebias
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_ebias_c(type_id, ebias) BIND(C,NAME='h5tget_ebias_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(OUT) :: ebias
END FUNCTION h5tget_ebias_c
END INTERFACE
hdferr = h5tget_ebias_c(type_id, ebias)
END SUBROUTINE h5tget_ebias_f
!>
!! \ingroup FH5T
!!
!! \brief Sets the exponent bias of a floating-point type.
!!
!! \param type_id Datatype identifier.
!! \param ebias Datatype exponent bias.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_ebias_f(type_id, ebias, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: ebias
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_ebias_c(type_id, ebias) BIND(C,NAME='h5tset_ebias_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(SIZE_T), INTENT(IN) :: ebias
END FUNCTION h5tset_ebias_c
END INTERFACE
hdferr = h5tset_ebias_c(type_id, ebias)
END SUBROUTINE h5tset_ebias_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves mantissa normalization of a floating-point datatype.
!!
!! \param type_id Datatype identifier.
!! \param norm Normalization types, valid values are:
!! \li H5T_NORM_IMPLIED_F
!! \li H5T_NORM_MSBSET_F
!! \li H5T_NORM_NONE_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_norm_f(type_id, norm, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: norm
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_norm_c(type_id, norm) BIND(C,NAME='h5tget_norm_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: norm
END FUNCTION h5tget_norm_c
END INTERFACE
hdferr = h5tget_norm_c(type_id, norm)
END SUBROUTINE h5tget_norm_f
!>
!! \ingroup FH5T
!!
!! \brief Sets the mantissa normalization of a floating-point datatype.
!!
!! \param type_id Datatype identifier.
!! \param norm Normalization types, valid values are:
!! \li H5T_NORM_IMPLIED_F
!! \li H5T_NORM_MSBSET_F
!! \li H5T_NORM_NONE_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_norm_f(type_id, norm, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: norm
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_norm_c(type_id, norm) BIND(C,NAME='h5tset_norm_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: norm
END FUNCTION h5tset_norm_c
END INTERFACE
hdferr = h5tset_norm_c(type_id, norm)
END SUBROUTINE h5tset_norm_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves the internal padding type for unused bits in floating-point datatypes.
!!
!! \param type_id Datatype identifier.
!! \param padtype Padding type for unused bits. Possible values are:
!! \li H5T_PAD_ZERO_F
!! \li H5T_PAD_ONE_F
!! \li H5T_PAD_BACKGROUND_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_inpad_f(type_id, padtype, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: padtype
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_inpad_c(type_id, padtype) BIND(C,NAME='h5tget_inpad_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: padtype
END FUNCTION h5tget_inpad_c
END INTERFACE
hdferr = h5tget_inpad_c(type_id, padtype)
END SUBROUTINE h5tget_inpad_f
!>
!! \ingroup FH5T
!!
!! \brief Fills unused internal floating point bits.
!!
!! \param type_id Datatype identifier.
!! \param padtype Padding type for unused bits. Possible values are:
!! \li H5T_PAD_ZERO_F
!! \li H5T_PAD_ONE_F
!! \li H5T_PAD_BACKGROUND_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_inpad_f(type_id, padtype, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: padtype
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_inpad_c(type_id, padtype) BIND(C,NAME='h5tset_inpad_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: padtype
END FUNCTION h5tset_inpad_c
END INTERFACE
hdferr = h5tset_inpad_c(type_id, padtype)
END SUBROUTINE h5tset_inpad_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves the character set type of a string datatype.
!!
!! \param type_id Datatype identifier.
!! \param cset Character set type of a string datatype. Possible values are:
!! \li H5T_CSET_ASCII_F
!! \li H5T_CSET_UTF8_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_cset_f(type_id, cset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: cset
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_cset_c(type_id, cset) BIND(C,NAME='h5tget_cset_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: cset
END FUNCTION h5tget_cset_c
END INTERFACE
hdferr = h5tget_cset_c(type_id, cset)
END SUBROUTINE h5tget_cset_f
!>
!! \ingroup FH5T
!!
!! \brief Sets character set to be used.
!!
!! \param type_id Datatype identifier.
!! \param cset Character set type of a string datatype. Possible values are:
!! \li H5T_CSET_ASCII_F
!! \li H5T_CSET_UTF8_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_cset_f(type_id, cset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: cset
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_cset_c(type_id, cset) BIND(C,NAME='h5tset_cset_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: cset
END FUNCTION h5tset_cset_c
END INTERFACE
hdferr = h5tset_cset_c(type_id, cset)
END SUBROUTINE h5tset_cset_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves the storage mechanism for a string datatype.
!!
!! \param type_id Datatype identifier.
!! \param strpad Storage method for a string datatype. Possible values are:
!! \li H5T_STR_NULLTERM_F
!! \li H5T_STR_NULLPAD_F
!! \li H5T_STR_SPACEPAD_F
!! \li H5T_STR_ERROR_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_strpad_f(type_id, strpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: strpad
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_strpad_c(type_id, strpad) BIND(C,NAME='h5tget_strpad_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: strpad
END FUNCTION h5tget_strpad_c
END INTERFACE
hdferr = h5tget_strpad_c(type_id, strpad)
END SUBROUTINE h5tget_strpad_f
!>
!! \ingroup FH5T
!!
!! \brief Defines the storage mechanism for character strings.
!!
!! \param type_id Datatype identifier.
!! \param strpad Storage method for a string datatype. Possible values are:
!! \li H5T_STR_NULLTERM_F
!! \li H5T_STR_NULLPAD_F
!! \li H5T_STR_SPACEPAD_F
!! \li H5T_STR_ERROR_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_strpad_f(type_id, strpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: strpad
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tset_strpad_c(type_id, strpad) BIND(C,NAME='h5tset_strpad_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: strpad
END FUNCTION h5tset_strpad_c
END INTERFACE
hdferr = h5tset_strpad_c(type_id, strpad)
END SUBROUTINE h5tset_strpad_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves the number of fields in a compound datatype.
!!
!! \param type_id Datatype identifier.
!! \param num_members Number of members.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_nmembers_f(type_id, num_members, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: num_members
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_nmembers_c(type_id, num_members) BIND(C,NAME='h5tget_nmembers_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: num_members
END FUNCTION h5tget_nmembers_c
END INTERFACE
hdferr = h5tget_nmembers_c(type_id, num_members)
END SUBROUTINE h5tget_nmembers_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves the name of a field of a compound datatype.
!!
!! \param type_id Datatype identifier.
!! \param index Filed index (0-based).
!! \param member_name Buffer to hold member's name.
!! \param namelen Name length.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_member_name_f(type_id, index, member_name, namelen, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: index
CHARACTER(LEN=*), INTENT(OUT) :: member_name
INTEGER, INTENT(OUT) :: namelen
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_member_name_c(type_id, index, member_name, namelen) BIND(C,NAME='h5tget_member_name_c')
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: index
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(OUT) :: member_name
INTEGER, INTENT(OUT) :: namelen
END FUNCTION h5tget_member_name_c
END INTERFACE
hdferr = h5tget_member_name_c(type_id, index, member_name, namelen)
END SUBROUTINE h5tget_member_name_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves the offset of a field of a compound datatype.
!!
!! \param type_id Datatype identifier.
!! \param member_no Number of the field.
!! \param offset Byte offset of the requested field.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_member_offset_f(type_id, member_no, offset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: member_no
INTEGER(SIZE_T), INTENT(OUT) :: offset
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_member_offset_c(type_id, member_no, offset ) BIND(C,NAME='h5tget_member_offset_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: member_no
INTEGER(SIZE_T), INTENT(OUT) :: offset
END FUNCTION h5tget_member_offset_c
END INTERFACE
hdferr = h5tget_member_offset_c(type_id, member_no, offset )
END SUBROUTINE h5tget_member_offset_f
!>
!! \ingroup FH5T
!!
!! \brief Retrieves the index of a compound or enumeration datatype member.
!!
!! \param type_id Datatype identifier.
!! \param name Name of the field or member whose index to be retrieved from the datatype.
!! \param index Based index of the filed or member (0 to N-1).
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_member_index_f(type_id, name, index, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER, INTENT(OUT) :: index
INTEGER, INTENT(OUT) :: hdferr
INTEGER :: namelen ! Name length
INTERFACE
INTEGER FUNCTION h5tget_member_index_c(type_id, name, namelen, index) BIND(C,NAME='h5tget_member_index_c')
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: name
INTEGER, INTENT(IN) :: namelen
INTEGER, INTENT(OUT) :: index
END FUNCTION h5tget_member_index_c
END INTERFACE
namelen = LEN(name)
hdferr = h5tget_member_index_c(type_id, name, namelen, index)
END SUBROUTINE h5tget_member_index_f
! !$!
!>
!! !$!
!! !$! NAME
!! !$! h5tget_member_dim_f
!! !$!
!! !$! PURPOSE
!! !$! This function is not supported in hdf5-1.4.*
!! !$!
!! !$! INPUTS
!! !$! OUTPUTS
!! !$! hdferr: - error code
!! !$! Success: 0
!! !$! Failure: -1
!! !$!
!! !$! AUTHOR
!! !$! Elena Pourmal
!! !$! August 12, 1999
!! !$!
!! !$! HISTORY
!! !$! Explicit Fortran interfaces were added for
!! !$! called C functions (it is needed for Windows
!! !$! port). March 7, 2001
!! !$!
!! !$! SOURCE
! !$! SUBROUTINE h5tget_member_dims_f(type_id, field_idx,dims, field_dims, perm, hdferr)
! !$!
! !$! IMPLICIT NONE
! !$!
! !$! END SUBROUTINE h5tget_member_dims_f
!>
!! \ingroup FH5T
!!
!! \brief Returns sizes of array dimensions.
!!
!! \param type_id Array datatype identifier.
!! \param dims Buffer to store array datatype dimensions.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_array_dims_f(type_id, dims, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HSIZE_T),DIMENSION(*), INTENT(OUT) :: dims
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_array_dims_c(type_id, dims) BIND(C,NAME='h5tget_array_dims_c')
IMPORT :: HID_T, HSIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HSIZE_T),DIMENSION(*), INTENT(OUT) :: dims
END FUNCTION h5tget_array_dims_c
END INTERFACE
hdferr = h5tget_array_dims_c(type_id, dims)
END SUBROUTINE h5tget_array_dims_f
!>
!! \ingroup FH5T
!!
!! \brief Returns the rank of an array datatype.
!!
!! \param type_id Array datatype identifier.
!! \param ndims Number of array dimensions.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_array_ndims_f(type_id, ndims, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: ndims
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_array_ndims_c(type_id, ndims) BIND(C,NAME='h5tget_array_ndims_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: ndims
END FUNCTION h5tget_array_ndims_c
END INTERFACE
hdferr = h5tget_array_ndims_c(type_id, ndims)
END SUBROUTINE h5tget_array_ndims_f
!>
!! \ingroup FH5T
!!
!! \brief Returns the base datatype from which a datatype is derived.
!!
!! \param type_id Datatype identifier.
!! \param base_type_id Identifier of the base type.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_super_f(type_id, base_type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HID_T), INTENT(OUT) :: base_type_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_super_c(type_id, base_type_id) BIND(C,NAME='h5tget_super_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HID_T), INTENT(OUT) :: base_type_id
END FUNCTION h5tget_super_c
END INTERFACE
hdferr = h5tget_super_c(type_id, base_type_id)
END SUBROUTINE h5tget_super_f
!>
!! \ingroup FH5T
!!
!! \brief Returns the datatype of the specified member.
!!
!! \param type_id Compound datatype identifier.
!! \param field_idx Field index (0-based).
!! \param datatype Identifier of the member's datatype.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_member_type_f(type_id, field_idx, datatype, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: field_idx
INTEGER(HID_T), INTENT(OUT) :: datatype
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_member_type_c(type_id, field_idx , datatype) &
BIND(C,NAME='h5tget_member_type_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: field_idx
INTEGER(HID_T), INTENT(OUT) :: datatype
END FUNCTION h5tget_member_type_c
END INTERFACE
hdferr = h5tget_member_type_c(type_id, field_idx , datatype)
END SUBROUTINE h5tget_member_type_f
!>
!! \ingroup FH5T
!!
!! \brief Creates a new datatype.
!!
!! \param class Datatype class can be one of:
!! \li H5T_COMPOUND_F
!! \li H5T_ENUM_F
!! \li H5T_OPAQUE_F
!! \li H5T_STRING_F
!! \param size Size of the datatype.
!! \param type_id Datatype identifier.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tcreate_f(class, size, type_id, hdferr)
IMPLICIT NONE
INTEGER , INTENT(IN) :: class
INTEGER(SIZE_T), INTENT(IN) :: size
INTEGER(HID_T) , INTENT(OUT) :: type_id
INTEGER , INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tcreate_c(class, size, type_id) BIND(C,NAME='h5tcreate_c')
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER, INTENT(IN) :: class
INTEGER(SIZE_T), INTENT(IN) :: size
INTEGER(HID_T), INTENT(OUT) :: type_id
END FUNCTION h5tcreate_c
END INTERFACE
hdferr = h5tcreate_c(class, size, type_id)
END SUBROUTINE h5tcreate_f
!>
!! \ingroup FH5T
!!
!! \brief Adds a new member to a compound datatype.
!!
!! \param type_id Compound datatype identifier.
!! \param name Name of the field to insert.
!! \param offset Start of the member in an instance of the compound datatype.
!! \param field_id Datatype identifier of the field to insert.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tinsert_f(type_id, name, offset, field_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER(SIZE_T), INTENT(IN) :: offset
INTEGER(HID_T), INTENT(IN) :: field_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER :: namelen
INTERFACE
INTEGER FUNCTION h5tinsert_c(type_id, name, namelen, offset, field_id) BIND(C,NAME='h5tinsert_c')
IMPORT :: C_CHAR
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: name
INTEGER(SIZE_T), INTENT(IN) :: offset
INTEGER(HID_T), INTENT(IN) :: field_id
INTEGER :: namelen
END FUNCTION h5tinsert_c
END INTERFACE
namelen = LEN(name)
hdferr = h5tinsert_c(type_id, name, namelen, offset, field_id )
END SUBROUTINE h5tinsert_f
!>
!! \ingroup FH5T
!!
!! \brief Recursively removes padding from within a compound datatype.
!!
!! \param type_id Compound datatype identifier.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tpack_f(type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tpack_c(type_id) BIND(C,NAME='h5tpack_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
END FUNCTION h5tpack_c
END INTERFACE
hdferr = h5tpack_c(type_id)
END SUBROUTINE h5tpack_f
! !$!
!>
!! !$!
!! !$! NAME
!! !$! h5tinsert_array_f
!! !$!
!! !$! PURPOSE
!! !$! This function is not available on hdf5-1.4.*
!! !$!
!! !$! INPUTS
!! !$! OUTPUTS
!! !$! hdferr: - error code
!! !$! Success: 0
!! !$! Failure: -1
!! !$!
!! !$! AUTHOR
!! !$! Elena Pourmal
!! !$! August 12, 1999
!! !$!
!! !$! HISTORY
!! !$! Explicit Fortran interfaces were added for
!! !$! called C functions (it is needed for Windows
!! !$! port). March 7, 2001
!! !$! SOURCE
! SUBROUTINE h5tinsert_array_f(parent_id,name,offset, ndims, dims, member_id, hdferr, perm)
! IMPLICIT NONE
! INTEGER, EXTERNAL :: h5tinsert_array_c, h5tinsert_array_c2
! namelen = LEN(name)
! if (present(perm)) then
! hdferr = h5tinsert_array_c(parent_id, name, namelen, offset, ndims,dims, member_id, perm)
! else
! hdferr = h5tinsert_array_c2(parent_id, name, namelen, offset, ndims,dims, member_id)
! end if
!
! END SUBROUTINE h5tinsert_array_f
!>
!! \ingroup FH5T
!!
!! \brief Creates an array datatype object.
!!
!! \param base_id Datatype identifier for the array base datatype
!! \param rank Rank of the array.
!! \param dims Array dimension sizes.
!! \param type_id Array datatype identifier.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tarray_create_f(base_id, rank, dims, type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: base_id
INTEGER, INTENT(IN) :: rank
INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: dims
INTEGER(HID_T), INTENT(OUT) :: type_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tarray_create_c(base_id, rank, dims, type_id) BIND(C,NAME='h5tarray_create_c')
IMPORT :: HID_T, HSIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: base_id
INTEGER, INTENT(IN) :: rank
INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: dims
INTEGER(HID_T), INTENT(OUT) :: type_id
END FUNCTION h5tarray_create_c
END INTERFACE
hdferr = h5tarray_create_c(base_id, rank, dims, type_id)
END SUBROUTINE h5tarray_create_f
!>
!! \ingroup FH5T
!!
!! \brief Creates a new enumeration datatype.
!!
!! \param parent_id Datatype identifier for base datatype.
!! \param new_type_id Datatype identifier for the enumeration datatype.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tenum_create_f(parent_id, new_type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: parent_id
INTEGER(HID_T), INTENT(OUT) :: new_type_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tenum_create_c(parent_id, new_type_id) BIND(C,NAME='h5tenum_create_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: parent_id
INTEGER(HID_T), INTENT(OUT) :: new_type_id
END FUNCTION h5tenum_create_c
END INTERFACE
hdferr = h5tenum_create_c(parent_id, new_type_id)
END SUBROUTINE h5tenum_create_f
!>
!! \ingroup FH5T
!!
!! \brief Returns the symbol name corresponding to a specified member of an enumeration datatype.
!!
!! \param type_id Datatype identifier.
!! \param value Value of the enumeration datatype.
!! \param namelen Name buffer size.
!! \param name Buffer to hold symbol name.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tenum_nameof_f(type_id, value, namelen, name, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(OUT) :: name
INTEGER(SIZE_T), INTENT(IN) :: namelen
INTEGER, INTENT(IN) :: value
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tenum_nameof_c(type_id, value, name, namelen) BIND(C,NAME='h5tenum_nameof_c')
IMPORT :: C_CHAR
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(OUT) :: name
INTEGER(SIZE_T), INTENT(IN) :: namelen
INTEGER, INTENT(IN) :: value
END FUNCTION h5tenum_nameof_c
END INTERFACE
name(1:LEN(name)) = ' '
hdferr = h5tenum_nameof_c(type_id, value, name, namelen)
END SUBROUTINE h5tenum_nameof_f
!>
!! \ingroup FH5T
!!
!! \brief Returns the value corresponding to a specified member of an enumeration datatype.
!!
!! \param type_id Datatype identifier.
!! \param name Symbol name.
!! \param value Value of the enumeration datatype.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tenum_valueof_f(type_id, name, value, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER, INTENT(OUT) :: value
INTEGER, INTENT(OUT) :: hdferr
INTEGER :: namelen
INTERFACE
INTEGER FUNCTION h5tenum_valueof_c(type_id, name, namelen, value) &
BIND(C,NAME='h5tenum_valueof_c')
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: name
INTEGER, INTENT(IN) :: namelen
INTEGER, INTENT(OUT) :: value
END FUNCTION h5tenum_valueof_c
END INTERFACE
namelen = LEN(name)
hdferr = h5tenum_valueof_c(type_id, name, namelen, value)
END SUBROUTINE h5tenum_valueof_f
!>
!! \ingroup FH5T
!!
!! \brief Returns the value of an enumeration datatype member.
!!
!! \param type_id Datatype identifier.
!! \param member_no Number of the enumeration datatype member.
!! \param value Value of the enumeration datatype.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_member_value_f(type_id, member_no, value, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: member_no
INTEGER, INTENT(OUT) :: value
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_member_value_c(type_id, member_no, value) &
BIND(C,NAME='h5tget_member_value_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: member_no
INTEGER, INTENT(OUT) :: value
END FUNCTION h5tget_member_value_c
END INTERFACE
hdferr = h5tget_member_value_c(type_id, member_no, value)
END SUBROUTINE h5tget_member_value_f
!>
!! \ingroup FH5T
!!
!! \brief Tags an opaque datatype.
!!
!! \param type_id Identifier for opaque datatype.
!! \param tag Unique ASCII string with which the opaque datatype is to be tagged.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tset_tag_f(type_id, tag, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(IN) :: tag
INTEGER, INTENT(OUT) :: hdferr
INTEGER :: taglen
INTERFACE
INTEGER FUNCTION h5tset_tag_c(type_id, tag, taglen) BIND(C,NAME='h5tset_tag_c')
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: tag
INTEGER :: taglen
END FUNCTION h5tset_tag_c
END INTERFACE
taglen = LEN(tag)
hdferr = h5tset_tag_c(type_id, tag, taglen)
END SUBROUTINE h5tset_tag_f
!>
!! \ingroup FH5T
!!
!! \brief Gets the tag associated with an opaque datatype.
!!
!! \param type_id Identifier for opaque datatype.
!! \param tag Unique ASCII string associated with opaque datatype.
!! \param taglen Length of tag.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_tag_f(type_id, tag,taglen, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(OUT) :: tag
INTEGER, INTENT(OUT) :: taglen
INTEGER, INTENT(OUT) :: hdferr
INTEGER(SIZE_T):: tag_size ! Declared character length of tab
INTERFACE
INTEGER FUNCTION h5tget_tag_c(type_id, tag, tag_size, taglen) &
BIND(C,NAME='h5tget_tag_c')
IMPORT :: C_CHAR
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(OUT) :: tag
INTEGER(SIZE_T), INTENT(IN) :: tag_size
INTEGER, INTENT(OUT) :: taglen
END FUNCTION h5tget_tag_c
END INTERFACE
tag_size = LEN(tag)
hdferr = h5tget_tag_c(type_id, tag, tag_size, taglen )
END SUBROUTINE h5tget_tag_f
!>
!! \ingroup FH5T
!!
!! \brief Creates a new variable-length datatype.
!!
!! \param type_id Identifier iof base datatype.
!! \param vltype_id Identifier for VL datatype.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tvlen_create_f(type_id, vltype_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HID_T), INTENT(OUT) :: vltype_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tvlen_create_c(type_id, vltype_id) BIND(C,NAME='h5tvlen_create_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER(HID_T), INTENT(OUT) :: vltype_id
END FUNCTION h5tvlen_create_c
END INTERFACE
hdferr = h5tvlen_create_c(type_id, vltype_id)
END SUBROUTINE h5tvlen_create_f
!>
!! \ingroup FH5T
!!
!! \brief Determines whether a dattype is a variable string.
!!
!! \param type_id Datartpe identifier.
!! \param status Flag to indicate if datatype is a variable string ( TRUE or FALSE).
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tis_variable_str_f(type_id, status, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
LOGICAL, INTENT(OUT) :: status
INTEGER, INTENT(OUT) :: hdferr
INTEGER :: flag ! "TRUE/FALSE/ERROR from C"
INTERFACE
INTEGER FUNCTION h5tis_variable_str_c(type_id, flag) &
BIND(C,NAME='h5tis_variable_str_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER :: flag
END FUNCTION h5tis_variable_str_c
END INTERFACE
hdferr = h5tis_variable_str_c(type_id, flag)
status = .TRUE.
IF (flag .EQ. 0) status = .FALSE.
END SUBROUTINE h5tis_variable_str_f
!>
!! \ingroup FH5T
!!
!! \brief Returns datatype class of compound datatype member.
!!
!! \param type_id Datartpe identifier.
!! \param member_no Index of compound datatype member.
!! \param class Class type for compound dadtype member. Valid classes:
!! \li H5T_NO_CLASS_F (error)
!! \li H5T_INTEGER_F
!! \li H5T_FLOAT_F
!! \li H5T_TIME_F
!! \li H5T_STRING_F
!! \li H5T_BITFIELD_F
!! \li H5T_OPAQUE_F
!! \li H5T_COMPOUND_F
!! \li H5T_REFERENCE_F
!! \li H5T_ENUM_F
!! \li H5T_VLEN_F
!! \li H5T_ARRAY_F
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_member_class_f(type_id, member_no, class, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: member_no
INTEGER, INTENT(OUT) :: class
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_member_class_c(type_id, member_no, class) &
BIND(C,NAME='h5tget_member_class_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
INTEGER, INTENT(IN) :: member_no
INTEGER, INTENT(OUT) :: class
END FUNCTION h5tget_member_class_c
END INTERFACE
hdferr = h5tget_member_class_c(type_id, member_no, class)
END SUBROUTINE h5tget_member_class_f
!>
!! \ingroup FH5T
!!
!! \brief Commits a transient datatype to a file, creating a new named datatype, but does not link it into the file structure.
!!
!! \param loc_id A file or group identifier specifying the file in which the new named datatype is to be created.
!! \param dtype_id A datatype identifier.
!! \param hdferr \fortran_error
!! \param tcpl_id A datatype creation property list identifier (H5P_DEFAULT_F for the default property list.)
!! \param tapl_id A datatype access property list identifier should always be passed as the value H5P_DEFAULT_F.
!!
SUBROUTINE h5tcommit_anon_f(loc_id, dtype_id, hdferr, tcpl_id, tapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
INTEGER(HID_T), INTENT(IN) :: dtype_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tcpl_id
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: tapl_id
INTEGER(HID_T) :: tcpl_id_default
INTEGER(HID_T) :: tapl_id_default
INTERFACE
INTEGER FUNCTION h5tcommit_anon_c(loc_id, dtype_id, &
tcpl_id_default, tapl_id_default) BIND(C,NAME='h5tcommit_anon_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
INTEGER(HID_T), INTENT(IN) :: dtype_id
INTEGER(HID_T) :: tcpl_id_default
INTEGER(HID_T) :: tapl_id_default
END FUNCTION h5tcommit_anon_c
END INTERFACE
tcpl_id_default = H5P_DEFAULT_F
tapl_id_default = H5P_DEFAULT_F
IF(PRESENT(tcpl_id)) tcpl_id_default = tcpl_id
IF(PRESENT(tapl_id)) tapl_id_default = tapl_id
hdferr = h5tcommit_anon_c(loc_id, dtype_id, &
tcpl_id_default, tapl_id_default )
END SUBROUTINE h5tcommit_anon_f
!>
!! \ingroup FH5T
!!
!! \brief Determines whether a datatype is a named type or a transient type.
!!
!! \param dtype_id A datatype identifier.
!! \param committed .TRUE. if the datatype has been committed, and .FALSE. if the datatype has not been committed.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tcommitted_f(dtype_id, committed, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dtype_id
LOGICAL, INTENT(OUT) :: committed
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tcommitted_c(dtype_id) BIND(C,NAME='h5tcommitted_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dtype_id
END FUNCTION h5tcommitted_c
END INTERFACE
hdferr = h5tcommitted_c(dtype_id)
IF(hdferr.GT.0)THEN
committed = .TRUE.
hdferr = 0
ELSE IF(hdferr.EQ.0)THEN
committed = .FALSE.
hdferr = 0
ELSE
hdferr = -1
ENDIF
END SUBROUTINE h5tcommitted_f
!>
!! \ingroup FH5T
!!
!! \brief Decode A binary object description of data type and return a new object handle.
!!
!! \param buf Buffer for the data space object to be decoded.
!! \param obj_id Object ID.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tdecode_f(buf, obj_id, hdferr)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: buf
INTEGER(HID_T), INTENT(OUT) :: obj_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tdecode_c(buf, obj_id) BIND(C,NAME='h5tdecode_c')
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: buf
INTEGER(HID_T), INTENT(OUT) :: obj_id
END FUNCTION h5tdecode_c
END INTERFACE
hdferr = h5tdecode_c(buf, obj_id)
END SUBROUTINE h5tdecode_f
!>
!! \ingroup FH5T
!!
!! \brief Encode a data type object description into a binary buffer.
!!
!! \param obj_id Identifier of the object to be encoded.
!! \param buf Buffer for the object to be encoded into.
!! \param nalloc If set to zero, returns the size of the buffer needed. Otherwise, it sets the size of \p buf allocated.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tencode_f(obj_id, buf, nalloc, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: obj_id
CHARACTER(LEN=*), INTENT(OUT) :: buf
INTEGER(SIZE_T), INTENT(INOUT) :: nalloc
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tencode_c(buf, obj_id, nalloc) BIND(C,NAME='h5tencode_c')
IMPORT :: C_CHAR
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: obj_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(OUT) :: buf
INTEGER(SIZE_T), INTENT(INOUT) :: nalloc
END FUNCTION h5tencode_c
END INTERFACE
hdferr = h5tencode_c(buf, obj_id, nalloc)
END SUBROUTINE h5tencode_f
!>
!! \ingroup FH5T
!!
!! \brief Returns a copy of a datatype creation property list.
!!
!! \param dtype_id Datatype identifier.
!! \param dtpl_id Datatype property list identifier.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_create_plist_f(dtype_id, dtpl_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dtype_id
INTEGER(HID_T), INTENT(OUT) :: dtpl_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_create_plist_c(dtype_id, dtpl_id) BIND(C,NAME='h5tget_create_plist_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dtype_id
INTEGER(HID_T), INTENT(OUT) :: dtpl_id
END FUNCTION h5tget_create_plist_c
END INTERFACE
hdferr = h5tget_create_plist_c(dtype_id, dtpl_id)
END SUBROUTINE h5tget_create_plist_f
!>
!! \ingroup FH5T
!!
!! \brief Check whether the library’s default conversion is hard conversion.
!!
!! \param src_id Identifier for the source datatype.
!! \param dst_id Identifier for the destination datatype.
!! \param flag .TRUE. for compiler conversion, .FALSE. for library conversion.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tcompiler_conv_f(src_id, dst_id, flag, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: src_id
INTEGER(HID_T), INTENT(IN) :: dst_id
LOGICAL, INTENT(OUT) :: flag
INTEGER, INTENT(OUT) :: hdferr
INTEGER :: c_flag
INTERFACE
INTEGER FUNCTION h5tcompiler_conv_c(src_id, dst_id, c_flag) BIND(C,NAME='h5tcompiler_conv_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: src_id
INTEGER(HID_T), INTENT(IN) :: dst_id
INTEGER :: c_flag
END FUNCTION h5tcompiler_conv_c
END INTERFACE
hdferr = h5tcompiler_conv_c(src_id, dst_id, c_flag)
flag = .FALSE.
IF(c_flag .GT. 0) flag = .TRUE.
END SUBROUTINE h5tcompiler_conv_f
!>
!! \ingroup FH5T
!!
!! \brief Returns the native datatype of a specified datatype.
!!
!! \param dtype_id Datatype identifier for the dataset datatype.
!! \param direction Direction of search:
!! H5T_DIR_DEFAULT, default direction is inscendent,
!! H5T_DIR_ASCEND , in inscendent order,
!! H5T_DIR_DESCEND, in descendent order.
!! * NOTE: In C it is defined as a structure: H5T_direction_t
!! \param native_dtype_id The native datatype identifier for the specified dataset datatype.
!! \param hdferr \fortran_error
!!
SUBROUTINE h5tget_native_type_f(dtype_id, direction, native_dtype_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dtype_id
INTEGER, INTENT(IN) :: direction
INTEGER(HID_T), INTENT(OUT) :: native_dtype_id
INTEGER, INTENT(OUT) :: hdferr
INTERFACE
INTEGER FUNCTION h5tget_native_type_c(dtype_id, direction, native_dtype_id) BIND(C,NAME='h5tget_native_type_c')
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: dtype_id
INTEGER, INTENT(IN) :: direction
INTEGER(HID_T), INTENT(OUT) :: native_dtype_id
END FUNCTION h5tget_native_type_c
END INTERFACE
hdferr = h5tget_native_type_c(dtype_id, direction, native_dtype_id)
END SUBROUTINE h5tget_native_type_f
!>
!! \ingroup FH5T
!!
!! \brief Converts data from between specified datatypes.
!!
!! \param src_id Identifier for the source datatype.
!! \param dst_id Identifier for the destination datatype.
!! \param nelmts Size of array buf.
!! \param buf Array containing pre-conversion values.
!! \param hdferr \fortran_error
!! \param background Background buffer.
!! \param plist_id Dataset transfer property list identifier.
!!
SUBROUTINE h5tconvert_f(src_id, dst_id, nelmts, buf, hdferr, background, plist_id)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: src_id
INTEGER(HID_T) , INTENT(IN) :: dst_id
INTEGER(SIZE_T), INTENT(IN) :: nelmts
TYPE(C_PTR) , INTENT(INOUT) :: buf
INTEGER , INTENT(OUT) :: hdferr
TYPE(C_PTR) , INTENT(INOUT), OPTIONAL :: background
INTEGER(HID_T) , INTENT(IN) , OPTIONAL :: plist_id
INTEGER(HID_T) :: plist_id_default
TYPE(C_PTR) :: background_default
INTERFACE
INTEGER FUNCTION h5tconvert_c(src_id, dst_id, nelmts, buf, background, plist_id) &
BIND(C, NAME='h5tconvert_c')
IMPORT :: c_ptr
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: src_id
INTEGER(HID_T) , INTENT(IN) :: dst_id
INTEGER(SIZE_T), INTENT(IN) :: nelmts
TYPE(C_PTR) , VALUE :: buf
TYPE(C_PTR) , VALUE :: background
INTEGER(HID_T) , INTENT(IN) :: plist_id
END FUNCTION h5tconvert_c
END INTERFACE
plist_id_default = H5P_DEFAULT_F
IF(PRESENT(plist_id)) plist_id_default = plist_id
background_default = C_NULL_PTR
IF(PRESENT(background)) background_default = background
hdferr = H5Tconvert_c(src_id, dst_id, nelmts, buf, background_default, plist_id_default)
END SUBROUTINE h5tconvert_f
!>
!! \ingroup FH5T
!!
!! \brief Inserts a new enumeration datatype member.
!!
!! \note \fortran_approved
!!
!! \param type_id Datatype identifier for the enumeration datatype.
!! \param name Datatype identifier.
!! \param value Pointer to the value of the new member.
!! \param hdferr \fortran_error
!!
#ifdef H5_DOXYGEN_FORTRAN
SUBROUTINE h5tenum_insert_f(&
#else
SUBROUTINE h5tenum_insert_f03(&
#endif
type_id, name, value, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(IN) :: name
TYPE(C_PTR) , INTENT(IN) :: value
INTEGER, INTENT(OUT) :: hdferr
INTEGER :: namelen
INTERFACE
INTEGER FUNCTION h5tenum_insert_ptr_c(type_id, name, namelen, value) &
BIND(C, NAME='h5tenum_insert_ptr_c')
IMPORT :: C_CHAR, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: name
INTEGER :: namelen
TYPE(C_PTR), VALUE :: value
END FUNCTION h5tenum_insert_ptr_c
END INTERFACE
namelen = LEN(name)
hdferr = h5tenum_insert_ptr_c(type_id, name, namelen, value)
#ifdef H5_DOXYGEN_FORTRAN
END SUBROUTINE h5tenum_insert_f
#else
END SUBROUTINE h5tenum_insert_f03
#endif
!>
!! \ingroup FH5T
!!
!! \brief Inserts a new enumeration datatype member.
!!
!! \note \fortran_obsolete
!!
!! \param type_id Datatype identifier for the enumeration datatype.
!! \param name Datatype identifier.
!! \param value Value of the new member.
!! \param hdferr \fortran_error
!!
#ifdef H5_DOXYGEN_FORTRAN
SUBROUTINE h5tenum_insert_f(type_id, name, value, hdferr)
#else
SUBROUTINE h5tenum_insert_f90(type_id, name, value, hdferr)
#endif
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER, INTENT(IN) :: value
INTEGER, INTENT(OUT) :: hdferr
INTEGER :: namelen
INTERFACE
INTEGER FUNCTION h5tenum_insert_c(type_id, name, namelen, value) BIND(C,NAME='h5tenum_insert_c')
IMPORT :: C_CHAR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: name
INTEGER, INTENT(IN) :: value
INTEGER :: namelen
END FUNCTION h5tenum_insert_c
END INTERFACE
namelen = LEN(name)
hdferr = h5tenum_insert_c(type_id, name, namelen, value)
#ifdef H5_DOXYGEN_FORTRAN
END SUBROUTINE h5tenum_insert_f
#else
END SUBROUTINE h5tenum_insert_f90
#endif
END MODULE H5T
|