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
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* This file contains public declarations for the H5T module.
*/
#ifndef H5Tpublic_H
#define H5Tpublic_H
/* Public headers needed by this file */
#include "H5public.h"
#include "H5Ipublic.h"
#define HOFFSET(S, M) (offsetof(S, M))
/**
* These are the various classes of datatypes
* internal If this goes over 16 types (0-15), the file format will need to
* change.
*/
//! <!-- [H5T_class_t_snip] -->
typedef enum H5T_class_t {
H5T_NO_CLASS = -1, /**< error */
H5T_INTEGER = 0, /**< integer types */
H5T_FLOAT = 1, /**< floating-point types */
H5T_TIME = 2, /**< date and time types */
H5T_STRING = 3, /**< character string types */
H5T_BITFIELD = 4, /**< bit field types */
H5T_OPAQUE = 5, /**< opaque types */
H5T_COMPOUND = 6, /**< compound types */
H5T_REFERENCE = 7, /**< reference types */
H5T_ENUM = 8, /**< enumeration types */
H5T_VLEN = 9, /**< variable-Length types */
H5T_ARRAY = 10, /**< array types */
H5T_NCLASSES /**< sentinel: this must be last */
} H5T_class_t;
//! <!-- [H5T_class_t_snip] -->
/**
* Byte orders
*/
//! <!-- [H5T_order_t_snip] -->
typedef enum H5T_order_t {
H5T_ORDER_ERROR = -1, /**< error */
H5T_ORDER_LE = 0, /**< little endian */
H5T_ORDER_BE = 1, /**< bit endian */
H5T_ORDER_VAX = 2, /**< VAX mixed endian */
H5T_ORDER_MIXED = 3, /**< Compound type with mixed member orders */
H5T_ORDER_NONE = 4 /**< no particular order (strings, bits,..) */
/*H5T_ORDER_NONE must be last */
} H5T_order_t;
//! <!-- [H5T_order_t_snip] -->
/**
* Types of integer sign schemes
*/
//! <!-- [H5T_sign_t_snip] -->
typedef enum H5T_sign_t {
H5T_SGN_ERROR = -1, /**< error */
H5T_SGN_NONE = 0, /**< this is an unsigned type */
H5T_SGN_2 = 1, /**< two's complement */
H5T_NSGN = 2 /** sentinel: this must be last! */
} H5T_sign_t;
//! <!-- [H5T_sign_t_snip] -->
/**
* Floating-point normalization schemes
*/
//! <!-- [H5T_norm_t_snip] -->
typedef enum H5T_norm_t {
H5T_NORM_ERROR = -1, /**< error */
H5T_NORM_IMPLIED = 0, /**< msb of mantissa isn't stored, always 1 */
H5T_NORM_MSBSET = 1, /**< msb of mantissa is always 1 */
H5T_NORM_NONE = 2 /**< not normalized */
/*H5T_NORM_NONE must be last */
} H5T_norm_t;
//! <!-- [H5T_norm_t_snip] -->
/**
* Character set to use for text strings.
* \internal Do not change these values since they appear in HDF5 files!
*/
typedef enum H5T_cset_t {
H5T_CSET_ERROR = -1, /**< error */
H5T_CSET_ASCII = 0, /**< US ASCII */
H5T_CSET_UTF8 = 1, /**< UTF-8 Unicode encoding */
H5T_CSET_RESERVED_2 = 2, /**< reserved for later use */
H5T_CSET_RESERVED_3 = 3, /**< reserved for later use */
H5T_CSET_RESERVED_4 = 4, /**< reserved for later use */
H5T_CSET_RESERVED_5 = 5, /**< reserved for later use */
H5T_CSET_RESERVED_6 = 6, /**< reserved for later use */
H5T_CSET_RESERVED_7 = 7, /**< reserved for later use */
H5T_CSET_RESERVED_8 = 8, /**< reserved for later use */
H5T_CSET_RESERVED_9 = 9, /**< reserved for later use */
H5T_CSET_RESERVED_10 = 10, /**< reserved for later use */
H5T_CSET_RESERVED_11 = 11, /**< reserved for later use */
H5T_CSET_RESERVED_12 = 12, /**< reserved for later use */
H5T_CSET_RESERVED_13 = 13, /**< reserved for later use */
H5T_CSET_RESERVED_14 = 14, /**< reserved for later use */
H5T_CSET_RESERVED_15 = 15 /**< reserved for later use */
} H5T_cset_t;
#define H5T_NCSET H5T_CSET_RESERVED_2 /*Number of character sets actually defined */
/**
* Type of padding to use in character strings.
* \internal Do not change these values since they appear in HDF5 files!
*/
typedef enum H5T_str_t {
H5T_STR_ERROR = -1, /**< error */
H5T_STR_NULLTERM = 0, /**< null terminate like in C */
H5T_STR_NULLPAD = 1, /**< pad with nulls */
H5T_STR_SPACEPAD = 2, /**< pad with spaces like in Fortran */
H5T_STR_RESERVED_3 = 3, /**< reserved for later use */
H5T_STR_RESERVED_4 = 4, /**< reserved for later use */
H5T_STR_RESERVED_5 = 5, /**< reserved for later use */
H5T_STR_RESERVED_6 = 6, /**< reserved for later use */
H5T_STR_RESERVED_7 = 7, /**< reserved for later use */
H5T_STR_RESERVED_8 = 8, /**< reserved for later use */
H5T_STR_RESERVED_9 = 9, /**< reserved for later use */
H5T_STR_RESERVED_10 = 10, /**< reserved for later use */
H5T_STR_RESERVED_11 = 11, /**< reserved for later use */
H5T_STR_RESERVED_12 = 12, /**< reserved for later use */
H5T_STR_RESERVED_13 = 13, /**< reserved for later use */
H5T_STR_RESERVED_14 = 14, /**< reserved for later use */
H5T_STR_RESERVED_15 = 15 /**< reserved for later use */
} H5T_str_t;
#define H5T_NSTR H5T_STR_RESERVED_3 /*num H5T_str_t types actually defined */
/**
* Type of padding to use in other atomic types
*/
//! <!-- [H5T_pad_t_snip] -->
typedef enum H5T_pad_t {
H5T_PAD_ERROR = -1, /**< error */
H5T_PAD_ZERO = 0, /**< always set to zero */
H5T_PAD_ONE = 1, /**< always set to one */
H5T_PAD_BACKGROUND = 2, /**< set to background value */
H5T_NPAD = 3 /**< sentinal: THIS MUST BE LAST */
} H5T_pad_t;
//! <!-- [H5T_pad_t_snip] -->
/**
* Commands sent to conversion functions
*/
typedef enum H5T_cmd_t {
H5T_CONV_INIT = 0, /**< query and/or initialize private data */
H5T_CONV_CONV = 1, /**< convert data from source to dest datatype */
H5T_CONV_FREE = 2 /**< function is being removed from path */
} H5T_cmd_t;
/**
* How is the `bkg' buffer used by the conversion function?
*/
typedef enum H5T_bkg_t {
H5T_BKG_NO = 0, /**< background buffer is not needed, send NULL */
H5T_BKG_TEMP = 1, /**< bkg buffer used as temp storage only */
H5T_BKG_YES = 2 /**< init bkg buf with data before conversion */
} H5T_bkg_t;
/**
* Type conversion client data
*/
//! <!-- [H5T_cdata_t_snip] -->
typedef struct H5T_cdata_t {
H5T_cmd_t command; /**< what should the conversion function do? */
H5T_bkg_t need_bkg; /**< is the background buffer needed? */
hbool_t recalc; /**< recalculate private data */
void * priv; /**< private data */
} H5T_cdata_t;
//! <!-- [H5T_cdata_t_snip] -->
/**
* Conversion function persistence
*/
typedef enum H5T_pers_t {
H5T_PERS_DONTCARE = -1, /**< wild card */
H5T_PERS_HARD = 0, /**< hard conversion function */
H5T_PERS_SOFT = 1 /**< soft conversion function */
} H5T_pers_t;
/**
* The order to retrieve atomic native datatype
*/
//! <!-- [H5T_direction_t_snip] -->
typedef enum H5T_direction_t {
H5T_DIR_DEFAULT = 0, /**< default direction is inscendent */
H5T_DIR_ASCEND = 1, /**< in inscendent order */
H5T_DIR_DESCEND = 2 /**< in descendent order */
} H5T_direction_t;
//! <!-- [H5T_direction_t_snip] -->
/**
* The exception type passed into the conversion callback function
*/
typedef enum H5T_conv_except_t {
H5T_CONV_EXCEPT_RANGE_HI = 0,
/**< Source value is greater than destination's range */
H5T_CONV_EXCEPT_RANGE_LOW = 1,
/**< Source value is less than destination's range */
H5T_CONV_EXCEPT_PRECISION = 2,
/**< Source value loses precision in destination */
H5T_CONV_EXCEPT_TRUNCATE = 3,
/**< Source value is truncated in destination */
H5T_CONV_EXCEPT_PINF = 4,
/**< Source value is positive infinity */
H5T_CONV_EXCEPT_NINF = 5,
/**< Source value is negative infinity */
H5T_CONV_EXCEPT_NAN = 6
/**< Source value is \c NaN (not a number, including \c QNaN and \c SNaN) */
} H5T_conv_except_t;
/**
* The return value from conversion callback function H5T_conv_except_func_t()
*/
typedef enum H5T_conv_ret_t {
H5T_CONV_ABORT = -1, /**< abort conversion */
H5T_CONV_UNHANDLED = 0, /**< callback function failed to handle the exception */
H5T_CONV_HANDLED = 1 /**< callback function handled the exception successfully */
} H5T_conv_ret_t;
/**
* Variable Length Datatype struct in memory (This is only used for VL
* sequences, not VL strings, which are stored in char *'s)
*/
typedef struct {
size_t len; /**< Length of VL data (in base type units) */
void * p; /**< Pointer to VL data */
} hvl_t;
/* Variable Length String information */
/**
* Indicate that a string is variable length (null-terminated in C, instead of
* fixed length)
*/
#define H5T_VARIABLE ((size_t)(-1))
/* Opaque information */
/**
* Maximum length of an opaque tag
* \internal This could be raised without too much difficulty
*/
#define H5T_OPAQUE_TAG_MAX 256
#ifdef __cplusplus
extern "C" {
#endif
/**
* All datatype conversion functions are...
*/
//! <!-- [H5T_conv_t_snip] -->
typedef herr_t (*H5T_conv_t)(hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata, size_t nelmts, size_t buf_stride,
size_t bkg_stride, void *buf, void *bkg, hid_t dset_xfer_plist);
//! <!-- [H5T_conv_t_snip] -->
//! <!-- [H5T_conv_except_func_t_snip] -->
/**
* \brief Exception handler.
*
* \param[in] except_type The kind of exception that occurred
* \param[in] src_id Source datatype identifier
* \param[in] dst_id Destination datatype identifier
* \param[in] src_buf Source data buffer
* \param[in,out] dst_buf Destination data buffer
* \param[in,out] user_data Callback context
* \returns Valid callback function return values are #H5T_CONV_ABORT,
* #H5T_CONV_UNHANDLED and #H5T_CONV_HANDLED.
*
* \details If an exception like overflow happenes during conversion, this
* function is called if it's registered through H5Pset_type_conv_cb().
*
*/
typedef H5T_conv_ret_t (*H5T_conv_except_func_t)(H5T_conv_except_t except_type, hid_t src_id, hid_t dst_id,
void *src_buf, void *dst_buf, void *user_data);
//! <!-- [H5T_conv_except_func_t_snip] -->
/* When this header is included from a private header, don't make calls to H5open() */
#undef H5OPEN
#ifndef H5private_H
#define H5OPEN H5open(),
#else /* H5private_H */
#define H5OPEN
#endif /* H5private_H */
/*
* The IEEE floating point types in various byte orders.
*/
/**
* \ingroup PDTIEEE
* 32-bit big-endian IEEE floating-point numbers
*/
#define H5T_IEEE_F32BE (H5OPEN H5T_IEEE_F32BE_g)
/**
* \ingroup PDTIEEE
* 32-bit little-endian IEEE floating-point numbers
*/
#define H5T_IEEE_F32LE (H5OPEN H5T_IEEE_F32LE_g)
/**
* \ingroup PDTIEEE
* 64-bit big-endian IEEE floating-point numbers
*/
#define H5T_IEEE_F64BE (H5OPEN H5T_IEEE_F64BE_g)
/**
* \ingroup PDTIEEE
* 64-bit little-endian IEEE floating-point numbers
*/
#define H5T_IEEE_F64LE (H5OPEN H5T_IEEE_F64LE_g)
H5_DLLVAR hid_t H5T_IEEE_F32BE_g;
H5_DLLVAR hid_t H5T_IEEE_F32LE_g;
H5_DLLVAR hid_t H5T_IEEE_F64BE_g;
H5_DLLVAR hid_t H5T_IEEE_F64LE_g;
/*
* These are "standard" types. For instance, signed (2's complement) and
* unsigned integers of various sizes and byte orders.
*/
/**
* \ingroup PDTSTD
* 8-bit big-endian signed integers
*/
#define H5T_STD_I8BE (H5OPEN H5T_STD_I8BE_g)
/**
* \ingroup PDTSTD
* 8-bit little-endian signed integers
*/
#define H5T_STD_I8LE (H5OPEN H5T_STD_I8LE_g)
/**
* \ingroup PDTSTD
* 16-bit big-endian signed integers
*/
#define H5T_STD_I16BE (H5OPEN H5T_STD_I16BE_g)
/**
* \ingroup PDTSTD
* 16-bit little-endian signed integers
*/
#define H5T_STD_I16LE (H5OPEN H5T_STD_I16LE_g)
/**
* \ingroup PDTSTD
* 32-bit big-endian signed integers
*/
#define H5T_STD_I32BE (H5OPEN H5T_STD_I32BE_g)
/**
* \ingroup PDTSTD
* 32-bit little-endian signed integers
*/
#define H5T_STD_I32LE (H5OPEN H5T_STD_I32LE_g)
/**
* \ingroup PDTSTD
* 64-bit big-endian signed integers
*/
#define H5T_STD_I64BE (H5OPEN H5T_STD_I64BE_g)
/**
* \ingroup PDTSTD
* 64-bit little-endian signed integers
*/
#define H5T_STD_I64LE (H5OPEN H5T_STD_I64LE_g)
/**
* \ingroup PDTSTD
* 8-bit big-endian unsigned integers
*/
#define H5T_STD_U8BE (H5OPEN H5T_STD_U8BE_g)
/**
* \ingroup PDTSTD
* 8-bit little-endian unsigned integers
*/
#define H5T_STD_U8LE (H5OPEN H5T_STD_U8LE_g)
/**
* \ingroup PDTSTD
* 16-bit big-endian unsigned integers
*/
#define H5T_STD_U16BE (H5OPEN H5T_STD_U16BE_g)
/**
* \ingroup PDTSTD
* 16-bit little-endian unsigned integers
*/
#define H5T_STD_U16LE (H5OPEN H5T_STD_U16LE_g)
/**
* \ingroup PDTSTD
* 32-bit big-endian unsigned integers
*/
#define H5T_STD_U32BE (H5OPEN H5T_STD_U32BE_g)
/**
* \ingroup PDTSTD
* 32-bit little-endian unsigned integers
*/
#define H5T_STD_U32LE (H5OPEN H5T_STD_U32LE_g)
/**
* \ingroup PDTSTD
* 64-bit big-endian unsigned integers
*/
#define H5T_STD_U64BE (H5OPEN H5T_STD_U64BE_g)
/**
* \ingroup PDTSTD
* 64-bit little-endian unsigned integers
*/
#define H5T_STD_U64LE (H5OPEN H5T_STD_U64LE_g)
/**
* \ingroup PDTSTD
* 8-bit big-endian bitfield
*/
#define H5T_STD_B8BE (H5OPEN H5T_STD_B8BE_g)
/**
* \ingroup PDTSTD
* 8-bit little-endian bitfield
*/
#define H5T_STD_B8LE (H5OPEN H5T_STD_B8LE_g)
/**
* \ingroup PDTSTD
* 16-bit big-endian bitfield
*/
#define H5T_STD_B16BE (H5OPEN H5T_STD_B16BE_g)
/**
* \ingroup PDTSTD
* 16-bit little-endian bitfield
*/
#define H5T_STD_B16LE (H5OPEN H5T_STD_B16LE_g)
/**
* \ingroup PDTSTD
* 32-bit big-endian bitfield
*/
#define H5T_STD_B32BE (H5OPEN H5T_STD_B32BE_g)
/**
* \ingroup PDTSTD
* 32-bit little-endian bitfield
*/
#define H5T_STD_B32LE (H5OPEN H5T_STD_B32LE_g)
/**
* \ingroup PDTSTD
* 64-bit big-endian bitfield
*/
#define H5T_STD_B64BE (H5OPEN H5T_STD_B64BE_g)
/**
* \ingroup PDTSTD
* 64-bit little-endian bitfield
*/
#define H5T_STD_B64LE (H5OPEN H5T_STD_B64LE_g)
/**
* \ingroup PDTSTD
* Object reference
*/
#define H5T_STD_REF_OBJ (H5OPEN H5T_STD_REF_OBJ_g)
/**
* \ingroup PDTSTD
* Dataset region reference
*/
#define H5T_STD_REF_DSETREG (H5OPEN H5T_STD_REF_DSETREG_g)
H5_DLLVAR hid_t H5T_STD_I8BE_g;
H5_DLLVAR hid_t H5T_STD_I8LE_g;
H5_DLLVAR hid_t H5T_STD_I16BE_g;
H5_DLLVAR hid_t H5T_STD_I16LE_g;
H5_DLLVAR hid_t H5T_STD_I32BE_g;
H5_DLLVAR hid_t H5T_STD_I32LE_g;
H5_DLLVAR hid_t H5T_STD_I64BE_g;
H5_DLLVAR hid_t H5T_STD_I64LE_g;
H5_DLLVAR hid_t H5T_STD_U8BE_g;
H5_DLLVAR hid_t H5T_STD_U8LE_g;
H5_DLLVAR hid_t H5T_STD_U16BE_g;
H5_DLLVAR hid_t H5T_STD_U16LE_g;
H5_DLLVAR hid_t H5T_STD_U32BE_g;
H5_DLLVAR hid_t H5T_STD_U32LE_g;
H5_DLLVAR hid_t H5T_STD_U64BE_g;
H5_DLLVAR hid_t H5T_STD_U64LE_g;
H5_DLLVAR hid_t H5T_STD_B8BE_g;
H5_DLLVAR hid_t H5T_STD_B8LE_g;
H5_DLLVAR hid_t H5T_STD_B16BE_g;
H5_DLLVAR hid_t H5T_STD_B16LE_g;
H5_DLLVAR hid_t H5T_STD_B32BE_g;
H5_DLLVAR hid_t H5T_STD_B32LE_g;
H5_DLLVAR hid_t H5T_STD_B64BE_g;
H5_DLLVAR hid_t H5T_STD_B64LE_g;
H5_DLLVAR hid_t H5T_STD_REF_OBJ_g;
H5_DLLVAR hid_t H5T_STD_REF_DSETREG_g;
/*
* Types which are particular to Unix.
*/
/**
* \ingroup PDTUNIX
*/
#define H5T_UNIX_D32BE (H5OPEN H5T_UNIX_D32BE_g)
/**
* \ingroup PDTUNIX
*/
#define H5T_UNIX_D32LE (H5OPEN H5T_UNIX_D32LE_g)
/**
* \ingroup PDTUNIX
*/
#define H5T_UNIX_D64BE (H5OPEN H5T_UNIX_D64BE_g)
/**
* \ingroup PDTUNIX
*/
#define H5T_UNIX_D64LE (H5OPEN H5T_UNIX_D64LE_g)
H5_DLLVAR hid_t H5T_UNIX_D32BE_g;
H5_DLLVAR hid_t H5T_UNIX_D32LE_g;
H5_DLLVAR hid_t H5T_UNIX_D64BE_g;
H5_DLLVAR hid_t H5T_UNIX_D64LE_g;
/*
* Types particular to the C language. String types use `bytes' instead
* of `bits' as their size.
*/
/**
* \ingroup PDTS
* String datatype in C (size defined in bytes rather than in bits)
*/
#define H5T_C_S1 (H5OPEN H5T_C_S1_g)
H5_DLLVAR hid_t H5T_C_S1_g;
/*
* Types particular to Fortran.
*/
/**
* \ingroup PDTS
* String datatype in Fortran (as defined for the HDF5 C library)
*/
#define H5T_FORTRAN_S1 (H5OPEN H5T_FORTRAN_S1_g)
H5_DLLVAR hid_t H5T_FORTRAN_S1_g;
/*
* These types are for Intel CPU's. They are little endian with IEEE
* floating point.
*/
/**
* \ingroup PDTX86
* 8-bit little-endian signed (2's complement) integers for Intel CPUs
*/
#define H5T_INTEL_I8 H5T_STD_I8LE
/**
* \ingroup PDTX86
* 16-bit little-endian signed (2's complement) integers for Intel CPUs
*/
#define H5T_INTEL_I16 H5T_STD_I16LE
/**
* \ingroup PDTX86
* 32-bit little-endian signed (2's complement) integers for Intel CPUs
*/
#define H5T_INTEL_I32 H5T_STD_I32LE
/**
* \ingroup PDTX86
* 64-bit little-endian signed (2's complement) integers for Intel CPUs
*/
#define H5T_INTEL_I64 H5T_STD_I64LE
/**
* \ingroup PDTX86
* 8-bit little-endian unsigned integers for Intel CPUs
*/
#define H5T_INTEL_U8 H5T_STD_U8LE
/**
* \ingroup PDTX86
* 16-bit little-endian unsigned integers for Intel CPUs
*/
#define H5T_INTEL_U16 H5T_STD_U16LE
/**
* \ingroup PDTX86
* 32-bit little-endian unsigned integers for Intel CPUs
*/
#define H5T_INTEL_U32 H5T_STD_U32LE
/**
* \ingroup PDTX86
* 64-bit little-endian unsigned integers for Intel CPUs
*/
#define H5T_INTEL_U64 H5T_STD_U64LE
/**
* \ingroup PDTX86
* 8-bit little-endian bitfield for Intel CPUs
*/
#define H5T_INTEL_B8 H5T_STD_B8LE
/**
* \ingroup PDTX86
* 16-bit little-endian bitfield for Intel CPUs
*/
#define H5T_INTEL_B16 H5T_STD_B16LE
/**
* \ingroup PDTX86
* 32-bit little-endian bitfield for Intel CPUs
*/
#define H5T_INTEL_B32 H5T_STD_B32LE
/**
* \ingroup PDTX86
* 64-bit little-endian bitfield for Intel CPUs
*/
#define H5T_INTEL_B64 H5T_STD_B64LE
/**
* \ingroup PDTX86
* 32-bit little-endian IEEE floating-point numbers for Intel CPUs
*/
#define H5T_INTEL_F32 H5T_IEEE_F32LE
/**
* \ingroup PDTX86
* 64-bit little-endian IEEE floating-point numbers for Intel CPUs
*/
#define H5T_INTEL_F64 H5T_IEEE_F64LE
/*
* These types are for DEC Alpha CPU's. They are little endian with IEEE
* floating point.
*/
/**
* \ingroup PDTALPHA
* 8-bit little-endian signed (2's complement) integers for DEC Alpha CPUs
*/
#define H5T_ALPHA_I8 H5T_STD_I8LE
/**
* \ingroup PDTALPHA
* 16-bit little-endian signed (2's complement) integers for DEC Alpha CPUs
*/
#define H5T_ALPHA_I16 H5T_STD_I16LE
/**
* \ingroup PDTALPHA
* 32-bit little-endian signed (2's complement) integers for DEC Alpha CPUs
*/
#define H5T_ALPHA_I32 H5T_STD_I32LE
/**
* \ingroup PDTALPHA
* 64-bit little-endian signed (2's complement) integers for DEC Alpha CPUs
*/
#define H5T_ALPHA_I64 H5T_STD_I64LE
/**
* \ingroup PDTALPHA
* 8-bit little-endian unsigned integers for DEC Alpha CPUs
*/
#define H5T_ALPHA_U8 H5T_STD_U8LE
/**
* \ingroup PDTALPHA
* 16-bit little-endian unsigned integers for DEC Alpha CPUs
*/
#define H5T_ALPHA_U16 H5T_STD_U16LE
/**
* \ingroup PDTALPHA
* 32-bit little-endian unsigned integers for DEC Alpha CPUs
*/
#define H5T_ALPHA_U32 H5T_STD_U32LE
/**
* \ingroup PDTALPHA
* 64-bit little-endian unsigned integers for DEC Alpha CPUs
*/
#define H5T_ALPHA_U64 H5T_STD_U64LE
/**
* \ingroup PDTALPHA
* 8-bit little-endian bitfield for DEC Alpha CPUs
*/
#define H5T_ALPHA_B8 H5T_STD_B8LE
/**
* \ingroup PDTALPHA
* 16-bit little-endian bitfield for DEC Alpha CPUs
*/
#define H5T_ALPHA_B16 H5T_STD_B16LE
/**
* \ingroup PDTALPHA
* 32-bit little-endian bitfield for DEC Alpha CPUs
*/
#define H5T_ALPHA_B32 H5T_STD_B32LE
/**
* \ingroup PDTALPHA
* 64-bit little-endian bitfield for DEC Alpha CPUs
*/
#define H5T_ALPHA_B64 H5T_STD_B64LE
/**
* \ingroup PDTALPHA
* 32-bit little-endian IEEE floating-point numbers for DEC Alpha CPUs
*/
#define H5T_ALPHA_F32 H5T_IEEE_F32LE
/**
* \ingroup PDTALPHA
* 64-bit little-endian IEEE floating-point numbers for DEC Alpha CPUs
*/
#define H5T_ALPHA_F64 H5T_IEEE_F64LE
/*
* These types are for MIPS cpu's commonly used in SGI systems. They are big
* endian with IEEE floating point.
*/
/**
* \ingroup PDTMIPS
* 8-bit big-endian signed (2's complement) integers for SGI MIPS CPUs
*/
#define H5T_MIPS_I8 H5T_STD_I8BE
/**
* \ingroup PDTMIPS
* 16-bit big-endian signed (2's complement) integers for SGI MIPS CPUs
*/
#define H5T_MIPS_I16 H5T_STD_I16BE
/**
* \ingroup PDTMIPS
* 32-bit big-endian signed (2's complement) integers for SGI MIPS CPUs
*/
#define H5T_MIPS_I32 H5T_STD_I32BE
/**
* \ingroup PDTMIPS
* 64-bit big-endian signed (2's complement) integers for SGI MIPS CPUs
*/
#define H5T_MIPS_I64 H5T_STD_I64BE
/**
* \ingroup PDTMIPS
* 8-bit big-endian unsigned integers for SGI MIPS CPUs
*/
#define H5T_MIPS_U8 H5T_STD_U8BE
/**
* \ingroup PDTMIPS
* 16-bit big-endian unsigned integers for SGI MIPS CPUs
*/
#define H5T_MIPS_U16 H5T_STD_U16BE
/**
* \ingroup PDTMIPS
* 32-bit big-endian unsigned integers for SGI MIPS CPUs
*/
#define H5T_MIPS_U32 H5T_STD_U32BE
/**
* \ingroup PDTMIPS
* 64-bit big-endian unsigned integers for SGI MIPS CPUs
*/
#define H5T_MIPS_U64 H5T_STD_U64BE
/**
* \ingroup PDTMIPS
* 8-bit big-endian bitfield for SGI MIPS CPUs
*/
#define H5T_MIPS_B8 H5T_STD_B8BE
/**
* \ingroup PDTMIPS
* 16-bit big-endian bitfield for SGI MIPS CPUs
*/
#define H5T_MIPS_B16 H5T_STD_B16BE
/**
* \ingroup PDTMIPS
* 32-bit big-endian bitfield for SGI MIPS CPUs
*/
#define H5T_MIPS_B32 H5T_STD_B32BE
/**
* \ingroup PDTMIPS
* 64-bit big-endian bitfield for SGI MIPS CPUs
*/
#define H5T_MIPS_B64 H5T_STD_B64BE
/**
* \ingroup PDTMIPS
* 32-bit big-endian IEEE floating-point numbers for MIPS CPUs
*/
#define H5T_MIPS_F32 H5T_IEEE_F32BE
/**
* \ingroup PDTMIPS
* 64-bit big-endian IEEE floating-point numbers for MIPS CPUs
*/
#define H5T_MIPS_F64 H5T_IEEE_F64BE
/*
* The VAX floating point types (i.e. in VAX byte order)
*/
/**
* \ingroup PDTALPHA
* 32-bit VAX byte order floating-point numbers for OpenVMS on DEC Alpha CPUs
*/
#define H5T_VAX_F32 (H5OPEN H5T_VAX_F32_g)
/**
* \ingroup PDTALPHA
* 64-bit VAX byte order floating-point numbers for OpenVMS on DEC Alpha CPUs
*/
#define H5T_VAX_F64 (H5OPEN H5T_VAX_F64_g)
H5_DLLVAR hid_t H5T_VAX_F32_g;
H5_DLLVAR hid_t H5T_VAX_F64_g;
/*
* The predefined native types. These are the types detected by H5detect and
* they violate the naming scheme a little. Instead of a class name,
* precision and byte order as the last component, they have a C-like type
* name. If the type begins with `U' then it is the unsigned version of the
* integer type; other integer types are signed. The type LLONG corresponds
* to C's `long long' and LDOUBLE is `long double' (these types might be the
* same as `LONG' and `DOUBLE' respectively).
*/
/**
* \ingroup PDTNAT
* C-style \c char
*/
#define H5T_NATIVE_CHAR (CHAR_MIN ? H5T_NATIVE_SCHAR : H5T_NATIVE_UCHAR)
/**
* \ingroup PDTNAT
* C-style \Code{signed char}
*/
#define H5T_NATIVE_SCHAR (H5OPEN H5T_NATIVE_SCHAR_g)
/**
* \ingroup PDTNAT
* C-style \Code{unsigned char}
*/
#define H5T_NATIVE_UCHAR (H5OPEN H5T_NATIVE_UCHAR_g)
/**
* \ingroup PDTNAT
* C-style \Code{short}
*/
#define H5T_NATIVE_SHORT (H5OPEN H5T_NATIVE_SHORT_g)
/**
* \ingroup PDTNAT
* C-style \Code{unsigned short}
*/
#define H5T_NATIVE_USHORT (H5OPEN H5T_NATIVE_USHORT_g)
/**
* \ingroup PDTNAT
* C-style \Code{int}
*/
#define H5T_NATIVE_INT (H5OPEN H5T_NATIVE_INT_g)
/**
* \ingroup PDTNAT
* C-style \Code{unsigned int}
*/
#define H5T_NATIVE_UINT (H5OPEN H5T_NATIVE_UINT_g)
/**
* \ingroup PDTNAT
* C-style \Code{long}
*/
#define H5T_NATIVE_LONG (H5OPEN H5T_NATIVE_LONG_g)
/**
* \ingroup PDTNAT
* C-style \Code{unsigned long}
*/
#define H5T_NATIVE_ULONG (H5OPEN H5T_NATIVE_ULONG_g)
/**
* \ingroup PDTNAT
* C-style \Code{long long}
*/
#define H5T_NATIVE_LLONG (H5OPEN H5T_NATIVE_LLONG_g)
/**
* \ingroup PDTNAT
* C-style \Code{unsigned long long}
*/
#define H5T_NATIVE_ULLONG (H5OPEN H5T_NATIVE_ULLONG_g)
/**
* \ingroup PDTNAT
* C-style \Code{float}
*/
#define H5T_NATIVE_FLOAT (H5OPEN H5T_NATIVE_FLOAT_g)
/**
* \ingroup PDTNAT
* C-style \Code{double}
*/
#define H5T_NATIVE_DOUBLE (H5OPEN H5T_NATIVE_DOUBLE_g)
#if H5_SIZEOF_LONG_DOUBLE != 0
/**
* \ingroup PDTNAT
* C-style \Code{long double}
*/
#define H5T_NATIVE_LDOUBLE (H5OPEN H5T_NATIVE_LDOUBLE_g)
#endif
/**
* \ingroup PDTNAT
* HDF5 8-bit bitfield based on native types
*/
#define H5T_NATIVE_B8 (H5OPEN H5T_NATIVE_B8_g)
/**
* \ingroup PDTNAT
* HDF5 16-bit bitfield based on native types
*/
#define H5T_NATIVE_B16 (H5OPEN H5T_NATIVE_B16_g)
/**
* \ingroup PDTNAT
* HDF5 32-bit bitfield based on native types
*/
#define H5T_NATIVE_B32 (H5OPEN H5T_NATIVE_B32_g)
/**
* \ingroup PDTNAT
* HDF5 64-bit bitfield based on native types
*/
#define H5T_NATIVE_B64 (H5OPEN H5T_NATIVE_B64_g)
/**
* \ingroup PDTNAT
* HDF5 opaque unit based on native types
*/
#define H5T_NATIVE_OPAQUE (H5OPEN H5T_NATIVE_OPAQUE_g)
/**
* \ingroup PDTNAT
* HDF5 address type based on native types
*/
#define H5T_NATIVE_HADDR (H5OPEN H5T_NATIVE_HADDR_g)
/**
* \ingroup PDTNAT
* HDF5 size type based on native types
*/
#define H5T_NATIVE_HSIZE (H5OPEN H5T_NATIVE_HSIZE_g)
/**
* \ingroup PDTNAT
* HDF5 signed size type based on native types
*/
#define H5T_NATIVE_HSSIZE (H5OPEN H5T_NATIVE_HSSIZE_g)
/**
* \ingroup PDTNAT
* HDF5 error code type based on native types
*/
#define H5T_NATIVE_HERR (H5OPEN H5T_NATIVE_HERR_g)
/**
* \ingroup PDTNAT
* HDF5 Boolean type based on native types
*/
#define H5T_NATIVE_HBOOL (H5OPEN H5T_NATIVE_HBOOL_g)
H5_DLLVAR hid_t H5T_NATIVE_SCHAR_g;
H5_DLLVAR hid_t H5T_NATIVE_UCHAR_g;
H5_DLLVAR hid_t H5T_NATIVE_SHORT_g;
H5_DLLVAR hid_t H5T_NATIVE_USHORT_g;
H5_DLLVAR hid_t H5T_NATIVE_INT_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT_g;
H5_DLLVAR hid_t H5T_NATIVE_LONG_g;
H5_DLLVAR hid_t H5T_NATIVE_ULONG_g;
H5_DLLVAR hid_t H5T_NATIVE_LLONG_g;
H5_DLLVAR hid_t H5T_NATIVE_ULLONG_g;
H5_DLLVAR hid_t H5T_NATIVE_FLOAT_g;
H5_DLLVAR hid_t H5T_NATIVE_DOUBLE_g;
#if H5_SIZEOF_LONG_DOUBLE != 0
H5_DLLVAR hid_t H5T_NATIVE_LDOUBLE_g;
#endif
H5_DLLVAR hid_t H5T_NATIVE_B8_g;
H5_DLLVAR hid_t H5T_NATIVE_B16_g;
H5_DLLVAR hid_t H5T_NATIVE_B32_g;
H5_DLLVAR hid_t H5T_NATIVE_B64_g;
H5_DLLVAR hid_t H5T_NATIVE_OPAQUE_g;
H5_DLLVAR hid_t H5T_NATIVE_HADDR_g;
H5_DLLVAR hid_t H5T_NATIVE_HSIZE_g;
H5_DLLVAR hid_t H5T_NATIVE_HSSIZE_g;
H5_DLLVAR hid_t H5T_NATIVE_HERR_g;
H5_DLLVAR hid_t H5T_NATIVE_HBOOL_g;
/* C9x integer types */
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT8 (H5OPEN H5T_NATIVE_INT8_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT8 (H5OPEN H5T_NATIVE_UINT8_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT_LEAST8 (H5OPEN H5T_NATIVE_INT_LEAST8_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT_LEAST8 (H5OPEN H5T_NATIVE_UINT_LEAST8_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT_FAST8 (H5OPEN H5T_NATIVE_INT_FAST8_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT_FAST8 (H5OPEN H5T_NATIVE_UINT_FAST8_g)
H5_DLLVAR hid_t H5T_NATIVE_INT8_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT8_g;
H5_DLLVAR hid_t H5T_NATIVE_INT_LEAST8_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT_LEAST8_g;
H5_DLLVAR hid_t H5T_NATIVE_INT_FAST8_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT_FAST8_g;
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT16 (H5OPEN H5T_NATIVE_INT16_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT16 (H5OPEN H5T_NATIVE_UINT16_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT_LEAST16 (H5OPEN H5T_NATIVE_INT_LEAST16_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT_LEAST16 (H5OPEN H5T_NATIVE_UINT_LEAST16_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT_FAST16 (H5OPEN H5T_NATIVE_INT_FAST16_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT_FAST16 (H5OPEN H5T_NATIVE_UINT_FAST16_g)
H5_DLLVAR hid_t H5T_NATIVE_INT16_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT16_g;
H5_DLLVAR hid_t H5T_NATIVE_INT_LEAST16_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT_LEAST16_g;
H5_DLLVAR hid_t H5T_NATIVE_INT_FAST16_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT_FAST16_g;
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT32 (H5OPEN H5T_NATIVE_INT32_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT32 (H5OPEN H5T_NATIVE_UINT32_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT_LEAST32 (H5OPEN H5T_NATIVE_INT_LEAST32_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT_LEAST32 (H5OPEN H5T_NATIVE_UINT_LEAST32_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT_FAST32 (H5OPEN H5T_NATIVE_INT_FAST32_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT_FAST32 (H5OPEN H5T_NATIVE_UINT_FAST32_g)
H5_DLLVAR hid_t H5T_NATIVE_INT32_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT32_g;
H5_DLLVAR hid_t H5T_NATIVE_INT_LEAST32_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT_LEAST32_g;
H5_DLLVAR hid_t H5T_NATIVE_INT_FAST32_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT_FAST32_g;
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT64 (H5OPEN H5T_NATIVE_INT64_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT64 (H5OPEN H5T_NATIVE_UINT64_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT_LEAST64 (H5OPEN H5T_NATIVE_INT_LEAST64_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT_LEAST64 (H5OPEN H5T_NATIVE_UINT_LEAST64_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_INT_FAST64 (H5OPEN H5T_NATIVE_INT_FAST64_g)
/**
* \ingroup PDTC9x
*/
#define H5T_NATIVE_UINT_FAST64 (H5OPEN H5T_NATIVE_UINT_FAST64_g)
H5_DLLVAR hid_t H5T_NATIVE_INT64_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT64_g;
H5_DLLVAR hid_t H5T_NATIVE_INT_LEAST64_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT_LEAST64_g;
H5_DLLVAR hid_t H5T_NATIVE_INT_FAST64_g;
H5_DLLVAR hid_t H5T_NATIVE_UINT_FAST64_g;
/* Operations defined on all datatypes */
/**
* \ingroup H5T
*
* \brief Creates a new datatype.
*
* \param[in] type Class of datatype to create
* \param[in] size Size, in bytes, of the datatype being created
*
* \return \hid_t{datatype}
*
* \details H5Tcreate() creates a new datatype of the specified class with the
* specified number of bytes. This function is used only with the
* following datatype classes:
* - #H5T_COMPOUND
* - #H5T_OPAQUE
* - #H5T_ENUM
* - #H5T_STRING
*
* Other datatypes, including integer and floating-point datatypes,
* are typically created by using H5Tcopy() to copy and modify a
* predefined datatype.
*
* When creating a variable-length string datatype, \p size must
* be #H5T_VARIABLE; see \ref_vlen_strings.
*
* When creating a fixed-length string datatype, \p size will
* be the length of the string in bytes. The length of the
* string in characters will depend on i the encoding used; see
* H5Pset_char_encoding().
*
* ENUMs created with this function have a signed native integer
* base datatype. Use H5Tenum_create() if a different integer base
* datatype is required.
*
* The datatype identifier returned from this function should be
* released with H5Tclose or resource leaks will result.
*
* \see H5Tclose()
*
* \since 1.2.0
*
*/
H5_DLL hid_t H5Tcreate(H5T_class_t type, size_t size);
/**
* \ingroup H5T
*
* \brief Copies an existing datatype.
*
* \type_id
*
* \return \hid_t{datatype}
*
* \details H5Tcopy() makes a copy of an existing datatype. The returned type
* is always transient and unlocked.
*
* The \p type_id argument can be either a datatype identifier,
* a predefined datatype (defined in H5Tpublic.h), or a dataset
* identifier. If \p type_id is a dataset identifier, this function
* returns a transient, modifiable datatype which is a copy of the
* dataset's datatype.
*
* The returned datatype identifier should be released with H5Tclose()
* to prevent resource leak.
*
*/
H5_DLL hid_t H5Tcopy(hid_t type_id);
/**
* \ingroup H5T
*
* \brief Releases a datatype
*
* \type_id
*
* \return \herr_t
*
* \details H5Tclose() releases the datatype \p dtype_id. Further access
* through this datatype identifier is illegal. Failure to release
* a datatype with this call will result in resource leaks.
*
*/
H5_DLL herr_t H5Tclose(hid_t type_id);
/**
* \ingroup H5T
*
* \brief Determines whether two datatype identifiers refer to the same datatype
*
* \type_id{type1_id}
* \type_id{type2_id}
*
* \return \htri_t
*
* \details H5Tequal() determines whether two datatype identifiers refer to
* the same datatype.
*
* \since 1.6 or earlier
*
*/
H5_DLL htri_t H5Tequal(hid_t type1_id, hid_t type2_id);
/**
* \ingroup H5T
*
* \brief Locks a datatype
*
* \type_id
*
* \return \herr_t
*
* \details H5Tlock() locks the datatype specified by the dtype_id identifier,
* making it read-only and non-destructible. This is normally done by
* the library for predefined datatypes so the application does not
* inadvertently change or delete a predefined type. Once a datatype
* is locked it can never be unlocked.
*
*/
H5_DLL herr_t H5Tlock(hid_t type_id);
/**
* \ingroup H5T
*
* \brief Commits a transient datatype, linking it into the file and creating
* a new committed datatype
*
* \fg_loc_id
* \param[in] name Name given to committed datatype
* \type_id Identifier of datatype to be committed and, upon function’s
* return, identifier for the committed datatype
* \lcpl_id
* \tcpl_id
* \tapl_id
*
* \return \herr_t
*
* \details H5Tcommit2() saves a transient datatype as an immutable committed
* datatype in a file. The datatype specified by \p dtype_id is
* committed to the file with the name name at the location specified
* by \p loc_id and with the datatype creation and access property
* lists \p tcpl_id and \p tapl_id, respectively.
*
* \p loc_id may be a file identifier, or a group identifier within
* that file. \p name may be either an absolute path in the file or
* a relative path from \p loc_id naming the newly-commited datatype.
*
* The link creation property list, \p lcpl_id, governs creation of
* the link(s) by which the new committed datatype is accessed and
* the creation of any intermediate groups that may be missing.
*
* Once commited, this datatype may be used to define the datatype
* of any other dataset or attribute in the file.
*
* This function will not accept a datatype that cannot actually hold
* information. This currently includes compound datatypes with no
* fields and enumerated datatypes with no members.
*
* Committed datatypes are sometimes referred to as named datatypes.
*
* \version 1.8.7 Function modified in this release to reject datatypes that
* will not accomodate actual data, such as a compound datatype
* with no fields or an enumerated datatype with no members.
*
* \since 1.8.0
*
*/
H5_DLL herr_t H5Tcommit2(hid_t loc_id, const char *name, hid_t type_id, hid_t lcpl_id, hid_t tcpl_id,
hid_t tapl_id);
/**
* --------------------------------------------------------------------------
* \ingroup H5T
*
* \brief Opens a committed (named) datatype
*
* \fgdta_loc_id
* \param[in] name Name of the datatype to open
* \tapl_id
*
* \return \hid_t{datatype}
*
* \details H5Topen2() opens a committed datatype at the location specified
* by \p loc_id and returns an identifier for the datatype. \p
* loc_id is either a file or group identifier. The identifier should
* eventually be closed by calling H5Tclose() to release resources.
*
* The committed datatype is opened with the datatype access property
* list tapl_id.
*
* \since 1.8.0
*
*/
H5_DLL hid_t H5Topen2(hid_t loc_id, const char *name, hid_t tapl_id);
/**
* \ingroup H5T
*
* \brief Commits a transient datatype to a file, creating a new named
* datatype, but does not link it into the file structure
*
* \fg_loc_id
* \type_id
* \tcpl_id
* \tapl_id
*
* \return \herr_t
*
* \details H5Tcommit_anon() commits a transient datatype (not immutable)
* to a file, turning it into a named datatype with the specified
* creation and property lists. With default property lists,
* #H5P_DEFAULT, H5Tcommit_anon() provides similar functionality to
* that of H5Tcommit(), with the differences described below.
*
* #H5P_DEFAULT can be passed in for the datatype creation property
* list identifier, \p tcpl_id. The datatype access property list
* identifier, \p tapl_id, is provided for future functionality and
* is not used at this time. This parameter should always be passed
* as the value #H5P_DEFAULT.
*
* Note that H5Tcommit_anon() does not link this newly-committed
* datatype into the file. After the H5Tcommit_anon() call, the
* datatype identifier \p type_id must be linked into the HDF5 file
* structure with H5Olink() or it will be deleted from the file when
* the file is closed.
*
* The differences between this function and H5Tcommit() are as follows:
* \li H5Tcommit_anon() explicitly includes property lists,
* which provides for greater control of the creation process
* and of the properties of the new named datatype. H5Tcommit()
* always uses default properties.
* \li H5Tcommit_anon() neither provides the new named datatype’s
* name nor links it into the HDF5 file structure; those actions
* must be performed separately through a call to H5Olink(),
* which offers greater control over linking.
*
* This function will not accept a datatype that cannot actually
* hold data. This currently includes compound datatypes with no
* fields and enumerated datatypes with no members.
*
* \version 1.8.7 Function modified in this release to reject datatypes that
* will not accomodate actual data, such as a compound datatype
* with no fields or an enumerated datatype with no members.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tcommit_anon(hid_t loc_id, hid_t type_id, hid_t tcpl_id, hid_t tapl_id);
/**
* \ingroup H5T
*
* \brief Returns a copy of a datatype's creation property list
*
* \type_id
*
* \return \hid_t{datatype creation property list}
*
* \details H5Tget_create_plist() returns a property list identifier
* for the datatype creation property list associated with the datatype
* specified by \p type_id.
*
* The creation property list identifier should be released with
* H5Pclose() to prevent memory leaks.
*
* \since 1.8.0
*
*/
H5_DLL hid_t H5Tget_create_plist(hid_t type_id);
/**
* \ingroup H5T
*
* \brief Determines whether a datatype is a committed type or a transient type
*
* \type_id
*
* \return \htri_t
*
* \details H5Tcommitted() queries a type to determine whether the type
* specified by the \p dtype_id identifier is a committed (formerly
* known as a \Emph{named}) type or a transient type. If this function returns
* a positive value, then the type is committed (that is, it has been
* committed, perhaps by some other application). Datasets which
* return committed datatypes with H5Dget_type() are able to share
* the datatype with other datasets in the same file.
*
* \version 1.8.0 Fortran API was added
*
* \since 1.6 or earlier
*
*/
H5_DLL htri_t H5Tcommitted(hid_t type_id);
/**
* \ingroup H5T
*
* \brief Encodes a datatype object description into a binary buffer
*
* \param[in] obj_id Identifier of the object to be encoded
* \param[in,out] buf Buffer for the object to be encoded into.
* \param[in,out] nalloc IN: The size of the allocated buffer
* OUT: The size of the buffer needed
*
* \return \herr_t
*
* \details H5Tencode() Given datatype identifier, H5Tencode() converts a
* datatype description into binary form in a buffer. Using this
* binary form in the buffer, a datatype object can be reconstructed
* using H5Tdecode() to return a new object handle (\ref hid_t) for
* this datatype.
*
* If the provided buffer is NULL, only the size of buffer needed is
* returned through \p nalloc.
*
* A preliminary H5Tencode() call can be made to find out the size
* of the buffer needed. This value is returned as \p nalloc. That
* value can then be assigned to \p nalloc for a second H5Tencode()
* call, which will retrieve the actual encoded object.
*
* If the library finds that \p nalloc is not big enough for the
* object, it simply returns the size of the buffer needed through
* \p nalloc without encoding the provided buffer.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tencode(hid_t obj_id, void *buf, size_t *nalloc);
/**
* \ingroup H5T
*
* \brief Decodes a binary object description of datatype and return a new
* object handle
*
* \param[in] buf Buffer for the datatype object to be decoded
*
* \return \hid_t{datatype}
*
* \details H5Tdecode() Given an object description of datatype in binary in a
* buffer, H5Tdecode() reconstructs the HDF5 datatype object and
* returns a new object handle for it. The binary description of
* the object is encoded by H5Tencode(). User is responsible for
* passing in the right buffer.
*
* The datatype identifier returned by this function can be released
* with H5Tclose() when the identifier is no longer needed so that
* resource leaks will not develop.
*
*/
H5_DLL hid_t H5Tdecode(const void *buf);
/* Operations defined on compound datatypes */
/**
* \ingroup COMPOUND
*
* \brief Adds a new member to a compound datatype.
*
* \type_id{parent_id}
* \param[in] name Name of the field to insert
* \param[in] offset Offset in memory structure of the field to insert
* \param[in] member_id Datatype identifier of the field to insert
*
* \return \herr_t
*
* \details H5Tinsert() adds another member to the compound datatype, specified
* \p type_id.
*
* The new member has a \p name which must be unique within the
* compound datatype. The \p offset argument defines the start of the
* member in an instance of the compound datatype, and \p member_id
* is the datatype identifier of the new member.
*
* \note Members of a compound datatype do not have to be atomic
* datatypes; a compound datatype can have a member which is a
* compound datatype.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tinsert(hid_t parent_id, const char *name, size_t offset, hid_t member_id);
/**
* \ingroup COMPOUND
*
* \brief Recursively removes padding from within a compound datatype
*
* \type_id
*
* \return \herr_t
*
* \details H5Tpack() recursively removes padding from within a compound
* datatype to make it more efficient (space-wise) to store that data.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tpack(hid_t type_id);
/* Operations defined on enumeration datatypes */
/**
* \ingroup ENUM
*
* \brief Creates a new enumeration datatype
*
* \param[in] base_id Datatype identifier for the base datatype. Must be an
* integer datatype
*
* \return \hid_t{enumeration datatype}
*
* \details H5Tenum_create() creates a new enumeration datatype based on the
* specified base datatype, dtype_id, which must be an integer datatype.
*
* If a particular architecture datatype is required, a little endian
* or big endian datatype for example, use a native datatype as the
* base datatype and use H5Tconvert() on values as they are read
* from or written to a dataset.
*
* \since 1.2.0
*
*/
H5_DLL hid_t H5Tenum_create(hid_t base_id);
/**
* \ingroup ENUM
*
* \brief Inserts a new enumeration datatype member
*
* \type_id{type}
* \param[in] name Name of the new member
* \param[in] value Pointer to the value of the new member
*
* \return \herr_t
*
* \details H5Tenum_insert() inserts a new enumeration datatype member into an
* enumeration datatype.
*
* \p type_id is the datatype identifier for the enumeration datatype,
* \p name is the name of the new member, and \p value points to the
* value of the new member.
*
* \p name and \p value must both be unique within \p dtype_id.
*
* \p value points to data which must be of the integer base datatype
* used when the enumeration datatype was created. If a particular
* architecture datatype is required, a little endian or big endian
* datatype for example, use a native datatype as the base datatype
* and use H5Tconvert() on values as they are read from or written
* to a dataset.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tenum_insert(hid_t type, const char *name, const void *value);
/**
* \ingroup ENUM
*
* \brief Returns the symbol name corresponding to a specified member of an
* enumeration datatype
*
* \type_id{type}
* \param[in] value Value of the enumeration datatype
* \param[out] name Buffer for output of the symbol name
* \param[in] size Anticipated size of the symbol name, in bytes
*
* \return Returns a non-negative value if successful. Otherwise returns a
* negative value
*
* \details H5Tenum_nameof() finds the symbol name that corresponds to the
* specified \p value of the enumeration datatype \p type.
*
* At most \p size characters of the symbol \p name are copied into
* the \p name buffer. If the entire symbol name and null terminator
* do not fit in the name buffer, then as many characters as possible
* are copied (not null terminated) and the function fails.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tenum_nameof(hid_t type, const void *value, char *name /*out*/, size_t size);
/**
* \ingroup ENUM
*
* \brief Returns the value corresponding to a specified member of an
* enumeration datatype
*
* \type_id{type}
* \param[in] name Symbol name of the enumeration datatype
* \param[out] value Buffer for the value of the enumeration datatype
*
* \return \herr_t
*
* \details H5Tenum_valueof() finds the value that corresponds to the
* specified name of the enumeration datatype \p dtype_id.
*
* Values returned in \p value will be of the enumerated type’s
* base type, that is, the datatype used by H5Tenum_create() when
* the enumerated type was created.
*
* The \p value buffer must be at least large enough to hold a value
* of that base type. If the size is unknown, you can determine it
* with H5Tget_size().
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tenum_valueof(hid_t type, const char *name, void *value /*out*/);
/* Operations defined on variable-length datatypes */
/**
* \ingroup VLEN
*
* \brief Creates a new variable-length array datatype
*
* \type_id{base_id}, the element type of the datatype to create
*
* \return \hid_t{variable-length datatype}
*
* \details H5Tvlen_create() creates a new one-dimensional array datatype of
* variable-length (VL) with the base datatype \p base_id.
*
* This one-dimensional array often represents a data sequence of the
* base datatype, such as characters for character sequences or vertex
* coordinates for polygon lists. The base type specified for the VL
* datatype can be any HDF5 datatype, including another VL datatype, a
* compound datatype, or an atomic datatype.
*
* When necessary, use H5Tget_super() to determine the base type of
* the VL datatype.
*
* The datatype identifier returned from this function should be
* released with H5Tclose() or resource leaks will result. Under
* certain circumstances, H5Dvlen_reclaim() must also be used.
*
* \attention H5Tvlen_create() cannot be used to create a variable-length
* string datatype. H5Tvlen_create() called with a string or
* character base type creates a variable-length sequence of strings
* (a variable-length, 1-dimensional array), with each element of
* the array being of the string or character base type.\n
* To create a variable-length string datatype, see \ref_vlen_strings.
*
*/
H5_DLL hid_t H5Tvlen_create(hid_t base_id);
/* Operations defined on array datatypes */
/**
* \ingroup ARRAY
*
* \brief Creates an array datatype object
*
* \param[in] base_id Datatype identifier for the array base datatype
* \param[in] ndims Rank of the array
* \param[in] dim Size of each array dimension
*
* \return \hid_t{array datatype}
*
* \details H5Tarray_create2() creates a new array datatype object.\n\n
* \p base_id is the datatype of every element of the array, i.e.,
* of the number at each position in the array.
*
* \p ndims is the number of dimensions and the size of each dimension
* is specified in the array \p dim. The value of \p rank is
* currently limited to #H5S_MAX_RANK and must be greater than 0
* (zero). All dimension sizes specified in \p dim must be greater
* than 0 (zero).
*
* \since 1.8.0
*
*/
H5_DLL hid_t H5Tarray_create2(hid_t base_id, unsigned ndims, const hsize_t dim[/* ndims */]);
/**
* \ingroup ARRAY
*
* \brief Returns the rank of an array datatype
*
* \type_id
*
* \return Returns the rank of the array if successful; otherwise returns a
* negative value.
*
* \details H5Tget_array_ndims() returns the rank, i.e., the number of
* dimensions, of an array datatype object.
*
* \since 1.2.0
*
*/
H5_DLL int H5Tget_array_ndims(hid_t type_id);
/**
* \ingroup ARRAY
*
* \brief Retrieves sizes of array dimensions
*
* \type_id
* \param[out] dims Sizes of array dimensions
*
* \return Returns the non-negative number of dimensions of the array type
* if successful; otherwise returns a negative value.
*
* \details H5Tget_array_dims2() returns the sizes of the dimensions of the
* specified array datatype object in the array \p dims.
*
* \since 1.2.0
*
*/
H5_DLL int H5Tget_array_dims2(hid_t type_id, hsize_t dims[]);
/* Operations defined on opaque datatypes */
/**
* \ingroup OPAQUE
*
* \brief Tags an opaque datatype
*
* \type_id{type} of an opaque datatype
* \param[in] tag Descriptive ASCII string with which the opaque datatype is
* to be tagged
*
* \return \herr_t
*
* \details H5Tset_tag() tags an opaque datatype \p type with a descriptive
* ASCII identifier, \p tag.
*
* \p tag is intended to provide a concise description; the maximum
* size is hard-coded in the HDF5 library as 256 bytes
* (#H5T_OPAQUE_TAG_MAX).
*
* \version 1.6.5 The #H5T_OPAQUE_TAG_MAX macro constant, specifying the
* maximum size of an opaque datatype tag, was added in
* H5Tpublic.h.
*
*/
H5_DLL herr_t H5Tset_tag(hid_t type, const char *tag);
/**
* \ingroup OPAQUE
*
* \brief Gets the tag associated with an opaque datatype
*
* \type_id{type} of an opaque datatype
*
* \return Returns a pointer to an allocated string if successful; otherwise
* returns NULL.
*
* \details H5Tget_tag() returns the tag associated with the opaque datatype
* \p type.
*
* \attention The tag is returned via a pointer to an allocated string, which
* the caller must free.
*
*/
H5_DLL char *H5Tget_tag(hid_t type);
/* Querying property values */
/**
* \ingroup H5T
*
* \brief Returns the base datatype from which a datatype is derived
*
* \type_id{type}
*
* \return \hid_t{datatype}
*
* \details H5Tget_super() returns the base datatype from which the datatype
* \p type_id is derived. In the case of an enumeration type, the
* return value is an integer type.
*
* The datatype identifier returned by this function must be released
* with H5Tclose() when the identifier is no longer needed so that
* resource leaks will not develop.
*
*/
H5_DLL hid_t H5Tget_super(hid_t type);
/**
* \ingroup H5T
*
* \brief Returns a datatype class
*
* \type_id
*
* \return Returns the datatype class if successful; otherwise #H5T_NO_CLASS.
*
* \details H5Tget_class() returns the class of the datatype \p type_id.
* Valid class identifiers, as defined in H5Tpublic.h, are:
* \snippet this H5T_class_t_snip
*
* \note The library returns #H5T_STRING for both fixed-length and
* variable-length strings.
*
* \note Unsupported datatype: The time datatype class, #H5T_TIME,
* is not supported. If #H5T_TIME is used, the resulting data will
* be readable and modifiable only on the originating computing
* platform; it will not be portable to other platforms.
*
*/
H5_DLL H5T_class_t H5Tget_class(hid_t type_id);
/**
* \ingroup H5T
*
* \brief Determines whether a datatype contains any datatypes of the given
* datatype class
*
* \type_id
* \param[in] cls Datatype class
*
* \return \htri_t
*
* \details H5Tdetect_class() determines whether the datatype specified in
* \p type_id contains any datatypes of the datatype class specified
* in \p dtype_class.
*
* This function is useful primarily in recursively examining all the
* fields and/or base types of compound, array, and variable-length
* datatypes.
*
* Valid class identifiers, as defined in H5Tpublic.h, are:
* \snippet this H5T_class_t_snip
*
* \since 1.6.0
*
*/
H5_DLL htri_t H5Tdetect_class(hid_t type_id, H5T_class_t cls);
/**
* \ingroup H5T
*
* \brief Returns the size of a datatype
*
* \type_id
*
* \return Returns the size of the datatype in bytes if successful; otherwise,
* returns 0.
*
* \details H5Tget_size() returns the size of a datatype in bytes.
* \li For atomic datatypes, array datatypes, compound datatypes, and
* other datatypes of a constant size, the returned value is the
* size of the actual datatype in bytes.
* \li For variable-length string datatypes the returned value is
* the size of the pointer to the actual string, or \c sizeof(\c
* char \c *). This function does not return the size of actual
* variable-length string data.
* \li For variable-length sequence datatypes (see H5Tvlen_create()),
* the returned value is the size of the \p hvl_t struct, or \c
* sizeof(\p hvl_t). The \p hvl_t struct contains a pointer to the
* actual data and a size value. This function does not return the
* size of actual variable-length sequence data.
*
* \see H5Tset_size()
*
* \since 1.2.0
*/
H5_DLL size_t H5Tget_size(hid_t type_id);
/**
* \ingroup ATOM
*
* \brief Returns the byte order of an atomic datatype
*
* \type_id
*
* \return Returns a byte order constant if successful; otherwise returns
* #H5T_ORDER_ERROR (-1)
*
* \details H5Tget_order() returns the byte order of an atomic datatype.
* Possible return values are:
* \snippet this H5T_order_t_snip
* Members of a compound datatype need not have the same byte
* order. If members of a compound datatype have more than one of
* little endian, big endian, or VAX byte order, H5Tget_order() will
* return #H5T_ORDER_MIXED for the compound datatype. A byte order of
* #H5T_ORDER_NONE will, however, be ignored; for example, if one or
* more members of a compound datatype have byte order #H5T_ORDER_NONE
* but all other members have byte order #H5T_ORDER_LE, H5Tget_order()
* will return #H5T_ORDER_LE for the compound datatype.
*
* \since 1.2.0
*
*/
H5_DLL H5T_order_t H5Tget_order(hid_t type_id);
/**
* \ingroup ATOM
*
* \brief Returns the precision of an atomic datatype
*
* \type_id
*
* \return Returns the number of significant bits if successful; otherwise 0
*
* \details H5Tget_precision() returns the precision of an atomic datatype
* (for example, integer or float) or a datatype whose base (parent)
* type is an atomic type (for example, array, enum and variable
* length). The precision is the number of significant bits which,
* unless padding is present, is 8 times larger than the value
* returned by H5Tget_size().
*
* \since 1.2.0
*
*/
H5_DLL size_t H5Tget_precision(hid_t type_id);
/**
* \ingroup ATOM
*
* \brief Retrieves the bit offset of the first significant bit
*
* \type_id
*
* \return Returns an offset value if successful; otherwise returns a
* negative value.
*
* \details H5Tget_offset() retrieves the bit offset of the first significant
* bit. The significant bits of an atomic datum can be offset from the
* beginning of the memory for that datum by an amount of padding. The
* 'offset' property specifies the number of bits of padding that
* appear to the "right of" the value. That is, if we have a 32-bit
* datum with 16-bits of precision having the value 0x1122 then it
* will be laid out in memory as (from small byte address toward
* larger byte addresses):
* \code{.unparsed}
* 0: [ pad] [0x11] [0x22] [ pad]
* 1: [ pad] [0x22] [0x11] [ pad]
* 2: [0x11] [ pad] [ pad] [0x22]
* 3: [0x22] [ pad] [ pad] [0x11]
* \endcode
*
* \since 1.2.0
*
*/
H5_DLL int H5Tget_offset(hid_t type_id);
/**
* \ingroup ATOM
*
* \brief Retrieves the padding type of the least and most-significant bit padding
*
* \type_id
* \param[out] lsb Buffer for the least-significant bit padding type
* \param[out] msb Buffer for the most-significant bit padding type
*
* \return \herr_t
*
* \details H5Tget_pad() retrieves the padding type of the least and
* most-significant bit padding. Valid padding types are:
* \snippet this H5T_pad_t_snip
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tget_pad(hid_t type_id, H5T_pad_t *lsb /*out*/, H5T_pad_t *msb /*out*/);
/**
* \ingroup ATOM
*
* \brief Retrieves the sign type for an integer type
*
* \type_id
*
* \return Returns a valid sign type if successful; otherwise #H5T_SGN_ERROR (-1)
*
* \details H5Tget_sign() retrieves the sign type for an integer type.
* Valid types are:
* \snippet this H5T_sign_t_snip
*
* \since 1.2.0
*
*/
H5_DLL H5T_sign_t H5Tget_sign(hid_t type_id);
/**
* \ingroup ATOM
*
* \brief Retrieves floating point datatype bit field information
*
* \type_id
* \param[out] spos Pointer to location to return floating-point sign bit
* \param[out] epos Pointer to location to return exponent bit-position
* \param[out] esize Pointer to location to return size of exponent in bits
* \param[out] mpos Pointer to location to return mantissa bit-position
* \param[out] msize Pointer to location to return size of mantissa in bits
*
* \return \herr_t
*
* \details H5Tget_fields() retrieves information about the locations of
* the various bit fields of a floating point datatype. The field
* positions are bit positions in the significant region of the
* datatype. Bits are numbered with the least significant bit number
* zero. Any (or even all) of the arguments can be null pointers.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tget_fields(hid_t type_id, size_t *spos /*out*/, size_t *epos /*out*/, size_t *esize /*out*/,
size_t *mpos /*out*/, size_t *msize /*out*/);
/**
* \ingroup ATOM
*
* \brief Retrieves the exponent bias of a floating-point type
*
* \type_id
*
* \return Returns the bias if successful and 0, otherwise.
*
* \details H5Tget_ebias() retrieves the exponent bias of a floating-point type.
*
* \since 1.2.0
*
*/
H5_DLL size_t H5Tget_ebias(hid_t type_id);
/**
* --------------------------------------------------------------------------
* \ingroup ATOM
*
* \brief Retrieves mantissa normalization of a floating-point datatype
*
* \type_id
*
* \return Returns a valid normalization type if successful; otherwise
* returns #H5T_NORM_ERROR (-1)
*
* \details H5Tget_norm() retrieves the mantissa normalization of a
* floating-point datatype. Valid normalization types are:
* \snippet this H5T_norm_t_snip
*
* \since 1.2.0
*
*/
H5_DLL H5T_norm_t H5Tget_norm(hid_t type_id);
/**
* \ingroup ATOM
*
* \brief Retrieves the internal padding type for unused bits in floating-point
* datatypes
*
* \type_id
*
* \return Returns a valid padding type if successful; otherwise returns
* #H5T_PAD_ERROR (-1).
*
* \details H5Tget_inpad() retrieves the internal padding type for unused
* bits in floating-point datatypes. Valid padding types are:
* \snippet this H5T_pad_t_snip
*
* \since 1.2.0
*
*/
H5_DLL H5T_pad_t H5Tget_inpad(hid_t type_id);
/**
* \ingroup ATOM
*
* \brief Retrieves the type of padding used for a string datatype
*
* \type_id
*
* \return Returns a valid string of the padding if successful; otherwise
* returns #H5T_STR_ERROR (-1)
*
* \details H5Tget_strpad() retrieves the type of padding used for a string
* datatype.
*
* The string padding type is set with H5Tset_strpad(). Possible
* values returned are:
* \str_pad_type
*
* \since 1.2.0
*
*/
H5_DLL H5T_str_t H5Tget_strpad(hid_t type_id);
/**
* \ingroup COMPOUND ENUM
*
* \brief Retrieves the number of elements in a compound or enumeration datatype
*
* \type_id
*
* \return Returns the number of elements if successful; otherwise returns a
* negative value.
*
* \details H5Tget_nmembers() retrieves the number of fields in a compound
* datatype or the number of members of an enumeration datatype.
*
* \since 1.2.0
*
*/
H5_DLL int H5Tget_nmembers(hid_t type_id);
/**
* \ingroup COMPOUND ENUM
*
* \brief Retrieves the name of a compound or enumeration datatype member
*
* \type_id
* \param[in] membno Zero-based index of the field or element
*
* \return Returns a valid pointer to a string allocated with malloc() if
* successful; otherwise returns NULL.
*
* \details H5Tget_member_name() retrieves the name of a field of a compound
* datatype or an element of an enumeration datatype.
*
* The index of the target field or element is specified in \p
* member_no. Compound datatype fields and enumeration datatype
* elements are stored in no particular order with index values of
* 0 through N-1, where N is the value returned by H5Tget_nmembers().
*
* The HDF5 library allocates a buffer to receive the name of
* the field. The caller must subsequently free the buffer with
* H5free_memory().
*
* \since 1.2.0
*
*/
H5_DLL char *H5Tget_member_name(hid_t type_id, unsigned membno);
/**
* \ingroup COMPOUND ENUM
*
* \brief Retrieves the index of a compound or enumeration datatype member
*
* \type_id
* \param[in] name Name of the field or member
*
* \return \herr_t
*
* \details H5Tget_member_index() retrieves the index of a field of a compound
* datatype or an element of an enumeration datatype.
*
* The name of the target field or element is specified by \p name.
*
* Fields are stored in no particular order with index values of 0
* through N-1, where N is the value returned by H5Tget_nmembers() .
*
* \since 1.2.0
*
*/
H5_DLL int H5Tget_member_index(hid_t type_id, const char *name);
/**
* \ingroup COMPOUND
*
* \brief Retrieves the offset of a field of a compound datatype
*
* \type_id
* \param[in] membno Zero-based index of the field or element
*
* \return Returns the byte offset of the field if successful; otherwise
* returns 0 (zero).
*
* \details H5Tget_member_offset() retrieves the byte offset of the beginning
* of a field within a compound datatype with respect to the beginning
* of the compound datatype datum.
*
* Note that zero is a valid offset and that this function will fail
* only if a call to H5Tget_member_class() fails with the same arguments.
*
* \version 1.6.4 \p member_no parameter type changed to unsigned.
*
* \since 1.2.0
*
*/
H5_DLL size_t H5Tget_member_offset(hid_t type_id, unsigned membno);
/**
* \ingroup COMPOUND
*
* \brief Returns datatype class of compound datatype member
*
* \type_id
* \param[in] membno Zero-based index of the field or element
*
* \return Returns the datatype class, a non-negative value, if successful;
* otherwise returns a negative value.
*
* \details Given a compound datatype, \p dtype_id, H5Tget_member_class()
* returns the datatype class of the member specified by \p member_no.
*
* Valid class identifiers, as defined in H5Tpublic.h, are:
* \snippet this H5T_class_t_snip
*
* \since 1.2.0
*
*/
H5_DLL H5T_class_t H5Tget_member_class(hid_t type_id, unsigned membno);
/**
* \ingroup COMPOUND
*
* \brief Returns the datatype of the specified member
*
* \type_id
* \param[in] membno Zero-based index of the field or element
*
* \return Returns the identifier of a copy of the datatype of the field if
* successful; otherwise returns a negative value.
*
* \details H5Tget_member_type() returns the datatype of the specified member.
* The caller should invoke H5Tclose() to release resources associated
* with the type.
*
* \version 1.6.4 \p membno parameter type changed to unsigned.
*
* \since 1.2.0
*
*/
H5_DLL hid_t H5Tget_member_type(hid_t type_id, unsigned membno);
/**
* \ingroup ENUM
*
* \brief Returns the value of an enumeration datatype member
*
* \type_id
* \param[in] membno Number of the enumeration datatype member
* \param[out] value Buffer for the value of the enumeration datatype member
*
* \return \herr_t
*
* \details H5Tget_member_value() returns the value of the enumeration datatype
* member \p member_no.
*
* The member value is returned in a user-supplied buffer pointed to
* by \p value. Values returned in \p value will be of the enumerated
* type’s base type, that is, the datatype used by H5Tenum_create()
* when the enumerated type was created.
*
* The value buffer must be at least large enough to hold a value
* of that base type. If the size is unknown, you can determine it
* with H5Tget_size().
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tget_member_value(hid_t type_id, unsigned membno, void *value /*out*/);
/**
* \ingroup ATOM
*
* \brief Retrieves the character set type of a string datatype
*
* \type_id
*
* \return Returns a valid character set type if successful; otherwise
* #H5T_CSET_ERROR (-1).
*
* \details H5Tget_cset() retrieves the character set type of a string datatype.
* Valid character set types are:
* \csets
*
* \since 1.2.0
*
*/
H5_DLL H5T_cset_t H5Tget_cset(hid_t type_id);
/**
* \ingroup ATOM
*
* \brief Determines whether datatype is a variable-length string
*
* \type_id
*
* \return Returns:
* \li a positive value if the specified datatype is a variable-length
* string
* \li 0 if the specified datatype is not a variable-length string
* \li a negative value when the function fails
*
* \details H5Tis_variable_str() determines whether the datatype identified
* by \p dtype_id is a variable-length string.
*
* This function can be used to distinguish between fixed and
* variable-length string datatypes.
*
* \since 1.6.0
*
*/
H5_DLL htri_t H5Tis_variable_str(hid_t type_id);
/**
* \ingroup H5T
*
* \brief Returns the native datatype identifier of a specified datatype
*
* \type_id
* \param[in] direction Direction of search
*
* \return \hid_t{native datatype}
*
* \details H5Tget_native_type() returns the equivalent native datatype
* identifier for the datatype specified by \p type_id.
*
* H5Tget_native_type() is designed primarily to facilitate use of
* the H5Dread() function, for which users otherwise must undertake a
* multi-step process to determine the native datatype of a dataset
* prior to reading it into memory. This function can be used for
* the following purposes:
*
* \li To determine the native datatype of an atomic datatype
* \li To determine the base datatype of an array, enumerated, or
* variable-length datatype
* \li To determine the native atomic datatypes of the individual
* components of a compound datatype
*
* For example, if \p type_id is a compound datatype, the returned
* datatype identifier will be for a similar compound datatype with
* each element converted to the corresponding native datatype;
* nested compound datatypes will be unwound. If \p type_id is an
* array, the returned datatype identifier will be for the native
* datatype of a single array element.
*
* H5Tget_native_type() selects the first matching native datatype
* from the following list:
*
* \li #H5T_NATIVE_CHAR
* \li #H5T_NATIVE_SHORT
* \li #H5T_NATIVE_INT
* \li #H5T_NATIVE_LONG
* \li #H5T_NATIVE_LLONG
*
* \li #H5T_NATIVE_UCHAR
* \li #H5T_NATIVE_USHORT
* \li #H5T_NATIVE_UINT
* \li #H5T_NATIVE_ULONG
* \li #H5T_NATIVE_ULLONG
*
* \li #H5T_NATIVE_FLOAT
* \li #H5T_NATIVE_DOUBLE
* \li #H5T_NATIVE_LDOUBLE
*
* \li #H5T_NATIVE_B8
* \li #H5T_NATIVE_B16
* \li #H5T_NATIVE_B32
* \li #H5T_NATIVE_B64
*
* The direction parameter indicates the order in which the library
* searches for a native datatype match. Valid values for direction
* are as follows:
* \snippet this H5T_direction_t_snip
*
* H5Tget_native_type() is designed primarily for use with integer,
* floating point, and bitfield datatypes. String, time, opaque, and
* reference datatypes are returned as a copy of dtype_id. See above
* for compound, array, enumerated, and variable-length datatypes.
*
* The identifier returned by H5Tget_native_type() should eventually
* be closed by calling H5Tclose() to release resources.
*
* \note Please note that a datatype is actually an object
* identifier or handle returned from opening the datatype. It
* is not persistent and its value can be different from one HDF5
* session to the next.
*
* \note H5Tequal() can be used to compare datatypes.
*
* \note HDF5 High Level APIs that may also be of interest are: H5LTdtype_to_text()
* creates a text description of a datatype. H5LTtext_to_dtype() creates an
* HDF5 datatype given a text description.
*
* \since 1.6.0
*
*/
H5_DLL hid_t H5Tget_native_type(hid_t type_id, H5T_direction_t direction);
/* Setting property values */
/**
* \ingroup H5T
*
* \brief Sets size for a datatype.
*
* \type_id
* \param[in] size New datatype size is bytes or #H5T_VARIABLE
*
* \return \herr_t
*
* \details H5Tset_size() sets the total size, \p size, in bytes, for a
* datatype.
*
* \p size must have a positive value, unless it is passed in as
* #H5T_VARIABLE and the datatype is a string datatype.
*
* \li Numeric datatypes: If the datatype is atomic and the size
* is decreased so that significant bits of the datatype extend
* beyond the edge of the new size, then the offset property of the
* datatype is decreased toward zero. If the offset becomes zero
* and the significant bits of the datatype still hang over the edge
* of the new size, then the number of significant bits is decreased.
*
* \li String or character datatypes: The size set for a string
* datatype should include space for the null-terminator character,
* otherwise it will not be stored on (or retrieved from)
* disk. Adjusting the size of a string automatically sets the
* precision to \p 8*size.
*
* \li Variable-length string datatypes: If \p dtype_id is a
* variable-length string, size must normally be set to #H5T_VARIABLE.
* See \ref_vlen_strings.
*
* \li Compound datatypes: This function may be used to increase or
* decrease the size of a compound datatype, but the function will
* fail if the new size is too small to accommodate all member fields.
*
* \li Ineligible datatypes: This function cannot be used with
* enumerated datatypes (#H5T_ENUM), array datatypes (#H5T_ARRAY),
* variable-length array datatypes (#H5T_VLEN), or reference datatypes
* (#H5T_REFERENCE).
*
* \see H5Tget_size()
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_size(hid_t type_id, size_t size);
/**
* \ingroup ATOM
*
* \brief Sets the byte order of a datatype
*
* \type_id
* \param[in] order Byte order constant
*
* \return \herr_t
*
* \details H5Tset_order() sets the byte order of a datatype.\n
* Byte order can currently be set to any of the following:
* \snippet this H5T_order_t_snip
* #H5T_ORDER_MIXED (3) is a valid value for order only when
* returned by the function H5Tget_order(); it cannot be set with
* H5Tset_order().
*
* #H5T_ORDER_NONE (4) is a valid value for order, but it has no
* effect. It is valid only for fixed-length strings and object and
* region references and specifies “no particular order.”
*
* The byte order of a derived datatype is initially the same as
* that of the parent type, but can be changed with H5Tset_order().
*
* This function cannot be used with a datatype after it has been
* committed.
*
* \note Special considerations:
* \li ENUM datatypes: Byte order must be set before any member on
* an ENUM is defined.
* \li Compound datatypes: Byte order is set individually on each member
* of a compound datatype; members of a compound datatype need not
* have the same byte order.
* \li Opaque datatypes: Byte order can be set but has no effect.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_order(hid_t type_id, H5T_order_t order);
/**
* \ingroup ATOM
*
* \brief Sets the precision of an atomic datatype
*
* \type_id
* \param[in] prec Number of bits of precision for datatype
*
* \return \herr_t
*
* \details H5Tset_precision() sets the precision of an atomic datatype. The
* precision is the number of significant bits which, unless
* padding is present, is 8 times larger than the value returned
* by H5Tget_size().
*
* If the precision is increased then the offset is decreased and
* then the size is increased to insure that significant bits do not
* "hang over" the edge of the datatype.
*
* Changing the precision of an #H5T_STRING automatically changes
* the size as well. The precision must be a multiple of 8.
*
* When decreasing the precision of a floating point type, set the
* locations and sizes of the sign, mantissa, and exponent fields
* first.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_precision(hid_t type_id, size_t prec);
/**
* \ingroup ATOM
*
* \brief Sets the bit offset of the first significant bit
*
* \type_id
* \param[in] offset Offset of first significant bit
*
* \return \herr_t
*
* \details H5Tset_offset() sets the bit offset of the first significant
* bit. The significant bits of an atomic datum can be offset from
* the beginning of the memory for that datum by an amount of
* padding. The offset property specifies the number of bits of
* padding that appear “to the right of” the value. That is,
* if we have a 32-bit datum with 16-bits of precision having the
* value 0x1122, then it will be laid out in memory as (from small
* byte address toward larger byte addresses):
* \code{.unparsed}
* 0: [ pad] [0x11] [0x22] [ pad]
* 1: [ pad] [0x22] [0x11] [ pad]
* 2: [0x11] [ pad] [ pad] [0x22]
* 3: [0x22] [ pad] [ pad] [0x11]
* \endcode
* If the offset is incremented then the total size is incremented
* also if necessary to prevent significant bits of the value from
* hanging over the edge of the datatype.
*
* The offset of an #H5T_STRING cannot be set to anything but zero.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_offset(hid_t type_id, size_t offset);
/**
* \ingroup ATOM
*
* \brief Sets the least and most-significant bits padding types
*
* \type_id
* \param[in] lsb Padding type for least-significant bits
* \param[in] msb Padding type for most-significant bits
*
* \return \herr_t
*
* \details H5Tset_pad() sets the least and most-significant bits padding types.
* Available values are:
* \padding_type
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_pad(hid_t type_id, H5T_pad_t lsb, H5T_pad_t msb);
/**
* \ingroup ATOM
*
* \brief Sets the sign property for an integer type
*
* \type_id
* \param[in] sign Sign type
*
* \return \herr_t
*
* \details H5Tset_sign() sets the sign property for an integer type:
* \sign_prop
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_sign(hid_t type_id, H5T_sign_t sign);
/**
* \ingroup ATOM
*
* \brief Sets locations and sizes of floating point bit fields
*
* \type_id
* \param[in] spos Sign position, i.e., the bit offset of the floating-point
* sign bit
* \param[in] epos Exponent bit position
* \param[in] esize Size of exponent in bits
* \param[in] mpos Mantissa bit position
* \param[in] msize Size of mantissa in bits
*
* \return \herr_t
*
* \details H5Tset_fields() sets the locations and sizes of the various
* floating-point bit fields. The field positions are bit positions
* in the significant region of the datatype. Bits are numbered with
* the least significant bit number zero.
*
* Fields are not allowed to extend beyond the number of bits of
* precision, nor are they allowed to overlap with one another.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_fields(hid_t type_id, size_t spos, size_t epos, size_t esize, size_t mpos, size_t msize);
/**
* \ingroup ATOM
*
* \brief Sets the exponent bias of a floating-point type
*
* \type_id
* \param[in] ebias Exponent bias value
*
* \return \herr_t
*
* \details H5Tset_ebias() sets the exponent bias of a floating-point type.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_ebias(hid_t type_id, size_t ebias);
/**
* \ingroup ATOM
*
* \brief Sets the mantissa normalization of a floating-point datatype
*
* \type_id
* \param[in] norm Mantissa normalization type
*
* \return \herr_t
*
* \details H5Tset_norm() sets the mantissa normalization of a floating-point
* datatype. Valid normalization types are:
* \snippet this H5T_norm_t_snip
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_norm(hid_t type_id, H5T_norm_t norm);
/**
* \ingroup ATOM
*
* \brief Fills unused internal floating-point bits
*
* \type_id
* \param[in] pad Padding type
*
* \return \herr_t
*
* \details H5Tset_inpad() If any internal bits of a floating point-type are
* unused (that is, those significant bits which are not part of the
* sign, exponent, or mantissa), then H5Tset_inpad() will be filled
* according to the value of the padding value property inpad. Valid
* padding types are:
* \snippet this H5T_pad_t_snip
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_inpad(hid_t type_id, H5T_pad_t pad);
/**
* \ingroup ATOM
*
* \brief Sets character set to be used in a string or character datatype
*
* \type_id
* \param[in] cset Character set type
*
* \return \herr_t
*
* \details H5Tset_cset() sets the character set to be used in a dataset with
* a string or character datatype.
*
* Valid values for cset include the following:
* \csets
* For example, if the character set for the datatype \p type_id is set
* to #H5T_CSET_UTF8, string or character data of datatype dtype_id
* will be encoded using the UTF-8 Unicode character set.
*
* ASCII and UTF-8 Unicode are the only currently supported character
* encodings. Extended ASCII encodings (for example, ISO 8859) are
* not supported. This encoding policy is not enforced by the HDF5
* library. Using encodings other than ASCII and UTF-8 can lead to
* compatibility and usability problems.
*
* Note that H5Tset_cset() sets the character set for a character or
* string datatype while H5Pset_char_encoding() sets the character
* set used for an HDF5 link or attribute name.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_cset(hid_t type_id, H5T_cset_t cset);
/**
* \ingroup ATOM
*
* \brief Defines the type of padding used for character strings
*
* \type_id
* \param[in] strpad String padding type
*
* \return \herr_t
*
* \details H5Tset_strpad() defines the type of padding used for a string
* datatype.
*
* The method used to store character strings differs with the
* programming language. C usually null terminates strings while
* Fortran left-justifies and space-pads strings.
*
* Valid values of \p strpad are as follows:
* \str_pad_type
* When converting from a longer string to a shorter string, the
* behavior is as follows. If the shorter string is #H5T_STR_NULLPAD
* or #H5T_STR_SPACEPAD, then the string is simply truncated. If
* the short string is #H5T_STR_NULLTERM, it is truncated and a null
* terminator is appended.
*
* When converting from a shorter string to a longer string, the
* longer string is padded on the end by appending nulls or spaces.
*
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tset_strpad(hid_t type_id, H5T_str_t strpad);
/* Type conversion database */
/**
* \ingroup CONV
*
* \brief Registers a datatype conversion function
*
* \param[in] pers Conversion function type
* \param[in] name Name displayed in diagnostic output
* \type_id{src_id} of source datatype
* \type_id{dst_id} of destination datatype
* \param[in] func Function to convert between source and destination datatypes
*
* \return \herr_t
*
* \details H5Tregister() registers a hard or soft conversion function for a
* datatype conversion path. The parameter \p pers indicates whether a
* conversion function is hard (#H5T_PERS_HARD) or soft
* (#H5T_PERS_SOFT). User-defined functions employing compiler casting
* are designated as \Emph{hard}; other user-defined conversion
* functions registered with the HDF5 library (with H5Tregister() )
* are designated as \Emph{soft}. The HDF5 library also has its own
* hard and soft conversion functions.
*
* A conversion path can have only one hard function. When type is
* #H5T_PERS_HARD, \p func replaces any previous hard function.
*
* When type is #H5T_PERS_SOFT, H5Tregister() adds the function to the
* end of the master soft list and replaces the soft function in all
* applicable existing conversion paths. Soft functions are used when
* determining which conversion function is appropriate for this path.
*
* The \p name is used only for debugging and should be a short
* identifier for the function.
*
* The path is specified by the source and destination datatypes \p
* src_id and \p dst_id. For soft conversion functions, only the class
* of these types is important.
*
* The type of the conversion function pointer is declared as:
* \snippet this H5T_conv_t_snip
*
* The \ref H5T_cdata_t \c struct is declared as:
* \snippet this H5T_cdata_t_snip
*
* \since 1.6.3 The following change occurred in the \ref H5T_conv_t function:
* the \c nelmts parameter type changed to size_t.
*
*/
H5_DLL herr_t H5Tregister(H5T_pers_t pers, const char *name, hid_t src_id, hid_t dst_id, H5T_conv_t func);
/**
* \ingroup CONV
*
* \brief Removes a conversion function
*
* \param[in] pers Conversion function type
* \param[in] name Name displayed in diagnostic output
* \type_id{src_id} of source datatype
* \type_id{dst_id} of destination datatype
* \param[in] func Function to convert between source and destination datatypes
*
* \return \herr_t
*
* \details H5Tunregister() removes a conversion function matching criteria
* such as soft or hard conversion, source and destination types, and
* the conversion function.
*
* If a user is trying to remove a conversion function he registered,
* all parameters can be used. If he is trying to remove a library’s
* default conversion function, there is no guarantee the \p name and
* \p func parameters will match the user’s chosen values. Passing in
* some values may cause this function to fail. A good practice is to
* pass in NULL as their values.
*
* All parameters are optional. The missing parameters will be used to
* generalize the search criteria.
*
* The conversion function pointer type declaration is described in
* H5Tregister().
*
* \version 1.6.3 The following change occurred in the \ref H5T_conv_t function:
* the \c nelmts parameter type changed to size_t.
*
*/
H5_DLL herr_t H5Tunregister(H5T_pers_t pers, const char *name, hid_t src_id, hid_t dst_id, H5T_conv_t func);
/**
* \ingroup CONV
*
* \brief Finds a conversion function
*
* \type_id{src_id} of source datatype
* \type_id{dst_id} of destination datatype
* \param[out] pcdata Pointer to type conversion data
*
* \return Returns a pointer to a suitable conversion function if successful.
* Otherwise returns NULL.
*
* \details H5Tfind() finds a conversion function that can handle a conversion
* from type \p src_id to type \p dst_id. The \p pcdata argument is a
* pointer to a pointer to type conversion data which was created and
* initialized by the soft type conversion function of this path when
* the conversion function was installed on the path.
*
*/
H5_DLL H5T_conv_t H5Tfind(hid_t src_id, hid_t dst_id, H5T_cdata_t **pcdata);
/**
* \ingroup CONV
*
* \brief Check whether the library’s default conversion is hard conversion
*
* \type_id{src_id} of source datatype
* \type_id{dst_id} of destination datatype
*
* \return \htri_t
*
* \details H5Tcompiler_conv() determines whether the library’s conversion
* function from type \p src_id to type \p dst_id is a compiler (hard)
* conversion or not. A compiler conversion uses compiler’s casting; a
* library (soft) conversion uses the library’s own conversion
* function.
*
* \since 1.8.0
*
*/
H5_DLL htri_t H5Tcompiler_conv(hid_t src_id, hid_t dst_id);
/**
* --------------------------------------------------------------------------
* \ingroup CONV
*
* \brief Converts data from one specified datatype to another
*
* \type_id{src_id} of source datatype
* \type_id{dst_id} of destination datatype
* \param[in] nelmts Size of array \p buf
* \param[in,out] buf Array containing pre- and post-conversion values
* \param[in] background Optional background buffer
* \dxpl_id{plist_id}
*
* \return \herr_t
*
* \details H5Tconvert() converts \p nelmts elements from a source datatype,
* specified by \p src_id, to a destination datatype, \p dst_id. The
* source elements are packed in \p buf and on return the destination
* elements will be packed in \p buf. That is, the conversion is
* performed in place.
*
* The optional background buffer is for use with compound datatypes.
* It is an array of \p nelmts values for the destination datatype
* which can then be merged with the converted values to recreate the
* compound datatype. For instance, background might be an array of
* structs with the \c a and \c b fields already initialized and the
* conversion of buf supplies the \c c and \c d field values.
*
* The parameter \p plist_id contains the dataset transfer property list
* identifier which is passed to the conversion functions. As of
* Release 1.2, this parameter is only used to pass along the
* variable-length datatype custom allocation information.
*
* \note H5Tconvert() will not resize the buffer \p buf; it must be large
* enough to hold the larger of the input and output data.
*
* \version 1.6.3 \p nelmts parameter type changed to size_t.
* \version 1.4.0 \p nelmts parameter type changed to hsize_t.
*
*/
H5_DLL herr_t H5Tconvert(hid_t src_id, hid_t dst_id, size_t nelmts, void *buf, void *background,
hid_t plist_id);
/* Symbols defined for compatibility with previous versions of the HDF5 API.
*
* Use of these symbols is deprecated.
*/
#ifndef H5_NO_DEPRECATED_SYMBOLS
/* Macros */
/* Typedefs */
/* Function prototypes */
/**
* \ingroup H5T
*
* \brief Commits a transient datatype to a file, creating a new named datatype
*
* \fg_loc_id
* \param[in] name Name given to committed datatype
* \param[in] type_id Identifier of datatype to be committed
*
* \return \herr_t
*
* \deprecated This function has been renamed from H5Tcommit() and is
* deprecated in favor of the macro #H5Tcommit or the function
* H5Tcommit2().
*
* \details H5Tcommit1() commits the transient datatype (not immutable) to
* a file, turning it into a named datatype.
*
* The datatype \p dtype_id is committed as a named datatype at the
* location \p loc_id, which is either a file or group identifier,
* with the name \p name.
*
* \p name can be a relative path based at \p loc_id or an absolute
* path from the root of the file. Use of this function requires
* that any intermediate groups specified in the path already exist.
*
* As is the case for any object in a group, the length of the name
* of a named datatype is not limited.
*
* See H5Tcommit_anon() for a discussion of the differences between
* H5Tcommit() and H5Tcommit_anon().
*
* This function will not accept a datatype that cannot actually
* hold data. This currently includes compound datatypes with no
* fields and enumerated datatypes with no members.
*
* \version 1.8.7 Function modified in this release to reject datatypes that
* will not accommodate actual data, such as a compound datatype with
* no fields or an enumerated datatype with no members.
* \version 1.8.0 C function H5Tcommit() renamed to H5Tcommit1() and deprecated
* in this release.
* \since 1.2.0
*
*/
H5_DLL herr_t H5Tcommit1(hid_t loc_id, const char *name, hid_t type_id);
/**
* \ingroup H5T
*
* \brief Opens a named datatype
*
* \fg_loc_id
* \param[in] name A datatype name, defined within the specified file or group
*
* \return \herr_t
*
* \deprecated This function has been renamed from H5Topen() and is
* deprecated in favor of the macro #H5Topen or the function
* H5Topen2().
*
* \details H5Topen1() opens a named datatype at the location specified by
* \p loc_id and returns an identifier for the datatype. \p loc_id
* can be either a file or group identifier. The identifier should
* eventually be closed by calling H5Tclose() to release resources.
*
* \version 1.8.0 Function H5Topen() renamed to H5Topen1() and deprecated in
* this release.
*
* \since 1.2.0
*
*/
H5_DLL hid_t H5Topen1(hid_t loc_id, const char *name);
/**
* \ingroup ARRAY
*
* \brief Creates an array datatype object
*
* \param[in] base_id Datatype identifier for the array base datatype
* \param[in] ndims Rank of the array
* \param[in] dim Size of each array dimension
* \param[in] perm Dimension permutation (Currently not implemented.)
*
* \return \hid_t{array datatype}
*
* \deprecated This function has been renamed from H5Tarray_create() and is
* deprecated in favor of the macro #H5Tarray_create or the function
* H5Tarray_create2().
*
* \details H5Tarray_create1() creates a new array datatype object.\n\n
* \p base_id is the datatype of every element of the array, i.e.,
* of the number at each position in the array.
*
* \p rank is the number of dimensions and the size of each dimension
* is specified in the array dims. The value of rank is currently
* limited to #H5S_MAX_RANK and must be greater than 0 (zero). All
* dimension sizes specified in dims must be greater than 0 (zero).
*
* The array \p perm is designed to contain the dimension permutation,
* i.e. C versus FORTRAN array order. (The parameter perm is
* currently unused and is not yet implemented.)
*
* \version 1.8.0 Function H5Tarray_create() renamed to H5Tarray_create1()
* and deprecated in this release.
* \since 1.4.0
*
*/
H5_DLL hid_t H5Tarray_create1(hid_t base_id, int ndims, const hsize_t dim[/* ndims */],
const int perm[/* ndims */]);
/**
* \ingroup ARRAY
*
* \brief Retrieves sizes of array dimensions
*
* \type_id
* \param[out] dims Sizes of array dimensions
* \param[out] perm Dimension permutations (This parameter is not used.)
*
* \return Returns the non-negative number of dimensions of the array type
* if successful; otherwise, returns a negative value.
*
* \deprecated This function has been renamed from H5Tget_array_dims() and is
* deprecated in favor of the macro #H5Tget_array_dims or the
* function H5Tget_array_dims2().
*
* \details H5Tget_array_dims1() returns the sizes of the dimensions and
* the dimension permutations of the specified array datatype object.
*
* The sizes of the dimensions are returned in the array \p dims.
*
* \version 1.8.0 Function H5Tarray_create() renamed to H5Tarray_create1()
* and deprecated in this release.
* \since 1.2.0
*
*/
H5_DLL int H5Tget_array_dims1(hid_t type_id, hsize_t dims[], int perm[]);
#endif /* H5_NO_DEPRECATED_SYMBOLS */
#ifdef __cplusplus
}
#endif
#endif /* H5Tpublic_H */
|