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
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
package hdf.hdf5lib;
import java.io.File;
import java.nio.ByteBuffer;
import java.util.Collection;
import java.util.LinkedHashSet;
import hdf.hdf5lib.callbacks.H5A_iterate_cb;
import hdf.hdf5lib.callbacks.H5A_iterate_t;
import hdf.hdf5lib.callbacks.H5D_iterate_cb;
import hdf.hdf5lib.callbacks.H5D_iterate_t;
import hdf.hdf5lib.callbacks.H5E_walk_cb;
import hdf.hdf5lib.callbacks.H5E_walk_t;
import hdf.hdf5lib.callbacks.H5L_iterate_t;
import hdf.hdf5lib.callbacks.H5L_iterate_opdata_t;
import hdf.hdf5lib.callbacks.H5O_iterate_t;
import hdf.hdf5lib.callbacks.H5O_iterate_opdata_t;
import hdf.hdf5lib.callbacks.H5P_cls_close_func_cb;
import hdf.hdf5lib.callbacks.H5P_cls_close_func_t;
import hdf.hdf5lib.callbacks.H5P_cls_copy_func_cb;
import hdf.hdf5lib.callbacks.H5P_cls_copy_func_t;
import hdf.hdf5lib.callbacks.H5P_cls_create_func_cb;
import hdf.hdf5lib.callbacks.H5P_cls_create_func_t;
import hdf.hdf5lib.callbacks.H5P_prp_set_func_cb;
import hdf.hdf5lib.callbacks.H5P_prp_get_func_cb;
import hdf.hdf5lib.callbacks.H5P_prp_delete_func_cb;
import hdf.hdf5lib.callbacks.H5P_prp_copy_func_cb;
import hdf.hdf5lib.callbacks.H5P_prp_compare_func_cb;
import hdf.hdf5lib.callbacks.H5P_prp_close_func_cb;
import hdf.hdf5lib.callbacks.H5P_prp_create_func_cb;
import hdf.hdf5lib.callbacks.H5P_iterate_cb;
import hdf.hdf5lib.callbacks.H5P_iterate_t;
import hdf.hdf5lib.exceptions.HDF5Exception;
import hdf.hdf5lib.exceptions.HDF5JavaException;
import hdf.hdf5lib.exceptions.HDF5LibraryException;
import hdf.hdf5lib.structs.H5AC_cache_config_t;
import hdf.hdf5lib.structs.H5A_info_t;
import hdf.hdf5lib.structs.H5E_error2_t;
import hdf.hdf5lib.structs.H5F_info2_t;
import hdf.hdf5lib.structs.H5FD_hdfs_fapl_t;
import hdf.hdf5lib.structs.H5FD_ros3_fapl_t;
import hdf.hdf5lib.structs.H5G_info_t;
import hdf.hdf5lib.structs.H5L_info_t;
import hdf.hdf5lib.structs.H5O_info_t;
import hdf.hdf5lib.structs.H5O_native_info_t;
import hdf.hdf5lib.structs.H5O_token_t;
/**
* This class is the Java interface for the HDF5 library.
* <p>
* This code is the called by Java programs to access the entry points of the HDF5 library. Each routine wraps a single
* HDF5 entry point, generally with the arguments and return codes analogous to the C interface.
* <p>
* For details of the HDF5 library, see the HDF5 Documentation at: <a
* href="http://hdfgroup.org/HDF5/">http://hdfgroup.org/HDF5/</a>
* <hr>
* <p>
* <b>Mapping of arguments for Java</b>
*
* <p>
* In general, arguments to the HDF Java API are straightforward translations from the 'C' API described in the HDF
* Reference Manual.
*
* <table border=1>
* <caption><b>HDF-5 C types to Java types</b> </caption>
* <tr>
* <td><b>HDF-5</b></td>
* <td><b>Java</b></td>
* </tr>
* <tr>
* <td>H5T_NATIVE_INT</td>
* <td>int, Integer</td>
* </tr>
* <tr>
* <td>H5T_NATIVE_SHORT</td>
* <td>short, Short</td>
* </tr>
* <tr>
* <td>H5T_NATIVE_FLOAT</td>
* <td>float, Float</td>
* </tr>
* <tr>
* <td>H5T_NATIVE_DOUBLE</td>
* <td>double, Double</td>
* </tr>
* <tr>
* <td>H5T_NATIVE_CHAR</td>
* <td>byte, Byte</td>
* </tr>
* <tr>
* <td>H5T_C_S1</td>
* <td>java.lang.String</td>
* </tr>
* <tr>
* <td>void * <BR>
* (i.e., pointer to `Any')</td>
* <td>Special -- see HDFArray</td>
* </tr>
* </table>
* <b>General Rules for Passing Arguments and Results</b>
* <p>
* In general, arguments passed <b>IN</b> to Java are the analogous basic types, as above. The exception is for arrays,
* which are discussed below.
* <p>
* The <i>return value</i> of Java methods is also the analogous type, as above. A major exception to that rule is that
* all HDF functions that return SUCCEED/FAIL are declared <i>boolean</i> in the Java version, rather than <i>int</i> as
* in the C. Functions that return a value or else FAIL are declared the equivalent to the C function. However, in most
* cases the Java method will raise an exception instead of returning an error code. See <a href="#ERRORS">Errors and
* Exceptions</a> below.
* <p>
* Java does not support pass by reference of arguments, so arguments that are returned through <b>OUT</b> parameters
* must be wrapped in an object or array. The Java API for HDF consistently wraps arguments in arrays.
* <p>
* For instance, a function that returns two integers is declared:
*
* <pre>
* h_err_t HDF5dummy( int *a1, int *a2)
* </pre>
*
* For the Java interface, this would be declared:
*
* <pre>
* public synchronized static native int HDF5dummy(int args[]);
* </pre>
*
* where <i>a1</i> is <i>args[0]</i> and <i>a2</i> is <i>args[1]</i>, and would be invoked:
*
* <pre>
* H5.HDF5dummy(a);
* </pre>
*
* <p>
* All the routines where this convention is used will have specific documentation of the details, given below.
* <p>
* <b>Arrays</b>
* <p>
* HDF5 needs to read and write multi-dimensional arrays of any number type (and records). The HDF5 API describes the
* layout of the source and destination, and the data for the array passed as a block of bytes, for instance,
*
* <pre>
* herr_t H5Dread(long fid, long filetype, long memtype, long memspace,
* void * data);
* </pre>
*
* <p>
* where ``void *'' means that the data may be any valid numeric type, and is a contiguous block of bytes that is the
* data for a multi-dimensional array. The other parameters describe the dimensions, rank, and datatype of the array on
* disk (source) and in memory (destination).
* <p>
* For Java, this ``ANY'' is a problem, as the type of data must always be declared. Furthermore, multidimensional
* arrays are definitely <i>not</i> layed out contiguously in memory. It would be infeasible to declare a separate
* routine for every combination of number type and dimensionality. For that reason, the <a
* href="./hdf.hdf5lib.HDFArray.html"><b>HDFArray</b></a> class is used to discover the type, shape, and size of the
* data array at run time, and to convert to and from a contiguous array of bytes in synchronized static native C order.
* <p>
* The upshot is that any Java array of numbers (either primitive or sub-classes of type <b>Number</b>) can be passed as
* an ``Object'', and the Java API will translate to and from the appropriate packed array of bytes needed by the C
* library. So the function above would be declared:
*
* <pre>
* public synchronized static native int H5Dread(long fid, long filetype, long memtype, long memspace, Object data);
* </pre>
* OPEN_IDS.addElement(id);
* and the parameter <i>data</i> can be any multi-dimensional array of numbers, such as float[][], or int[][][], or
* Double[][].
* <p>
* <b>HDF-5 Constants</b>
* <p>
* The HDF-5 API defines a set of constants and enumerated values. Most of these values are available to Java programs
* via the class <a href="./hdf.hdf5lib.HDF5Constants.html"> <b>HDF5Constants</b></a>. For example, the parameters for
* the h5open() call include two numeric values, <b><i>HDFConstants.H5F_ACC_RDWR</i></b> and
* <b><i>HDF5Constants.H5P_DEFAULT</i></b>. As would be expected, these numbers correspond to the C constants
* <b><i>H5F_ACC_RDWR</i></b> and <b><i>H5P_DEFAULT</i></b>.
* <p>
* The HDF-5 API defines a set of values that describe number types and sizes, such as "H5T_NATIVE_INT" and "hsize_t".
* These values are determined at run time by the HDF-5 C library. To support these parameters, the Java class <a
* href="./hdf.hdf5lib.HDF5CDataTypes.html"> <b>HDF5CDataTypes</b></a> looks up the values when initiated. The values
* can be accessed as public variables of the Java class, such as:
*
* <pre>
* long data_type = HDF5CDataTypes.JH5T_NATIVE_INT;
* </pre>
*
* The Java application uses both types of constants the same way, the only difference is that the
* <b><i>HDF5CDataTypes</i></b> may have different values on different platforms.
* <p>
* <b>Error handling and Exceptions</b>
* <p>
* The HDF5 error API (H5E) manages the behavior of the error stack in the HDF-5 library. This API is omitted from the
* JHI5. Errors are converted into Java exceptions. This is totally different from the C interface, but is very natural
* for Java programming.
* <p>
* The exceptions of the JHI5 are organized as sub-classes of the class <a
* href="./hdf.hdf5lib.exceptions.HDF5Exception.html"> <b>HDF5Exception</b></a>. There are two subclasses of
* <b>HDF5Exception</b>, <a href="./hdf.hdf5lib.exceptions.HDF5LibraryException.html"> <b>HDF5LibraryException</b></a>
* and <a href="./hdf.hdf5lib.exceptions.HDF5JavaException.html"> <b>HDF5JavaException</b></a>. The sub-classes of the
* former represent errors from the HDF-5 C library, while sub-classes of the latter represent errors in the JHI5
* wrapper and support code.
* <p>
* The super-class <b><i>HDF5LibraryException</i></b> implements the method '<b><i>printStackTrace()</i></b>', which
* prints out the HDF-5 error stack, as described in the HDF-5 C API <i><b>H5Eprint()</b>.</i> This may be used by Java
* exception handlers to print out the HDF-5 error stack.
* <hr>
*
* @version HDF5 1.12.2 <BR>
* <b>See also: <a href ="./hdf.hdf5lib.HDFArray.html"> hdf.hdf5lib.HDFArray</a> </b><BR>
* <a href ="./hdf.hdf5lib.HDF5Constants.html"> hdf.hdf5lib.HDF5Constants</a><BR>
* <a href ="./hdf.hdf5lib.HDF5CDataTypes.html"> hdf.hdf5lib.HDF5CDataTypes</a><BR>
* <a href ="./hdf.hdf5lib.HDF5Exception.html"> hdf.hdf5lib.HDF5Exception</a><BR>
* <a href="http://hdfgroup.org/HDF5/"> http://hdfgroup.org/HDF5"</a>
**/
public class H5 implements java.io.Serializable {
/**
*
*/
private static final long serialVersionUID = 6129888282117053288L;
private final static org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(H5.class);
/**
* The version number of the HDF5 library:
* LIB_VERSION[0]: The major version of the library.
* LIB_VERSION[1]: The minor version of the library.
* LIB_VERSION[2]: The release number of the library.
*
* Make sure to update the versions number when a different library is used.
*/
public final static int LIB_VERSION[] = { 1, 12, 2 };
/**
* add system property to load library by path
*/
public final static String H5PATH_PROPERTY_KEY = "hdf.hdf5lib.H5.hdf5lib";
/**
* add system property to load library by name from library path, via System.loadLibrary()
*/
public final static String H5_LIBRARY_NAME_PROPERTY_KEY = "hdf.hdf5lib.H5.loadLibraryName";
private static String s_libraryName;
private static boolean isLibraryLoaded = false;
private final static boolean IS_CRITICAL_PINNING = true;
// change from Vector to LinkedHashSet - jp 6-Oct-2014
private final static LinkedHashSet<Long> OPEN_IDS = new LinkedHashSet<Long>();
static {
loadH5Lib();
}
/**
* load native library
*/
public static void loadH5Lib() {
// Make sure that the library is loaded only once
if (isLibraryLoaded)
return;
// first try loading library by name from user supplied library path
s_libraryName = System.getProperty(H5_LIBRARY_NAME_PROPERTY_KEY, null);
String mappedName = null;
if ((s_libraryName != null) && (s_libraryName.length() > 0)) {
try {
mappedName = System.mapLibraryName(s_libraryName);
System.loadLibrary(s_libraryName);
isLibraryLoaded = true;
}
catch (Throwable err) {
err.printStackTrace();
isLibraryLoaded = false;
}
finally {
log.info("HDF5 library: " + s_libraryName);
log.debug(" resolved to: " + mappedName + "; ");
log.info((isLibraryLoaded ? "" : " NOT") + " successfully loaded from system property");
}
}
if (!isLibraryLoaded) {
// else try loading library via full path
String filename = System.getProperty(H5PATH_PROPERTY_KEY, null);
if ((filename != null) && (filename.length() > 0)) {
File h5dll = new File(filename);
if (h5dll.exists() && h5dll.canRead() && h5dll.isFile()) {
try {
System.load(filename);
isLibraryLoaded = true;
}
catch (Throwable err) {
err.printStackTrace();
isLibraryLoaded = false;
}
finally {
log.info("HDF5 library: ");
log.debug(filename);
log.info((isLibraryLoaded ? "" : " NOT") + " successfully loaded.");
}
}
else {
isLibraryLoaded = false;
throw (new UnsatisfiedLinkError("Invalid HDF5 library, " + filename));
}
}
}
// else load standard library
if (!isLibraryLoaded) {
try {
s_libraryName = "hdf5_java";
mappedName = System.mapLibraryName(s_libraryName);
System.loadLibrary("hdf5_java");
isLibraryLoaded = true;
}
catch (Throwable err) {
err.printStackTrace();
isLibraryLoaded = false;
}
finally {
log.info("HDF5 library: " + s_libraryName);
log.debug(" resolved to: " + mappedName + "; ");
log.info((isLibraryLoaded ? "" : " NOT") + " successfully loaded from java.library.path");
}
}
/* Important! Exit quietly */
try {
H5.H5dont_atexit();
}
catch (HDF5LibraryException e) {
System.exit(1);
}
/* Important! Disable error output to C stdout */
if (!log.isDebugEnabled())
H5.H5error_off();
/*
* Optional: confirm the version This will crash immediately if not the specified version.
*/
Integer majnum = Integer.getInteger("hdf.hdf5lib.H5.hdf5maj", null);
Integer minnum = Integer.getInteger("hdf.hdf5lib.H5.hdf5min", null);
Integer relnum = Integer.getInteger("hdf.hdf5lib.H5.hdf5rel", null);
if ((majnum != null) && (minnum != null) && (relnum != null)) {
H5.H5check_version(majnum.intValue(), minnum.intValue(), relnum.intValue());
}
}
// ////////////////////////////////////////////////////////////
// //
// H5: General Library Functions //
// //
// ////////////////////////////////////////////////////////////
/**
* Get number of open IDs.
*
* @return Returns a count of open IDs
*/
public final static int getOpenIDCount() {
return OPEN_IDS.size();
}
/**
* Get the open IDs
*
* @return Returns a collection of open IDs
*/
public final static Collection<Long> getOpenIDs() {
return OPEN_IDS;
}
/**
* H5check_version verifies that the arguments match the version numbers compiled into the library.
*
* @param majnum
* The major version of the library.
* @param minnum
* The minor version of the library.
* @param relnum
* The release number of the library.
* @return a non-negative value if successful. Upon failure (when the versions do not match), this function causes
* the application to abort (i.e., crash)
*
* See C API function: herr_t H5check_version()
**/
public synchronized static native int H5check_version(int majnum, int minnum, int relnum);
/**
* H5close flushes all data to disk, closes all file identifiers, and cleans up all memory used by the library.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5close() throws HDF5LibraryException;
/**
* H5open initialize the library.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5open() throws HDF5LibraryException;
/**
* H5dont_atexit indicates to the library that an atexit() cleanup routine should not be installed. In order to be
* effective, this routine must be called before any other HDF function calls, and must be called each time the
* library is loaded/linked into the application (the first time and after it's been unloaded).
* <P>
* This is called by the static initializer, so this should never need to be explicitly called by a Java program.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
private synchronized static native int H5dont_atexit() throws HDF5LibraryException;
/**
* Turn off error handling. By default, the C library prints the error stack of the HDF-5 C library on stdout. This
* behavior may be disabled by calling H5error_off().
*
* @return a non-negative value if successful
*/
public synchronized static native int H5error_off();
/**
* Turn on error handling. By default, the C library prints the error stack of the HDF-5 C library on stdout. This
* behavior may be reenabled by calling H5error_on().
*/
public synchronized static native void H5error_on();
/**
* H5garbage_collect collects on all free-lists of all types.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5garbage_collect() throws HDF5LibraryException;
/**
* H5get_libversion retrieves the major, minor, and release numbers of the version of the HDF library which is
* linked to the application.
*
* @param libversion
* The version information of the HDF library.
*
* <pre>
* libversion[0] = The major version of the library.
* libversion[1] = The minor version of the library.
* libversion[2] = The release number of the library.
* </pre>
* @return a non-negative value if successful, along with the version information.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5get_libversion(int[] libversion) throws HDF5LibraryException;
/**
* H5set_free_list_limits
* Sets limits on the different kinds of free lists. Setting a value
* of -1 for a limit means no limit of that type. These limits are global
* for the entire library. Each "global" limit only applies to free lists
* of that type, so if an application sets a limit of 1 MB on each of the
* global lists, up to 3 MB of total storage might be allocated (1MB on
* each of regular, array and block type lists).
*
* The settings for block free lists are duplicated to factory free lists.
* Factory free list limits cannot be set independently currently.
*
* @param reg_global_lim
* The limit on all "regular" free list memory used
* @param reg_list_lim
* The limit on memory used in each "regular" free list
* @param arr_global_lim
* The limit on all "array" free list memory used
* @param arr_list_lim
* The limit on memory used in each "array" free list
* @param blk_global_lim
* The limit on all "block" free list memory used
* @param blk_list_lim
* The limit on memory used in each "block" free list
* @return a non-negative value if successful, along with the version information.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native int H5set_free_list_limits(int reg_global_lim, int reg_list_lim,
int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim) throws HDF5LibraryException;
/**
* H5export_dataset is a utility function to save data in a file.
*
* @param file_export_name
* The file name to export data into.
* @param file_id
* The identifier of the HDF5 file containing the dataset.
* @param object_path
* The full path of the dataset to be exported.
* @param binary_order
* 99 - export data as text.
* 1 - export data as binary Native Order.
* 2 - export data as binary Little Endian.
* 3 - export data as binary Big Endian.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5export_dataset(String file_export_name, long file_id,
String object_path, int binary_order) throws HDF5LibraryException;
/**
* H5export_attribute is a utility function to save data in a file.
*
* @param file_export_name
* The file name to export data into.
* @param dataset_id
* The identifier of the dataset containing the attribute.
* @param attribute_name
* The attribute to be exported.
* @param binary_order
* 99 - export data as text.
* 1 - export data as binary Native Order.
* 2 - export data as binary Little Endian.
* 3 - export data as binary Big Endian.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5export_attribute(String file_export_name, long dataset_id,
String attribute_name, int binary_order) throws HDF5LibraryException;
/**
* H5is_library_threadsafe Checks to see if the library was built with thread-safety enabled.
*
* @return true if hdf5 library implements threadsafe
*
**/
private synchronized static native boolean H5is_library_threadsafe();
// /////// unimplemented ////////
// herr_t H5free_memory(void *mem);
// void *H5allocate_memory(size_t size, hbool_t clear);
// void *H5resize_memory(void *mem, size_t size);
// ////////////////////////////////////////////////////////////
// //
// H5A: HDF5 1.8 Attribute Interface API Functions //
// //
// ////////////////////////////////////////////////////////////
/**
* H5Aclose terminates access to the attribute specified by its identifier, attr_id.
*
* @param attr_id
* IN: Attribute to release access to.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Aclose(long attr_id) throws HDF5LibraryException {
if (attr_id < 0)
return 0; // throw new HDF5LibraryException("Negative ID");;
log.trace("OPEN_IDS: H5Aclose remove {}", attr_id);
OPEN_IDS.remove(attr_id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
return _H5Aclose(attr_id);
}
private synchronized static native int _H5Aclose(long attr_id) throws HDF5LibraryException;
/**
* H5Acopy copies the content of one attribute to another.
*
* @param src_aid
* the identifier of the source attribute
* @param dst_aid
* the identifier of the destination attribute
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native int H5Acopy(long src_aid, long dst_aid) throws HDF5LibraryException;
/**
* H5Acreate creates an attribute, attr_name, which is attached to the object specified by the identifier loc_id.
*
* @param loc_id
* IN: Location or object identifier; may be dataset or group
* @param attr_name
* IN: Attribute name
* @param type_id
* IN: Attribute datatype identifier
* @param space_id
* IN: Attribute dataspace identifier
* @param acpl_id
* IN: Attribute creation property list identifier
* @param aapl_id
* IN: Attribute access property list identifier
*
* @return An attribute identifier if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - Name is null.
**/
public static long H5Acreate(long loc_id, String attr_name, long type_id, long space_id, long acpl_id, long aapl_id)
throws HDF5LibraryException, NullPointerException {
long id = _H5Acreate2(loc_id, attr_name, type_id, space_id, acpl_id, aapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5A create add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
/**
* H5Acreate2 an attribute, attr_name, which is attached to the object specified by the identifier loc_id.
*
* @see public static long H5Acreate( long loc_id, String attr_name, long type_id, long space_id, long acpl_id, long
* aapl_id )
**/
private synchronized static native long _H5Acreate2(long loc_id, String attr_name, long type_id, long space_id,
long acpl_id, long aapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Acreate_by_name creates an attribute, attr_name, which is attached to the object specified by loc_id and
* obj_name.
*
* @param loc_id
* IN: Location or object identifier; may be dataset or group
* @param obj_name
* IN: Name, relative to loc_id, of object that attribute is to be attached to
* @param attr_name
* IN: Attribute name
* @param type_id
* IN: Attribute datatype identifier
* @param space_id
* IN: Attribute dataspace identifier
* @param acpl_id
* IN: Attribute creation property list identifier (currently not used).
* @param aapl_id
* IN: Attribute access property list identifier (currently not used).
* @param lapl_id
* IN: Link access property list
*
* @return An attribute identifier if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static long H5Acreate_by_name(long loc_id, String obj_name, String attr_name, long type_id, long space_id,
long acpl_id, long aapl_id, long lapl_id) throws HDF5LibraryException, NullPointerException {
long id = _H5Acreate_by_name(loc_id, obj_name, attr_name, type_id, space_id, acpl_id, aapl_id, lapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Acreate_by_name add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Acreate_by_name(long loc_id, String obj_name, String attr_name,
long type_id, long space_id, long acpl_id, long aapl_id, long lapl_id) throws HDF5LibraryException,
NullPointerException;
/**
* H5Adelete removes the attribute specified by its name, name, from a dataset, group, or named datatype.
*
* @param loc_id
* IN: Identifier of the dataset, group, or named datatype.
* @param name
* IN: Name of the attribute to delete.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Adelete(long loc_id, String name) throws HDF5LibraryException,
NullPointerException;
/**
* H5Adelete_by_idx removes an attribute, specified by its location in an index, from an object.
*
* @param loc_id
* IN: Location or object identifier; may be dataset or group
* @param obj_name
* IN: Name of object, relative to location, from which attribute is to be removed
* @param idx_type
* IN: Type of index
* @param order
* IN: Order in which to iterate over index
* @param n
* IN: Offset within index
* @param lapl_id
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - obj_name is null.
**/
public synchronized static native void H5Adelete_by_idx(long loc_id, String obj_name, int idx_type, int order,
long n, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Adelete_by_name removes the attribute attr_name from an object specified by location and name, loc_id and
* obj_name, respectively.
*
* @param loc_id
* IN: Location or object identifier; may be dataset or group
* @param obj_name
* IN: Name of object, relative to location, from which attribute is to be removed
* @param attr_name
* IN: Name of attribute to delete
* @param lapl_id
* IN: Link access property list identifier.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Adelete_by_name(long loc_id, String obj_name, String attr_name, long lapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aexists determines whether the attribute attr_name exists on the object specified by obj_id.
*
* @param obj_id
* IN: Object identifier.
* @param attr_name
* IN: Name of the attribute.
*
* @return boolean true if an attribute with a given name exists.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - attr_name is null.
**/
public synchronized static native boolean H5Aexists(long obj_id, String attr_name) throws HDF5LibraryException,
NullPointerException;
/**
* H5Aexists_by_name determines whether the attribute attr_name exists on an object. That object is specified by its
* location and name, loc_id and obj_name, respectively.
*
* @param loc_id
* IN: Location of object to which attribute is attached .
* @param obj_name
* IN: Name, relative to loc_id, of object that attribute is attached to.
* @param attr_name
* IN: Name of attribute.
* @param lapl_id
* IN: Link access property list identifier.
*
* @return boolean true if an attribute with a given name exists, otherwise returns false.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native boolean H5Aexists_by_name(long loc_id, String obj_name, String attr_name,
long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Aget_info retrieves attribute information, by attribute identifier.
*
* @param attr_id
* IN: Attribute identifier
*
* @return A buffer(H5A_info_t) for Attribute information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native H5A_info_t H5Aget_info(long attr_id) throws HDF5LibraryException;
/**
* H5Aget_info_by_idx Retrieves attribute information, by attribute index position.
*
* @param loc_id
* IN: Location of object to which attribute is attached
* @param obj_name
* IN: Name of object to which attribute is attached, relative to location
* @param idx_type
* IN: Type of index
* @param order
* IN: Index traversal order
* @param n
* IN: Attribute's position in index
* @param lapl_id
* IN: Link access property list
*
* @return A buffer(H5A_info_t) for Attribute information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - obj_name is null.
**/
public synchronized static native H5A_info_t H5Aget_info_by_idx(long loc_id, String obj_name, int idx_type,
int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Aget_info_by_name Retrieves attribute information, by attribute name.
*
* @param loc_id
* IN: Location of object to which attribute is attached
* @param obj_name
* IN: Name of object to which attribute is attached, relative to location
* @param attr_name
* IN: Attribute name
* @param lapl_id
* IN: Link access property list
*
* @return A buffer(H5A_info_t) for Attribute information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - obj_name is null.
**/
public synchronized static native H5A_info_t H5Aget_info_by_name(long loc_id, String obj_name, String attr_name,
long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Aget_name retrieves the name of an attribute specified by the identifier, attr_id.
*
* @param attr_id
* IN: Identifier of the attribute.
*
* @return String for Attribute name.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native String H5Aget_name(long attr_id)
throws HDF5LibraryException;
/**
* H5Aget_name_by_idx retrieves the name of an attribute that is attached to an object, which is specified by its
* location and name, loc_id and obj_name, respectively.
*
* @param attr_id
* IN: Attribute identifier
* @param obj_name
* IN: Name of object to which attribute is attached, relative to location
* @param idx_type
* IN: Type of index
* @param order
* IN: Index traversal order
* @param n
* IN: Attribute's position in index
* @param lapl_id
* IN: Link access property list
*
* @return String for Attribute name.
*
* @exception HDF5LibraryException
* - Error from the HDF5 Library.
* @exception NullPointerException
* - obj_name is null.
**/
public synchronized static native String H5Aget_name_by_idx(long attr_id, String obj_name, int idx_type, int order,
long n, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Aget_space retrieves a copy of the dataspace for an attribute.
*
* @param attr_id
* IN: Identifier of an attribute.
*
* @return attribute dataspace identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Aget_space(long attr_id) throws HDF5LibraryException
{
long id = _H5Aget_space(attr_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Aget_space add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Aget_space(long attr_id) throws HDF5LibraryException;
/**
* H5Aget_storage_size returns the amount of storage that is required for the specified attribute, attr_id.
*
* @param attr_id
* IN: Identifier of the attribute to query.
*
* @return the amount of storage size allocated for the attribute; otherwise returns 0 (zero)
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Aget_storage_size(long attr_id) throws HDF5LibraryException;
/**
* H5Aget_type retrieves a copy of the datatype for an attribute.
*
* @param attr_id
* IN: Identifier of an attribute.
*
* @return a datatype identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Aget_type(long attr_id) throws HDF5LibraryException
{
long id = _H5Aget_type(attr_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Aget_type add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Aget_type(long attr_id) throws HDF5LibraryException;
/**
* H5Aopen opens an existing attribute, attr_name, that is attached to an object specified an object identifier,
* object_id.
*
* @param obj_id
* IN: Identifier for object to which attribute is attached
* @param attr_name
* IN: Name of attribute to open
* @param aapl_id
* IN: Attribute access property list identifier
*
* @return An attribute identifier if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - Name is null.
**/
public static long H5Aopen(long obj_id, String attr_name, long aapl_id)
throws HDF5LibraryException, NullPointerException
{
long id = _H5Aopen(obj_id, attr_name, aapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Aopen add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Aopen(long obj_id, String attr_name, long aapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aopen_by_idx opens an existing attribute that is attached to an object specified by location and name, loc_id
* and obj_name, respectively
*
* @param loc_id
* IN: Location of object to which attribute is attached
* @param obj_name
* IN: Name of object to which attribute is attached, relative to location
* @param idx_type
* IN: Type of index
* @param order
* IN: Index traversal order
* @param n
* IN: Attribute's position in index
* @param aapl_id
* IN: Attribute access property list
* @param lapl_id
* IN: Link access property list
*
* @return An attribute identifier if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - Name is null.
**/
public static long H5Aopen_by_idx(long loc_id, String obj_name, int idx_type, int order, long n, long aapl_id,
long lapl_id) throws HDF5LibraryException, NullPointerException
{
long id = _H5Aopen_by_idx(loc_id, obj_name, idx_type, order, n, aapl_id, lapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Aopen_by_idx add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Aopen_by_idx(long loc_id, String obj_name, int idx_type, int order,
long n, long aapl_id, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Aopen_by_name Opens an attribute for an object by object name and attribute name
*
* @param loc_id
* IN: Location from which to find object to which attribute is attached
* @param obj_name
* IN: Name of object to which attribute is attached, relative to loc_id
* @param attr_name
* IN: Name of attribute to open
* @param aapl_id
* IN: Attribute access property list
* @param lapl_id
* IN: Link access property list identifier
*
* @return Returns an attribute identifier if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - obj_name is null.
**/
public static long H5Aopen_by_name(long loc_id, String obj_name, String attr_name, long aapl_id, long lapl_id)
throws HDF5LibraryException, NullPointerException
{
long id = _H5Aopen_by_name(loc_id, obj_name, attr_name, aapl_id, lapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Aopen_by_name add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Aopen_by_name(long loc_id, String obj_name, String attr_name,
long aapl_id, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param obj
* Buffer to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Aread(long attr_id, long mem_type_id, byte[] obj, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Aread(long attr_id, long mem_type_id, byte[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Aread(attr_id, mem_type_id, buf, true);
}
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param obj
* Buffer to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Aread(long attr_id, long mem_type_id, Object obj) throws HDF5Exception, HDF5LibraryException, NullPointerException
{
return H5Aread(attr_id, mem_type_id, obj, true);
}
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into data object from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param obj
* IN: Object for data to be read.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5Exception
* - Failure in the data conversion.
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null. See public synchronized static native int H5Aread( )
**/
public synchronized static int H5Aread(long attr_id, long mem_type_id, Object obj, boolean isCriticalPinning)
throws HDF5Exception, HDF5LibraryException, NullPointerException
{
int status = -1;
boolean is1D = false;
Class dataClass = obj.getClass();
if (!dataClass.isArray()) {
throw (new HDF5JavaException("H5Aread: data is not an array"));
}
String cname = dataClass.getName();
is1D = (cname.lastIndexOf('[') == cname.indexOf('['));
char dname = cname.charAt(cname.lastIndexOf("[") + 1);
log.trace("H5Aread: cname={} is1D={} dname={}", cname, is1D, dname);
if (is1D && (dname == 'B')) {
log.trace("H5Aread_dname_B");
status = H5Aread(attr_id, mem_type_id, (byte[]) obj, isCriticalPinning);
}
else if (is1D && (dname == 'S')) {
log.trace("H5Aread_dname_S");
status = H5Aread_short(attr_id, mem_type_id, (short[]) obj, isCriticalPinning);
}
else if (is1D && (dname == 'I')) {
log.trace("H5Aread_dname_I");
status = H5Aread_int(attr_id, mem_type_id, (int[]) obj, isCriticalPinning);
}
else if (is1D && (dname == 'J')) {
log.trace("H5Aread_dname_J");
status = H5Aread_long(attr_id, mem_type_id, (long[]) obj, isCriticalPinning);
}
else if (is1D && (dname == 'F')) {
log.trace("H5Aread_dname_F");
status = H5Aread_float(attr_id, mem_type_id, (float[]) obj, isCriticalPinning);
}
else if (is1D && (dname == 'D')) {
log.trace("H5Aread_dname_D");
status = H5Aread_double(attr_id, mem_type_id, (double[]) obj, isCriticalPinning);
}
else if ((H5.H5Tdetect_class(mem_type_id, HDF5Constants.H5T_REFERENCE) &&
(is1D && (dataClass.getComponentType() == String.class))) ||
H5.H5Tequal(mem_type_id, HDF5Constants.H5T_STD_REF_DSETREG)) {
log.trace("H5Aread_reg_ref");
status = H5Aread_reg_ref(attr_id, mem_type_id, (String[]) obj);
}
else if (is1D && (dataClass.getComponentType() == String.class)) {
log.trace("H5Aread_string type");
status = H5Aread_string(attr_id, mem_type_id, (String[]) obj);
}
else {
// Create a data buffer to hold the data into a Java Array
HDFArray theArray = new HDFArray(obj);
byte[] buf = theArray.emptyBytes();
log.trace("H5Aread_else");
// This will raise an exception if there is an error
status = H5Aread(attr_id, mem_type_id, buf, isCriticalPinning);
// No exception: status really ought to be OK
if (status >= 0) {
obj = theArray.arrayify(buf);
}
// clean up these: assign 'null' as hint to gc()
buf = null;
theArray = null;
}
return status;
}
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of double from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of double to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Aread_double(long attr_id, long mem_type_id, double[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of double from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of double to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Aread_double(long attr_id, long mem_type_id, double[] buf)
throws HDF5LibraryException, NullPointerException
{
return H5Aread_double(attr_id, mem_type_id, buf, true);
}
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of float from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of float to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Aread_float(long attr_id, long mem_type_id, float[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of float from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of float to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Aread_float(long attr_id, long mem_type_id, float[] buf)
throws HDF5LibraryException, NullPointerException
{
return H5Aread_float(attr_id, mem_type_id, buf, true);
}
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of int from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of int to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Aread_int(long attr_id, long mem_type_id, int[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of int from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of int to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Aread_int(long attr_id, long mem_type_id, int[] buf)
throws HDF5LibraryException, NullPointerException
{
return H5Aread_int(attr_id, mem_type_id, buf, true);
}
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of long from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of long to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Aread_long(long attr_id, long mem_type_id, long[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of long from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of long to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Aread_long(long attr_id, long mem_type_id, long[] buf)
throws HDF5LibraryException, NullPointerException
{
return H5Aread_long(attr_id, mem_type_id, buf, true);
}
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of String from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of String to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Aread_reg_ref(long attr_id, long mem_type_id, String[] buf)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of short from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of short to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Aread_short(long attr_id, long mem_type_id, short[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of shortfrom the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of short to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Aread_short(long attr_id, long mem_type_id, short[] buf)
throws HDF5LibraryException, NullPointerException
{
return H5Aread_short(attr_id, mem_type_id, buf, true);
}
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of variable-lenght from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of variable-lenght to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5AreadVL(long attr_id, long mem_type_id, Object[] buf)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of String from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of String to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Aread_string(long attr_id, long mem_type_id, String[] buf)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of variable-lenght strings from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of variable-lenght strings to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Aread_VLStrings(long attr_id, long mem_type_id, Object[] buf)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aread reads an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is read into buffer of string from the file.
*
* @param attr_id
* IN: Identifier of an attribute to read.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* Buffer of string to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5AreadComplex(long attr_id, long mem_type_id, String[] buf)
throws HDF5LibraryException, NullPointerException;
/**
* H5Arename changes the name of attribute that is attached to the object specified by loc_id. The attribute named
* old_attr_name is renamed new_attr_name.
*
* @param loc_id
* IN: Location or object identifier; may be dataset or group
* @param old_attr_name
* IN: Prior attribute name
* @param new_attr_name
* IN: New attribute name
*
* @return A non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - Name is null.
**/
public synchronized static native int H5Arename(long loc_id, String old_attr_name, String new_attr_name)
throws HDF5LibraryException, NullPointerException;
/**
* H5Arename_by_name changes the name of attribute that is attached to the object specified by loc_id and obj_name.
* The attribute named old_attr_name is renamed new_attr_name.
*
* @param loc_id
* IN: Location or object identifier; may be dataset or group
* @param obj_name
* IN: Name of object, relative to location, whose attribute is to be renamed
* @param old_attr_name
* IN: Prior attribute name
* @param new_attr_name
* IN: New attribute name
* @param lapl_id
* IN: Link access property list
*
* @return A non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - Name is null.
**/
public synchronized static native int H5Arename_by_name(long loc_id, String obj_name, String old_attr_name,
String new_attr_name, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buf to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer with data to be written to the file.
* @param isCriticalPinning
* IN: request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static native int H5Awrite(long attr_id, long mem_type_id, byte[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buf to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static int H5Awrite(long attr_id, long mem_type_id, byte[] buf)
throws HDF5LibraryException, NullPointerException
{
return H5Awrite(attr_id, mem_type_id, buf, true);
}
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buf to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param obj
* IN: Buffer with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static int H5Awrite(long attr_id, long mem_type_id, Object obj)
throws HDF5Exception, HDF5LibraryException, NullPointerException
{
return H5Awrite(attr_id, mem_type_id, obj, true);
}
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from data object to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param obj
* IN: Data object to be written.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5Exception
* - Failure in the data conversion.
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data object is null
**/
public synchronized static int H5Awrite(long attr_id, long mem_type_id, Object obj, boolean isCriticalPinning)
throws HDF5Exception, HDF5LibraryException, NullPointerException
{
int status = -1;
boolean is1D = false;
Class dataClass = obj.getClass();
if (!dataClass.isArray()) {
throw (new HDF5JavaException("H5Dwrite: data is not an array"));
}
String cname = dataClass.getName();
is1D = (cname.lastIndexOf('[') == cname.indexOf('['));
char dname = cname.charAt(cname.lastIndexOf("[") + 1);
if (is1D && (dname == 'B')) {
status = H5Awrite(attr_id, mem_type_id, (byte[]) obj, isCriticalPinning);
}
else if (is1D && (dname == 'S')) {
status = H5Awrite_short(attr_id, mem_type_id, (short[]) obj, isCriticalPinning);
}
else if (is1D && (dname == 'I')) {
status = H5Awrite_int(attr_id, mem_type_id, (int[]) obj, isCriticalPinning);
}
else if (is1D && (dname == 'J')) {
status = H5Awrite_long(attr_id, mem_type_id, (long[]) obj, isCriticalPinning);
}
else if (is1D && (dname == 'F')) {
status = H5Awrite_float(attr_id, mem_type_id, (float[]) obj, isCriticalPinning);
}
else if (is1D && (dname == 'D')) {
status = H5Awrite_double(attr_id, mem_type_id, (double[]) obj, isCriticalPinning);
}
else if (is1D && (dataClass.getComponentType() == String.class)) {
log.trace("H5Dwrite_string type");
status = H5Awrite_string(attr_id, mem_type_id, (String[]) obj);
}
else {
HDFArray theArray = new HDFArray(obj);
byte[] buf = theArray.byteify();
status = H5Awrite(attr_id, mem_type_id, buf);
buf = null;
theArray = null;
}
return status;
}
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of double to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of double with data to be written to the file.
* @param isCriticalPinning
* IN: request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static native int H5Awrite_double(long attr_id, long mem_type_id, double[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of double to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of double with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static int H5Awrite_double(long attr_id, long mem_type_id, double[] buf)
throws HDF5LibraryException, NullPointerException
{
return H5Awrite_double(attr_id, mem_type_id, buf, true);
}
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of float to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of float with data to be written to the file.
* @param isCriticalPinning
* IN: request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static native int H5Awrite_float(long attr_id, long mem_type_id, float[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of float to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of float with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static int H5Awrite_float(long attr_id, long mem_type_id, float[] buf)
throws HDF5LibraryException, NullPointerException
{
return H5Awrite_float(attr_id, mem_type_id, buf, true);
}
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of int to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of int with data to be written to the file.
* @param isCriticalPinning
* IN: request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static native int H5Awrite_int(long attr_id, long mem_type_id, int[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of int to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of int with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static int H5Awrite_int(long attr_id, long mem_type_id, int[] buf)
throws HDF5LibraryException, NullPointerException
{
return H5Awrite_int(attr_id, mem_type_id, buf, true);
}
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of long to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of long with data to be written to the file.
* @param isCriticalPinning
* IN: request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static native int H5Awrite_long(long attr_id, long mem_type_id, long[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of long to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of long with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static int H5Awrite_long(long attr_id, long mem_type_id, long[] buf)
throws HDF5LibraryException, NullPointerException
{
return H5Awrite_long(attr_id, mem_type_id, buf, true);
}
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of short to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of short with data to be written to the file.
* @param isCriticalPinning
* IN: request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static native int H5Awrite_short(long attr_id, long mem_type_id, short[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of short to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of short with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static int H5Awrite_short(long attr_id, long mem_type_id, short[] buf)
throws HDF5LibraryException, NullPointerException
{
return H5Awrite_short(attr_id, mem_type_id, buf, true);
}
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of string to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of string with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static native int H5Awrite_string(long attr_id, long mem_type_id, String[] buf)
throws HDF5LibraryException, NullPointerException;
/**
* H5Awrite writes an attribute, specified with attr_id. The attribute's memory datatype is specified with
* mem_type_id. The entire attribute is written from buffer of variable-lenght to the file.
*
* @param attr_id
* IN: Identifier of an attribute to write.
* @param mem_type_id
* IN: Identifier of the attribute datatype (in memory).
* @param buf
* IN: Buffer of variable-lenght with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data is null.
**/
public synchronized static native int H5AwriteVL(long attr_id, long mem_type_id, Object[] buf)
throws HDF5LibraryException, NullPointerException;
/**
* H5Awrite_VLStrings writes a variable length String dataset, specified by its identifier attr_id, from
* the application memory buffer buffer of variable-lenght strings into the file.
*
* ---- contributed by Rosetta Biosoftware
*
* @param attr_id
* Identifier of the attribute read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param buf
* Buffer of variable-lenght strings with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Awrite_VLStrings(long attr_id, long mem_type_id, Object[] buf)
throws HDF5LibraryException, NullPointerException;
/**
* H5Aget_create_plist retrieves a copy of the attribute creation property list identifier.
*
* @param attr_id
* IN: Identifier of an attribute.
*
* @return identifier for the attribute's creation property list if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Aget_create_plist(long attr_id)
throws HDF5LibraryException
{
long id = _H5Aget_create_plist(attr_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Aget_create_plist add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Aget_create_plist(long attr_id) throws HDF5LibraryException;
/**
* H5Aiterate2 iterates over the attributes attached to a dataset, named datatype, or group, as
* specified by obj_id. For each attribute, user-provided data, op_data, with additional information
* as defined below, is passed to a user-defined function, op, which operates on that attribute.
*
* @param loc_id
* IN: Identifier for object to which attributes are attached; may be group, dataset, or named datatype.
* @param idx_type
* IN: The type of index specified by idx_type can be one of the following:
* H5_INDEX_NAME An alpha-numeric index by attribute name.
* H5_INDEX_CRT_ORDER An index by creation order.
* @param order
* IN: The order in which the index is to be traversed, as specified by order, can be one of the following:
* H5_ITER_INC Iteration is from beginning to end, i.e., a top-down iteration
* incrementing the index position at each step.
* H5_ITER_DEC Iteration starts at the end of the index, i.e., a bottom-up iteration
* decrementing the index position at each step.
* H5_ITER_NATIVE HDF5 iterates in the fastest-available order. No information is provided
* as to the order, but HDF5 ensures that each element in the index will be
* visited if the iteration completes successfully.
* @param idx
* IN/OUT: Initial and returned offset within index.
* @param op
* IN: Callback function to operate on each value.
* @param op_data
* IN/OUT: Pointer to any user-efined data for use by operator function.
*
* @return returns the return value of the first operator that returns a positive value, or zero if all members were
* processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public synchronized static native int H5Aiterate(long loc_id, int idx_type, int order, long idx,
H5A_iterate_cb op, H5A_iterate_t op_data) throws HDF5LibraryException, NullPointerException;
/**
* H5Aiterate_by_name iterates over the attributes attached to the dataset or group specified with loc_id
* and obj_name. For each attribute, user-provided data, op_data, with additional information as defined
* below, is passed to a user-defined function, op, which operates on that attribute.
*
* @param loc_id
* IN: Identifier for object to which attributes are attached; may be group, dataset, or named datatype.
* @param obj_name
* IN: Name of object, relative to location.
* @param idx_type
* IN: The type of index specified by idx_type can be one of the following:
* H5_INDEX_NAME An alpha-numeric index by attribute name.
* H5_INDEX_CRT_ORDER An index by creation order.
* @param order
* IN: The order in which the index is to be traversed, as specified by order, can be one of the following:
* H5_ITER_INC Iteration is from beginning to end, i.e., a top-down iteration
* incrementing the index position at each step.
* H5_ITER_DEC Iteration starts at the end of the index, i.e., a bottom-up iteration
* decrementing the index position at each step.
* H5_ITER_NATIVE HDF5 iterates in the fastest-available order. No information is provided
* as to the order, but HDF5 ensures that each element in the index will be
* visited if the iteration completes successfully.
* @param idx
* IN/OUT: Initial and returned offset within index.
* @param op
* IN: Callback function to operate on each value.
* @param op_data
* IN/OUT: Pointer to any user-efined data for use by operator function.
* @param lapl_id
* IN: Link access property list
*
* @return returns the return value of the first operator that returns a positive value, or zero if all members were
* processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public synchronized static native int H5Aiterate_by_name(long loc_id, String obj_name, int idx_type,
int order, long idx, H5A_iterate_cb op, H5A_iterate_t op_data, long lapl_id) throws HDF5LibraryException, NullPointerException;
// ////////////////////////////////////////////////////////////
// //
// H5AC: Cache Interface Functions //
// //
// ////////////////////////////////////////////////////////////
// No public Functions
// ////////////////////////////////////////////////////////////
// //
// H5B: B-link-tree Interface Functions //
// //
// ////////////////////////////////////////////////////////////
// No public Functions
// ////////////////////////////////////////////////////////////
// //
// H5B2: v2 B-tree Interface Functions //
// //
// ////////////////////////////////////////////////////////////
// No public Functions
// ////////////////////////////////////////////////////////////
// //
// H5C: Cache Interface Functions //
// //
// ////////////////////////////////////////////////////////////
// No public Functions
// ////////////////////////////////////////////////////////////
// //
// H5D: Datasets Interface Functions //
// //
// ////////////////////////////////////////////////////////////
/**
* H5Dcopy copies the content of one dataset to another dataset.
*
* @param src_did
* the identifier of the source dataset
* @param dst_did
* the identifier of the destinaiton dataset
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native int H5Dcopy(long src_did, long dst_did) throws HDF5LibraryException;
/**
* H5Dclose ends access to a dataset specified by dataset_id and releases resources used by it.
*
* @param dataset_id
* Identifier of the dataset to finish access to.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Dclose(long dataset_id) throws HDF5LibraryException {
if (dataset_id < 0)
return 0; // throw new HDF5LibraryException("Negative ID");
log.trace("OPEN_IDS: H5Dclose remove {}", dataset_id);
OPEN_IDS.remove(dataset_id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
return _H5Dclose(dataset_id);
}
private synchronized static native int _H5Dclose(long dataset_id) throws HDF5LibraryException;
/**
* H5Dcreate creates a new dataset named name at the location specified by loc_id.
*
* @param loc_id
* IN: Location identifier
* @param name
* IN: Dataset name
* @param type_id
* IN: Datatype identifier
* @param space_id
* IN: Dataspace identifier
* @param lcpl_id
* IN: Identifier of link creation property list.
* @param dcpl_id
* IN: Identifier of dataset creation property list.
* @param dapl_id
* IN: Identifier of dataset access property list.
*
* @return a dataset identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static long H5Dcreate(long loc_id, String name, long type_id, long space_id, long lcpl_id, long dcpl_id,
long dapl_id) throws HDF5LibraryException, NullPointerException {
long id = _H5Dcreate2(loc_id, name, type_id, space_id, lcpl_id, dcpl_id, dapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Dcreate add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
/**
* H5Dcreate2 creates a new dataset named name at the location specified by loc_id.
*
* @see public static int H5Dcreate(int loc_id, String name, int type_id, int space_id, int lcpl_id, int dcpl_id,
* int dapl_id)
**/
private synchronized static native long _H5Dcreate2(long loc_id, String name, long type_id, long space_id,
long lcpl_id, long dcpl_id, long dapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Dcreate_anon creates a dataset in the file specified by loc_id.
*
* @param loc_id
* IN: Location identifier
* @param type_id
* IN: Datatype identifier
* @param space_id
* IN: Dataspace identifier
* @param dcpl_id
* IN: Identifier of dataset creation property list.
* @param dapl_id
* IN: Identifier of dataset access property list.
*
* @return a dataset identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Dcreate_anon(long loc_id, long type_id, long space_id, long dcpl_id, long dapl_id)
throws HDF5LibraryException {
long id = _H5Dcreate_anon(loc_id, type_id, space_id, dcpl_id, dapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Dcreate_anon add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Dcreate_anon(long loc_id, long type_id, long space_id, long dcpl_id,
long dapl_id) throws HDF5LibraryException;
/**
* H5Dfill explicitly fills the dataspace selection in memory, space_id, with the fill value specified in fill.
*
* @param fill
* IN: Pointer to the fill value to be used.
* @param fill_type
* IN: Fill value datatype identifier.
* @param buf
* IN/OUT: Pointer to the memory buffer containing the selection to be filled.
* @param buf_type
* IN: Datatype of dataspace elements to be filled.
* @param space_id
* IN: Dataspace describing memory buffer and containing the selection to be filled.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public synchronized static native void H5Dfill(byte[] fill, long fill_type, byte[] buf, long buf_type, long space_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Dget_access_plist returns an identifier for a copy of the dataset access property list for a dataset.
*
* @param dset_id
* IN: Identifier of the dataset to query.
*
* @return a dataset access property list identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Dget_access_plist(long dset_id) throws HDF5LibraryException;
/**
* H5Dget_create_plist returns an identifier for a copy of the dataset creation property list for a dataset.
*
* @param dataset_id
* Identifier of the dataset to query.
* @return a dataset creation property list identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Dget_create_plist(long dataset_id) throws HDF5LibraryException {
long id = _H5Dget_create_plist(dataset_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Dget_create_plist add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Dget_create_plist(long dataset_id) throws HDF5LibraryException;
/**
* H5Dget_offset returns the address in the file of the dataset dset_id.
*
* @param dset_id
* IN: Identifier of the dataset in question
*
* @return the offset in bytes.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Dget_offset(long dset_id) throws HDF5LibraryException;
/**
* H5Dget_space returns an identifier for a copy of the dataspace for a dataset.
*
* @param dataset_id
* Identifier of the dataset to query.
*
* @return a dataspace identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Dget_space(long dataset_id) throws HDF5LibraryException {
long id = _H5Dget_space(dataset_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Dget_space add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Dget_space(long dataset_id) throws HDF5LibraryException;
/**
* H5Dget_space_status determines whether space has been allocated for the dataset dset_id.
*
* @param dset_id
* IN: Identifier of the dataset to query.
*
* @return the space allocation status
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Dget_space_status(long dset_id) throws HDF5LibraryException;
/**
* H5Dget_storage_size returns the amount of storage that is required for the dataset.
*
* @param dataset_id
* Identifier of the dataset in question
*
* @return he amount of storage space allocated for the dataset.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Dget_storage_size(long dataset_id) throws HDF5LibraryException,
IllegalArgumentException;
/**
* H5Dget_type returns an identifier for a copy of the datatype for a dataset.
*
* @param dataset_id
* Identifier of the dataset to query.
*
* @return a datatype identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Dget_type(long dataset_id) throws HDF5LibraryException {
long id = _H5Dget_type(dataset_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Dget_type add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Dget_type(long dataset_id) throws HDF5LibraryException;
/**
* H5Diterate iterates over all the data elements in the memory buffer buf, executing the callback function operator
* once for each such data element.
*
* @param buf
* IN/OUT: Pointer to the memory containing the elements to iterate over.
* @param buf_type
* IN: Buffer datatype identifier.
* @param space_id
* IN: Dataspace describing memory buffer.
* @param op
* IN: Callback function to operate on each value.
* @param op_data
* IN/OUT: Pointer to any user-efined data for use by operator function.
*
* @return returns the return value of the first operator that returns a positive value, or zero if all members were
* processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public synchronized static native int H5Diterate(byte[] buf, long buf_type, long space_id, H5D_iterate_cb op,
H5D_iterate_t op_data) throws HDF5LibraryException, NullPointerException;
/**
* H5Dopen opens the existing dataset specified by a location identifier and name, loc_id and name, respectively.
*
* @param loc_id
* IN: Location identifier
* @param name
* IN: Dataset name
* @param dapl_id
* IN: Identifier of dataset access property list.
*
* @return a dataset identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static long H5Dopen(long loc_id, String name, long dapl_id) throws HDF5LibraryException, NullPointerException
{
long id = _H5Dopen2(loc_id, name, dapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Dopen add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
/**
* H5Dopen2 opens the existing dataset specified by a location identifier and name, loc_id and name, respectively.
*
* @see public static int H5Dopen(int loc_id, String name, int dapl_id)
**/
private synchronized static native long _H5Dopen2(long loc_id, String name, long dapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer buf.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param obj
* Buffer to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Dread(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, byte[] obj, boolean isCriticalPinning) throws HDF5LibraryException,
NullPointerException;
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer buf.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Dread(long dataset_id, long mem_type_id, long mem_space_id, long file_space_id,
long xfer_plist_id, byte[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dread(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer buf.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param obj
* Buffer to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Dread(long dataset_id, long mem_type_id, long mem_space_id, long file_space_id,
long xfer_plist_id, Object obj) throws HDF5Exception, HDF5LibraryException, NullPointerException
{
return H5Dread(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, obj, true);
}
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* data object.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param obj
* Object to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5Exception
* - Failure in the data conversion.
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data object is null.
**/
public synchronized static int H5Dread(long dataset_id, long mem_type_id, long mem_space_id, long file_space_id,
long xfer_plist_id, Object obj, boolean isCriticalPinning) throws HDF5Exception, HDF5LibraryException,
NullPointerException
{
int status = -1;
boolean is1D = false;
Class dataClass = obj.getClass();
if (!dataClass.isArray()) {
throw (new HDF5JavaException("H5Dread: data is not an array"));
}
String cname = dataClass.getName();
is1D = (cname.lastIndexOf('[') == cname.indexOf('['));
char dname = cname.charAt(cname.lastIndexOf("[") + 1);
log.trace("H5Dread: cname={} is1D={} dname={}", cname, is1D, dname);
if (is1D && (dname == 'B')) {
log.trace("H5Dread_dname_B");
status = H5Dread(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, (byte[]) obj,
isCriticalPinning);
}
else if (is1D && (dname == 'S')) {
log.trace("H5Dread_dname_S");
status = H5Dread_short(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, (short[]) obj,
isCriticalPinning);
}
else if (is1D && (dname == 'I')) {
log.trace("H5Dread_dname_I");
status = H5Dread_int(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, (int[]) obj,
isCriticalPinning);
}
else if (is1D && (dname == 'J')) {
log.trace("H5Dread_dname_J");
status = H5Dread_long(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, (long[]) obj,
isCriticalPinning);
}
else if (is1D && (dname == 'F')) {
log.trace("H5Dread_dname_F");
status = H5Dread_float(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, (float[]) obj,
isCriticalPinning);
}
else if (is1D && (dname == 'D')) {
log.trace("H5Dread_dname_D");
status = H5Dread_double(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id,
(double[]) obj, isCriticalPinning);
}
else if ((H5.H5Tdetect_class(mem_type_id, HDF5Constants.H5T_REFERENCE) &&
(is1D && (dataClass.getComponentType() == String.class))) ||
H5.H5Tequal(mem_type_id, HDF5Constants.H5T_STD_REF_DSETREG)) {
log.trace("H5Dread_reg_ref");
status = H5Dread_reg_ref(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id,
(String[]) obj);
}
else if (is1D && (dataClass.getComponentType() == String.class)) {
log.trace("H5Dread_string type");
status = H5Dread_string(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id,
(String[]) obj);
}
else {
// Create a data buffer to hold the data into a Java Array
HDFArray theArray = new HDFArray(obj);
byte[] buf = theArray.emptyBytes();
log.trace("H5Dread_else");
// will raise exception if read fails
status = H5Dread(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf,
isCriticalPinning);
if (status >= 0) {
// convert the data into a Java Array
obj = theArray.arrayify(buf);
}
// clean up these: assign 'null' as hint to gc()
buf = null;
theArray = null;
}
return status;
}
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of type double.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of type double to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Dread_double(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, double[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of type double.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of double to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Dread_double(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, double[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dread_double(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of float.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of float to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Dread_float(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, float[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of float.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of float to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Dread_float(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, float[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dread_float(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of int.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of int to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Dread_int(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, int[] buf, boolean isCriticalPinning) throws HDF5LibraryException,
NullPointerException;
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of int.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of int to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Dread_int(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, int[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dread_int(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of long.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of long to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Dread_long(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, long[] buf, boolean isCriticalPinning) throws HDF5LibraryException,
NullPointerException;
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of long.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of long to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Dread_long(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, long[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dread_long(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of string.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of string to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Dread_reg_ref(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, String[] buf) throws HDF5LibraryException, NullPointerException;
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of short.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of short to store data read from the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Dread_short(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, short[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of short.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of short to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static int H5Dread_short(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, short[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dread_short(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of variable-lenght.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of variable-lenght to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5DreadVL(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, Object[] buf) throws HDF5LibraryException, NullPointerException;
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of string.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of string to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Dread_string(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, String[] buf) throws HDF5LibraryException, NullPointerException;
/**
* H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application
* memory buffer of variable-lenght strings.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of variable-lenght strings to store data read from the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data buffer is null.
**/
public synchronized static native int H5Dread_VLStrings(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, Object[] buf) throws HDF5LibraryException, NullPointerException;
/**
* H5Dset_extent sets the current dimensions of the chunked dataset dset_id to the sizes specified in size.
*
* @param dset_id
* IN: Chunked dataset identifier.
* @param size
* IN: Array containing the new magnitude of each dimension of the dataset.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - size is null.
**/
public synchronized static native void H5Dset_extent(long dset_id, long size[]) throws HDF5LibraryException,
NullPointerException;
/**
* H5Dvlen_get_buf_size determines the number of bytes required to store the VL data from the dataset, using the
* space_id for the selection in the dataset on disk and the type_id for the memory representation of the VL data in
* memory.
*
* @param dset_id
* IN: Identifier of the dataset read from.
* @param type_id
* IN: Identifier of the datatype.
* @param space_id
* IN: Identifier of the dataspace.
*
* @return the size in bytes of the memory buffer required to store the VL data.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public synchronized static native long H5Dvlen_get_buf_size(long dset_id, long type_id, long space_id)
throws HDF5LibraryException;
/**
* H5Dvlen_reclaim reclaims buffer used for VL data.
*
* @param type_id
* Identifier of the datatype.
* @param space_id
* Identifier of the dataspace.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer with data to be reclaimed.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
*
* @deprecated As of HDF5 1.12.0 in favor of H5Treclaim
**/
@Deprecated
public synchronized static native int H5Dvlen_reclaim(long type_id, long space_id, long xfer_plist_id, byte[] buf)
throws HDF5LibraryException, NullPointerException;
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer with data to be written to the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Dwrite(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, byte[] buf, boolean isCriticalPinning) throws HDF5LibraryException,
NullPointerException;
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static int H5Dwrite(long dataset_id, long mem_type_id, long mem_space_id, long file_space_id,
long xfer_plist_id, byte[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dwrite(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param obj
* Buffer with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static int H5Dwrite(long dataset_id, long mem_type_id, long mem_space_id, long file_space_id,
long xfer_plist_id, Object obj) throws HDF5Exception, HDF5LibraryException, NullPointerException
{
return H5Dwrite(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, obj, true);
}
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory data
* object into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param obj
* Object with data to be written to the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5Exception
* - Failure in the data conversion.
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - data object is null.
**/
public synchronized static int H5Dwrite(long dataset_id, long mem_type_id, long mem_space_id, long file_space_id,
long xfer_plist_id, Object obj, boolean isCriticalPinning) throws HDF5Exception, HDF5LibraryException,
NullPointerException
{
int status = -1;
boolean is1D = false;
Class dataClass = obj.getClass();
if (!dataClass.isArray()) {
throw (new HDF5JavaException("H5Dwrite: data is not an array"));
}
String cname = dataClass.getName();
is1D = (cname.lastIndexOf('[') == cname.indexOf('['));
char dname = cname.charAt(cname.lastIndexOf("[") + 1);
if (is1D && (dname == 'B')) {
status = H5Dwrite(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, (byte[]) obj,
isCriticalPinning);
}
else if (is1D && (dname == 'S')) {
status = H5Dwrite_short(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, (short[]) obj,
isCriticalPinning);
}
else if (is1D && (dname == 'I')) {
status = H5Dwrite_int(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, (int[]) obj,
isCriticalPinning);
}
else if (is1D && (dname == 'J')) {
status = H5Dwrite_long(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, (long[]) obj,
isCriticalPinning);
}
else if (is1D && (dname == 'F')) {
status = H5Dwrite_float(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, (float[]) obj,
isCriticalPinning);
}
else if (is1D && (dname == 'D')) {
status = H5Dwrite_double(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id,
(double[]) obj, isCriticalPinning);
}
else if (is1D && (dataClass.getComponentType() == String.class)) {
log.trace("H5Dwrite_string type");
status = H5Dwrite_string(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id,
(String[]) obj);
}
else {
HDFArray theArray = new HDFArray(obj);
byte[] buf = theArray.byteify();
// will raise exception on error
status = H5Dwrite(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf,
isCriticalPinning);
// clean up these: assign 'null' as hint to gc()
buf = null;
theArray = null;
}
return status;
}
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of double with data to be written to the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Dwrite_double(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, double[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of double with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static int H5Dwrite_double(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, double[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dwrite_double(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of float with data to be written to the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Dwrite_float(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, float[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of float with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static int H5Dwrite_float(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, float[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dwrite_float(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of int with data to be written to the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Dwrite_int(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, int[] buf, boolean isCriticalPinning) throws HDF5LibraryException,
NullPointerException;
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of int with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static int H5Dwrite_int(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, int[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dwrite_int(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of long with data to be written to the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Dwrite_long(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, long[] buf, boolean isCriticalPinning) throws HDF5LibraryException,
NullPointerException;
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of long with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static int H5Dwrite_long(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, long[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dwrite_long(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of short with data to be written to the file.
* @param isCriticalPinning
* request lock on data reference.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Dwrite_short(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, short[] buf, boolean isCriticalPinning)
throws HDF5LibraryException, NullPointerException;
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of short with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static int H5Dwrite_short(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, short[] buf) throws HDF5LibraryException, NullPointerException
{
return H5Dwrite_short(dataset_id, mem_type_id, mem_space_id, file_space_id, xfer_plist_id, buf, true);
}
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of string with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Dwrite_string(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, String[] buf) throws HDF5LibraryException, NullPointerException;
/**
* H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer
* into the file.
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer of variable-length with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5DwriteVL(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, Object[] buf) throws HDF5LibraryException, NullPointerException;
/**
* H5Dwrite_VLStrings writes a (partial) variable length String dataset, specified by its identifier dataset_id, from
* the application memory buffer buf into the file.
*
* ---- contributed by Rosetta Biosoftware
*
* @param dataset_id
* Identifier of the dataset read from.
* @param mem_type_id
* Identifier of the memory datatype.
* @param mem_space_id
* Identifier of the memory dataspace.
* @param file_space_id
* Identifier of the dataset's dataspace in the file.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer with data to be written to the file.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Dwrite_VLStrings(long dataset_id, long mem_type_id, long mem_space_id,
long file_space_id, long xfer_plist_id, Object[] buf) throws HDF5LibraryException, NullPointerException;
/**
* H5Dflush causes all buffers associated with a dataset to be immediately flushed to disk without removing the
* data from the cache.
*
* @param dset_id
* IN: Identifier of the dataset to be flushed.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Dflush(long dset_id) throws HDF5LibraryException;
/**
* H5Drefresh causes all buffers associated with a dataset to be cleared and immediately re-loaded with updated
* contents from disk. This function essentially closes the dataset, evicts all metadata associated with it
* from the cache, and then re-opens the dataset. The reopened dataset is automatically re-registered with the same ID.
*
* @param dset_id
* IN: Identifier of the dataset to be refreshed.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Drefresh(long dset_id) throws HDF5LibraryException;
// /////// unimplemented ////////
// herr_t H5Ddebug(hid_t dset_id);
// herr_t H5Dget_chunk_storage_size(hid_t dset_id, const hsize_t *offset, hsize_t *chunk_bytes);
// herr_t H5Dformat_convert(hid_t dset_id);
// herr_t H5Dget_chunk_index_type(hid_t did, H5D_chunk_index_t *idx_type);
// herr_t H5Dgather(hid_t src_space_id, const void *src_buf, hid_t type_id,
// size_t dst_buf_size, void *dst_buf, H5D_gather_func_t op, void *op_data);
// herr_t H5Dscatter(H5D_scatter_func_t op, void *op_data, hid_t type_id, hid_t dst_space_id, void *dst_buf);
// ////////////////////////////////////////////////////////////
// //
// H5E: Error Stack //
// //
// ////////////////////////////////////////////////////////////
/**
* H5Eauto_is_v2 determines whether the error auto reporting function for an error stack conforms to the H5E_auto2_t
* typedef or the H5E_auto1_t typedef.
*
* @param stack_id
* IN: Error stack identifier.
*
* @return boolean true if the error stack conforms to H5E_auto2_t and false if it conforms to H5E_auto1_t.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Eauto_is_v2(long stack_id) throws HDF5LibraryException;
/**
* H5Eclear clears the error stack for the current thread. H5Eclear can fail if there are problems initializing the
* library.
* <p>
* This may be used by exception handlers to assure that the error condition in the HDF-5 library has been reset.
*
* @return Returns a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Eclear() throws HDF5LibraryException {
H5Eclear2(HDF5Constants.H5E_DEFAULT);
return 0;
}
/**
* H5Eclear clears the error stack specified by estack_id, or, if estack_id is set to H5E_DEFAULT, the error stack
* for the current thread.
*
* @param stack_id
* IN: Error stack identifier.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static void H5Eclear(long stack_id) throws HDF5LibraryException {
H5Eclear2(stack_id);
}
/**
* H5Eclear2 clears the error stack specified by estack_id, or, if estack_id is set to H5E_DEFAULT, the error stack
* for the current thread.
*
* @param stack_id
* IN: Error stack identifier.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Eclear2(long stack_id) throws HDF5LibraryException;
/**
* H5Eclose_msg closes an error message identifier, which can be either a major or minor message.
*
* @param err_id
* IN: Error message identifier.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Eclose_msg(long err_id) throws HDF5LibraryException;
/**
* H5Eclose_stack closes the object handle for an error stack and releases its resources.
*
* @param stack_id
* IN: Error stack identifier.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Eclose_stack(long stack_id) throws HDF5LibraryException;
/**
* H5Ecreate_msg adds an error message to an error class defined by client library or application program.
*
* @param cls_id
* IN: Error class identifier.
* @param msg_type
* IN: The type of the error message.
* @param msg
* IN: The error message.
*
* @return a message identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - msg is null.
**/
public synchronized static native long H5Ecreate_msg(long cls_id, int msg_type, String msg)
throws HDF5LibraryException, NullPointerException;
/**
* H5Ecreate_stack creates a new empty error stack and returns the new stack's identifier.
*
* @return an error stack identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Ecreate_stack() throws HDF5LibraryException;
/**
* H5Eget_class_name retrieves the name of the error class specified by the class identifier.
*
* @param class_id
* IN: Error class identifier.
*
* @return the name of the error class
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native String H5Eget_class_name(long class_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Eget_current_stack copies the current error stack and returns an error stack identifier for the new copy.
*
* @return an error stack identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Eget_current_stack() throws HDF5LibraryException;
/**
* H5Eset_current_stack replaces the content of the current error stack with a copy of the content of the error
* stack specified by estack_id.
*
* @param stack_id
* IN: Error stack identifier.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Eset_current_stack(long stack_id) throws HDF5LibraryException;
/**
* H5Eget_msg retrieves the error message including its length and type.
*
* @param msg_id
* IN: Name of the error class.
* @param type_list
* OUT: The type of the error message. Valid values are H5E_MAJOR and H5E_MINOR.
*
* @return the error message
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native String H5Eget_msg(long msg_id, int[] type_list) throws HDF5LibraryException;
/**
* H5Eget_num retrieves the number of error records in the error stack specified by estack_id (including major,
* minor messages and description).
*
* @param stack_id
* IN: Error stack identifier.
*
* @return the number of error messages
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Eget_num(long stack_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Eprint2 prints the error stack specified by estack_id on the specified stream, stream.
*
* @param stack_id
* IN: Error stack identifier.If the identifier is H5E_DEFAULT, the current error stack will be printed.
* @param stream
* IN: File pointer, or stderr if null.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Eprint2(long stack_id, Object stream) throws HDF5LibraryException;
/**
* H5Epop deletes the number of error records specified in count from the top of the error stack specified by
* estack_id (including major, minor messages and description).
*
* @param stack_id
* IN: Error stack identifier.
* @param count
* IN: Version of the client library or application to which the error class belongs.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Epop(long stack_id, long count) throws HDF5LibraryException;
/**
* H5Epush pushes a new error record onto the error stack specified by estack_id.
*
* @param stack_id
* IN: Error stack identifier.
* @param file
* IN: Name of the file in which the error was detected.
* @param func
* IN: Name of the function in which the error was detected.
* @param line
* IN: Line number within the file at which the error was detected.
* @param cls_id
* IN: Error class identifier.
* @param maj_id
* IN: Major error identifier.
* @param min_id
* IN: Minor error identifier.
* @param msg
* IN: Error description string.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - file, func, or msg is null.
**/
public static void H5Epush(long stack_id, String file, String func, int line,
long cls_id, long maj_id, long min_id, String msg) throws HDF5LibraryException, NullPointerException
{
H5Epush2(stack_id, file, func, line, cls_id, maj_id, min_id, msg);
}
/**
* H5Epush2 pushes a new error record onto the error stack specified by estack_id.
*
* @param stack_id
* IN: Error stack identifier.
* @param file
* IN: Name of the file in which the error was detected.
* @param func
* IN: Name of the function in which the error was detected.
* @param line
* IN: Line number within the file at which the error was detected.
* @param cls_id
* IN: Error class identifier.
* @param maj_id
* IN: Major error identifier.
* @param min_id
* IN: Minor error identifier.
* @param msg
* IN: Error description string.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - file, func, or msg is null.
**/
public synchronized static native void H5Epush2(long stack_id, String file, String func, int line,
long cls_id, long maj_id, long min_id, String msg) throws HDF5LibraryException, NullPointerException;
/**
* H5Eregister_class registers a client library or application program to the HDF5 error API so that the client
* library or application program can report errors together with HDF5 library.
*
* @param cls_name
* IN: Name of the error class.
* @param lib_name
* IN: Name of the client library or application to which the error class belongs.
* @param version
* IN: Version of the client library or application to which the error class belongs.
*
* @return a class identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native long H5Eregister_class(String cls_name, String lib_name, String version)
throws HDF5LibraryException, NullPointerException;
/**
* H5Eunregister_class removes the error class specified by class_id.
*
* @param class_id
* IN: Error class identifier.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Eunregister_class(long class_id) throws HDF5LibraryException;
/**
* H5Ewalk walks the error stack specified by estack_id for the current thread and calls the
* function specified in func for each error along the way.
*
* @param stack_id
* IN: Error stack identifier.
* @param direction
* IN: Direction in which the error stack is to be walked.
* @param func
* IN: Function to be called for each error encountered.
* @param client_data
* IN: Data to be passed with func.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - func is null.
**/
public static void H5Ewalk(long stack_id, long direction, H5E_walk_cb func, H5E_walk_t client_data) throws HDF5LibraryException, NullPointerException
{
H5Ewalk2(stack_id, direction, func, client_data);
}
/**
* H5Ewalk2 walks the error stack specified by estack_id for the current thread and calls the
* function specified in func for each error along the way.
*
* @param stack_id
* IN: Error stack identifier.
* @param direction
* IN: Direction in which the error stack is to be walked.
* @param func
* IN: Function to be called for each error encountered.
* @param client_data
* IN: Data to be passed with func.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - func is null.
**/
public synchronized static native void H5Ewalk2(long stack_id, long direction, H5E_walk_cb func, H5E_walk_t client_data)
throws HDF5LibraryException, NullPointerException;
// /////// unimplemented ////////
// public interface H5E_auto2_t extends Callback
// {
// int callback(int estack, Pointer client_data);
// }
// int H5Eget_auto(long estack_id, H5E_auto2_t func, PointerByReference client_data);
// {
// return H5Eget_auto2(estack_id, func, client_data);
// }
// int H5Eget_auto2(long estack_id, H5E_auto2_t func, PointerByReference client_data);
// int H5Eset_auto(long estack_id, H5E_auto2_t func, Pointer client_data);
// {
// return H5Eset_auto2(estack_id, func, client_data);
// }
// int H5Eset_auto2(long estack_id, H5E_auto2_t func, Pointer client_data);
// public static void H5Epush(long err_stack, String file, String func, int line,
// long cls_id, long maj_id, long min_id, String msg, ...)
// {
// H5Epush2(err_stack, file, func, line, cls_id, maj_id, min_id, msg, ...);
// }
// public synchronized static native void H5Epush2(long err_stack, String file, String func, int line,
// long cls_id, long maj_id, long min_id, String msg, ...);
// ////////////////////////////////////////////////////////////
// //
// H5F: File Interface Functions //
// //
// ////////////////////////////////////////////////////////////
/**
* H5Fclose terminates access to an HDF5 file.
*
* @param file_id
* Identifier of a file to terminate access to.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Fclose(long file_id) throws HDF5LibraryException {
if (file_id < 0)
return 0; // throw new HDF5LibraryException("Negative ID");;
log.trace("OPEN_IDS: H5Fclose remove {}", file_id);
OPEN_IDS.remove(file_id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
return _H5Fclose(file_id);
}
private synchronized static native int _H5Fclose(long file_id) throws HDF5LibraryException;
/**
* H5Fopen opens an existing file and is the primary function for accessing existing HDF5 files.
*
* @param name
* Name of the file to access.
* @param flags
* File access flags.
* @param access_id
* Identifier for the file access properties list.
*
* @return a file identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static long H5Fopen(String name, int flags, long access_id) throws HDF5LibraryException,
NullPointerException {
long id = _H5Fopen(name, flags, access_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Fopen add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Fopen(String name, int flags, long access_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Freopen reopens an HDF5 file.
*
* @param file_id
* Identifier of a file to terminate and reopen access to.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @return a new file identifier if successful
**/
public static long H5Freopen(long file_id) throws HDF5LibraryException {
long id = _H5Freopen(file_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Freopen add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Freopen(long file_id) throws HDF5LibraryException;
/**
* H5Fcreate is the primary function for creating HDF5 files.
*
* @param name
* Name of the file to access.
* @param flags
* File access flags. Possible values include:
* <UL>
* <LI>
* H5F_ACC_RDWR Allow read and write access to file.</LI>
* <LI>
* H5F_ACC_RDONLY Allow read-only access to file.</LI>
* <LI>
* H5F_ACC_TRUNC Truncate file, if it already exists, erasing all data previously stored in the file.</LI>
* <LI>
* H5F_ACC_EXCL Fail if file already exists.</LI>
* <LI>
* H5P_DEFAULT Apply default file access and creation properties.</LI>
* </UL>
*
* @param create_id
* File creation property list identifier, used when modifying default file meta-data. Use H5P_DEFAULT
* for default access properties.
* @param access_id
* File access property list identifier. If parallel file access is desired, this is a collective call
* according to the communicator stored in the access_id (not supported in Java). Use H5P_DEFAULT for
* default access properties.
*
* @return a file identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static long H5Fcreate(String name, int flags, long create_id, long access_id) throws HDF5LibraryException,
NullPointerException {
long id = _H5Fcreate(name, flags, create_id, access_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Fcreate add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Fcreate(String name, int flags, long create_id, long access_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Fflush causes all buffers associated with a file or object to be immediately flushed (written) to disk without
* removing the data from the (memory) cache.
* <P>
* After this call completes, the file (or object) is in a consistent state and all data written to date is assured
* to be permanent.
*
* @param object_id
* Identifier of object used to identify the file. <b>object_id</b> can be any object associated with the
* file, including the file itself, a dataset, a group, an attribute, or a named data type.
* @param scope
* specifies the scope of the flushing action, in the case that the HDF-5 file is not a single physical
* file.
* <P>
* Valid values are:
* <UL>
* <LI>
* H5F_SCOPE_GLOBAL Flushes the entire virtual file.</LI>
* <LI>
* H5F_SCOPE_LOCAL Flushes only the specified file.</LI>
* </UL>
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Fflush(long object_id, int scope) throws HDF5LibraryException;
/**
* H5Fget_access_plist returns the file access property list identifier of the specified file.
*
* @param file_id
* Identifier of file to get access property list of
*
* @return a file access property list identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Fget_access_plist(long file_id) throws HDF5LibraryException {
long id = _H5Fget_access_plist(file_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Fget_access_plist add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Fget_access_plist(long file_id) throws HDF5LibraryException;
/**
* H5Fget_create_plist returns a file creation property list identifier identifying the creation properties used to
* create this file.
*
* @param file_id
* Identifier of the file to get creation property list
*
* @return a file creation property list identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Fget_create_plist(long file_id) throws HDF5LibraryException {
long id = _H5Fget_create_plist(file_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Fget_create_plist add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Fget_create_plist(long file_id) throws HDF5LibraryException;
/**
* H5Fget_filesize retrieves the file size of the HDF5 file. This function
* is called after an existing file is opened in order
* to learn the true size of the underlying file.
*
* @param file_id
* IN: File identifier for a currently-open HDF5 file
*
* @return the file size of the HDF5 file
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Fget_filesize(long file_id) throws HDF5LibraryException;
/**
* H5Fget_freespace returns the amount of space that is unused by any objects in the file.
*
* @param file_id
* IN: File identifier for a currently-open HDF5 file
*
* @return the amount of free space in the file
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Fget_freespace(long file_id) throws HDF5LibraryException;
/**
* H5Fget_intent retrieves the intended access mode flag passed with H5Fopen when the file was opened.
*
* @param file_id
* IN: File identifier for a currently-open HDF5 file
*
* @return the intended access mode flag, as originally passed with H5Fopen.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Fget_intent(long file_id) throws HDF5LibraryException;
/**
* H5Fget_fileno retrieves the "file number" for an open file.
*
* @param file_id
* IN: File identifier for a currently-open HDF5 file
*
* @return the unique file number for the file.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Fget_fileno(long file_id) throws HDF5LibraryException;
/**
* H5Fget_mdc_hit_rate queries the metadata cache of the target file to obtain its hit rate (cache hits / (cache
* hits + cache misses)) since the last time hit rate statistics were reset.
*
* @param file_id
* IN: Identifier of the target file.
*
* @return the double in which the hit rate is returned.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native double H5Fget_mdc_hit_rate(long file_id) throws HDF5LibraryException;
/**
* H5Fget_mdc_size queries the metadata cache of the target file for the desired size information.
*
* @param file_id
* IN: Identifier of the target file.
* @param metadata_cache
* OUT: Current metadata cache information
* <ul>
* <li>metadata_cache[0] = max_size_ptr // current cache maximum size</li>
* <li>metadata_cache[1] = min_clean_size_ptr // current cache minimum clean size</li>
* <li>metadata_cache[2] = cur_size_ptr // current cache size</li>
* </ul>
*
* @return current number of entries in the cache
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - metadata_cache is null.
**/
public synchronized static native int H5Fget_mdc_size(long file_id, long[] metadata_cache)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Fget_name retrieves the name of the file to which the object obj_id belongs.
*
* @param obj_id
* IN: Identifier of the object for which the associated filename is sought.
*
* @return the filename.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native String H5Fget_name(long obj_id) throws HDF5LibraryException;
/**
* H5Fget_obj_count returns the number of open object identifiers for the file.
*
* @param file_id
* IN: File identifier for a currently-open HDF5 file
* @param types
* IN: Type of object for which identifiers are to be returned.
* <ul>
* <li>H5F_OBJ_FILE Files only</li>
* <li>H5F_OBJ_DATASET Datasets only</li>
* <li>H5F_OBJ_GROUP Groups only</li>
* <li>H5F_OBJ_DATATYPE Named datatypes only</li>
* <li>H5F_OBJ_ATTR Attributes only</li>
* <li>H5F_OBJ_ALL All of the above</li>
* <li>H5F_OBJ_LOCAL Restrict search to objects opened through current file identifier.</li>
* </ul>
*
* @return the number of open objects.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Fget_obj_count(long file_id, int types) throws HDF5LibraryException;
/**
* H5Fget_obj_ids returns the list of identifiers for all open HDF5 objects fitting the specified criteria.
*
* @param file_id
* IN: File identifier for a currently-open HDF5 file
* @param types
* IN: Type of object for which identifiers are to be returned.
* @param max_objs
* IN: Maximum number of object identifiers to place into obj_id_list.
* @param obj_id_list
* OUT: Pointer to the returned list of open object identifiers.
*
* @return the number of objects placed into obj_id_list.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - obj_id_list is null.
**/
public synchronized static native long H5Fget_obj_ids(long file_id, int types, long max_objs, long[] obj_id_list)
throws HDF5LibraryException, NullPointerException;
/**
* H5Fis_hdf5 determines whether a file is in the HDF5 format.
*
* @param name
* File name to check format.
*
* @return true if is HDF-5, false if not.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
*
* @deprecated As of HDF5 1.10.5 in favor of H5Fis_accessible.
**/
@Deprecated
public synchronized static native boolean H5Fis_hdf5(String name) throws HDF5LibraryException, NullPointerException;
/**
* H5Fis_accessible determines if the file can be opened with the given fapl.
*
* @param name
* IN: File name to check.
* @param file_id
* IN: File identifier for a currently-open HDF5 file
*
* @return true if file is accessible, false if not.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native boolean H5Fis_accessible(String name, long file_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Fmount mounts the file specified by child_id onto the group specified by loc_id and name using the mount
* properties plist_id.
*
* @param loc_id
* The identifier for the group onto which the file specified by child_id is to be mounted.
* @param name
* The name of the group onto which the file specified by child_id is to be mounted.
* @param child_id
* The identifier of the file to be mounted.
* @param plist_id
* The identifier of the property list to be used.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Fmount(long loc_id, String name, long child_id, long plist_id)
throws HDF5LibraryException, NullPointerException;
/**
* Given a mount point, H5Funmount dissassociates the mount point's file from the file mounted there.
*
* @param loc_id
* The identifier for the location at which the specified file is to be unmounted.
* @param name
* The name of the file to be unmounted.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Funmount(long loc_id, String name) throws HDF5LibraryException,
NullPointerException;
/**
* H5Freset_mdc_hit_rate_stats resets the hit rate statistics counters in the metadata cache associated with the
* specified file.
*
* @param file_id
* IN: Identifier of the target file.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Freset_mdc_hit_rate_stats(long file_id) throws HDF5LibraryException;
/**
* H5Fget_info returns global information for the file associated with the
* object identifier obj_id.
*
* @param obj_id IN: Object identifier for any object in the file.
*
* @return A buffer(H5F_info2_t) for current "global" information about file
*
* @exception HDF5LibraryException - Error from the HDF-5 Library.
**/
public synchronized static native H5F_info2_t H5Fget_info(long obj_id) throws HDF5LibraryException;
/**
* H5Fclear_elink_file_cache evicts all the cached child files in the specified file's external file
* cache, causing them to be closed if there is nothing else holding them open.
*
* @param file_id
* IN: Identifier of the target file.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Fclear_elink_file_cache(long file_id) throws HDF5LibraryException;
/**
* H5Fstart_swmr_write will activate SWMR writing mode for a file associated with file_id. This routine will
* prepare and ensure the file is safe for SWMR writing.
*
* @param file_id
* IN: Identifier of the target file.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Fstart_swmr_write(long file_id) throws HDF5LibraryException;
/**
* H5Fstart_mdc_logging starts logging metadata cache events if logging was previously enabled.
*
* @param file_id
* IN: Identifier of the target file.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Fstart_mdc_logging(long file_id) throws HDF5LibraryException;
/**
* H5Fstop_mdc_logging stops logging metadata cache events if logging was previously enabled and is currently ongoing.
*
* @param file_id
* IN: Identifier of the target file.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Fstop_mdc_logging(long file_id) throws HDF5LibraryException;
/**
* H5Fget_mdc_logging_status gets the current metadata cache logging status.
*
* @param file_id
* IN: Identifier of the target file.
*
* @param mdc_logging_status
* the status
* mdc_logging_status[0] = is_enabled, whether logging is enabled
* mdc_logging_status[1] = is_currently_logging, whether events are currently being logged
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - mdc_logging_status is null.
**/
public synchronized static native void H5Fget_mdc_logging_status(long file_id, boolean[] mdc_logging_status)
throws HDF5LibraryException, NullPointerException;
/**
* H5Fget_dset_no_attrs_hint gets the file-level setting to create minimized dataset object headers.
*
* @param file_id
* IN: Identifier of the target file.
*
* @return true if the file-level is set to create minimized dataset object headers, false if not.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Fget_dset_no_attrs_hint(long file_id)
throws HDF5LibraryException;
/**
* H5Fset_dset_no_attrs_hint sets the file-level setting to create minimized dataset object headers.
*
* @param file_id
* IN: Identifier of the target file.
* @param minimize
* the minimize hint setting
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Fset_dset_no_attrs_hint(long file_id, boolean minimize)
throws HDF5LibraryException;
/**
* H5Fset_libver_bounds sets a different low and high bounds while a file is open.
*
* @param file_id
* IN: Identifier of the target file.
* @param low
* IN: The earliest version of the library that will be used for writing objects
* @param high
* IN: The latest version of the library that will be used for writing objects.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Fset_libver_bounds(long file_id, int low, int high)
throws HDF5LibraryException;
// /////// unimplemented ////////
// herr_t H5Fget_eoa(hid_t file_id, haddr_t *eoa);
// herr_t H5Fincrement_filesize(hid_t file_id, hsize_t increment);
// ssize_t H5Fget_file_image(hid_t file_id, void * buf_ptr, size_t buf_len);
// herr_t H5Fget_metadata_read_retry_info(hid_t file_id, H5F_retry_info_t *info);
// ssize_t H5Fget_free_sections(hid_t file_id, H5F_mem_t type, size_t nsects, H5F_sect_info_t *sect_info/*out*/);
// herr_t H5Fformat_convert(hid_t fid);
// herr_t H5Freset_page_buffering_stats(hid_t file_id);
// herr_t H5Fget_page_buffering_stats(hid_t file_id, unsigned accesses[2],
// unsigned hits[2], unsigned misses[2], unsigned evictions[2], unsigned bypasses[2]);
// herr_t H5Fget_mdc_image_info(hid_t file_id, haddr_t *image_addr, hsize_t *image_size);
// #ifdef H5_HAVE_PARALLEL
// herr_t H5Fset_mpi_atomicity(hid_t file_id, hbool_t flag);
// herr_t H5Fget_mpi_atomicity(hid_t file_id, hbool_t *flag);
// #endif /* H5_HAVE_PARALLEL */
// /**
// * H5Fget_vfd_handle returns a pointer to the file handle from the
// low-level file driver
// * currently being used by the HDF5 library for file I/O.
// *
// * @param file_id IN: Identifier of the file to be queried.
// * @param fapl IN: File access property list identifier.
// *
// * @return a pointer to the file handle being used by the low-level
// virtual file driver.
// *
// * @exception HDF5LibraryException - Error from the HDF-5 Library.
// **/
// public synchronized static native Pointer file_handle
// H5Fget_vfd_handle(int file_id, int fapl)
// throws HDF5LibraryException;
// /**
// * H5Fget_mdc_config loads the current metadata cache configuration into
// * the instance of H5AC_cache_config_t pointed to by the config_ptr
// parameter.
// *
// * @param file_id IN: Identifier of the target file
// * @param config_ptr IN/OUT: Pointer to the instance of
// H5AC_cache_config_t in which the current metadata cache configuration is to be reported.
// *
// * @return none
// *
// * @exception HDF5LibraryException - Error from the HDF-5 Library.
// * @exception NullPointerException - config_ptr is null.
// **/
// public synchronized static native void H5Fget_mdc_config(int file_id, H5AC_cache_config_t config_ptr)
// throws HDF5LibraryException, NullPointerException;
// /**
// * H5Fset_mdc_config attempts to configure the file's metadata cache
// according to the configuration supplied.
// *
// * @param file_id IN: Identifier of the target file
// * @param config_ptr IN: Pointer to the instance of H5AC_cache_config_t
// containing the desired configuration.
// *
// * @return none
// *
// * @exception HDF5LibraryException - Error from the HDF-5 Library.
// * @exception NullPointerException - config_ptr is null.
// **/
// public synchronized static native int H5Fset_mdc_config(int file_id, H5AC_cache_config_t config_ptr)
// throws HDF5LibraryException, NullPointerException;
// ////////////////////////////////////////////////////////////
// //
// H5FD: File Driver Interface Functions //
// //
// ////////////////////////////////////////////////////////////
// /////// unimplemented ////////
// hid_t H5FDregister(const H5FD_class_t *cls);
// herr_t H5FDunregister(hid_t driver_id);
// H5FD_t *H5FDopen(const char *name, unsigned flags, hid_t fapl_id, haddr_t maxaddr);
// herr_t H5FDclose(H5FD_t *file);
// int H5FDcmp(const H5FD_t *f1, const H5FD_t *f2);
// int H5FDquery(const H5FD_t *f, unsigned long *flags);
// haddr_t H5FDalloc(H5FD_t *file, H5FD_mem_t type, hid_t dxpl_id, hsize_t size);
// herr_t H5FDfree(H5FD_t *file, H5FD_mem_t type, hid_t dxpl_id, haddr_t addr, hsize_t size);
// haddr_t H5FDget_eoa(H5FD_t *file, H5FD_mem_t type);
// herr_t H5FDset_eoa(H5FD_t *file, H5FD_mem_t type, haddr_t eoa);
// haddr_t H5FDget_eof(H5FD_t *file, H5FD_mem_t type);
// herr_t H5FDget_vfd_handle(H5FD_t *file, hid_t fapl, void**file_handle);
// herr_t H5FDread(H5FD_t *file, H5FD_mem_t type, hid_t dxpl_id, haddr_t addr, size_t size, void *buf/*out*/);
// herr_t H5FDwrite(H5FD_t *file, H5FD_mem_t type, hid_t dxpl_id, haddr_t addr, size_t size, const void *buf);
// herr_t H5FDflush(H5FD_t *file, hid_t dxpl_id, hbool_t closing);
// herr_t H5FDtruncate(H5FD_t *file, hid_t dxpl_id, hbool_t closing);
// herr_t H5FDlock(H5FD_t *file, hbool_t rw);
// herr_t H5FDunlock(H5FD_t *file);
// herr_t H5FDdriver_query(hid_t driver_id, unsigned long *flags/*out*/);
// ////////////////////////////////////////////////////////////
// //
// H5FS: File Free Space Interface Functions //
// //
// ////////////////////////////////////////////////////////////
// No public Functions
// ////////////////////////////////////////////////////////////
// //
// H5G: Group Interface Functions //
// //
// ////////////////////////////////////////////////////////////
/**
* H5Gclose releases resources used by a group which was opened by a call to H5Gcreate() or H5Gopen().
*
* @param group_id
* Group identifier to release.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Gclose(long group_id) throws HDF5LibraryException {
if (group_id < 0)
return 0; // throw new HDF5LibraryException("Negative ID");;
log.trace("OPEN_IDS: H5Gclose remove {}", group_id);
OPEN_IDS.remove(group_id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
return _H5Gclose(group_id);
}
private synchronized static native int _H5Gclose(long group_id) throws HDF5LibraryException;
/**
* H5Gcreate creates a new group with the specified name at the specified location, loc_id.
*
* @param loc_id
* IN: The file or group identifier.
* @param name
* IN: The absolute or relative name of the new group.
* @param lcpl_id
* IN: Identifier of link creation property list.
* @param gcpl_id
* IN: Identifier of group creation property list.
* @param gapl_id
* IN: Identifier of group access property list. (No group access properties have been implemented at
* this time; use H5P_DEFAULT.)
*
* @return a valid group identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static long H5Gcreate(long loc_id, String name, long lcpl_id, long gcpl_id, long gapl_id)
throws HDF5LibraryException, NullPointerException {
long id = _H5Gcreate2(loc_id, name, lcpl_id, gcpl_id, gapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Gcreate add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Gcreate2(long loc_id, String name, long lcpl_id, long gcpl_id,
long gapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Gcreate_anon creates a new empty group in the file specified by loc_id.
*
* @param loc_id
* IN: File or group identifier specifying the file in which the new group is to be created.
* @param gcpl_id
* IN: Identifier of group creation property list.
* @param gapl_id
* IN: Identifier of group access property list. (No group access properties have been implemented at
* this time; use H5P_DEFAULT.)
*
* @return a valid group identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Gcreate_anon(long loc_id, long gcpl_id, long gapl_id) throws HDF5LibraryException {
long id = _H5Gcreate_anon(loc_id, gcpl_id, gapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Gcreate_anon add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Gcreate_anon(long loc_id, long gcpl_id, long gapl_id)
throws HDF5LibraryException;
/**
* H5Gget_create_plist returns an identifier for the group creation property list associated with the group
* specified by group_id.
*
* @param group_id
* IN: Identifier of the group.
*
* @return an identifier for the group's creation property list
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Gget_create_plist(long group_id) throws HDF5LibraryException;
/**
* H5Gget_info retrieves information about the group specified by group_id. The information is returned in the
* group_info struct.
*
* @param group_id
* IN: Identifier of the group.
*
* @return a structure in which group information is returned
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native H5G_info_t H5Gget_info(long group_id) throws HDF5LibraryException;
/**
* H5Gget_info_by_idx retrieves information about a group, according to the group's position within an index.
*
* @param group_id
* IN: File or group identifier.
* @param group_name
* IN: Name of group for which information is to be retrieved.
* @param idx_type
* IN: Type of index by which objects are ordered
* @param order
* IN: Order of iteration within index
* @param n
* IN: Attribute's position in index
* @param lapl_id
* IN: Link access property list.
*
* @return a structure in which group information is returned
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native H5G_info_t H5Gget_info_by_idx(long group_id, String group_name, int idx_type,
int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Gget_info_by_name retrieves information about the group group_name located in the file or group specified by
* loc_id.
*
* @param group_id
* IN: File or group identifier.
* @param name
* IN: Name of group for which information is to be retrieved.
* @param lapl_id
* IN: Link access property list.
*
* @return a structure in which group information is returned
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native H5G_info_t H5Gget_info_by_name(long group_id, String name, long lapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* retrieves information of all objects under the group (name) located in the file or group specified by loc_id.
*
* @param loc_id
* IN: File or group identifier
* @param name
* IN: Name of group for which information is to be retrieved
* @param objNames
* OUT: Names of all objects under the group, name.
* @param objTypes
* OUT: Types of all objects under the group, name.
* @param tokens
* OUT: Object token of all objects under the group, name.
*
* @return the number of items found
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
*/
public synchronized static int H5Gget_obj_info_all(long loc_id, String name, String[] objNames, int[] objTypes,
H5O_token_t[] tokens) throws HDF5LibraryException, NullPointerException {
if (objNames == null) {
throw new NullPointerException("H5Gget_obj_info_all(): name array is null");
}
return H5Gget_obj_info_all(loc_id, name, objNames, objTypes, null, null, tokens, HDF5Constants.H5_INDEX_NAME);
}
/**
* retrieves information of all objects under the group (name) located in the file or group specified by loc_id.
*
* @param loc_id
* IN: File or group identifier
* @param name
* IN: Name of group for which information is to be retrieved
* @param objNames
* OUT: Names of all objects under the group, name.
* @param objTypes
* OUT: Types of all objects under the group, name.
* @param ltype
* OUT: Link type
* @param tokens
* OUT: Object token of all objects under the group, name.
* @param indx_type
* IN: Index type for iterate
*
* @return the number of items found
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
*/
public synchronized static int H5Gget_obj_info_all(long loc_id, String name, String[] objNames, int[] objTypes,
int[] ltype, H5O_token_t[] tokens, int indx_type) throws HDF5LibraryException, NullPointerException {
return H5Gget_obj_info_full(loc_id, name, objNames, objTypes, ltype, null, tokens, indx_type, -1);
}
/**
* retrieves information of all objects under the group (name) located in the file or group specified by loc_id.
*
* @param loc_id
* IN: File or group identifier
* @param name
* IN: Name of group for which information is to be retrieved
* @param objNames
* OUT: Names of all objects under the group, name.
* @param objTypes
* OUT: Types of all objects under the group, name.
* @param ltype
* OUT: Link type
* @param fno
* OUT: File number
* @param tokens
* OUT: Object token of all objects under the group, name.
* @param indx_type
* IN: Index type for iterate
*
* @return the number of items found
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
*/
public synchronized static int H5Gget_obj_info_all(long loc_id, String name, String[] objNames, int[] objTypes,
int[] ltype, long[] fno, H5O_token_t[] tokens, int indx_type) throws HDF5LibraryException, NullPointerException {
return H5Gget_obj_info_full(loc_id, name, objNames, objTypes, ltype, fno, tokens, indx_type, -1);
}
/**
* retrieves information of all objects under the group (name) located in the file or group specified by loc_id.
*
* @param loc_id
* IN: File or group identifier
* @param name
* IN: Name of group for which information is to be retrieved
* @param objNames
* OUT: Names of all objects under the group, name.
* @param objTypes
* OUT: Types of all objects under the group, name.
* @param ltype
* OUT: Link type
* @param fno
* OUT: File number
* @param tokens
* OUT: Object token of all objects under the group, name.
* @param indx_type
* IN: Index type for iterate
* @param indx_order
* IN: Index order for iterate
*
* @return the number of items found
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
*/
public synchronized static int H5Gget_obj_info_full(long loc_id, String name, String[] objNames, int[] objTypes,
int[] ltype, long[] fno, H5O_token_t[] tokens, int indx_type, int indx_order) throws HDF5LibraryException,
NullPointerException {
if (objNames == null) {
throw new NullPointerException("H5Gget_obj_info_full(): name array is null");
}
if (objTypes == null) {
throw new NullPointerException("H5Gget_obj_info_full(): object type array is null");
}
if (objNames.length == 0) {
throw new HDF5LibraryException("H5Gget_obj_info_full(): array size is zero");
}
if (objNames.length != objTypes.length) {
throw new HDF5LibraryException("H5Gget_obj_info_full(): name and type array sizes are different");
}
if (ltype == null)
ltype = new int[objTypes.length];
if (fno == null)
fno = new long[tokens.length];
if (indx_type < 0)
indx_type = HDF5Constants.H5_INDEX_NAME;
if (indx_order < 0)
indx_order = HDF5Constants.H5_ITER_INC;
log.trace("H5Gget_obj_info_full: objNames_len={}", objNames.length);
int status = H5Gget_obj_info_full(loc_id, name, objNames, objTypes, ltype, fno, tokens, objNames.length, indx_type,
indx_order);
for (int indx = 0; indx < objNames.length; indx++)
log.trace("H5Gget_obj_info_full: objNames={}", objNames[indx]);
return status;
}
private synchronized static native int H5Gget_obj_info_full(long loc_id, String name, String[] objNames, int[] objTypes,
int[] ltype, long[] fno, H5O_token_t[] tokens, int n, int indx_type, int indx_order) throws HDF5LibraryException,
NullPointerException;
/**
* H5Gget_obj_info_idx report the name and type of object with index 'idx' in a Group. The 'idx' corresponds to the
* index maintained by H5Giterate. Each link is returned, so objects with multiple links will be counted once for
* each link.
*
* @param loc_id
* IN: file or group ID.
* @param name
* IN: name of the group to iterate, relative to the loc_id
* @param idx
* IN: the index of the object to iterate.
* @param oname
* OUT: the name of the object
* @param type
* OUT: the type of the object
*
* @return non-negative if successful, -1 if not.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
*/
public synchronized static int H5Gget_obj_info_idx(long loc_id, String name, int idx, String[] oname, int[] type)
throws HDF5LibraryException, NullPointerException {
String n[] = new String[1];
n[0] = new String("");
oname[0] = H5Lget_name_by_idx(loc_id, name, HDF5Constants.H5_INDEX_NAME, HDF5Constants.H5_ITER_INC, idx,
HDF5Constants.H5P_DEFAULT);
H5L_info_t info = H5Lget_info_by_idx(loc_id, name, HDF5Constants.H5_INDEX_NAME, HDF5Constants.H5_ITER_INC, idx,
HDF5Constants.H5P_DEFAULT);
type[0] = info.type;
return 0;
}
/*
* Add these methods so that we don't need to call
* in a loop to get information for all the object in a group, which takes
* a lot of time to finish if the number of objects is more than 10,000
*/
/**
* retrieves information of all objects (recurvisely) under the group (name) located in the file or group specified
* by loc_id upto maximum specified by objMax.
*
* @param loc_id
* IN: File or group identifier
* @param objNames
* OUT: Names of all objects under the group, name.
* @param objTypes
* OUT: Types of all objects under the group, name.
* @param lnkTypes
* OUT: Types of all links under the group, name.
* @param objToken
* OUT: Object token of all objects under the group, name.
* @param objMax
* IN: Maximum number of all objects under the group, name.
*
* @return the number of items found
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
*/
public synchronized static int H5Gget_obj_info_max(long loc_id, String[] objNames, int[] objTypes, int[] lnkTypes,
H5O_token_t[] objToken, long objMax) throws HDF5LibraryException, NullPointerException {
if (objNames == null) {
throw new NullPointerException("H5Gget_obj_info_max(): name array is null");
}
if (objTypes == null) {
throw new NullPointerException("H5Gget_obj_info_max(): object type array is null");
}
if (lnkTypes == null) {
throw new NullPointerException("H5Gget_obj_info_max(): link type array is null");
}
if (objNames.length <= 0) {
throw new HDF5LibraryException("H5Gget_obj_info_max(): array size is zero");
}
if (objMax <= 0) {
throw new HDF5LibraryException("H5Gget_obj_info_max(): maximum array size is zero");
}
if (objNames.length != objTypes.length) {
throw new HDF5LibraryException("H5Gget_obj_info_max(): name and type array sizes are different");
}
return H5Gget_obj_info_max(loc_id, objNames, objTypes, lnkTypes, objToken, objMax, objNames.length);
}
private synchronized static native int H5Gget_obj_info_max(long loc_id, String[] oname, int[] otype, int[] ltype,
H5O_token_t[] tokens, long amax, int n) throws HDF5LibraryException, NullPointerException;
/**
* H5Gn_members report the number of objects in a Group. The 'objects' include everything that will be visited by
* H5Giterate. Each link is returned, so objects with multiple links will be counted once for each link.
*
* @param loc_id
* file or group ID.
* @param name
* name of the group to iterate, relative to the loc_id
*
* @return the number of members in the group or -1 if error.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
*/
public synchronized static long H5Gn_members(long loc_id, String name) throws HDF5LibraryException,
NullPointerException {
long grp_id = H5Gopen(loc_id, name, HDF5Constants.H5P_DEFAULT);
long n = -1;
try {
H5G_info_t info = H5.H5Gget_info(grp_id);
n = info.nlinks;
}
finally {
H5Gclose(grp_id);
}
return n;
}
/**
* H5Gopen opens an existing group, name, at the location specified by loc_id.
*
* @param loc_id
* IN: File or group identifier specifying the location of the group to be opened.
* @param name
* IN: Name of group to open.
* @param gapl_id
* IN: Identifier of group access property list.
*
* @return a valid group identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static long H5Gopen(long loc_id, String name, long gapl_id) throws HDF5LibraryException,
NullPointerException {
long id = _H5Gopen2(loc_id, name, gapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Gopen add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Gopen2(long loc_id, String name, long gapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Gflush causes all buffers associated with a group to be immediately flushed to disk without
* removing the data from the cache.
*
* @param group_id
* IN: Identifier of the group to be flushed.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Gflush(long group_id) throws HDF5LibraryException;
/**
* H5Grefresh causes all buffers associated with a group to be cleared and immediately re-loaded
* with updated contents from disk. This function essentially closes the group, evicts all metadata
* associated with it from the cache, and then re-opens the group. The reopened group is automatically
* re-registered with the same ID.
*
* @param group_id
* IN: Identifier of the group to be refreshed.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Grefresh(long group_id) throws HDF5LibraryException;
// ////////////////////////////////////////////////////////////
// //
// H5HF: Fractal Heap Interface Functions //
// //
// ////////////////////////////////////////////////////////////
// No public Functions
// ////////////////////////////////////////////////////////////
// //
// H5HG: Global Heap Interface Functions //
// //
// ////////////////////////////////////////////////////////////
// No public Functions
// ////////////////////////////////////////////////////////////
// //
// H5HL: Local Heap Interface Functions //
// //
// ////////////////////////////////////////////////////////////
// No public Functions
// ////////////////////////////////////////////////////////////
// //
// H5I: HDF5 Identifier Interface API Functions //
// //
// ////////////////////////////////////////////////////////////
/**
* H5Iget_file_id obtains the file ID specified by the identifier, obj_id.
*
* @param obj_id
* IN: Identifier of the object.
*
* @return the file ID.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Iget_file_id(long obj_id) throws HDF5LibraryException;
/**
* H5Iget_name_long retrieves the name of an object specified by the identifier, obj_id.
* @deprecated
*
* @param obj_id
* IN: Identifier of the object.
* @param name
* OUT: Attribute name buffer.
* @param size
* IN: Maximum length of the name to retrieve.
*
* @return the length of the name retrieved.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
@Deprecated
public synchronized static native long H5Iget_name_long(long obj_id, String[] name, long size)
throws HDF5LibraryException, NullPointerException;
/**
* H5Iget_name retrieves the name of an object specified by the identifier, obj_id.
*
* @param obj_id
* IN: Identifier of the object.
*
* @return String for Attribute name.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native String H5Iget_name(long obj_id)
throws HDF5LibraryException;
/**
* H5Iget_ref obtains the number of references outstanding specified by the identifier, obj_id.
*
* @param obj_id
* IN: Identifier of the object.
*
* @return the reference count.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Iget_ref(long obj_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Idec_ref decrements the reference count specified by the identifier, obj_id.
* If the reference count for an ID reaches zero, the object will be closed.
*
* @param obj_id
* IN: Identifier of the object.
*
* @return the reference count.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Idec_ref(long obj_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Iinc_ref increments the reference count specified by the identifier, obj_id.
*
* @param obj_id
* IN: Identifier of the object.
*
* @return the reference count.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Iinc_ref(long obj_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Iget_type retrieves the type of the object identified by obj_id.
*
* @param obj_id
* IN: Object identifier whose type is to be determined.
*
* @return the object type if successful; otherwise H5I_BADID.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Iget_type(long obj_id) throws HDF5LibraryException;
/**
* H5Iget_type_ref retrieves the reference count on an ID type. The reference count is used by the library to
* indicate when an ID type can be destroyed.
*
* @param type_id
* IN: The identifier of the type whose reference count is to be retrieved
*
* @return The current reference count on success, negative on failure.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Iget_type_ref(long type_id) throws HDF5LibraryException;
/**
* H5Idec_type_ref decrements the reference count on an identifier type. The reference count is used by the
* library to indicate when an identifier type can be destroyed. If the reference count reaches zero,
* this function will destroy it.
*
* @param type_id
* IN: The identifier of the type whose reference count is to be decremented
*
* @return The current reference count on success, negative on failure.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Idec_type_ref(long type_id) throws HDF5LibraryException;
/**
* H5Iinc_type_ref increments the reference count on an ID type. The reference count is used by the library
* to indicate when an ID type can be destroyed.
*
* @param type_id
* IN: The identifier of the type whose reference count is to be incremented
*
* @return The current reference count on success, negative on failure.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Iinc_type_ref(long type_id) throws HDF5LibraryException;
/**
* H5Inmembers returns the number of identifiers of the identifier type specified in type.
*
* @param type_id
* IN: Identifier for the identifier type whose member count will be retrieved
*
* @return Number of identifiers of the specified identifier type
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Inmembers(long type_id) throws HDF5LibraryException;
/**
* H5Iis_valid indicates if the identifier type specified in obj_id is valid.
*
* @param obj_id
* IN: Identifier to be checked
*
* @return a boolean, true if the specified identifier id is valid
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Iis_valid(long obj_id) throws HDF5LibraryException;
/**
* H5Itype_exists indicates if the identifier type specified in type exists.
*
* @param type_id
* IN: the identifier type to be checked
*
* @return a boolean, true if the specified identifier type exists
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Itype_exists(int type_id) throws HDF5LibraryException;
/**
* H5Iclear_type deletes all identifiers of the type identified by the argument type.
*
* @param type_id
* IN: Identifier of identifier type which is to be cleared of identifiers
* @param force
* IN: Whether or not to force deletion of all identifiers
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Iclear_type(int type_id, boolean force) throws HDF5LibraryException;
/**
* H5Idestroy_type deletes an entire identifier type. All identifiers of this type are destroyed
* and no new identifiers of this type can be registered.
*
* @param type_id
* IN: Identifier of identifier type which is to be destroyed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Idestroy_type(int type_id) throws HDF5LibraryException;
// /////// unimplemented ////////
// void *H5Iobject_verify(hid_t id, H5I_type_t id_type);
// hid_t H5Iregister(H5I_type_t type, const void *object);
// typedef herr_t (*H5I_free_t)(void *);
// H5I_type_t H5Iregister_type(size_t hash_size, unsigned reserved, H5I_free_t free_func);
// void *H5Iremove_verify(hid_t id, H5I_type_t id_type);
// Type of the function to compare objects & keys
// typedef int (*H5I_search_func_t)(void *obj, hid_t id, void *key);
// void *H5Isearch(H5I_type_t type, H5I_search_func_t func, void *key);
// Type of the H5Iiterate callback function
// typedef herr_t (*H5I_iterate_func_t)(hid_t id, void *udata);
// herr_t H5Iiterate(H5I_type_t type, H5I_iterate_func_t op, void *op_data);
// //////////////////////////////////////////////////////////////////
// H5L: Link Interface Functions //
// //////////////////////////////////////////////////////////////////
/**
* H5Lcopy copies a link from one location to another.
*
* @param src_loc
* IN: Location identifier of the source link
* @param src_name
* IN: Name of the link to be copied
* @param dst_loc
* IN: Location identifier specifying the destination of the copy
* @param dst_name
* IN: Name to be assigned to the new copy
* @param lcpl_id
* IN: Link creation property list identifier
* @param lapl_id
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native void H5Lcopy(long src_loc, String src_name, long dst_loc, String dst_name,
long lcpl_id, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Lcreate_external creates a new soft link to an external object, which is an object in a different HDF5 file
* from the location of the link.
*
* @param file_name
* IN: Name of the target file containing the target object.
* @param obj_name
* IN: Path within the target file to the target object.
* @param link_loc_id
* IN: The file or group identifier for the new link.
* @param link_name
* IN: The name of the new link.
* @param lcpl_id
* IN: Link creation property list identifier
* @param lapl_id
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native void H5Lcreate_external(String file_name, String obj_name, long link_loc_id,
String link_name, long lcpl_id, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Lcreate_hard creates a new hard link to a pre-existing object in an HDF5 file.
*
* @param cur_loc
* IN: The file or group identifier for the target object.
* @param cur_name
* IN: Name of the target object, which must already exist.
* @param dst_loc
* IN: The file or group identifier for the new link.
* @param dst_name
* IN: The name of the new link.
* @param lcpl_id
* IN: Link creation property list identifier
* @param lapl_id
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - cur_name or dst_name is null.
**/
public synchronized static native void H5Lcreate_hard(long cur_loc, String cur_name, long dst_loc, String dst_name,
long lcpl_id, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Lcreate_soft creates a new soft link to an object in an HDF5 file.
*
* @param link_target
* IN: Path to the target object, which is not required to exist.
* @param link_loc_id
* IN: The file or group identifier for the new link.
* @param link_name
* IN: The name of the new link.
* @param lcpl_id
* IN: Link creation property list identifier
* @param lapl_id
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - link_name is null.
**/
public synchronized static native void H5Lcreate_soft(String link_target, long link_loc_id, String link_name,
long lcpl_id, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Ldelete removes the link specified from a group.
*
* @param loc_id
* IN: Identifier of the file or group containing the object.
* @param name
* IN: Name of the link to delete.
* @param lapl_id
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native void H5Ldelete(long loc_id, String name, long lapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Ldelete_by_idx removes the nth link in a group according to the specified order and in the specified index.
*
* @param loc_id
* IN: File or group identifier specifying location of subject group
* @param group_name
* IN: Name of subject group
* @param idx_type
* IN: Index or field which determines the order
* @param order
* IN: Order within field or index
* @param n
* IN: Link for which to retrieve information
* @param lapl_id
* IN: Link access property list identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - group_name is null.
**/
public synchronized static native void H5Ldelete_by_idx(long loc_id, String group_name, int idx_type, int order,
long n, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Lexists checks if a link with a particular name exists in a group.
*
* @param loc_id
* IN: Identifier of the file or group to query.
* @param name
* IN: The name of the link to check.
* @param lapl_id
* IN: Link access property list identifier
*
* @return a boolean, true if the name exists, otherwise false.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native boolean H5Lexists(long loc_id, String name, long lapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Lget_info returns information about the specified link.
*
* @param loc_id
* IN: Identifier of the file or group.
* @param name
* IN: Name of the link for which information is being sought.
* @param lapl_id
* IN: Link access property list identifier
*
* @return a buffer(H5L_info_t) for the link information.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native H5L_info_t H5Lget_info(long loc_id, String name, long lapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Lget_info_by_idx opens a named datatype at the location specified by loc_id and return an identifier for the
* datatype.
*
* @param loc_id
* IN: File or group identifier specifying location of subject group
* @param group_name
* IN: Name of subject group
* @param idx_type
* IN: Type of index
* @param order
* IN: Order within field or index
* @param n
* IN: Link for which to retrieve information
* @param lapl_id
* IN: Link access property list identifier
*
* @return a buffer(H5L_info_t) for the link information.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - group_name is null.
**/
public synchronized static native H5L_info_t H5Lget_info_by_idx(long loc_id, String group_name, int idx_type,
int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Lget_name_by_idx retrieves name of the nth link in a group, according to the order within a specified field or
* index.
*
* @param loc_id
* IN: File or group identifier specifying location of subject group
* @param group_name
* IN: Name of subject group
* @param idx_type
* IN: Type of index
* @param order
* IN: Order within field or index
* @param n
* IN: Link for which to retrieve information
* @param lapl_id
* IN: Link access property list identifier
*
* @return a String for the link name.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - group_name is null.
**/
public synchronized static native String H5Lget_name_by_idx(long loc_id, String group_name, int idx_type,
int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Lget_value returns the link value of a symbolic link. Note that this function is a combination
* of H5Lget_info(), H5Lget_val() and for external links, H5Lunpack_elink_val.
*
* @param loc_id
* IN: Identifier of the file or group containing the object.
* @param name
* IN: Name of the symbolic link.
* @param link_value
* OUT: Path of the symbolic link, or the file_name and path of an external file.
* @param lapl_id
* IN: Link access property list identifier
*
* @return the link type
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Lget_value(long loc_id, String name, String[] link_value, long lapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Lget_value_by_idx retrieves value of the nth link in a group, according to the order within an index.
* Note that this function is a combination of H5Lget_info(), H5Lget_val() and for external links,
* H5Lunpack_elink_val.
*
* @param loc_id
* IN: File or group identifier specifying location of subject group
* @param group_name
* IN: Name of subject group
* @param idx_type
* IN: Type of index
* @param order
* IN: Order within field or index
* @param n
* IN: Link for which to retrieve information
* @param link_value
* OUT: Path of the symbolic link, or the file_name and path of an external file.
* @param lapl_id
* IN: Link access property list identifier
*
* @return the link type
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - group_name is null.
**/
public synchronized static native int H5Lget_value_by_idx(long loc_id, String group_name, int idx_type, int order,
long n, String[] link_value, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Literate iterates through links in a group.
*
* @param grp_id
* IN: Identifier specifying subject group
* @param idx_type
* IN: Type of index
* @param order
* IN: Order of iteration within index
* @param idx
* IN: Iteration position at which to start
* @param op
* IN: Callback function passing data regarding the link to the calling application
* @param op_data
* IN: User-defined pointer to data required by the application for its processing of the link
*
* @return returns the return value of the first operator that returns a positive value, or zero if all members were
* processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Literate(long grp_id, int idx_type, int order, long idx, H5L_iterate_t op,
H5L_iterate_opdata_t op_data) throws HDF5LibraryException;
/**
* H5Literate_by_name iterates through links in a group.
*
* @param grp_id
* IN: Identifier specifying subject group
* @param group_name
* IN: Name of subject group
* @param idx_type
* IN: Type of index
* @param order
* IN: Order of iteration within index
* @param idx
* IN: Iteration position at which to start
* @param op
* IN: Callback function passing data regarding the link to the calling application
* @param op_data
* IN: User-defined pointer to data required by the application for its processing of the link
* @param lapl_id
* IN: Link access property list identifier
*
* @return returns the return value of the first operator that returns a positive value, or zero if all members were
* processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - group_name is null.
**/
public synchronized static native int H5Literate_by_name(long grp_id, String group_name, int idx_type, int order,
long idx, H5L_iterate_t op, H5L_iterate_opdata_t op_data, long lapl_id) throws HDF5LibraryException,
NullPointerException;
/**
* H5Lmove renames a link within an HDF5 file.
*
* @param src_loc
* IN: Original file or group identifier.
* @param src_name
* IN: Original link name.
* @param dst_loc
* IN: Destination file or group identifier.
* @param dst_name
* IN: New link name.
* @param lcpl_id
* IN: Link creation property list identifier to be associated with the new link.
* @param lapl_id
* IN: Link access property list identifier to be associated with the new link.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native void H5Lmove(long src_loc, String src_name, long dst_loc, String dst_name,
long lcpl_id, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Lvisit recursively visits all links starting from a specified group.
*
* @param grp_id
* IN: Identifier specifying subject group
* @param idx_type
* IN: Type of index
* @param order
* IN: Order of iteration within index
* @param op
* IN: Callback function passing data regarding the link to the calling application
* @param op_data
* IN: User-defined pointer to data required by the application for its processing of the link
*
* @return returns the return value of the first operator that returns a positive value, or zero if all members were
* processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Lvisit(long grp_id, int idx_type, int order, H5L_iterate_t op,
H5L_iterate_opdata_t op_data) throws HDF5LibraryException;
/**
* H5Lvisit_by_name recursively visits all links starting from a specified group.
*
* @param loc_id
* IN: Identifier specifying subject group
* @param group_name
* IN: Name of subject group
* @param idx_type
* IN: Type of index
* @param order
* IN: Order of iteration within index
* @param op
* IN: Callback function passing data regarding the link to the calling application
* @param op_data
* IN: User-defined pointer to data required by the application for its processing of the link
* @param lapl_id
* IN: link access property
*
* @return returns the return value of the first operator that returns a positive value, or zero if all members were
* processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - group_name is null.
**/
public synchronized static native int H5Lvisit_by_name(long loc_id, String group_name, int idx_type, int order,
H5L_iterate_t op, H5L_iterate_opdata_t op_data, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Lis_registered tests whether a user-defined link class is currently registered,
* either by the HDF5 Library or by the user through the use of H5Lregister.
*
* @param link_cls_id
* IN: User-defined link class identifier
*
* @return Returns a positive value if the link class has been registered and zero if it is unregistered.
* Otherwise returns a negative value; this may mean that the identifier is not a valid user-defined class identifier.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Lis_registered(int link_cls_id) throws HDF5LibraryException;
/**
* H5Lunregister unregisters a class of user-defined links, preventing them from being traversed, queried, moved, etc.
*
* @param link_cls_id
* IN: User-defined link class identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Lunregister(int link_cls_id) throws HDF5LibraryException;
// /////// unimplemented ////////
// herr_t H5Lcreate_ud(hid_t link_loc_id, const char *link_name,
// H5L_type_t link_type, const void *udata, size_t udata_size, hid_t lcpl_id,
// hid_t lapl_id);
// herr_t H5Lregister(const H5L_class_t *cls);
// herr_t H5Lunpack_elink_val(const void *ext_linkval/*in*/, size_t link_size,
// unsigned *flags, const char **filename/*out*/, const char **obj_path /*out*/);
// herr_t H5Lget_val(hid_t loc_id, const char *name, void *buf/*out*/,
// size_t size, hid_t lapl_id);
// herr_t H5Lget_val_by_idx(hid_t loc_id, const char *group_name,
// H5_index_t idx_type, H5_iter_order_t order, hsize_t n,
// void *buf/*out*/, size_t size, hid_t lapl_id);
// ////////////////////////////////////////////////////////////
// //
// H5MM: Memory Management Interface API Functions //
// //
// ////////////////////////////////////////////////////////////
// /////// unimplemented ////////
// typedef void *(*H5MM_allocate_t)(size_t size, void *alloc_info);
// typedef void (*H5MM_free_t)(void *mem, void *free_info);
// ////////////////////////////////////////////////////////////
// //
// H5O: HDF5 1.8 Object Interface API Functions //
// //
// ////////////////////////////////////////////////////////////
/**
* H5Oclose closes the group, dataset, or named datatype specified.
*
* @param object_id
* IN: Object identifier
*
* @return non-negative on success
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Oclose(long object_id) throws HDF5LibraryException {
if (object_id < 0)
return 0; // throw new HDF5LibraryException("Negative ID");;
log.trace("OPEN_IDS: H5Oclose remove {}", object_id);
OPEN_IDS.remove(object_id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
return _H5Oclose(object_id);
}
private synchronized static native int _H5Oclose(long object_id) throws HDF5LibraryException;
/**
* H5Ocopy copies the group, dataset or named datatype specified from the file or group specified by source location
* to the destination location.
*
* @param src_loc_id
* IN: Object identifier indicating the location of the source object to be copied
* @param src_name
* IN: Name of the source object to be copied
* @param dst_loc_id
* IN: Location identifier specifying the destination
* @param dst_name
* IN: Name to be assigned to the new copy
* @param ocpypl_id
* IN: Object copy property list
* @param lcpl_id
* IN: Link creation property list for the new hard link
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native void H5Ocopy(long src_loc_id, String src_name, long dst_loc_id, String dst_name,
long ocpypl_id, long lcpl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Oget_comment retrieves the comment for the specified object.
*
* @param obj_id
* IN: File or group identifier
*
* @return the comment
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native String H5Oget_comment(long obj_id) throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Oset_comment sets the comment for the specified object.
*
* @param obj_id
* IN: Identifier of the target object
* @param comment
* IN: The new comment.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
* @deprecated As of HDF5 1.8 in favor of object attributes.
**/
@Deprecated
public synchronized static native void H5Oset_comment(long obj_id, String comment) throws HDF5LibraryException;
/**
* H5Oget_comment_by_name retrieves the comment for an object.
*
* @param loc_id
* IN: Identifier of a file, group, dataset, or named datatype.
* @param name
* IN: Relative name of the object whose comment is to be set or reset.
* @param lapl_id
* IN: Link access property list identifier.
*
* @return the comment
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native String H5Oget_comment_by_name(long loc_id, String name, long lapl_id)
throws HDF5LibraryException, IllegalArgumentException, NullPointerException;
/**
* H5Oset_comment_by_name sets the comment for the specified object.
*
* @param loc_id
* IN: Identifier of a file, group, dataset, or named datatype.
* @param name
* IN: Relative name of the object whose comment is to be set or reset.
* @param comment
* IN: The new comment.
* @param lapl_id
* IN: Link access property list identifier.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
*
* @deprecated As of HDF5 1.8 in favor of object attributes.
**/
@Deprecated
public synchronized static native void H5Oset_comment_by_name(long loc_id, String name, String comment, long lapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Oget_info retrieves the metadata for an object specified by an identifier.
*
* @param loc_id
* IN: Identifier for target object
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static H5O_info_t H5Oget_info(long loc_id) throws HDF5LibraryException,
NullPointerException {
return H5Oget_info(loc_id, HDF5Constants.H5O_INFO_ALL);
}
/**
* H5Oget_info retrieves the metadata for an object specified by an identifier.
*
* @param loc_id
* IN: Identifier for target object
* @param fields
* IN: Object fields to select
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native H5O_info_t H5Oget_info(long loc_id, int fields) throws HDF5LibraryException,
NullPointerException;
/**
* H5Oget_info_by_name retrieves the metadata for an object, identifying the object by location and relative name.
*
* @param loc_id
* IN: File or group identifier specifying location of group in which object is located
* @param name
* IN: Relative name of group
* @param lapl_id
* IN: Access property list identifier for the link pointing to the object (Not currently used; pass as
* H5P_DEFAULT.)
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static H5O_info_t H5Oget_info_by_name(long loc_id, String name, long lapl_id)
throws HDF5LibraryException, NullPointerException {
return H5Oget_info_by_name(loc_id, name, HDF5Constants.H5O_INFO_ALL, lapl_id);
}
/**
* H5Oget_info_by_name retrieves the metadata for an object, identifying the object by location and relative name.
*
* @param loc_id
* IN: File or group identifier specifying location of group in which object is located
* @param name
* IN: Relative name of group
* @param fields
* IN: Object fields to select
* @param lapl_id
* IN: Access property list identifier for the link pointing to the object (Not currently used; pass as
* H5P_DEFAULT.)
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native H5O_info_t H5Oget_info_by_name(long loc_id, String name, int fields, long lapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Oget_info_by_idx retrieves the metadata for an object, identifying the object by an index position.
*
* @param loc_id
* IN: File or group identifier
* @param group_name
* IN: Name of group, relative to loc_id, in which object is located
* @param idx_type
* IN: Type of index by which objects are ordered
* @param order
* IN: Order of iteration within index
* @param n
* IN: Object to open
* @param lapl_id
* IN: Access property list identifier for the link pointing to the object (Not currently used; pass as
* H5P_DEFAULT.)
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static H5O_info_t H5Oget_info_by_idx(long loc_id, String group_name, int idx_type,
int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException {
return H5Oget_info_by_idx(loc_id, group_name, idx_type, order, n, HDF5Constants.H5O_INFO_ALL, lapl_id);
}
/**
* H5Oget_info_by_idx retrieves the metadata for an object, identifying the object by an index position.
*
* @param loc_id
* IN: File or group identifier
* @param group_name
* IN: Name of group, relative to loc_id, in which object is located
* @param idx_type
* IN: Type of index by which objects are ordered
* @param order
* IN: Order of iteration within index
* @param n
* IN: Object to open
* @param fields
* IN: Object fields to select
* @param lapl_id
* IN: Access property list identifier for the link pointing to the object (Not currently used; pass as
* H5P_DEFAULT.)
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native H5O_info_t H5Oget_info_by_idx(long loc_id, String group_name, int idx_type,
int order, long n, int fields, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Oget_native_info retrieves the native HDF5-specific metadata for an HDF5 object specified by an identifier.
* Native HDF5-specific metadata includes things like object header information and object storage layout information.
*
* @param loc_id
* IN: Identifier for target object
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static H5O_native_info_t H5Oget_native_info(long loc_id) throws HDF5LibraryException,
NullPointerException {
return H5Oget_native_info(loc_id, HDF5Constants.H5O_NATIVE_INFO_ALL);
}
/**
* H5Oget_native_info retrieves the native HDF5-specific metadata for an HDF5 object specified by an identifier.
* Native HDF5-specific metadata includes things like object header information and object storage layout information.
*
* @param loc_id
* IN: Identifier for target object
* @param fields
* IN: Object fields to select
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native H5O_native_info_t H5Oget_native_info(long loc_id, int fields) throws HDF5LibraryException,
NullPointerException;
/**
* H5Oget_native_info_by_name retrieves the native HDF5-specific metadata for an HDF5 object, identifying the object
* by location and relative name. Native HDF5-specific metadata includes things like object header information and
* object storage layout information.
*
* @param loc_id
* IN: File or group identifier specifying location of group in which object is located
* @param name
* IN: Relative name of group
* @param lapl_id
* IN: Access property list identifier for the link pointing to the object (Not currently used; pass as
* H5P_DEFAULT.)
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static H5O_native_info_t H5Oget_native_info_by_name(long loc_id, String name, long lapl_id)
throws HDF5LibraryException, NullPointerException {
return H5Oget_native_info_by_name(loc_id, name, HDF5Constants.H5O_NATIVE_INFO_ALL, lapl_id);
}
/**
* H5Oget_native_info_by_name retrieves the native HDF5-specific metadata for an HDF5 object, identifying the object
* by location and relative name. Native HDF5-specific metadata includes things like object header information and
* object storage layout information.
*
* @param loc_id
* IN: File or group identifier specifying location of group in which object is located
* @param name
* IN: Relative name of group
* @param fields
* IN: Object fields to select
* @param lapl_id
* IN: Access property list identifier for the link pointing to the object (Not currently used; pass as
* H5P_DEFAULT.)
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native H5O_native_info_t H5Oget_native_info_by_name(long loc_id, String name, int fields, long lapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Oget_native_info_by_idx retrieves the native HDF5-specific metadata for an HDF5 object, identifying the object
* by an index position. Native HDF5-specific metadata includes things like object header information and
* object storage layout information.
*
* @param loc_id
* IN: File or group identifier
* @param group_name
* IN: Name of group, relative to loc_id, in which object is located
* @param idx_type
* IN: Type of index by which objects are ordered
* @param order
* IN: Order of iteration within index
* @param n
* IN: Object to open
* @param lapl_id
* IN: Access property list identifier for the link pointing to the object (Not currently used; pass as
* H5P_DEFAULT.)
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static H5O_native_info_t H5Oget_native_info_by_idx(long loc_id, String group_name, int idx_type,
int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException {
return H5Oget_native_info_by_idx(loc_id, group_name, idx_type, order, n, HDF5Constants.H5O_NATIVE_INFO_ALL, lapl_id);
}
/**
* H5Oget_native_info_by_idx retrieves the native HDF5-specific metadata for an HDF5 object, identifying the object
* by an index position. Native HDF5-specific metadata includes things like object header information and
* object storage layout information.
*
* @param loc_id
* IN: File or group identifier
* @param group_name
* IN: Name of group, relative to loc_id, in which object is located
* @param idx_type
* IN: Type of index by which objects are ordered
* @param order
* IN: Order of iteration within index
* @param n
* IN: Object to open
* @param fields
* IN: Object fields to select
* @param lapl_id
* IN: Access property list identifier for the link pointing to the object (Not currently used; pass as
* H5P_DEFAULT.)
*
* @return object information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native H5O_native_info_t H5Oget_native_info_by_idx(long loc_id, String group_name, int idx_type,
int order, long n, int fields, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Olink creates a new hard link to an object in an HDF5 file.
*
* @param obj_id
* IN: Object to be linked.
* @param new_loc_id
* IN: File or group identifier specifying location at which object is to be linked.
* @param new_name
* IN: Relative name of link to be created.
* @param lcpl_id
* IN: Link creation property list identifier.
* @param lapl_id
* IN: Access property list identifier.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native void H5Olink(long obj_id, long new_loc_id, String new_name, long lcpl_id,
long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Oopen opens a group, dataset, or named datatype specified by a location and a path name.
*
* @param loc_id
* IN: File or group identifier
* @param name
* IN: Relative path to the object
* @param lapl_id
* IN: Access property list identifier for the link pointing to the object
*
* @return an object identifier for the opened object
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static long H5Oopen(long loc_id, String name, long lapl_id) throws HDF5LibraryException, NullPointerException {
long id = _H5Oopen(loc_id, name, lapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Oopen add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Oopen(long loc_id, String name, long lapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Ovisit recursively visits all objects accessible from a specified object.
*
* @param obj_id
* IN: Identifier of the object at which the recursive iteration begins.
* @param idx_type
* IN: Type of index
* @param order
* IN: Order of iteration within index
* @param op
* IN: Callback function passing data regarding the object to the calling application
* @param op_data
* IN: User-defined pointer to data required by the application for its processing of the object
*
* @return returns the return value of the first operator that returns a positive value, or zero if all members were
* processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static int H5Ovisit(long obj_id, int idx_type, int order, H5O_iterate_t op, H5O_iterate_opdata_t op_data)
throws HDF5LibraryException, NullPointerException {
return H5Ovisit(obj_id, idx_type, order, op, op_data, HDF5Constants.H5O_INFO_ALL);
}
/**
* H5Ovisit recursively visits all objects accessible from a specified object.
*
* @param obj_id
* IN: Identifier of the object at which the recursive iteration begins.
* @param idx_type
* IN: Type of index
* @param order
* IN: Order of iteration within index
* @param op
* IN: Callback function passing data regarding the object to the calling application
* @param op_data
* IN: User-defined pointer to data required by the application for its processing of the object
* @param fields
* IN: Object fields to select
*
* @return returns the return value of the first operator that returns a positive value, or zero if all members were
* processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Ovisit(long obj_id, int idx_type, int order, H5O_iterate_t op,
H5O_iterate_opdata_t op_data, int fields) throws HDF5LibraryException, NullPointerException;
/**
* H5Ovisit_by_name recursively visits all objects starting from a specified object.
*
* @param loc_id
* IN: File or group identifier
* @param obj_name
* IN: Relative path to the object
* @param idx_type
* IN: Type of index
* @param order
* IN: Order of iteration within index
* @param op
* IN: Callback function passing data regarding the object to the calling application
* @param op_data
* IN: User-defined pointer to data required by the application for its processing of the object
* @param lapl_id
* IN: Link access property list identifier
*
* @return returns the return value of the first operator that returns a positive value, or zero if all members were
* processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static int H5Ovisit_by_name(long loc_id, String obj_name, int idx_type, int order,
H5O_iterate_t op, H5O_iterate_opdata_t op_data, long lapl_id) throws HDF5LibraryException, NullPointerException {
return H5Ovisit_by_name(loc_id, obj_name, idx_type, order, op, op_data, HDF5Constants.H5O_INFO_ALL, lapl_id);
}
/**
* H5Ovisit_by_name recursively visits all objects starting from a specified object.
*
* @param loc_id
* IN: File or group identifier
* @param obj_name
* IN: Relative path to the object
* @param idx_type
* IN: Type of index
* @param order
* IN: Order of iteration within index
* @param op
* IN: Callback function passing data regarding the object to the calling application
* @param op_data
* IN: User-defined pointer to data required by the application for its processing of the object
* @param fields
* IN: Object fields to select
* @param lapl_id
* IN: Link access property list identifier
*
* @return returns the return value of the first operator that returns a positive value, or zero if all members were
* processed with no operator returning non-zero.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Ovisit_by_name(long loc_id, String obj_name, int idx_type, int order,
H5O_iterate_t op, H5O_iterate_opdata_t op_data, int fields, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Oexists_by_name is used by an application to check that an existing link resolves to an object.
* Primarily, it is designed to check for dangling soft, external, or user-defined links.
*
* @param loc_id
* IN: File or group identifier
* @param obj_name
* IN: Relative path to the object
* @param lapl_id
* IN: Link access property list identifier
*
* @return Returns TRUE or FALSE if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native boolean H5Oexists_by_name(long loc_id, String obj_name, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Odecr_refcount decrements the hard link reference count for an object.
*
* @param object_id IN: Object identifier
*
* @exception HDF5LibraryException - Error from the HDF-5 Library.
**/
public synchronized static native void H5Odecr_refcount(long object_id) throws HDF5LibraryException;
/**
* H5Oincr_refcount increments the hard link reference count for an object.
*
* @param object_id IN: Object identifier
*
* @exception HDF5LibraryException - Error from the HDF-5 Library.
**/
public synchronized static native void H5Oincr_refcount(long object_id) throws HDF5LibraryException;
/**
* H5Oopen_by_token opens a group, dataset, or named datatype using its object token within an HDF5 file.
*
* @param loc_id IN: File or group identifier
* @param token IN: Object's token in the file
*
* @return an object identifier for the opened object
*
* @exception HDF5LibraryException - Error from the HDF-5 Library.
**/
public static long H5Oopen_by_token(long loc_id, H5O_token_t token) throws HDF5LibraryException {
long id = _H5Oopen_by_token(loc_id, token);
if (id > 0) {
log.trace("OPEN_IDS: H5Oopen_by_token add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Oopen_by_token(long loc_id, H5O_token_t token)
throws HDF5LibraryException, NullPointerException;
/**
* H5Oopen_by_idx opens the nth object in the group specified.
*
* @param loc_id IN: File or group identifier
* @param group_name IN: Name of group, relative to loc_id, in which object is located
* @param idx_type IN: Type of index by which objects are ordered
* @param order IN: Order of iteration within index
* @param n IN: Object to open
* @param lapl_id IN: Access property list identifier for the link pointing to the object
*
* @return an object identifier for the opened object
*
* @exception HDF5LibraryException - Error from the HDF-5 Library.
* @exception NullPointerException - group_name is null.
**/
public static long H5Oopen_by_idx(long loc_id, String group_name,
int idx_type, int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException {
long id = _H5Oopen_by_idx(loc_id, group_name, idx_type, order, n, lapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Oopen_by_idx add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Oopen_by_idx(long loc_id, String group_name,
int idx_type, int order, long n, long lapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Oflush causes all buffers associated with an object to be immediately flushed to disk without removing
* the data from the cache. object_id can be any named object associated with an HDF5 file including a
* dataset, a group, or a committed datatype.
*
* @param object_id
* IN: Identifier of the object to be flushed.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Oflush(long object_id) throws HDF5LibraryException;
/**
* H5Orefresh causes all buffers associated with an object to be cleared and immediately re-loaded with
* updated contents from disk. This function essentially closes the object, evicts all metadata associated
* with it from the cache, and then re-opens the object. The reopened object is automatically re-registered
* with the same ID. object_id can be any named object associated with an HDF5 file including a
* dataset, a group, or a committed datatype.
*
* @param object_id
* IN: Identifier of the object to be refreshed.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Orefresh(long object_id) throws HDF5LibraryException;
/**
* H5Odisable_mdc_flushes corks an object, keeping dirty entries associated with the object in the metadata cache.
*
* @param object_id
* IN: Identifier of the object to be corked.
**/
public synchronized static native void H5Odisable_mdc_flushes(long object_id);
/**
* H5Oenable_mdc_flushes uncorks an object, keeping dirty entries associated with the object in the metadata cache.
*
* @param object_id
* IN: Identifier of the object to be uncorked.
**/
public synchronized static native void H5Oenable_mdc_flushes(long object_id);
/**
* H5Oare_mdc_flushes_disabled retrieve the object's "cork" status.
*
* @param object_id
* IN: Identifier of the object to be flushed.
*
* @return the cork status
* TRUE if mdc flushes for the object is disabled
* FALSE if mdc flushes for the object is not disabled
**/
public synchronized static native boolean H5Oare_mdc_flushes_disabled(long object_id);
// /////// unimplemented ////////
// herr_t H5Otoken_cmp(hid_t loc_id, const H5O_token_t *token1, const H5O_token_t *token2,
// int *cmp_value);
// herr_t H5Otoken_to_str(hid_t loc_id, const H5O_token_t *token, char **token_str);
// herr_t H5Otoken_from_str(hid_t loc_id, const char *token_str, H5O_token_t *token);
// ////////////////////////////////////////////////////////////
// //
// H5P: Property List Interface Functions //
// //
// ////////////////////////////////////////////////////////////
// /////// Generic property list routines ///////
/**
* H5Pget_class_name retrieves the name of a generic property list class
*
* @param plid
* IN: Identifier of property object to query
* @return name of a property list if successful; null if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native String H5Pget_class_name(long plid) throws HDF5LibraryException;
/**
* H5Pcreate creates a new property as an instance of some property list class.
*
* @param type
* IN: The type of property list to create.
*
* @return a property list identifier (plist) if successful; otherwise Fail (-1).
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Pcreate(long type) throws HDF5LibraryException {
long id = _H5Pcreate(type);
if (id > 0) {
log.trace("OPEN_IDS: H5Pcreate add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Pcreate(long type) throws HDF5LibraryException;
/**
* H5Pget retrieves a copy of the value for a property in a property list (support integer only)
*
* @param plid
* IN: Identifier of property object to query
* @param name
* IN: Name of property to query
* @return value for a property if successful; a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native int H5Pget(long plid, String name) throws HDF5LibraryException;
/**
* Sets a property list value (support integer only)
*
* @param plid
* IN: Property list identifier to modify
* @param name
* IN: Name of property to modify
* @param value
* IN: value to set the property to
* @return a non-negative value if successful; a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native int H5Pset(long plid, String name, int value) throws HDF5LibraryException;
/**
* H5Pexist determines whether a property exists within a property list or class
*
* @param plid
* IN: Identifier for the property to query
* @param name
* IN: Name of property to check for
* @return a true value if the property exists in the property object; false if the property does not exist;
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native boolean H5Pexist(long plid, String name) throws HDF5LibraryException;
/**
* H5Pget_size retrieves the size of a property's value in bytes
*
* @param plid
* IN: Identifier of property object to query
* @param name
* IN: Name of property to query
* @return size of a property's value if successful; a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native long H5Pget_size(long plid, String name) throws HDF5LibraryException;
/**
* H5Pget_nprops retrieves the number of properties in a property list or class
*
* @param plid
* IN: Identifier of property object to query
* @return number of properties if successful; a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native long H5Pget_nprops(long plid) throws HDF5LibraryException;
/**
* H5Pget_class returns the property list class for the property list identified by the plist parameter.
*
* @param plist
* IN: Identifier of property list to query.
* @return a property list class if successful. Otherwise returns H5P_ROOT (-1).
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Pget_class(long plist) throws HDF5LibraryException;
/**
* H5Pget_class_parent retrieves an identifier for the parent class of a property class
*
* @param plid
* IN: Identifier of the property class to query
* @return a valid parent class object identifier if successful; a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native long H5Pget_class_parent(long plid) throws HDF5LibraryException;
/**
* H5Pequal determines if two property lists or classes are equal
*
* @param plid1
* IN: First property object to be compared
* @param plid2
* IN: Second property object to be compared
*
* @return positive value if equal; zero if unequal, a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native int H5Pequal(long plid1, long plid2) throws HDF5LibraryException;
/**
* H5Pequal determines if two property lists or classes are equal
*
* @param plid1
* IN: First property object to be compared
* @param plid2
* IN: Second property object to be compared
*
* @return TRUE if equal, FALSE if unequal
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public static boolean H5P_equal(long plid1, long plid2) throws HDF5LibraryException {
if (H5Pequal(plid1, plid2) == 1)
return true;
return false;
}
/**
* H5Pisa_class checks to determine whether a property list is a member of the specified class
*
* @param plist
* IN: Identifier of the property list
* @param pclass
* IN: Identifier of the property class
* @return a positive value if equal; zero if unequal; a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native int H5Pisa_class(long plist, long pclass) throws HDF5LibraryException;
/**
* H5Pcopy_prop copies a property from one property list or class to another
*
* @param dst_id
* IN: Identifier of the destination property list or class
* @param src_id
* IN: Identifier of the source property list or class
* @param name
* IN: Name of the property to copy
* @return a non-negative value if successful; a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native int H5Pcopy_prop(long dst_id, long src_id, String name)
throws HDF5LibraryException;
/**
* H5Premove removes a property from a property list
*
* @param plid
* IN: Identifier of the property list to modify
* @param name
* IN: Name of property to remove
* @return a non-negative value if successful; a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native int H5Premove(long plid, String name) throws HDF5LibraryException;
/**
* H5Punregister removes a property from a property list class
*
* @param plid
* IN: Property list class from which to remove permanent property
* @param name
* IN: Name of property to remove
* @return a non-negative value if successful; a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native int H5Punregister(long plid, String name) throws HDF5LibraryException;
/**
* Closes an existing property list class
*
* @param plid
* IN: Property list class to close
* @return a non-negative value if successful; a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public static int H5Pclose_class(long plid) throws HDF5LibraryException {
if (plid < 0)
return 0; // throw new HDF5LibraryException("Negative ID");;
log.trace("OPEN_IDS: H5Pclose_class remove {}", plid);
OPEN_IDS.remove(plid);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
return _H5Pclose_class(plid);
}
private synchronized static native int _H5Pclose_class(long plid) throws HDF5LibraryException;
/**
* H5Pclose terminates access to a property list.
*
* @param plist
* IN: Identifier of the property list to terminate access to.
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Pclose(long plist) throws HDF5LibraryException {
if (plist < 0)
return 0; // throw new HDF5LibraryException("Negative ID");;
log.trace("OPEN_IDS: H5Pclose remove {}", plist);
OPEN_IDS.remove(plist);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
return _H5Pclose(plist);
}
private synchronized static native int _H5Pclose(long plist) throws HDF5LibraryException;
/**
* H5Pcopy copies an existing property list to create a new property list.
*
* @param plist
* IN: Identifier of property list to duplicate.
*
* @return a property list identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Pcopy(long plist) throws HDF5LibraryException {
long id = _H5Pcopy(plist);
if (id > 0) {
log.trace("OPEN_IDS: H5Pcopy add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Pcopy(long plist) throws HDF5LibraryException;
// Define property list class callback function pointer types
// typedef herr_t (*H5P_cls_create_func_t)(hid_t prop_id, void *create_data);
// typedef herr_t (*H5P_cls_copy_func_t)(hid_t new_prop_id, hid_t old_prop_id, void *copy_data);
// typedef herr_t (*H5P_cls_close_func_t)(hid_t prop_id, void *close_data);
// Define property list callback function pointer types
// typedef herr_t (*H5P_prp_cb1_t)(const char *name, size_t size, void *value);
// typedef herr_t (*H5P_prp_cb2_t)(hid_t prop_id, const char *name, size_t size, void *value);
// typedef H5P_prp_cb1_t H5P_prp_create_func_t;
// typedef H5P_prp_cb2_t H5P_prp_set_func_t;
// typedef H5P_prp_cb2_t H5P_prp_get_func_t;
// typedef herr_t (*H5P_prp_encode_func_t)(const void *value, void **buf, size_t *size);
// typedef herr_t (*H5P_prp_decode_func_t)(const void **buf, void *value);
// typedef H5P_prp_cb2_t H5P_prp_delete_func_t;
// typedef H5P_prp_cb1_t H5P_prp_copy_func_t;
// typedef int (*H5P_prp_compare_func_t)(const void *value1, const void *value2, size_t size);
// typedef H5P_prp_cb1_t H5P_prp_close_func_t;
// Define property list iteration function type
// typedef herr_t (*H5P_iterate_t)(hid_t id, const char *name, void *iter_data);
/**
* H5Pcreate_class_nocb creates an new property class with no callback functions.
*
* @param parent_class
* IN: Identifier of the parent property class.
* @param name
* IN: Name of the property class.
*
* @return a property list identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Pcreate_class_nocb(long parent_class, String name) throws HDF5LibraryException {
long id = _H5Pcreate_class_nocb(parent_class, name);
if (id > 0) {
log.trace("OPEN_IDS: H5Pcreate_class_nocb add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Pcreate_class_nocb(long parent_class, String name) throws HDF5LibraryException;
// public static long H5Pcreate_class(long parent_class, String name, H5P_cls_create_func_cb create_op, H5P_cls_create_func_t create_data,
// H5P_cls_copy_func_cb copy_op, H5P_cls_copy_func_t copy_data, H5P_cls_close_func_cb close_op, H5P_cls_close_func_t close_data) throws HDF5LibraryException {
// long id = _H5Pcreate_class(parent_class, name, create_op, create_data, copy_op, copy_data, close_op, close_data);
// if (id > 0) {
// log.trace("OPEN_IDS: H5Pcreate_class add {}", id);
// OPEN_IDS.add(id);
// log.trace("OPEN_IDS: {}", OPEN_IDS.size());
// }
// return id;
// }
//
// private synchronized static native long _H5Pcreate_class(long parent_class, String name, H5P_cls_create_func_cb create_op, H5P_cls_create_func_t create_data,
// H5P_cls_copy_func_cb copy_op, H5P_cls_copy_func_t copy_data, H5P_cls_close_func_cb close_op, H5P_cls_close_func_t close_data) throws HDF5LibraryException;
/**
* H5Pregister2_nocb registers a property list with no callback functions.
*
* @param plist_class
* IN: Identifier of the property list.
* @param name
* IN: Name of the property.
* @param size
* IN: Size the property value.
* @param def_value
* IN: Defaul value of the property
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Pregister2_nocb(long plist_class, String name, long size, byte[] def_value) throws HDF5LibraryException;
// public synchronized static native void H5Pregister2(long plist_class, String name, long size, byte[] def_value, H5P_prp_create_func_cb prp_create, H5P_prp_set_func_cb prp_set,
// H5P_prp_get_func_cb prp_get, H5P_prp_delete_func_cb prp_delete, H5P_prp_copy_func_cb prp_copy, H5P_prp_compare_func_cb prp_cmp, H5P_prp_close_func_cb prp_close) throws HDF5LibraryException;
/**
* H5Pinsert2_nocb inserts a property list with no callback functions.
*
* @param plist
* IN: Identifier of the property list.
* @param name
* IN: Name of the property.
* @param size
* IN: Size the property value.
* @param value
* IN: Defaul value of the property
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Pinsert2_nocb(long plist, String name, long size, byte[] value) throws HDF5LibraryException;
// public synchronized static native void H5Pinsert2(long plist, String name, long size, byte[] value, H5P_prp_set_func_cb prp_set, H5P_prp_get_func_cb prp_get,
// H5P_prp_delete_func_cb prp_delete, H5P_prp_copy_func_cb prp_copy, H5P_prp_compare_func_cb prp_cmp, H5P_prp_close_func_cb prp_close) throws HDF5LibraryException;
/**
* H5Piterate iterates over the properties in a property list or class
*
* @param plist
* IN: ID of property object to iterate over
* @param idx
* IN/OUT: index of the property to begin with
* @param op
* IN: function to be called with each property iterated over.
* @param op_data
* IN: iteration data from user
*
* @return
* the return value of the last call to op if it was non-zero,
* zero if all properties have been processed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - size is null.
*
**/
public synchronized static native int H5Piterate(long plist, int[] idx, H5P_iterate_cb op, H5P_iterate_t op_data) throws HDF5LibraryException;
// /////// Object creation property list (OCPL) routines ///////
/**
* H5Pget_attr_phase_change retrieves attribute storage phase change thresholds.
*
* @param ocpl_id
* IN: : Object (dataset or group) creation property list identifier
* @param attributes
* The maximun and minimum no. of attributes to be stored.
*
* <pre>
* attributes[0] = The maximum number of attributes to be stored in compact storage
* attributes[1] = The minimum number of attributes to be stored in dense storage
* </pre>
*
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - size is null.
*
**/
public synchronized static native int H5Pget_attr_phase_change(long ocpl_id, int[] attributes)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_attr_phase_change sets threshold values for attribute storage on an object. These
* thresholds determine the point at which attribute storage changes
* from compact storage (i.e., storage in the object header)
* to dense storage (i.e., storage in a heap and indexed with a B-tree).
*
* @param ocpl_id
* IN: : Object (dataset or group) creation property list identifier
* @param max_compact
* IN: Maximum number of attributes to be stored in compact storage (Default: 8)
* @param min_dense
* IN: Minimum number of attributes to be stored in dense storage (Default: 6)
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native void H5Pset_attr_phase_change(long ocpl_id, int max_compact, int min_dense)
throws HDF5LibraryException;
/**
* H5Pget_attr_creation_order retrieves the settings for tracking and indexing attribute creation order on an object
*
* @param ocpl_id
* IN: Object (group or dataset) creation property list identifier
*
* @return Flags specifying whether to track and index attribute creation order
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_attr_creation_order(long ocpl_id) throws HDF5LibraryException;
/**
* H5Pset_attr_creation_order sets flags specifying whether to track and index attribute creation order on an
* object.
*
* @param ocpl_id
* IN: Object creation property list identifier
* @param crt_order_flags
* IN: Flags specifying whether to track and index attribute creation order
*
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_attr_creation_order(long ocpl_id, int crt_order_flags)
throws HDF5LibraryException;
/**
* H5Pget_obj_track_times queries the object creation property list, ocpl_id, to determine whether object times are
* being recorded.
*
* @param ocpl_id
* IN: Object creation property list identifier
*
* @return TRUE or FALSE, specifying whether object times are being recorded
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native boolean H5Pget_obj_track_times(long ocpl_id) throws HDF5LibraryException;
/**
* H5Pset_obj_track_times sets a property in the object creation property list, ocpl_id, that governs the recording
* of times associated with an object.
*
* @param ocpl_id
* IN: Object creation property list identifier
*
* @param track_times
* IN: TRUE or FALSE, specifying whether object times are to be tracked
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native void H5Pset_obj_track_times(long ocpl_id, boolean track_times)
throws HDF5LibraryException;
/**
* H5Pmodify_filter modifies the specified FILTER in the transient or permanent output filter pipeline
* depending on whether PLIST is a dataset creation or dataset
* transfer property list. The FLAGS argument specifies certain
* general properties of the filter and is documented below.
* The CD_VALUES is an array of CD_NELMTS integers which are
* auxiliary data for the filter. The integer vlues will be
* stored in the dataset object header as part of the filter
* information.
*<p>
* The FLAGS argument is a bit vector of the following fields:
*<p>
* H5Z_FLAG_OPTIONAL(0x0001)
* If this bit is set then the filter is optional. If the
* filter fails during an H5Dwrite() operation then the filter
* is just excluded from the pipeline for the chunk for which it
* failed; the filter will not participate in the pipeline
* during an H5Dread() of the chunk. If this bit is clear and
* the filter fails then the entire I/O operation fails.
* If this bit is set but encoding is disabled for a filter,
* attempting to write will generate an error.
*<p>
* Note: This function currently supports only the permanent filter
* pipeline. That is, PLIST_ID must be a dataset creation
* property list.
*
* @param plist
* IN: Property list identifier.
* @param filter
* IN: Filter to be modified to the pipeline.
* @param flags
* IN: Bit vector specifying certain general properties of the filter.
* @param cd_nelmts
* IN: Number of elements in cd_values
* @param cd_values
* IN: Auxiliary data for the filter.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name or an array is null.
*
**/
public synchronized static native int H5Pmodify_filter(long plist, long filter, int flags, long cd_nelmts,
int[] cd_values) throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_filter adds the specified filter and corresponding properties to the end of an output filter pipeline.
*
* @param plist
* IN: Property list identifier.
* @param filter
* IN: Filter to be added to the pipeline.
* @param flags
* IN: Bit vector specifying certain general properties of the filter.
* @param cd_nelmts
* IN: Number of elements in cd_values
* @param cd_values
* IN: Auxiliary data for the filter.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_filter(long plist, int filter, int flags, long cd_nelmts,
int[] cd_values) throws HDF5LibraryException;
/**
* H5Pget_nfilters returns the number of filters defined in the filter pipeline associated with the property list
* plist.
*
* @param plist
* IN: Property list identifier.
*
* @return the number of filters in the pipeline if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pget_nfilters(long plist) throws HDF5LibraryException;
/**
* H5Pget_filter returns information about a filter, specified by its filter number, in a filter pipeline, specified
* by the property list with which it is associated.
*
* @param plist
* IN: Property list identifier.
* @param filter_number
* IN: Sequence number within the filter pipeline of the filter for which information is sought.
* @param flags
* OUT: Bit vector specifying certain general properties of the filter.
* @param cd_nelmts
* IN/OUT: Number of elements in cd_values
* @param cd_values
* OUT: Auxiliary data for the filter.
* @param namelen
* IN: Anticipated number of characters in name.
* @param name
* OUT: Name of the filter.
* @param filter_config
* OUT:A bit field encoding the returned filter information
*
* @return the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).
*
* @exception ArrayIndexOutOfBoundsException
* Fatal error on Copyback
* @exception ArrayStoreException
* Fatal error on Copyback
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name or an array is null.
*
**/
public static int H5Pget_filter(long plist, int filter_number, int[] flags, long[] cd_nelmts, int[] cd_values,
long namelen, String[] name, int[] filter_config) throws ArrayIndexOutOfBoundsException,
ArrayStoreException, HDF5LibraryException, NullPointerException {
return H5Pget_filter2(plist, filter_number, flags, cd_nelmts, cd_values, namelen, name, filter_config);
}
/**
* H5Pget_filter2 returns information about a filter, specified by its filter number, in a filter pipeline,
* specified by the property list with which it is associated.
*
* @see public static int H5Pget_filter(int plist, int filter_number, int[] flags, int[] cd_nelmts, int[] cd_values,
* int namelen, String[] name, int[] filter_config)
*
**/
private synchronized static native int H5Pget_filter2(long plist, int filter_number, int[] flags, long[] cd_nelmts,
int[] cd_values, long namelen, String[] name, int[] filter_config) throws ArrayIndexOutOfBoundsException,
ArrayStoreException, HDF5LibraryException, NullPointerException;
/**
* H5Pget_filter_by_id returns information about the filter specified in filter_id, a filter identifier. plist_id
* must be a dataset or group creation property list and filter_id must be in the associated filter pipeline. The
* filter_id and flags parameters are used in the same manner as described in the discussion of H5Pset_filter. Aside
* from the fact that they are used for output, the parameters cd_nelmts and cd_values[] are used in the same manner
* as described in the discussion of H5Pset_filter. On input, the cd_nelmts parameter indicates the number of
* entries in the cd_values[] array allocated by the calling program; on exit it contains the number of values
* defined by the filter. On input, the namelen parameter indicates the number of characters allocated for the
* filter name by the calling program in the array name[]. On exit name[] contains the name of the filter with one
* character of the name in each element of the array. If the filter specified in filter_id is not set for the
* property list, an error will be returned and H5Pget_filter_by_id1 will fail.
*
* @param plist_id
* IN: Property list identifier.
* @param filter_id
* IN: Filter identifier.
* @param flags
* OUT: Bit vector specifying certain general properties of the filter.
* @param cd_nelmts
* N/OUT: Number of elements in cd_values
* @param cd_values
* OUT: Auxiliary data for the filter.
* @param namelen
* IN: Anticipated number of characters in name.
* @param name
* OUT: Name of the filter.
* @param filter_config
* OUT: A bit field encoding the returned filter information
*
* @return the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception ArrayIndexOutOfBoundsException
* Fatal error on Copyback
* @exception ArrayStoreException
* Fatal error on Copyback
* @exception NullPointerException
* - name or an array is null.
*
**/
public static int H5Pget_filter_by_id(long plist_id, long filter_id, int[] flags, long[] cd_nelmts,
int[] cd_values, long namelen, String[] name, int[] filter_config) throws ArrayIndexOutOfBoundsException,
ArrayStoreException, HDF5LibraryException, NullPointerException {
return H5Pget_filter_by_id2(plist_id, filter_id, flags, cd_nelmts, cd_values, namelen, name, filter_config);
}
/**
* H5Pget_filter_by_id2 returns information about a filter, specified by its filter id, in a filter pipeline,
* specified by the property list with which it is associated.
*
* @param plist_id
* IN: Property list identifier.
* @param filter_id
* IN: Filter identifier.
* @param flags
* OUT: Bit vector specifying certain general properties of the filter.
* @param cd_nelmts
* N/OUT: Number of elements in cd_values
* @param cd_values
* OUT: Auxiliary data for the filter.
* @param namelen
* IN: Anticipated number of characters in name.
* @param name
* OUT: Name of the filter.
* @param filter_config
* OUT: A bit field encoding the returned filter information
*
* @return the filter identification number if successful. Otherwise returns H5Z_FILTER_ERROR (-1).
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name or an array is null.
*
**/
public synchronized static native int H5Pget_filter_by_id2(long plist_id, long filter_id, int[] flags,
long[] cd_nelmts, int[] cd_values, long namelen, String[] name, int[] filter_config)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pall_filters_avail query to verify that all the filters set
* in the dataset creation property list are available currently.
*
* @param dcpl_id
* IN: Property list identifier.
*
* @return
* TRUE if all filters available
* FALSE if one or more filters not currently available.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Pall_filters_avail(long dcpl_id) throws HDF5LibraryException,
NullPointerException;
/**
* H5Premove_filter deletes a filter from the dataset creation property list;
* deletes all filters if filter is H5Z_FILTER_NONE
*
* @param obj_id
* IN: Property list identifier.
* @param filter
* IN: Filter identifier.
*
* @return a non-negative value and the size of the user block; if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Premove_filter(long obj_id, long filter) throws HDF5LibraryException;
/**
* H5Pset_deflate sets the compression method for a dataset.
*
* @param plist
* IN: Identifier for the dataset creation property list.
* @param level
* IN: Compression level.
*
* @return non-negative if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_deflate(long plist, int level) throws HDF5LibraryException;
/**
* H5Pset_fletcher32 sets Fletcher32 checksum of EDC for a dataset creation
* property list or group creation property list.
*
* @param plist
* IN: Property list identifier.
*
* @return a non-negative value and the size of the user block; if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_fletcher32(long plist) throws HDF5LibraryException,
NullPointerException;
// /////// File creation property list (FCPL) routines ///////
/**
* H5Pget_userblock retrieves the size of a user block in a file creation property list.
*
* @param plist
* IN: Identifier for property list to query.
* @param size
* OUT: Pointer to location to return user-block size.
*
* @return a non-negative value and the size of the user block; if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - size is null.
**/
public synchronized static native int H5Pget_userblock(long plist, long[] size) throws HDF5LibraryException,
NullPointerException;
/**
* H5Pset_userblock sets the user block size of a file creation property list.
*
* @param plist
* IN: Identifier of property list to modify.
* @param size
* IN: Size of the user-block in bytes.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_userblock(long plist, long size) throws HDF5LibraryException;
/**
* H5Pget_sizes retrieves the size of the offsets and lengths used in an HDF5 file. This function is only valid for
* file creation property lists.
*
* @param plist
* IN: Identifier of property list to query.
* @param size
* OUT: the size of the offsets and length.
*
* <pre>
* size[0] = sizeof_addr // offset size in bytes
* size[1] = sizeof_size // length size in bytes
* </pre>
* @return a non-negative value with the sizes initialized; if successful;
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - size is null.
* @exception IllegalArgumentException
* - size is invalid.
**/
public synchronized static native int H5Pget_sizes(long plist, long[] size) throws HDF5LibraryException,
NullPointerException, IllegalArgumentException;
/**
* H5Pset_sizes sets the byte size of the offsets and lengths used to address objects in an HDF5 file.
*
* @param plist
* IN: Identifier of property list to modify.
* @param sizeof_addr
* IN: Size of an object offset in bytes.
* @param sizeof_size
* IN: Size of an object length in bytes.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_sizes(long plist, int sizeof_addr, int sizeof_size)
throws HDF5LibraryException;
/**
* H5Pget_sym_k retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size.
*
* @param plist
* IN: Property list to query.
* @param size
* OUT: the symbol table's B-tree 1/2 rank and leaf node 1/2size.
*
* <pre>
* size[0] = ik // the symbol table's B-tree 1/2 rank
* size[1] = lk // leaf node 1/2 size
* </pre>
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - size is null.
* @exception IllegalArgumentException
* - size is invalid.
**/
public synchronized static native int H5Pget_sym_k(long plist, int[] size) throws HDF5LibraryException,
NullPointerException, IllegalArgumentException;
/**
* H5Pset_sym_k sets the size of parameters used to control the symbol table nodes.
*
* @param plist
* IN: Identifier for property list to query.
* @param ik
* IN: Symbol table tree rank.
* @param lk
* IN: Symbol table node size.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_sym_k(long plist, int ik, int lk) throws HDF5LibraryException;
/**
* H5Pget_istore_k queries the 1/2 rank of an indexed storage B-tree.
*
* @param plist
* IN: Identifier of property list to query.
* @param ik
* OUT: Pointer to location to return the chunked storage B-tree 1/2 rank.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - ik array is null.
**/
public synchronized static native int H5Pget_istore_k(long plist, int[] ik) throws HDF5LibraryException,
NullPointerException;
/**
* H5Pset_istore_k sets the size of the parameter used to control the B-trees for indexing chunked datasets.
*
* @param plist
* IN: Identifier of property list to query.
* @param ik
* IN: 1/2 rank of chunked storage B-tree.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_istore_k(long plist, int ik) throws HDF5LibraryException;
/**
* H5Pget_shared_mesg_nindexes retrieves number of shared object header message indexes in file creation property
* list.
*
* @param fcpl_id
* IN: : File creation property list identifier
*
* @return nindexes, the number of shared object header message indexes available in files created with this
* property list
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_shared_mesg_nindexes(long fcpl_id) throws HDF5LibraryException;
/**
* H5Pset_shared_mesg_nindexes sets the number of shared object header message indexes in the specified file
* creation property list.
*
* @param plist_id
* IN: File creation property list
* @param nindexes
* IN: Number of shared object header message indexes to be available in files created with this property
* list
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid value of nindexes
*
**/
public synchronized static native int H5Pset_shared_mesg_nindexes(long plist_id, int nindexes)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_shared_mesg_index Retrieves the configuration settings for a shared message index.
*
* @param fcpl_id
* IN: File creation property list identifier
* @param index_num
* IN: Index being configured.
* @param mesg_info
* The message type and minimum message size
*
* <pre>
* mesg_info[0] = Types of messages that may be stored in this index.
* mesg_info[1] = Minimum message size.
* </pre>
*
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - mesg_info is null.
* @exception IllegalArgumentException
* - Invalid value of nindexes
*
**/
public synchronized static native int H5Pget_shared_mesg_index(long fcpl_id, int index_num, int[] mesg_info)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Pset_shared_mesg_index Configures the specified shared object header message index
*
* @param fcpl_id
* IN: File creation property list identifier.
* @param index_num
* IN: Index being configured.
* @param mesg_type_flags
* IN: Types of messages that should be stored in this index.
* @param min_mesg_size
* IN: Minimum message size.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid value of nindexes
*
**/
public synchronized static native int H5Pset_shared_mesg_index(long fcpl_id, int index_num, int mesg_type_flags,
int min_mesg_size) throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_shared_mesg_phase_change retrieves shared object header message phase change information.
*
* @param fcpl_id
* IN: : File creation property list identifier
* @param size
* The threshold values for storage of shared object header message indexes in a file.
*
* <pre>
* size[0] = Threshold above which storage of a shared object header message index shifts from list to B-tree
* size[1] = Threshold below which storage of a shared object header message index reverts to list format
* </pre>
*
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - size is null.
*
**/
public synchronized static native int H5Pget_shared_mesg_phase_change(long fcpl_id, int[] size)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_shared_mesg_phase_change sets shared object header message storage phase change thresholds.
*
* @param fcpl_id
* IN: File creation property list identifier
* @param max_list
* IN: Threshold above which storage of a shared object header message index shifts from list to B-tree
* @param min_btree
* IN: Threshold below which storage of a shared object header message index reverts to list format
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid values of max_list and min_btree.
*
**/
public synchronized static native int H5Pset_shared_mesg_phase_change(long fcpl_id, int max_list, int min_btree)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pset_file_space_strategy sets the file space management strategy for the file associated with fcpl_id to strategy.
* There are four strategies that applications can select and they are described in the Parameters section.
*
* @param fcpl_id
* IN: File creation property list identifier
* @param strategy
* IN: The strategy for file space management.
* H5F_FSPACE_STRATEGY_FSM_AGGR
* Mechanisms: free-space managers, aggregators, and virtual file drivers
* This is the library default when not set.
* H5F_FSPACE_STRATEGY_PAGE
* Mechanisms: free-space managers with embedded paged aggregation and virtual file drivers
* H5F_FSPACE_STRATEGY_AGGR
* Mechanisms: aggregators and virtual file drivers
* H5F_FSPACE_STRATEGY_NONE
* Mechanisms: virtual file drivers
* @param persist
* IN: True to persist free-space.
* @param threshold
* IN: The free-space section threshold. The library default is 1, which is to track all free-space sections.
* Passing a value of zero (0) indicates that the value of threshold is not to be modified.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid values of max_list and min_btree.
*
**/
public synchronized static native void H5Pset_file_space_strategy(long fcpl_id, int strategy, boolean persist, long threshold)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_file_space_strategy provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.
*
* @param fcpl_id
* IN: File creation property list identifier
* @param persist
* IN/OUT: The current free-space persistence. NULL, persist not queried.
* @param threshold
* IN/OUT: The current free-space section threshold. NULL, threshold not queried.
*
* @return the current free-space strategy.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid values of max_list and min_btree.
*
**/
public synchronized static native int H5Pget_file_space_strategy(long fcpl_id, boolean[] persist, long[] threshold)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_file_space_strategy_persist provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.
*
* @param fcpl_id
* IN: File creation property list identifier
*
* @return the current free-space persistence.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid values of max_list and min_btree.
*
**/
public synchronized static native boolean H5Pget_file_space_strategy_persist(long fcpl_id)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_file_space_strategy_threshold provides the means for applications to manage the HDF5 file's file space strategy for their specific needs.
*
* @param fcpl_id
* IN: File creation property list identifier
*
* @return the current free-space section threshold.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid values of max_list and min_btree.
*
**/
public synchronized static native long H5Pget_file_space_strategy_threshold(long fcpl_id)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pset_file_space_page_size retrieves the file space page size for aggregating small metadata or raw data.
*
* @param fcpl_id
* IN: File creation property list identifier
* @param page_size
* IN: the file space page size.
*
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid values of max_list and min_btree.
*
**/
public synchronized static native void H5Pset_file_space_page_size(long fcpl_id, long page_size)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_file_space_page_size Sets the file space page size for paged aggregation.
*
* @param fcpl_id
* IN: File creation property list identifier
*
* @return the current file space page size.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid values of max_list and min_btree.
*
**/
public synchronized static native long H5Pget_file_space_page_size(long fcpl_id)
throws HDF5LibraryException, IllegalArgumentException;
// /////// File access property list (FAPL) routines ///////
/**
* H5Pget_alignment retrieves the current settings for alignment properties from a file access property list.
*
* @param plist
* IN: Identifier of a file access property list.
* @param alignment
* OUT: threshold value and alignment value.
*
* <pre>
* alignment[0] = threshold // threshold value
* alignment[1] = alignment // alignment value
* </pre>
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - aligment array is null.
* @exception IllegalArgumentException
* - aligment array is invalid.
**/
public synchronized static native int H5Pget_alignment(long plist, long[] alignment) throws HDF5LibraryException,
NullPointerException, IllegalArgumentException;
/**
* H5Pset_alignment sets the alignment properties of a file access property list so that any file object >=
* THRESHOLD bytes will be aligned on an address which is a multiple of ALIGNMENT.
*
* @param plist
* IN: Identifier for a file access property list.
* @param threshold
* IN: Threshold value.
* @param alignment
* IN: Alignment value.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_alignment(long plist, long threshold, long alignment)
throws HDF5LibraryException;
/**
* H5Pget_driver returns the identifier of the low-level file driver associated with the file access property list
* or data transfer property list plid.
*
* @param plid
* IN: File access or data transfer property list identifier.
* @return a valid low-level driver identifier if successful; a negative value if failed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*/
public synchronized static native long H5Pget_driver(long plid) throws HDF5LibraryException;
/**
* H5Pget_family_offset gets offset for family driver.
*
* @param fapl_id
* IN: File access property list identifier
*
* @return the offset.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native long H5Pget_family_offset(long fapl_id) throws HDF5LibraryException;
/**
* H5Pset_family_offset sets the offset for family driver.
*
* @param fapl_id
* IN: File access property list identifier
* @param offset
* IN: the offset value
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_family_offset(long fapl_id, long offset) throws HDF5LibraryException;
/**
* Retrieves the maximum possible number of elements in the meta data cache and the maximum possible number of bytes
* and the RDCC_W0 value in the raw data chunk cache.
*
* @param plist
* IN: Identifier of the file access property list.
* @param mdc_nelmts
* IN/OUT: No longer used, will be ignored.
* @param rdcc_nelmts
* IN/OUT: Number of elements (objects) in the raw data chunk cache.
* @param rdcc_nbytes
* IN/OUT: Total size of the raw data chunk cache, in bytes.
* @param rdcc_w0
* IN/OUT: Preemption policy.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an array is null.
**/
public synchronized static native int H5Pget_cache(long plist, int[] mdc_nelmts, long[] rdcc_nelmts,
long[] rdcc_nbytes, double[] rdcc_w0) throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_cache sets the number of elements (objects) in the meta data cache and the total number of bytes in the
* raw data chunk cache.
*
* @param plist
* IN: Identifier of the file access property list.
* @param mdc_nelmts
* IN: No longer used, will be ignored.
* @param rdcc_nelmts
* IN: Number of elements (objects) in the raw data chunk cache.
* @param rdcc_nbytes
* IN: Total size of the raw data chunk cache, in bytes.
* @param rdcc_w0
* IN: Preemption policy.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_cache(long plist, int mdc_nelmts, long rdcc_nelmts, long rdcc_nbytes,
double rdcc_w0) throws HDF5LibraryException;
/**
* H5Pget_mdc_config gets the initial metadata cache configuration contained in a file access property list.
* This configuration is used when the file is opened.
*
* @param plist_id
* IN: Identifier of the file access property list.
*
* @return A buffer(H5AC_cache_config_t) for the current metadata cache configuration information
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native H5AC_cache_config_t H5Pget_mdc_config(long plist_id) throws HDF5LibraryException;
/**
* H5Pset_mdc_config sets the initial metadata cache configuration contained in a file access property list and
* loads it into the instance of H5AC_cache_config_t pointed to by the config_ptr parameter. This configuration is
* used when the file is opened.
*
* @param plist_id
* IN: Identifier of the file access property list.
* @param config_ptr
* IN: H5AC_cache_config_t, the initial metadata cache configuration.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Pset_mdc_config(long plist_id, H5AC_cache_config_t config_ptr)
throws HDF5LibraryException;
/**
* H5Pget_gc_references Returns the current setting for the garbage collection refernces property from a file access
* property list.
*
* @param fapl_id
* IN File access property list
*
* @return GC is on (true) or off (false)
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Pget_gc_references(long fapl_id) throws HDF5LibraryException;
/**
* H5Pset_gc_references Sets the flag for garbage collecting references for the file. Default value for garbage
* collecting references is off.
*
* @param fapl_id
* IN File access property list
* @param gc_ref
* IN set GC on (true) or off (false)
*
* @return non-negative if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_gc_references(long fapl_id, boolean gc_ref)
throws HDF5LibraryException;
/**
* H5Pget_fclose_degree returns the degree for the file close behavior for a file access
* property list.
*
* @param fapl_id
* IN File access property list
*
* @return the degree for the file close behavior
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pget_fclose_degree(long fapl_id) throws HDF5LibraryException,
NullPointerException;
/**
* H5Pset_fclose_degree sets the degree for the file close behavior.
*
* @param fapl_id
* IN File access property list
* @param degree
* IN the degree for the file close behavior
*
* @return non-negative if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_fclose_degree(long fapl_id, int degree) throws HDF5LibraryException,
NullPointerException;
/**
* H5Pget_meta_block_size the current metadata block size setting.
*
* @param fapl_id
* IN: File access property list identifier
*
* @return the minimum size, in bytes, of metadata block allocations.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native long H5Pget_meta_block_size(long fapl_id) throws HDF5LibraryException;
/**
* H5Pset_meta_block_size sets the minimum metadata block size.
*
* @param fapl_id
* IN: File access property list identifier
* @param size
* IN: Minimum size, in bytes, of metadata block allocations.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native void H5Pset_meta_block_size(long fapl_id, long size) throws HDF5LibraryException;
/**
* H5Pget_sieve_buf_size retrieves the current settings for the data sieve buffer size
* property from a file access property list.
*
* @param fapl_id
* IN: Identifier for property list to query.
*
* @return a non-negative value and the size of the user block; if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Pget_sieve_buf_size(long fapl_id) throws HDF5LibraryException;
/**
* H5Pset_sieve_buf_size Sets the maximum size of the data seive buffer used for file
* drivers which are capable of using data sieving. The data sieve
* buffer is used when performing I/O on datasets in the file. Using a
* buffer which is large anough to hold several pieces of the dataset
* being read in for hyperslab selections boosts performance by quite a
* bit.
* <p>
* The default value is set to 64KB, indicating that file I/O for raw data
* reads and writes will occur in at least 64KB blocks. Setting the value to 0
* with this function will turn off the data sieving
*
* @param fapl_id
* IN: Identifier of property list to modify.
* @param size
* IN: maximum size of the data seive buffer.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Pset_sieve_buf_size(long fapl_id, long size) throws HDF5LibraryException;
/**
* H5Pget_small_data_block_size retrieves the size of a block of small data in a file creation property list.
*
* @param plist
* IN: Identifier for property list to query.
*
* @return a non-negative value and the size of the user block; if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Pget_small_data_block_size(long plist) throws HDF5LibraryException;
/**
* H5Pset_small_data_block_size reserves blocks of size bytes for the contiguous storage of the raw data portion of
* small datasets.
*
* @param plist
* IN: Identifier of property list to modify.
* @param size
* IN: Size of the blocks in bytes.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_small_data_block_size(long plist, long size)
throws HDF5LibraryException;
/**
* H5Pget_libver_bounds retrieves the lower and upper bounds on the HDF5 Library versions that indirectly determine
* the object formats versions used when creating objects in the file.
*
* @param fapl_id
* IN: File access property list identifier
* @param libver
* The earliest/latest version of the library that will be used for writing objects.
*
* <pre>
* libver[0] = The earliest version of the library that will be used for writing objects
* libver[1] = The latest version of the library that will be used for writing objects.
* </pre>
*
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - size is null.
*
**/
public synchronized static native int H5Pget_libver_bounds(long fapl_id, int[] libver) throws HDF5LibraryException,
NullPointerException;
/**
* H5Pset_libver_bounds Sets bounds on library versions, and indirectly format versions, to be used when creating
* objects
*
* @param fapl_id
* IN: File access property list identifier
* @param low
* IN: The earliest version of the library that will be used for writing objects
* @param high
* IN: The latest version of the library that will be used for writing objects.
*
*
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Argument is Illegal
*
**/
public synchronized static native int H5Pset_libver_bounds(long fapl_id, int low, int high)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_elink_file_cache_size retrieves the size of the external link open file cache.
*
* @param fapl_id
* IN: File access property list identifier
*
* @return External link open file cache size in number of files.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_elink_file_cache_size(long fapl_id) throws HDF5LibraryException;
/**
* H5Pset_elink_file_cache_size sets the number of files that can be held open in an external link open file cache.
*
* @param fapl_id
* IN: File access property list identifier
* @param efc_size
* IN: External link open file cache size in number of files.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native void H5Pset_elink_file_cache_size(long fapl_id, int efc_size)
throws HDF5LibraryException;
/**
* H5Pset_mdc_log_options sets metadata cache logging options.
*
* @param fapl_id
* IN: File access property list identifier
* @param is_enabled
* IN: Whether logging is enabled.
* @param location
* IN: Location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII).
* @param start_on_access
* IN: Whether the logging begins as soon as the file is opened or created.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - location is null.
*
**/
public synchronized static native void H5Pset_mdc_log_options(long fapl_id, boolean is_enabled, String location, boolean start_on_access)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pget_mdc_log_options gets metadata cache logging options.
*
* @param fapl_id
* IN: File access property list identifier
* @param mdc_log_options
* the options
* mdc_logging_options[0] = is_enabled, whether logging is enabled
* mdc_logging_options[1] = start_on_access, whether the logging begins as soon as the file is opened or created
*
* @return the location of log in UTF-8/ASCII (file path/name) (On Windows, this must be ASCII).
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native String H5Pget_mdc_log_options(long fapl_id, boolean[] mdc_log_options)
throws HDF5LibraryException;
/**
* H5Pget_metadata_read_attempts retrieves the number of read attempts that is set in the file access property list plist_id.
*
* @param plist_id
* IN: File access property list identifier
*
* @return The number of read attempts.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native long H5Pget_metadata_read_attempts(long plist_id) throws HDF5LibraryException;
/**
* H5Pset_metadata_read_attempts sets the number of reads that the library will try when reading checksummed
* metadata in an HDF5 file opened with SWMR access. When reading such metadata, the library will compare the
* checksum computed for the metadata just read with the checksum stored within the piece of checksum. When
* performing SWMR operations on a file, the checksum check might fail when the library reads data on a system
* that is not atomic. To remedy such situations, the library will repeatedly read the piece of metadata until
* the check passes or finally fails the read when the allowed number of attempts is reached.
*
* @param plist_id
* IN: File access property list identifier
* @param attempts
* IN: The number of read attempts which is a value greater than 0.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native void H5Pset_metadata_read_attempts(long plist_id, long attempts)
throws HDF5LibraryException;
/**
* H5Pget_evict_on_close retrieves the file access property list setting that determines whether an HDF5 object
* will be evicted from the library's metadata cache when it is closed.
*
* @param fapl_id
* IN: File access property list identifier
*
* @return indication if the object will be evicted on close.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native boolean H5Pget_evict_on_close(long fapl_id)
throws HDF5LibraryException;
/**
* H5Pset_evict_on_close controls the library's behavior of evicting metadata associated with a closed object.
*
* @param fapl_id
* IN: File access property list identifier
* @param evict_on_close
* IN: Whether the HDF5 object should be evicted on close.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native void H5Pset_evict_on_close(long fapl_id, boolean evict_on_close)
throws HDF5LibraryException;
/**
* H5Pget_use_file_locking retrieves whether we are using file locking.
*
* @param fapl_id
* IN: File access property list identifier
*
* @return indication if file locking is used.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native boolean H5Pget_use_file_locking(long fapl_id)
throws HDF5LibraryException;
/**
* H5Pget_use_file_locking retrieves whether we ignore file locks when they are disabled.
*
* @param fapl_id
* IN: File access property list identifier
*
* @return indication if file locking is ignored.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native boolean H5Pget_ignore_disabled_file_locking(long fapl_id)
throws HDF5LibraryException;
/**
* H5Pset_file_locking sets parameters related to file locking.
*
* @param fapl_id
* IN: File access property list identifier
*
* @param use_file_locking
* IN: Whether the library will use file locking when opening files (mainly for SWMR semantics).
*
* @param ignore_when_disabled
* IN: Whether file locking will be ignored when disabled on a file system (useful for Lustre).
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native void H5Pset_file_locking(long fapl_id, boolean use_file_locking, boolean ignore_when_disabled)
throws HDF5LibraryException;
// ///// unimplemented /////
// herr_t H5Pset_vol(hid_t plist_id, hid_t new_vol_id, const void *new_vol_info);
// herr_t H5Pget_vol_id(hid_t plist_id, hid_t *vol_id);
// herr_t H5Pget_vol_info(hid_t plist_id, void **vol_info);
// Dataset creation property list (DCPL) routines //
/**
* H5Pget_layout returns the layout of the raw data for a dataset.
*
* @param plist
* IN: Identifier for property list to query.
*
* @return the layout type of a dataset creation property list if successful. Otherwise returns H5D_LAYOUT_ERROR
* (-1).
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pget_layout(long plist) throws HDF5LibraryException;
/**
* H5Pset_layout sets the type of storage used store the raw data for a dataset.
*
* @param plist
* IN: Identifier of property list to query.
* @param layout
* IN: Type of storage layout for raw data.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_layout(long plist, int layout) throws HDF5LibraryException;
/**
* H5Pget_chunk retrieves the size of chunks for the raw data of a chunked layout dataset.
*
* @param plist
* IN: Identifier of property list to query.
* @param max_ndims
* IN: Size of the dims array.
* @param dims
* OUT: Array to store the chunk dimensions.
*
* @return chunk dimensionality successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - dims array is null.
* @exception IllegalArgumentException
* - max_ndims <=0
**/
public synchronized static native int H5Pget_chunk(long plist, int max_ndims, long[] dims)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Pset_chunk sets the size of the chunks used to store a chunked layout dataset.
*
* @param plist
* IN: Identifier for property list to query.
* @param ndims
* IN: The number of dimensions of each chunk.
* @param dim
* IN: An array containing the size of each chunk.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - dims array is null.
* @exception IllegalArgumentException
* - dims <=0
**/
public synchronized static native int H5Pset_chunk(long plist, int ndims, byte[] dim) throws HDF5LibraryException,
NullPointerException, IllegalArgumentException;
/**
* H5Pset_chunk sets the size of the chunks used to store a chunked layout dataset.
*
* @param plist
* IN: Identifier for property list to query.
* @param ndims
* IN: The number of dimensions of each chunk.
* @param dim
* IN: An array containing the size of each chunk.
*
* @return a non-negative value if successful
*
* @exception HDF5Exception
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - dims array is null.
* @exception IllegalArgumentException
* - dims <=0
**/
public synchronized static int H5Pset_chunk(long plist, int ndims, long[] dim) throws HDF5Exception,
NullPointerException, IllegalArgumentException {
if (dim == null) {
return -1;
}
HDFArray theArray = new HDFArray(dim);
byte[] thedims = theArray.byteify();
int retVal = H5Pset_chunk(plist, ndims, thedims);
thedims = null;
theArray = null;
return retVal;
}
/**
* H5Pset_virtual maps elements of the virtual dataset (VDS) described by the
* virtual dataspace identifier vspace_id to the elements of the source dataset
* described by the source dataset dataspace identifier src_space_id. The source
* dataset is identified by the name of the file where it is located, src_file_name,
* and the name of the dataset, src_dset_name.
*
* @param dcpl_id
* IN: The identifier of the dataset creation property list that will be used when creating the virtual dataset.
* @param vspace_id
* IN: The dataspace identifier with the selection within the virtual dataset applied, possibly an unlimited selection.
* @param src_file_name
* IN: The name of the HDF5 file where the source dataset is located. The file might not exist yet. The name can be specified using a C-style printf statement.
* @param src_dset_name
* IN: The path to the HDF5 dataset in the file specified by src_file_name. The dataset might not exist yet. The dataset name can be specified using a C-style printf statement.
* @param src_space_id
* IN: The source dataset dataspace identifier with a selection applied, possibly an unlimited selection.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an name string is null.
* @exception IllegalArgumentException
* - An id is <=0
**/
public synchronized static native void H5Pset_virtual(long dcpl_id, long vspace_id, String src_file_name, String src_dset_name, long src_space_id) throws HDF5LibraryException,
NullPointerException, IllegalArgumentException;
/**
* H5Pget_virtual_count gets the number of mappings for a virtual dataset that has the creation property list specified by dcpl_id.
*
* @param dcpl_id
* IN: The identifier of the virtual dataset creation property list.
*
* @return a non-negative number of mappings if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - An id is <=0
**/
public synchronized static native long H5Pget_virtual_count(long dcpl_id) throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_virtual_vspace takes the dataset creation property list for the virtual dataset, dcpl_id, and the mapping index, index,
* and returns a dataspace identifier for the selection within the virtual dataset used in the mapping.
*
* @param dcpl_id
* IN: The identifier of the virtual dataset creation property list.
* @param index
* IN: Mapping index.
*
* @return a valid dataspace identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - An id is <=0
**/
public synchronized static native long H5Pget_virtual_vspace(long dcpl_id, long index) throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_virtual_srcspace takes the dataset creation property list for the virtual dataset, dcpl_id, and the mapping index, index,
* and returns a dataspace identifier for the selection within the source dataset used in the mapping.
*
* @param dcpl_id
* IN: The identifier of the virtual dataset creation property list.
* @param index
* IN: Mapping index.
*
* @return a valid dataspace identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - An id is <=0
**/
public synchronized static native long H5Pget_virtual_srcspace(long dcpl_id, long index) throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_virtual_filename takes the dataset creation property list for the virtual dataset, dcpl_id, the mapping index, index,
* the size of the filename for a source dataset, size, and retrieves the name of the file for a source dataset used in the mapping.
*
* @param dcpl_id
* IN: The identifier of the virtual dataset creation property list.
* @param index
* IN: Mapping index.
*
* @return the name of the file containing the source dataset if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - An id is <=0
**/
public synchronized static native String H5Pget_virtual_filename(long dcpl_id, long index) throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_virtual_dsetname takes the dataset creation property list for the virtual dataset, dcpl_id, the mapping index, index, the
* size of the dataset name for a source dataset, size, and retrieves the name of the source dataset used in the mapping.
*
* @param dcpl_id
* IN: The identifier of the virtual dataset creation property list.
* @param index
* IN: Mapping index.
*
* @return the name of the source dataset if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - An id is <=0
**/
public synchronized static native String H5Pget_virtual_dsetname(long dcpl_id, long index) throws HDF5LibraryException, IllegalArgumentException;
// ///// unimplemented /////
// /**
// * H5Pget_vds_file_cache_size retrieves the size of the vds link open file cache.
// *
// * @param fapl_id
// * IN: File access property list identifier
// *
// * @return VDS link open file cache size in number of files.
// *
// * @exception HDF5LibraryException
// * - Error from the HDF-5 Library.
// *
// **/
// public synchronized static native int H5Pget_vds_file_cache_size(long fapl_id) throws HDF5LibraryException;
//
// /**
// * H5Pset_vds_file_cache_size sets the number of files that can be held open in an vds link open file cache.
// *
// * @param fapl_id
// * IN: File access property list identifier
// * @param efc_size
// * IN: VDS link open file cache size in number of files.
// *
// * @exception HDF5LibraryException
// * - Error from the HDF-5 Library.
// *
// **/
// public synchronized static native void H5Pset_vds_file_cache_size(long fapl_id, int efc_size)
// throws HDF5LibraryException;
/**
* H5Pget_external returns information about an external file.
*
* @param plist
* IN: Identifier of a dataset creation property list.
* @param idx
* IN: External file index.
* @param name_size
* IN: Maximum length of name array.
* @param name
* OUT: Name of the external file.
* @param size
* OUT: the offset value and the size of the external file data.
*
* <pre>
* size[0] = offset // a location to return an offset value
* size[1] = size // a location to return the size of
* // the external file data.
* </pre>
*
* @return a non-negative value if successful
*
* @exception ArrayIndexOutOfBoundsException
* Fatal error on Copyback
* @exception ArrayStoreException
* Fatal error on Copyback
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name or size is null.
* @exception IllegalArgumentException
* - name_size <= 0 .
*
**/
public synchronized static native int H5Pget_external(long plist, int idx, long name_size, String[] name,
long[] size) throws ArrayIndexOutOfBoundsException, ArrayStoreException, HDF5LibraryException,
NullPointerException, IllegalArgumentException;
/**
* H5Pset_external adds an external file to the list of external files.
*
* @param plist
* IN: Identifier of a dataset creation property list.
* @param name
* IN: Name of an external file.
* @param offset
* IN: Offset, in bytes, from the beginning of the file to the location in the file where the data
* starts.
* @param size
* IN: Number of bytes reserved in the file for the data.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Pset_external(long plist, String name, long offset, long size)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pget_external_count returns the number of external files for the specified dataset.
*
* @param plist
* IN: Identifier of a dataset creation property list.
*
* @return the number of external files if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pget_external_count(long plist) throws HDF5LibraryException;
/**
* H5Pset_szip Sets up the use of the szip filter.
*
* @param plist
* IN: Dataset creation property list identifier.
* @param options_mask
* IN: Bit vector specifying certain general properties of the filter.
* @param pixels_per_block
* IN: Number of pixels in blocks
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_szip(long plist, int options_mask, int pixels_per_block)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_shuffle Sets up the use of the shuffle filter.
*
* @param plist_id
* IN: Dataset creation property list identifier.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_shuffle(long plist_id) throws HDF5LibraryException,
NullPointerException;
/**
* H5Pset_nbit Sets up the use of the N-Bit filter.
*
* @param plist_id
* IN: Dataset creation property list identifier.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_nbit(long plist_id) throws HDF5LibraryException;
/**
* H5Pset_scaleoffset sets the Scale-Offset filter for a dataset.
*
* @param plist_id
* IN: Dataset creation property list identifier.
* @param scale_type
* IN: Flag indicating compression method.
* @param scale_factor
* IN: Parameter related to scale.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid arguments
*
**/
public synchronized static native int H5Pset_scaleoffset(long plist_id, int scale_type, int scale_factor)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_fill_value queries the fill value property of a dataset creation property list.
*
* @param plist_id
* IN: Property list identifier.
* @param type_id
* IN: The datatype identifier of value.
* @param value
* IN: The fill value.
*
* @return a non-negative value if successful
*
* @exception HDF5Exception
* - Error converting data array.
**/
public synchronized static native int H5Pget_fill_value(long plist_id, long type_id, byte[] value)
throws HDF5Exception;
/**
* H5Pget_fill_value queries the fill value property of a dataset creation property list.
*
* @param plist_id
* IN: Property list identifier.
* @param type_id
* IN: The datatype identifier of value.
* @param obj
* IN: The fill value.
*
* @return a non-negative value if successful
*
* @exception HDF5Exception
* - Error converting data array.
**/
public synchronized static int H5Pget_fill_value(long plist_id, long type_id, Object obj) throws HDF5Exception {
HDFArray theArray = new HDFArray(obj);
byte[] buf = theArray.emptyBytes();
int status = H5Pget_fill_value(plist_id, type_id, buf);
if (status >= 0) {
obj = theArray.arrayify(buf);
}
return status;
}
/**
* H5Pset_fill_value sets the fill value for a dataset creation property list.
*
* @param plist_id
* IN: Property list identifier.
* @param type_id
* IN: The datatype identifier of value.
* @param value
* IN: The fill value.
*
* @return a non-negative value if successful
*
* @exception HDF5Exception
* - Error converting data array
**/
public synchronized static native int H5Pset_fill_value(long plist_id, long type_id, byte[] value)
throws HDF5Exception;
/**
* H5Pset_fill_value sets the fill value for a dataset creation property list.
*
* @param plist_id
* IN: Property list identifier.
* @param type_id
* IN: The datatype identifier of value.
* @param obj
* IN: The fill value.
*
* @return a non-negative value if successful
*
* @exception HDF5Exception
* - Error converting data array
**/
public synchronized static int H5Pset_fill_value(long plist_id, long type_id, Object obj) throws HDF5Exception {
HDFArray theArray = new HDFArray(obj);
byte[] buf = theArray.byteify();
int retVal = H5Pset_fill_value(plist_id, type_id, buf);
buf = null;
theArray = null;
return retVal;
}
/**
* H5Pset_fill_value checks if the fill value is defined for a dataset creation property list.
*
* @param plist_id
* IN: Property list identifier.
* @param status
* IN: The fill value setting:
* H5D_FILL_VALUE_UNDEFINED
* H5D_FILL_VALUE_DEFAULT
* H5D_FILL_VALUE_USER_DEFINED
* H5D_FILL_VALUE_ERROR
*
* @return a non-negative value if successful
*
* @exception HDF5Exception
* - Error converting data array
**/
public synchronized static native int H5Pfill_value_defined(long plist_id, int[] status)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_alloc_time Gets space allocation time for dataset during creation.
*
* @param plist_id
* IN: Dataset creation property list identifier.
* @param alloc_time
* OUT: allocation time.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_alloc_time(long plist_id, int[] alloc_time)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_alloc_time Sets space allocation time for dataset during creation.
*
* @param plist_id
* IN: Dataset creation property list identifier.
* @param alloc_time
* IN: allocation time.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_alloc_time(long plist_id, int alloc_time) throws HDF5LibraryException,
NullPointerException;
/**
* H5Pset_fill_time Gets fill value writing time.
*
* @param plist_id
* IN: Dataset creation property list identifier.
* @param fill_time
* OUT: fill time.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_fill_time(long plist_id, int[] fill_time) throws HDF5LibraryException;
/**
* H5Pset_fill_time Sets the fill value writing time.
*
* @param plist_id
* IN: Dataset creation property list identifier.
* @param fill_time
* IN: fill time.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_fill_time(long plist_id, int fill_time) throws HDF5LibraryException;
/**
* H5Pset_chunk_opts Sets the edge chunk option in a dataset creation property list.
*
* @param dcpl_id
* IN: Dataset creation property list identifier
* @param opts
* IN: Edge chunk option flag. Valid values are:
* H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS - filters are not applied to partial edge chunks.
* 0 - Disables option; partial edge chunks will be compressed.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library
**/
public synchronized static native void H5Pset_chunk_opts(long dcpl_id, int opts) throws HDF5LibraryException;
/**
* H5Pget_chunk_opts retrieves the edge chunk option setting stored in the dataset creation property list .
*
* @param dcpl_id
* IN: Dataset creation property list
* @return The edge chunk option setting.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library
**/
public synchronized static native int H5Pget_chunk_opts(long dcpl_id) throws HDF5LibraryException;
/**
* H5Pget_dset_no_attrs_hint accesses the flag for whether or not datasets created by the given dcpl
* will be created with a "minimized" object header.
*
* @param dcpl_id
* IN: Dataset creation property list
*
* @return true if the given dcpl is set to create minimized dataset object headers, false if not.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Pget_dset_no_attrs_hint(long dcpl_id)
throws HDF5LibraryException;
/**
* H5Pset_dset_no_attrs_hint sets the dcpl to minimize (or explicitly to not minimized) dataset object
* headers upon creation.
*
* @param dcpl_id
* IN: Dataset creation property list
*
* @param minimize
* the minimize hint setting
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Pset_dset_no_attrs_hint(long dcpl_id, boolean minimize)
throws HDF5LibraryException;
// /////// Dataset access property list (DAPL) routines ///////
/**
* Retrieves the maximum possible number of elements in the meta data cache and the maximum possible number of bytes
* and the RDCC_W0 value in the raw data chunk cache on a per-datset basis.
*
* @param dapl_id
* IN: Identifier of the dataset access property list.
* @param rdcc_nslots
* IN/OUT: Number of elements (objects) in the raw data chunk cache.
* @param rdcc_nbytes
* IN/OUT: Total size of the raw data chunk cache, in bytes.
* @param rdcc_w0
* IN/OUT: Preemption policy.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an array is null.
**/
public synchronized static native void H5Pget_chunk_cache(long dapl_id, long[] rdcc_nslots, long[] rdcc_nbytes,
double[] rdcc_w0) throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_chunk_cache sets the number of elements (objects) in the meta data cache and the total number of bytes in
* the raw data chunk cache on a per-datset basis.
*
* @param dapl_id
* IN: Identifier of the datset access property list.
* @param rdcc_nslots
* IN: Number of elements (objects) in the raw data chunk cache.
* @param rdcc_nbytes
* IN: Total size of the raw data chunk cache, in bytes.
* @param rdcc_w0
* IN: Preemption policy.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Pset_chunk_cache(long dapl_id, long rdcc_nslots, long rdcc_nbytes,
double rdcc_w0) throws HDF5LibraryException;
/**
* H5Pset_virtual_view takes the access property list for the virtual dataset, dapl_id, and the flag,
* view, and sets the VDS view according to the flag value.
*
* @param dapl_id
* IN: Dataset access property list identifier for the virtual dataset
* @param view
* IN: Flag specifying the extent of the data to be included in the view.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library
**/
public synchronized static native void H5Pset_virtual_view(long dapl_id, int view) throws HDF5LibraryException;
/**
* H5Pget_virtual_view takes the virtual dataset access property list, dapl_id, and retrieves the flag,
* view, set by the H5Pset_virtual_view call.
*
* @param dapl_id
* IN: Dataset access property list identifier for the virtual dataset
* @return The flag specifying the view of the virtual dataset.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library
**/
public synchronized static native int H5Pget_virtual_view(long dapl_id) throws HDF5LibraryException;
/**
* H5Pset_virtual_printf_gap sets the access property list for the virtual dataset, dapl_id, to instruct the
* library to stop looking for the mapped data stored in the files and/or datasets with the printf-style names
* after not finding gap_size files and/or datasets. The found source files and datasets will determine the
* extent of the unlimited virtual dataset with the printf-style mappings.
*
* @param dapl_id
* IN: Dataset access property list identifier for the virtual dataset
* @param gap_size
* IN: Maximum number of files and/or datasets allowed to be missing for determining
* the extent of an unlimited virtual dataset with printf-style mappings.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library
**/
public synchronized static native void H5Pset_virtual_printf_gap(long dapl_id, long gap_size) throws HDF5LibraryException;
/**
* H5Pget_virtual_printf_gap returns the maximum number of missing printf-style files and/or datasets for
* determining the extent of an unlimited virtual dataaset, gap_size, using the access property list for
* the virtual dataset, dapl_id.
*
* @param dapl_id
* IN: Dataset access property list identifier for the virtual dataset
* @return Maximum number of files and/or datasets allowed to be missing for determining
* the extent of an unlimited virtual dataset with printf-style mappings.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library
**/
public synchronized static native long H5Pget_virtual_printf_gap(long dapl_id) throws HDF5LibraryException;
/**
* H5Pget_virtual_prefix Retrieves prefix applied to virtual file paths.
*
* @param dapl_id
* IN: Link access property list identifier
*
* @return the prefix to be applied to virtual file paths.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native String H5Pget_virtual_prefix(long dapl_id)
throws HDF5LibraryException;
/**
* H5Pset_virtual_prefix Sets prefix to be applied to virtual file paths.
*
* @param dapl_id
* IN: Dataset access property list identifier
* @param prefix
* IN: Prefix to be applied to virtual file paths
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - prefix is null.
*
**/
public synchronized static native void H5Pset_virtual_prefix(long dapl_id, String prefix)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pget_efile_prefix Retrieves prefix applied to external file paths.
*
* @param dapl_id
* IN: Link access property list identifier
*
* @return the prefix to be applied to external file paths.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native String H5Pget_efile_prefix(long dapl_id)
throws HDF5LibraryException;
/**
* H5Pset_efile_prefix Sets prefix to be applied to external file paths.
*
* @param dapl_id
* IN: Dataset access property list identifier
* @param prefix
* IN: Prefix to be applied to external file paths
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - prefix is null.
*
**/
public synchronized static native void H5Pset_efile_prefix(long dapl_id, String prefix)
throws HDF5LibraryException, NullPointerException;
// public synchronized static native void H5Pset_append_flush(long plist_id, int ndims, long[] boundary, H5D_append_cb func, H5D_append_t udata) throws HDF5LibraryException;
// public synchronized static native void H5Pget_append_flush(long plist_id, int dims, long[] boundary, H5D_append_cb func, H5D_append_t udata) throws HDF5LibraryException;
// /////// Dataset xfer property list (DXPL) routines ///////
/**
* H5Pget_data_transform retrieves the data transform expression previously set in the dataset transfer property
* list plist_id by H5Pset_data_transform.
*
* @param plist_id
* IN: Identifier of the property list or class
* @param size
* IN: Number of bytes of the transform expression to copy to
* @param expression
* OUT: A data transform expression
*
* @return The size of the transform expression if successful; 0(zero) if no transform expression exists. Otherwise
* returns a negative value.
*
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Size is <= 0.
*
**/
public synchronized static native long H5Pget_data_transform(long plist_id, String[] expression, long size)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pset_data_transform sets a data transform expression
*
* @param plist_id
* IN: Identifier of the property list or class
* @param expression
* IN: Pointer to the null-terminated data transform expression
*
* @return a non-negative valule if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - expression is null.
*
**/
public synchronized static native int H5Pset_data_transform(long plist_id, String expression)
throws HDF5LibraryException, NullPointerException;
/**
* HH5Pget_buffer gets type conversion and background buffers. Returns buffer size, in bytes, if successful;
* otherwise 0 on failure.
*
* @param plist
* Identifier for the dataset transfer property list.
* @param tconv
* byte array of application-allocated type conversion buffer.
* @param bkg
* byte array of application-allocated background buffer.
*
* @return buffer size, in bytes, if successful; otherwise 0 on failure
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - plist is invalid.
**/
public synchronized static native int H5Pget_buffer(long plist, byte[] tconv, byte[] bkg)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_buffer_size gets type conversion and background buffer size, in bytes, if successful;
* otherwise 0 on failure.
*
* @param plist
* Identifier for the dataset transfer property list.
*
* @return buffer size, in bytes, if successful; otherwise 0 on failure
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - plist is invalid.
**/
public synchronized static native long H5Pget_buffer_size(long plist)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pset_buffer sets type conversion and background buffers. status to TRUE or FALSE.
*
* Given a dataset transfer property list, H5Pset_buffer sets the maximum size for the type conversion buffer and
* background buffer and optionally supplies pointers to application-allocated buffers. If the buffer size is
* smaller than the entire amount of data being transferred between the application and the file, and a type
* conversion buffer or background buffer is required, then strip mining will be used.
*
* Note that there are minimum size requirements for the buffer. Strip mining can only break the data up along the
* first dimension, so the buffer must be large enough to accommodate a complete slice that encompasses all of the
* remaining dimensions. For example, when strip mining a 100x200x300 hyperslab of a simple data space, the buffer
* must be large enough to hold 1x200x300 data elements. When strip mining a 100x200x300x150 hyperslab of a simple
* data space, the buffer must be large enough to hold 1x200x300x150 data elements.
*
* @param plist
* Identifier for the dataset transfer property list.
* @param size
* Size, in bytes, of the type conversion and background buffers.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - plist is invalid.
**/
public synchronized static native void H5Pset_buffer_size(long plist, long size) throws HDF5LibraryException,
IllegalArgumentException;
/**
* H5Pget_edc_check gets the error-detecting algorithm in use.
*
* @param plist
* Identifier for the dataset transfer property list.
*
* @return the error-detecting algorithm
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pget_edc_check(long plist) throws HDF5LibraryException;
/**
* H5Pset_edc_check sets the error-detecting algorithm.
*
* @param plist
* Identifier for the dataset transfer property list.
* @param check
* the error-detecting algorithm to use.
*
* @return non-negative if succeed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_edc_check(long plist, int check) throws HDF5LibraryException;
/**
* H5Pget_btree_ratio Get the B-tree split ratios for a dataset transfer property list.
*
* @param plist_id
* IN Dataset transfer property list
* @param left
* OUT split ratio for leftmost nodes
* @param right
* OUT split ratio for righttmost nodes
* @param middle
* OUT split ratio for all other nodes
*
* @return non-negative if succeed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
**/
public synchronized static native int H5Pget_btree_ratios(long plist_id, double[] left, double[] middle,
double[] right) throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_btree_ratio Sets B-tree split ratios for a dataset transfer property list. The split ratios determine what
* percent of children go in the first node when a node splits.
*
* @param plist_id
* IN Dataset transfer property list
* @param left
* IN split ratio for leftmost nodes
* @param right
* IN split ratio for righttmost nodes
* @param middle
* IN split ratio for all other nodes
*
* @return non-negative if succeed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Pset_btree_ratios(long plist_id, double left, double middle, double right)
throws HDF5LibraryException;
/**
* H5Pget_hyper_vector_size reads values previously set with H5Pset_hyper_vector_size.
*
* @param dxpl_id
* IN: Dataset transfer property list identifier.
* @param vector_size
* OUT: hyper vector size.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_hyper_vector_size(long dxpl_id, long[] vector_size)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_hyper_vector_size sets the number of
* "I/O vectors" (offset and length pairs) which are to be
* accumulated in memory before being issued to the lower levels
* of the library for reading or writing the actual data.
* Increasing the number should give better performance, but use
* more memory during hyperslab I/O. The vector size must be
* greater than 1.
*,p.
* The default is to use 1024 vectors for I/O during hyperslab
* reading/writing.
*
* @param dxpl_id
* IN: Dataset transfer property list identifier.
* @param vector_size
* IN: hyper vestor size.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_hyper_vector_size(long dxpl_id, long vector_size)
throws HDF5LibraryException, NullPointerException;
// /////// Link creation property list (LCPL) routines ///////
/**
* H5Pget_create_intermediate_group determines whether property is set to enable creating missing intermediate
* groups.
*
* @param lcpl_id
* IN: Link creation property list identifier
*
* @return Boolean true or false
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native boolean H5Pget_create_intermediate_group(long lcpl_id)
throws HDF5LibraryException;
/**
* H5Pset_create_intermediate_group specifies in property list whether to create missing intermediate groups
*
* @param lcpl_id
* IN: Link creation property list identifier
* @param crt_intermed_group
* IN: Flag specifying whether to create intermediate groups upon the creation of an object
*
* @return a non-negative valule if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_create_intermediate_group(long lcpl_id, boolean crt_intermed_group)
throws HDF5LibraryException;
// /////// Group creation property list (GCPL) routines ///////
/**
* H5Pget_local_heap_size_hint Retrieves the anticipated size of the local heap for original-style groups.
*
* @param gcpl_id
* IN: Group creation property list identifier
*
* @return size_hint, the anticipated size of local heap
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native long H5Pget_local_heap_size_hint(long gcpl_id) throws HDF5LibraryException;
/**
* H5Pset_local_heap_size_hint Specifies the anticipated maximum size of a local heap.
*
* @param gcpl_id
* IN: Group creation property list identifier
* @param size_hint
* IN: Anticipated maximum size in bytes of local heap
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_local_heap_size_hint(long gcpl_id, long size_hint)
throws HDF5LibraryException;
/**
* H5Pget_link_phase_change Queries the settings for conversion between compact and dense groups.
*
* @param gcpl_id
* IN: Group creation property list identifier
* @param links
* The max. no. of compact links & the min. no. of dense links, which are used for storing groups
*
* <pre>
* links[0] = The maximum number of links for compact storage
* links[1] = The minimum number of links for dense storage
* </pre>
*
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - size is null.
*
**/
public synchronized static native int H5Pget_link_phase_change(long gcpl_id, int[] links)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_link_phase_change Sets the parameters for conversion between compact and dense groups.
*
* @param gcpl_id
* IN: Group creation property list identifier
* @param max_compact
* IN: Maximum number of links for compact storage(Default: 8)
* @param min_dense
* IN: Minimum number of links for dense storage(Default: 6)
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid values of max_compact and min_dense.
*
**/
public synchronized static native int H5Pset_link_phase_change(long gcpl_id, int max_compact, int min_dense)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_est_link_info Queries data required to estimate required local heap or object header size.
*
* @param gcpl_id
* IN: Group creation property list identifier
* @param link_info
* Estimated number of links to be inserted into group And the estimated average length of link names
*
* <pre>
* link_info[0] = Estimated number of links to be inserted into group
* link_info[1] = Estimated average length of link names
* </pre>
*
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - link_info is null.
*
**/
public synchronized static native int H5Pget_est_link_info(long gcpl_id, int[] link_info)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_est_link_info Sets estimated number of links and length of link names in a group.
*
* @param gcpl_id
* IN: Group creation property list identifier
* @param est_num_entries
* IN: Estimated number of links to be inserted into group
* @param est_name_len
* IN: Estimated average length of link names
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid values to est_num_entries and est_name_len.
*
**/
public synchronized static native int H5Pset_est_link_info(long gcpl_id, int est_num_entries, int est_name_len)
throws HDF5LibraryException, IllegalArgumentException;
/**
* H5Pget_link_creation_order queries the group creation property list, gcpl_id, and returns a flag indicating
* whether link creation order is tracked and/or indexed in a group.
*
* @param gcpl_id
* IN: Group creation property list identifier
*
* @return crt_order_flags -Creation order flag(s)
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_link_creation_order(long gcpl_id) throws HDF5LibraryException;
/**
* H5Pset_link_creation_order Sets flags in a group creation property list, gcpl_id, for tracking and/or indexing
* links on creation order.
*
* @param gcpl_id
* IN: Group creation property list identifier
* @param crt_order_flags
* IN: Creation order flag(s)
*
*
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_link_creation_order(long gcpl_id, int crt_order_flags)
throws HDF5LibraryException;
// /////// String creation property list (STRCPL) routines ///////
/**
* H5Pget_char_encoding gets the character encoding of the string.
*
* @param plist_id
* IN: the property list identifier
*
* @return Returns the character encoding of the string.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_char_encoding(long plist_id) throws HDF5LibraryException;
/**
* H5Pset_char_encoding sets the character encoding of the string.
*
* @param plist_id
* IN: the property list identifier
* @param encoding
* IN: the character encoding of the string
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native void H5Pset_char_encoding(long plist_id, int encoding)
throws HDF5LibraryException;
// /////// Link access property list (LAPL) routines ///////
/**
* H5Pget_nlinks retrieves the maximum number of soft or user-defined link traversals allowed, nlinks, before the
* library assumes it has found a cycle and aborts the traversal. This value is retrieved from the link access
* property list lapl_id.
*
* @param lapl_id
* IN: File access property list identifier
*
* @return Returns a Maximum number of links to traverse.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native long H5Pget_nlinks(long lapl_id) throws HDF5LibraryException;
/**
* H5Pset_nlinks sets the maximum number of soft or user-defined link traversals allowed, nlinks, before the library
* assumes it has found a cycle and aborts the traversal. This value is set in the link access property list
* lapl_id.
*
* @param lapl_id
* IN: File access property list identifier
* @param nlinks
* IN: Maximum number of links to traverse
*
* @return Returns a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Argument is Illegal
*
**/
public synchronized static native int H5Pset_nlinks(long lapl_id, long nlinks) throws HDF5LibraryException,
IllegalArgumentException;
/**
* H5Pget_elink_prefix Retrieves prefix applied to external link paths.
*
* @param lapl_id
* IN: Link access property list identifier
* @param prefix
* OUT: Prefix applied to external link paths
*
* @return If successful, returns a non-negative value specifying the size in bytes of the prefix without the NULL
* terminator; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - prefix is null.
*
**/
public synchronized static native long H5Pget_elink_prefix(long lapl_id, String[] prefix)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_elink_prefix Sets prefix to be applied to external link paths.
*
* @param lapl_id
* IN: Link access property list identifier
* @param prefix
* IN: Prefix to be applied to external link paths
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - prefix is null.
*
**/
public synchronized static native int H5Pset_elink_prefix(long lapl_id, String prefix) throws HDF5LibraryException,
NullPointerException;
/**
* H5Pget_elink_fapl Retrieves the file access property list identifier associated with the link access property
* list.
*
* @param lapl_id
* IN: Link access property list identifier
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public static long H5Pget_elink_fapl(long lapl_id) throws HDF5LibraryException {
long id = _H5Pget_elink_fapl(lapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Pget_elink_fapl add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Pget_elink_fapl(long lapl_id) throws HDF5LibraryException;
/**
* H5Pset_elink_fapl sets a file access property list for use in accessing a file pointed to by an external link.
*
* @param lapl_id
* IN: Link access property list identifier
* @param fapl_id
* IN: File access property list identifier
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_elink_fapl(long lapl_id, long fapl_id) throws HDF5LibraryException;
/**
* H5Pget_elink_acc_flags retrieves the external link traversal file access flag from the specified link access
* property list.
*
* @param lapl_id
* IN: Link access property list identifier
*
* @return File access flag for link traversal.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_elink_acc_flags(long lapl_id) throws HDF5LibraryException;
/**
* H5Pset_elink_acc_flags Sets the external link traversal file access flag in a link access property list.
*
* @param lapl_id
* IN: Link access property list identifier
* @param flags
* IN: The access flag for external link traversal.
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception IllegalArgumentException
* - Invalid Flag values.
*
**/
public synchronized static native int H5Pset_elink_acc_flags(long lapl_id, int flags) throws HDF5LibraryException,
IllegalArgumentException;
// /////// Object copy property list (OCPYPL) routines ///////
/**
* H5Pget_copy_object retrieves the properties to be used when an object is copied.
*
* @param ocp_plist_id
* IN: Object copy property list identifier
*
* @return Copy option(s) set in the object copy property list
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_copy_object(long ocp_plist_id) throws HDF5LibraryException;
/**
* H5Pset_copy_object Sets properties to be used when an object is copied.
*
* @param ocp_plist_id
* IN: Object copy property list identifier
* @param copy_options
* IN: Copy option(s) to be set
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native void H5Pset_copy_object(long ocp_plist_id, int copy_options)
throws HDF5LibraryException;
// /////// file drivers property list routines ///////
/**
* H5Pget_fapl_core retrieve H5FD_CORE I/O settings.
*
* @param fapl_id
* IN: File access property list identifier
* @param increment
* OUT: how much to grow the memory each time
* @param backing_store
* OUT: write to file name on flush setting
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native void H5Pget_fapl_core(long fapl_id, long[] increment, boolean[] backing_store)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_fapl_core modifies the file access property list to use the H5FD_CORE driver.
*
* @param fapl_id
* IN: File access property list identifier
* @param increment
* IN: how much to grow the memory each time
* @param backing_store
* IN: write to file name on flush setting
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_fapl_core(long fapl_id, long increment, boolean backing_store)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pget_fapl_direct queries properties set by the H5Pset_fapl_direct.
*
* @param fapl_id
* IN: File access property list identifier
* @param info
* OUT: Returned property list information
* info[0] = increment -how much to grow the memory each time
* info[1] = backing_store - write to file name on flush setting
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_fapl_direct(long fapl_id, long[] info) throws HDF5LibraryException;
/**
* H5Pset_fapl_direct Sets up use of the direct I/O driver.
*
* @param fapl_id
* IN: File access property list identifier
* @param alignment
* IN: Required memory alignment boundary
* @param block_size
* IN: File system block size
* @param cbuf_size
* IN: Copy buffer size
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_fapl_direct(long fapl_id, long alignment, long block_size,
long cbuf_size) throws HDF5LibraryException;
/**
* H5Pget_fapl_family Returns information about the family file access property list.
*
* @param fapl_id
* IN: File access property list identifier
* @param memb_size
* OUT: the size in bytes of each file member (used only when creating a new file)
* @param memb_fapl_id
* OUT: the file access property list to be used for each family member
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pget_fapl_family(long fapl_id, long[] memb_size, long[] memb_fapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_fapl_family Sets up use of the direct I/O driver.
*
* @param fapl_id
* IN: File access property list identifier
* @param memb_size
* IN: the size in bytes of each file member (used only when creating a new file)
* @param memb_fapl_id
* IN: the file access property list to be used for each family member
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_fapl_family(long fapl_id, long memb_size, long memb_fapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_fapl_hdfs Modify the file access property list to use the H5FD_HDFS driver.
*
* @param fapl_id
* IN: File access property list identifier
* @param fapl_conf
* IN: the properties of the hdfs driver
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_fapl_hdfs(long fapl_id, H5FD_hdfs_fapl_t fapl_conf) throws HDF5LibraryException, NullPointerException;
/**
* H5Pget_fapl_hdfs gets the properties hdfs I/O driver.
*
* @param fapl_id
* IN: File access property list identifier
*
* @return the properties of the hdfs driver.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native H5FD_hdfs_fapl_t H5Pget_fapl_hdfs(long fapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Pget_fapl_multi Sets up use of the multi I/O driver.
*
* @param fapl_id
* IN: File access property list identifier
* @param memb_map
* IN: Maps memory usage types to other memory usage types.
* @param memb_fapl
* IN: Property list for each memory usage type.
* @param memb_name
* IN: Name generator for names of member files.
* @param memb_addr
* IN: The offsets within the virtual address space, from 0 (zero) to HADDR_MAX, at which each type of
* data storage begins.
*
* @return a boolean value; Allows read-only access to incomplete file sets when TRUE.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an array is null.
*
**/
public synchronized static native boolean H5Pget_fapl_multi(long fapl_id, int[] memb_map, long[] memb_fapl,
String[] memb_name, long[] memb_addr) throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_fapl_multi Sets up use of the multi I/O driver.
*
* @param fapl_id
* IN: File access property list identifier
* @param memb_map
* IN: Maps memory usage types to other memory usage types.
* @param memb_fapl
* IN: Property list for each memory usage type.
* @param memb_name
* IN: Name generator for names of member files.
* @param memb_addr
* IN: The offsets within the virtual address space, from 0 (zero) to HADDR_MAX, at which each type of
* data storage begins.
* @param relax
* IN: Allows read-only access to incomplete file sets when TRUE.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an array is null.
*
**/
public synchronized static native void H5Pset_fapl_multi(long fapl_id, int[] memb_map, long[] memb_fapl,
String[] memb_name, long[] memb_addr, boolean relax) throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_fapl_log Sets up the logging virtual file driver (H5FD_LOG) for use. H5Pset_fapl_log modifies the file
* access property list to use the logging driver, H5FD_LOG. The logging virtual file driver (VFD) is a clone of the
* standard SEC2 (H5FD_SEC2) driver with additional facilities for logging VFD metrics and activity to a file.
*
* @param fapl_id
* IN: File access property list identifier.
* @param logfile
* IN: logfile is the name of the file in which the logging entries are to be recorded.
* @param flags
* IN: Flags specifying the types of logging activity.
* @param buf_size
* IN: The size of the logging buffers, in bytes.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - logfile is null.
**/
public synchronized static native void H5Pset_fapl_log(long fapl_id, String logfile, long flags, long buf_size)
throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_fapl_sec2 Sets up use of the sec2 I/O driver.
*
* @param fapl_id
* IN: File access property list identifier
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_fapl_sec2(long fapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_fapl_split Sets up use of the split I/O driver. Makes the multi driver act like the
* old split driver which stored meta data in one file and raw
* data in another file
*
* @param fapl_id
* IN: File access property list identifier
* @param meta_ext
* IN: meta filename extension
* @param meta_plist_id
* IN: File access property list identifier for metadata
* @param raw_ext
* IN: raw data filename extension
* @param raw_plist_id
* IN: File access property list identifier raw data
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native void H5Pset_fapl_split(long fapl_id, String meta_ext, long meta_plist_id,
String raw_ext, long raw_plist_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_fapl_stdio Sets up use of the stdio I/O driver.
*
* @param fapl_id
* IN: File access property list identifier
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_fapl_stdio(long fapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_fapl_windows Sets up use of the windows I/O driver.
*
* @param fapl_id
* IN: File access property list identifier
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_fapl_windows(long fapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Pset_fapl_ros3 Modify the file access property list to use the H5FD_ROS3 driver.
*
* @param fapl_id
* IN: File access property list identifier
* @param fapl_conf
* IN: the properties of the ros3 driver
*
* @return a non-negative value if successful; otherwise returns a negative value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native int H5Pset_fapl_ros3(long fapl_id, H5FD_ros3_fapl_t fapl_conf) throws HDF5LibraryException, NullPointerException;
/**
* H5Pget_fapl_ros3 gets the properties of the ros3 I/O driver.
*
* @param fapl_id
* IN: File access property list identifier
*
* @return the properties of the ros3 driver.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
*
**/
public synchronized static native H5FD_ros3_fapl_t H5Pget_fapl_ros3(long fapl_id) throws HDF5LibraryException, NullPointerException;
// /////// unimplemented ////////
// Generic property list routines //
// herr_t H5Pencode(hid_t plist_id, void *buf, size_t *nalloc);
// hid_t H5Pdecode(const void *buf);
// Object creation property list (OCPL) routines //
// File creation property list (FCPL) routines //
// File access property list (FAPL) routines //
// herr_t H5Pset_driver(hid_t plist_id, hid_t new_driver_id, const void *new_driver_info)
// const void *H5Pget_driver_info(hid_t plist_id)
// herr_t H5Pget_multi_type(hid_t fapl_id, H5FD_mem_t *type)
// herr_t H5Pset_multi_type(hid_t fapl_id, H5FD_mem_t type)
// herr_t H5Pget_file_image(hid_t fapl_id, void **buf_ptr_ptr, size_t *buf_len_ptr);
// herr_t H5Pset_file_image(hid_t fapl_id, void *buf_ptr, size_t buf_len);
// herr_t H5Pget_file_image_callbacks(hid_t fapl_id, H5FD_file_image_callbacks_t *callbacks_ptr);
// herr_t H5Pset_file_image_callbacks(hid_t fapl_id, H5FD_file_image_callbacks_t *callbacks_ptr);
// herr_t H5Pset_core_write_tracking(hid_t fapl_id, hbool_t is_enabled, size_t page_size);
// herr_t H5Pget_core_write_tracking(hid_t fapl_id, hbool_t *is_enabled, size_t *page_size);
// #ifdef H5_HAVE_PARALLEL
// herr_t H5Pset_all_coll_metadata_ops(hid_t accpl_id, hbool_t is_collective);
// herr_t H5Pget_all_coll_metadata_ops(hid_t plist_id, hbool_t *is_collective);
// herr_t H5Pset_coll_metadata_write(hid_t fapl_id, hbool_t is_collective);
// herr_t H5Pget_coll_metadata_write(hid_t fapl_id, hbool_t *is_collective);
// #endif /* H5_HAVE_PARALLEL */
// herr_t H5Pset_mdc_image_config(hid_t plist_id, H5AC_cache_image_config_t *config_ptr);
// herr_t H5Pget_mdc_image_config(hid_t plist_id, H5AC_cache_image_config_t *config_ptr /*out*/);
// herr_t H5Pset_page_buffer_size(hid_t plist_id, size_t buf_size, unsigned min_meta_per, unsigned min_raw_per);
// herr_t H5Pget_page_buffer_size(hid_t fapl_id, size_t *buf_size, unsigned *min_meta_perc, unsigned *min_raw_perc);
// herr_t H5Pset_object_flush_cb (hid_t fapl_id, H5F_flush_cb_t func, void *user_data);
// herr_t H5Pget_object_flush_cb (hid_t fapl_id, H5F_flush_cb_t *func, void **user_data);
// Dataset creation property list (DCPL) routines //
// Dataset access property list (DAPL) routines //
// herr_t H5Pset_append_flush (hid_t dapl_id, int ndims, const hsize_t boundary[], H5D_append_cb_t func, void *user_data);
// herr_t H5Pget_append_flush(hid_t dapl_id, int ndims, hsize_t boundary[], H5D_append_cb_t *func, void **user_data)
// Dataset xfer property list (DXPL) routines //
// herr_t H5Pset_buffer(hid_t plist_id, size_t size, void *tconv, void *bkg);
// herr_t H5Pset_preserve(hid_t plist_id, hbool_t status);
// int H5Pget_preserve(hid_t plist_id);
// herr_t H5Pset_filter_callback(hid_t plist, H5Z_filter_func_t func, void *op_data)
// herr_t H5Pget_vlen_mem_manager(hid_t plist, H5MM_allocate_t *alloc, void **alloc_info, H5MM_free_t *free, void
// **free_info )
// herr_t H5Pset_vlen_mem_manager(hid_t plist, H5MM_allocate_t alloc, void *alloc_info, H5MM_free_t free, void
// *free_info )
// herr_t H5Pget_type_conv_cb(hid_t plist, H5T_conv_except_func_t *func, void **op_data)
// herr_t H5Pset_type_conv_cb( hid_t plist, H5T_conv_except_func_t func, void *op_data)
// #ifdef H5_HAVE_PARALLEL
// herr_t H5Pget_mpio_actual_chunk_opt_mode(hid_t plist_id, H5D_mpio_actual_chunk_opt_mode_t *actual_chunk_opt_mode);
// herr_t H5Pget_mpio_actual_io_mode(hid_t plist_id, H5D_mpio_actual_io_mode_t *actual_io_mode);
// herr_t H5Pget_mpio_no_collective_cause(hid_t plist_id, uint32_t *local_no_collective_cause, uint32_t *global_no_collective_cause);
// #endif /* H5_HAVE_PARALLEL */
// Link creation property list (LCPL) routines //
// Group creation property list (GCPL) routines //
// String creation property list (STRCPL) routines //
// Link access property list (LAPL) routines //
// herr_t H5Pget_elink_cb( hid_t lapl_id, H5L_elink_traverse_t *func, void **op_data )
// herr_t H5Pset_elink_cb( hid_t lapl_id, H5L_elink_traverse_t func, void *op_data )
// Object copy property list (OCPYPL) routines //
// herr_t H5Padd_merge_committed_dtype_path(hid_t plist_id, const char *path);
// herr_t H5Pfree_merge_committed_dtype_paths(hid_t plist_id);
// herr_t H5Pget_mcdt_search_cb(hid_t plist_id, H5O_mcdt_search_cb_t *func, void **op_data);
// herr_t H5Pset_mcdt_search_cb(hid_t plist_id, H5O_mcdt_search_cb_t func, void *op_data);
// ////////////////////////////////////////////////////////////
// //
// H5PL: HDF5 1.8 Plugin API Functions //
// //
// ////////////////////////////////////////////////////////////
/**
* H5PLset_loading_state uses one argument to enable or disable individual plugins.
* The plugin_flags parameter is an encoded integer in which each bit controls a specific
* plugin or class of plugins.
* A plugin bit set to 0 (zero) prevents the use of the dynamic plugin corresponding
* to that bit position. A plugin bit set to 1 (one) allows the use of that dynamic plugin.
* All dynamic plugins can be enabled by setting plugin_flags to a negative value.
* A value of 0 (zero) will disable all dynamic plugins.
*
* H5PLset_loading_state inspects the HDF5_PLUGIN_PRELOAD environment variable every
* time it is called. If the environment variable is set to the special :: string,
* all dynamic plugins will be disabled.
*
* @param plugin_flags
* IN: The list of dynamic plugin types to enable or disable.
* A plugin bit set to 0 (zero) prevents use of that dynamic plugin.
* A plugin bit set to 1 (one) enables use of that dynamic plugin.
* Setting plugin_flags to a negative value enables all dynamic plugins.
* Setting plugin_flags to 0 (zero) disables all dynamic plugins.
*
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5PLset_loading_state(int plugin_flags) throws HDF5LibraryException;
/**
* H5PLget_loading_state retrieves the state of the dynamic plugins flag, plugin_flags..
*
* @return the list of dynamic plugin types that are enabled or disabled.
* A plugin bit set to 0 (zero) indicates that that dynamic plugin is disabled.
* A plugin bit set to 1 (one) indicates that that dynamic plugin is enabled.
* If the value of plugin_flags is negative, all dynamic plugins are enabled.
* If the value of plugin_flags is 0 (zero), all dynamic plugins are disabled.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5PLget_loading_state() throws HDF5LibraryException;
/**
* H5PLappend inserts the plugin path at the end of the table.
*
* @param plugin_path
* IN: Path for location of filter plugin libraries.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5PLappend(String plugin_path) throws HDF5LibraryException;
/**
* H5PLprepend inserts the plugin path at the beginning of the table.
*
* @param plugin_path
* IN: Path for location of filter plugin libraries.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5PLprepend(String plugin_path) throws HDF5LibraryException;
/**
* H5PLreplace replaces the plugin path at the specified index.
*
* @param plugin_path
* IN: Path for location of filter plugin libraries.
* @param index
* IN: The table index (0-based).
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5PLreplace(String plugin_path, int index) throws HDF5LibraryException;
/**
* H5PLinsert inserts the plugin path at the specified index.
*
* @param plugin_path
* IN: Path for location of filter plugin libraries.
* @param index
* IN: The table index (0-based).
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5PLinsert(String plugin_path, int index) throws HDF5LibraryException;
/**
* H5PLremove removes the plugin path at the specified index.
*
* @param index
* IN: The table index (0-based).
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5PLremove(int index) throws HDF5LibraryException;
/**
* H5PLget retrieves the plugin path at the specified index.
*
* @param index
* IN: The table index (0-based).
*
* @return the current path at the index in plugin path table
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native String H5PLget(int index) throws HDF5LibraryException;
/**
* H5PLsize retrieves the size of the current list of plugin paths.
*
* @return the current number of paths in the plugin path table
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5PLsize() throws HDF5LibraryException;
// ////////////////////////////////////////////////////////////
// //
// H5R: HDF5 1.12 Reference API Functions //
// //
// ////////////////////////////////////////////////////////////
// Constructors //
/**
* H5Rcreate_object creates a reference pointing to the object named name located at loc id.
*
* @param loc_id
* IN: Location identifier used to locate the object being pointed to.
* @param name
* IN: Name of object at location loc_id.
* @param access_id
* IN: Object access identifier to the object being pointed to.
*
* @return the reference (byte[]) if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native byte[] H5Rcreate_object(long loc_id, String name, long access_id)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Rcreate_region creates the reference, pointing to the region represented by
* space id within the object named name located at loc id.
*
* @param loc_id
* IN: Location identifier used to locate the object being pointed to.
* @param name
* IN: Name of object at location loc_id.
* @param space_id
* IN: Identifies the dataset region that a dataset region reference points to.
* @param access_id
* IN: Object access identifier to the object being pointed to.
*
* @return the reference (byte[]) if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native byte[] H5Rcreate_region(long loc_id, String name, long space_id, long access_id)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Rcreate_attr creates the reference, pointing to the attribute named attr name
* and attached to the object named name located at loc id.
*
* @param loc_id
* IN: Location identifier used to locate the object being pointed to.
* @param name
* IN: Name of object at location loc_id.
* @param attr_name
* IN: Name of the attribute within the object.
* @param access_id
* IN: Object access identifier to the object being pointed to.
*
* @return the reference (byte[]) if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native byte[] H5Rcreate_attr(long loc_id, String name, String attr_name, long access_id)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Rdestroy destroys a reference and releases resources.
*
* @param ref_ptr
* IN: Reference to an object, region or attribute attached to an object.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native void H5Rdestroy(byte[] ref_ptr)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
// Info //
/**
* H5Rget_type retrieves the type of a reference.
*
* @param ref_ptr
* IN: Reference to an object, region or attribute attached to an object.
*
* @return a valid reference type if successful; otherwise returns H5R UNKNOWN.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native int H5Rget_type(byte[] ref_ptr)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Requal determines whether two references point to the same object, region or attribute.
*
* @param ref1_ptr
* IN: Reference to an object, region or attribute attached to an object.
* @param ref2_ptr
* IN: Reference to an object, region or attribute attached to an object.
*
* @return true if equal, else false
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native boolean H5Requal(byte[] ref1_ptr, byte[] ref2_ptr)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Rcopy creates a copy of an existing reference.
*
* @param src_ref_ptr
* IN: Reference to an object, region or attribute attached to an object.
*
* @return a valid copy of the reference (byte[]) if successful.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native byte[] H5Rcopy(byte[] src_ref_ptr)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
// Dereference //
/**
* H5Ropen_object opens that object and returns an identifier.
* The object opened with this function should be closed when it is no longer needed
* so that resource leaks will not develop. Use the appropriate close function such
* as H5Oclose or H5Dclose for datasets.
*
* @param ref_ptr
* IN: Reference to an object, region or attribute attached to an object.
* @param rapl_id
* IN: A reference access property list identifier for the reference. The access property
* list can be used to access external files that the reference points
* to (through a file access property list).
* @param oapl_id
* IN: An object access property list identifier for the reference. The access property
* property list must be of the same type as the object being referenced,
* that is a group or dataset property list.
*
* @return a valid identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native long H5Ropen_object(byte[] ref_ptr, long rapl_id, long oapl_id)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Ropen region creates a copy of the dataspace of the dataset pointed to by a region reference,
* ref ptr, and defines a selection matching the selection pointed to by ref ptr within the dataspace copy.
* Use H5Sclose to release the dataspace identifier returned by this function when the identifier is no longer needed.
*
* @param ref_ptr
* IN: Reference to an object, region or attribute attached to an object.
* @param rapl_id
* IN: A reference access property list identifier for the reference. The access property
* list can be used to access external files that the reference points
* to (through a file access property list).
* @param oapl_id
* IN: An object access property list identifier for the reference. The access property
* property list must be of the same type as the object being referenced,
* that is a group or dataset property list.
*
* @return a valid dataspace identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native long H5Ropen_region(byte[] ref_ptr, long rapl_id, long oapl_id)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Ropen_attr opens the attribute attached to the object and returns an identifier.
* The attribute opened with this function should be closed with H5Aclose when it is no longer needed
* so that resource leaks will not develop.
*
* @param ref_ptr
* IN: Reference to an object, region or attribute attached to an object.
* @param rapl_id
* IN: A reference access property list identifier for the reference. The access property
* list can be used to access external files that the reference points
* to (through a file access property list).
* @param aapl_id
* IN: An attribute access property list identifier for the reference. The access property
* property list must be of the same type as the object being referenced,
* that is a group or dataset property list.
*
* @return a valid attribute identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native long H5Ropen_attr(byte[] ref_ptr, long rapl_id, long aapl_id)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
// Get type //
/**
* H5Rget obj type3 retrieves the type of the referenced object pointed to.
*
* @param ref_ptr
* IN: Reference to an object, region or attribute attached to an object.
* @param rapl_id
* IN: A reference access property list identifier for the reference. The access property
* list can be used to access external files that the reference points
* to (through a file access property list).
*
* @return Returns the object type
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - array is null.
* @exception IllegalArgumentException
* - array is invalid.
**/
public synchronized static native int H5Rget_obj_type3(byte[] ref_ptr, long rapl_id)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
// Get name //
/**
* H5Rget_file_name retrieves the file name for the object, region or attribute reference pointed to.
*
* @param ref_ptr
* IN: Reference to an object, region or attribute attached to an object.
*
* @return Returns the file name of the reference
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - array is null.
* @exception IllegalArgumentException
* - array is invalid.
**/
public synchronized static native String H5Rget_file_name(byte[] ref_ptr)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Rget_obj_name retrieves the object name for the object, region or attribute reference pointed to.
*
* @param ref_ptr
* IN: Reference to an object, region or attribute attached to an object.
* @param rapl_id
* IN: A reference access property list identifier for the reference. The access property
* list can be used to access external files that the reference points
* to (through a file access property list).
*
* @return Returns the object name of the reference
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - array is null.
* @exception IllegalArgumentException
* - array is invalid.
**/
public synchronized static native String H5Rget_obj_name(byte[] ref_ptr, long rapl_id)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Rget_attr_name retrieves the attribute name for the object, region or attribute reference pointed to.
*
* @param ref_ptr
* IN: Reference to an object, region or attribute attached to an object.
*
* @return Returns the attribute name of the reference
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - array is null.
* @exception IllegalArgumentException
* - array is invalid.
**/
public synchronized static native String H5Rget_attr_name(byte[] ref_ptr)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
// ////////////////////////////////////////////////////////////
// //
// H5R: HDF5 1.8 Reference API Functions //
// //
// ////////////////////////////////////////////////////////////
private synchronized static native int H5Rcreate(byte[] ref, long loc_id, String name, int ref_type, long space_id)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Rcreate creates the reference, ref, of the type specified in ref_type, pointing to the object name located at
* loc_id.
*
* @param loc_id
* IN: Location identifier used to locate the object being pointed to.
* @param name
* IN: Name of object at location loc_id.
* @param ref_type
* IN: Type of reference.
* @param space_id
* IN: Dataspace identifier with selection.
*
* @return the reference (byte[]) if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static byte[] H5Rcreate(long loc_id, String name, int ref_type, long space_id)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException {
/* These sizes are correct for HDF5.1.2 */
int ref_size = 8;
if (ref_type == HDF5Constants.H5R_DATASET_REGION) {
ref_size = 12;
}
byte rbuf[] = new byte[ref_size];
/* will raise an exception if fails */
H5Rcreate(rbuf, loc_id, name, ref_type, space_id);
return rbuf;
}
/**
* Given a reference to some object, H5Rdereference opens that object and return an identifier.
*
* @param dataset
* IN: Dataset containing reference object.
* @param access_list
* IN: Property list of the object being referenced.
* @param ref_type
* IN: The reference type of ref.
* @param ref
* IN: reference to an object
*
* @return valid identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - output array is null.
* @exception IllegalArgumentException
* - output array is invalid.
**/
public static long H5Rdereference(long dataset, long access_list, int ref_type, byte[] ref)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException {
long id = _H5Rdereference(dataset, access_list, ref_type, ref);
if (id > 0) {
log.trace("OPEN_IDS: H5Rdereference add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Rdereference(long dataset, long access_list, int ref_type, byte[] ref)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Rget_name retrieves a name for the object identified by ref.
*
* @param loc_id
* IN: Identifier for the dataset containing the reference or for the group that dataset is in.
* @param ref_type
* IN: Type of reference.
* @param ref
* IN: An object or dataset region reference.
* @param name
* OUT: A name associated with the referenced object or dataset region.
* @param size
* IN: The size of the name buffer.
*
* @return Returns the length of the name if successful, returning 0 (zero) if no name is associated with the
* identifier. Otherwise returns a negative value.
*
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - size is null.
* @exception IllegalArgumentException
* - Argument is illegal.
*
**/
public synchronized static native long H5Rget_name(long loc_id, int ref_type, byte[] ref, String[] name, long size)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Rget_obj_type Given a reference to an object ref, H5Rget_obj_type returns the type of the object pointed to.
*
* @param loc_id
* IN: loc_id of the reference object.
* @param ref_type
* IN: Type of reference to query.
* @param ref
* IN: the reference
*
* @return Returns the object type
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - array is null.
* @exception IllegalArgumentException
* - array is invalid.
**/
public synchronized static native int H5Rget_obj_type(long loc_id, int ref_type, byte ref[])
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Rget_obj_type2 Retrieves the type of object that an object reference points to.
*
* @see public static int H5Rget_obj_type(int loc_id, int ref_type, byte ref[])
**/
private synchronized static native int H5Rget_obj_type2(long loc_id, int ref_type, byte ref[], int[] obj_type)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* Given a reference to an object ref, H5Rget_region creates a copy of the dataspace of the dataset pointed to and
* defines a selection in the copy which is the region pointed to.
*
* @param loc_id
* IN: loc_id of the reference object.
* @param ref_type
* IN: The reference type of ref.
* @param ref
* OUT: the reference to the object and region
*
* @return a valid identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - output array is null.
* @exception IllegalArgumentException
* - output array is invalid.
**/
public static long H5Rget_region(long loc_id, int ref_type, byte[] ref) throws HDF5LibraryException,
NullPointerException, IllegalArgumentException {
long id = _H5Rget_region(loc_id, ref_type, ref);
if (id > 0) {
log.trace("OPEN_IDS: H5Rget_region add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Rget_region(long loc_id, int ref_type, byte[] ref)
throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
// ////////////////////////////////////////////////////////////
// //
// H5S: Dataspace Interface Functions //
// //
// ////////////////////////////////////////////////////////////
/**************** Operations on dataspaces ********************/
/**
* H5Screate creates a new dataspace of a particular type.
*
* @param type
* IN: The type of dataspace to be created.
*
* @return a dataspace identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Screate(int type) throws HDF5LibraryException {
long id = _H5Screate(type);
if (id > 0) {
log.trace("OPEN_IDS: H5Screate add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Screate(int type) throws HDF5LibraryException;
/**
* H5Screate_simple creates a new simple data space and opens it for access.
*
* @param rank
* IN: Number of dimensions of dataspace.
* @param dims
* IN: An array of the size of each dimension.
* @param maxdims
* IN: An array of the maximum size of each dimension.
*
* @return a dataspace identifier
*
* @exception HDF5Exception
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - dims or maxdims is null.
**/
public static long H5Screate_simple(int rank, long[] dims, long[] maxdims) throws HDF5Exception,
NullPointerException {
long id = _H5Screate_simple(rank, dims, maxdims);
if (id > 0) {
log.trace("OPEN_IDS: H5Screate_simple add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Screate_simple(int rank, long[] dims, long[] maxdims)
throws HDF5Exception, NullPointerException;
/**
* H5Sset_extent_simple sets or resets the size of an existing dataspace.
*
* @param space_id
* Dataspace identifier.
* @param rank
* Rank, or dimensionality, of the dataspace.
* @param current_size
* Array containing current size of dataspace.
* @param maximum_size
* Array containing maximum size of dataspace.
*
* @return a dataspace identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Sset_extent_simple(long space_id, int rank, long[] current_size,
long[] maximum_size) throws HDF5LibraryException, NullPointerException;
/**
* H5Sset_extent_simple sets or resets the size of an existing dataspace.
*
* @param space_id
* Dataspace identifier.
* @param rank
* Rank, or dimensionality, of the dataspace.
* @param current_size
* Array containing current size of dataspace.
* @param maximum_size
* Array containing maximum size of dataspace.
*
* @return a dataspace identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static long H5Sset_extent_simple(long space_id, int rank, byte[] current_size,
byte[] maximum_size) throws HDF5LibraryException, NullPointerException {
ByteBuffer csbb = ByteBuffer.wrap(current_size);
long[] lacs = (csbb.asLongBuffer()).array();
ByteBuffer maxsbb = ByteBuffer.wrap(maximum_size);
long[] lamaxs = (maxsbb.asLongBuffer()).array();
return H5Sset_extent_simple(space_id, rank, lacs, lamaxs);
}
/**
* H5Scopy creates a new dataspace which is an exact copy of the dataspace identified by space_id.
*
* @param space_id
* Identifier of dataspace to copy.
* @return a dataspace identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Scopy(long space_id) throws HDF5LibraryException {
long id = _H5Scopy(space_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Scopy add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Scopy(long space_id) throws HDF5LibraryException;
/**
* H5Sclose releases a dataspace.
*
* @param space_id
* Identifier of dataspace to release.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Sclose(long space_id) throws HDF5LibraryException {
if (space_id < 0)
return 0; // throw new HDF5LibraryException("Negative ID");;
log.trace("OPEN_IDS: H5Sclose remove {}", space_id);
OPEN_IDS.remove(space_id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
return _H5Sclose(space_id);
}
private synchronized static native int _H5Sclose(long space_id) throws HDF5LibraryException;
/**
* H5Sencode converts a data space description into binary form in a buffer.
*
* @param obj_id
* IN: Identifier of the object to be encoded.
*
* @return the buffer for the object to be encoded into.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native byte[] H5Sencode(long obj_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Sdecode reconstructs the HDF5 data space object and returns a new object handle for it.
*
* @param buf
* IN: Buffer for the data space object to be decoded.
*
* @return a new object handle
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public synchronized static native long H5Sdecode(byte[] buf) throws HDF5LibraryException, NullPointerException;
/**
* H5Sget_simple_extent_npoints determines the number of elements in a dataspace.
*
* @param space_id
* ID of the dataspace object to query
* @return the number of elements in the dataspace if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Sget_simple_extent_npoints(long space_id) throws HDF5LibraryException;
/**
* H5Sget_simple_extent_ndims determines the dimensionality (or rank) of a dataspace.
*
* @param space_id
* IN: Identifier of the dataspace
*
* @return the number of dimensions in the dataspace if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Sget_simple_extent_ndims(long space_id) throws HDF5LibraryException;
/**
* H5Sget_simple_extent_dims returns the size and maximum sizes of each dimension of a dataspace through the dims
* and maxdims parameters.
*
* @param space_id
* IN: Identifier of the dataspace object to query
* @param dims
* OUT: Pointer to array to store the size of each dimension.
* @param maxdims
* OUT: Pointer to array to store the maximum size of each dimension.
*
* @return the number of dimensions in the dataspace if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - dims or maxdims is null.
**/
public synchronized static native int H5Sget_simple_extent_dims(long space_id, long[] dims, long[] maxdims)
throws HDF5LibraryException, NullPointerException;
/**
* H5Sis_simple determines whether a dataspace is a simple dataspace.
*
* @param space_id
* Identifier of the dataspace to query
*
* @return true if is a simple dataspace
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Sis_simple(long space_id) throws HDF5LibraryException;
/**
* H5Sget_simple_extent_type queries a dataspace to determine the current class of a dataspace.
*
* @param space_id
* Dataspace identifier.
*
* @return a dataspace class name if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Sget_simple_extent_type(long space_id) throws HDF5LibraryException;
/**
* H5Sset_extent_none removes the extent from a dataspace and sets the type to H5S_NONE.
*
* @param space_id
* The identifier for the dataspace from which the extent is to be removed.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Sset_extent_none(long space_id) throws HDF5LibraryException;
/**
* H5Sextent_copy copies the extent from source_space_id to dest_space_id. This action may change the type of the
* dataspace.
*
* @param dest_space_id
* IN: The identifier for the dataspace from which the extent is copied.
* @param source_space_id
* IN: The identifier for the dataspace to which the extent is copied.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Sextent_copy(long dest_space_id, long source_space_id)
throws HDF5LibraryException;
/**
* H5Sextent_equal determines whether the dataspace extents of two dataspaces, space1_id and space2_id, are equal.
*
* @param first_space_id
* IN: The identifier for the first dataspace.
* @param second_space_id
* IN: The identifier for the seconddataspace.
*
* @return true if successful, else false
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Sextent_equal(long first_space_id, long second_space_id)
throws HDF5LibraryException;
/***************** Operations on dataspace selections *****************/
/**
* H5Sget_select_type retrieves the type of selection currently defined for the dataspace space_id.
*
* @param space_id
* IN: Identifier of the dataspace object to query
*
* @return the dataspace selection type if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Sget_select_type(long space_id) throws HDF5LibraryException;
/**
* H5Sget_select_npoints determines the number of elements in the current selection of a dataspace.
*
* @param space_id
* IN: Identifier of the dataspace object to query
*
* @return the number of elements in the selection if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Sget_select_npoints(long space_id) throws HDF5LibraryException;
/**
* H5Sselect_copy copies all the selection information (including offset) from the source
* dataspace to the destination dataspace.
* @param dst_id ID of the destination dataspace
* @param src_id ID of the source dataspace
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Sselect_copy(long dst_id, long src_id) throws HDF5LibraryException;
/**
* H5Sselect_valid verifies that the selection for the dataspace.
*
* @param space_id
* The identifier for the dataspace in which the selection is being reset.
*
* @return true if the selection is contained within the extent and FALSE if it is not or is an error.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Sselect_valid(long space_id) throws HDF5LibraryException;
/**
* H5Sselect_adjust moves a selection by subtracting an offset from it.
*
* @param space_id
* ID of dataspace to adjust
* @param offset
* Offset to subtract
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - offset is null.
**/
public synchronized static native void H5Sselect_adjust(long space_id, long[][] offset)
throws HDF5LibraryException, NullPointerException;
/**
* H5Sget_select_bounds retrieves the coordinates of the bounding box containing the current selection and places
* them into user-supplied buffers.
* <P>
* The start and end buffers must be large enough to hold the dataspace rank number of coordinates.
*
* @param space_id
* Identifier of dataspace to release.
* @param start
* coordinates of lowest corner of bounding box.
* @param end
* coordinates of highest corner of bounding box.
*
* @return a non-negative value if successful,with start and end initialized.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - start or end is null.
**/
public synchronized static native int H5Sget_select_bounds(long space_id, long[] start, long[] end)
throws HDF5LibraryException, NullPointerException;
/**
* H5Sselect_shape_same checks to see if the current selection in the dataspaces are the same
* dimensionality and shape.
* This is primarily used for reading the entire selection in one swoop.
*
* @param space1_id ID of 1st Dataspace pointer to compare
* @param space2_id ID of 2nd Dataspace pointer to compare
*
* @return true if the selection is the same dimensionality and shape;
* false otherwise
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Sselect_shape_same(long space1_id, long space2_id) throws HDF5LibraryException;
/**
* H5Sselect_intersect_block checks to see if the current selection in the
* dataspace intersects with the block given.
*
* @param space_id
* ID of dataspace pointer to compare
* @param start
* Starting coordinate of block
* @param end
* Opposite ("ending") coordinate of block
*
* @return a TRUE if the current selection in the dataspace intersects with the block given
* FALSE otherwise
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - offset is null.
**/
public synchronized static native boolean H5Sselect_intersect_block(long space_id, long[] start, long[] end)
throws HDF5LibraryException, NullPointerException;
/**
* H5Soffset_simple sets the offset of a simple dataspace space_id.
*
* @param space_id
* IN: The identifier for the dataspace object to reset.
* @param offset
* IN: The offset at which to position the selection.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - offset array is null.
**/
public synchronized static native int H5Soffset_simple(long space_id, byte[] offset) throws HDF5LibraryException,
NullPointerException;
/**
* H5Soffset_simple sets the offset of a simple dataspace space_id.
*
* @param space_id
* IN: The identifier for the dataspace object to reset.
* @param offset
* IN: The offset at which to position the selection.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - offset array is null.
**/
public synchronized static int H5Soffset_simple(long space_id, long[] offset) throws HDF5Exception,
NullPointerException {
if (offset == null) {
return -1;
}
HDFArray theArray = new HDFArray(offset);
byte[] theArr = theArray.byteify();
int retVal = H5Soffset_simple(space_id, theArr);
theArr = null;
theArray = null;
return retVal;
}
/**
* H5Sselect_all selects the entire extent of the dataspace space_id.
*
* @param space_id
* IN: The identifier of the dataspace to be selected.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Sselect_all(long space_id) throws HDF5LibraryException;
/**
* H5Sselect_none resets the selection region for the dataspace space_id to include no elements.
*
* @param space_id
* IN: The identifier of the dataspace to be reset.
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Sselect_none(long space_id) throws HDF5LibraryException;
/**
* H5Sselect_elements selects array elements to be included in the selection for the space_id dataspace.
*
* @param space_id
* Identifier of the dataspace.
* @param op
* operator specifying how the new selection is combined.
* @param num_elements
* Number of elements to be selected.
* @param coord
* A 2-dimensional array specifying the coordinates of the elements.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
private synchronized static native int H5Sselect_elements(long space_id, int op, int num_elements, byte[] coord)
throws HDF5LibraryException, NullPointerException;
/**
* H5Sselect_elements selects array elements to be included in the selection for the space_id dataspace.
*
* @param space_id
* Identifier of the dataspace.
* @param op
* operator specifying how the new selection is combined.
* @param num_elements
* Number of elements to be selected.
* @param coord2D
* A 2-dimensional array specifying the coordinates of the elements.
*
* @return a non-negative value if successful
*
* @exception HDF5Exception
* - Error in the data conversion
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - cord array is
**/
public synchronized static int H5Sselect_elements(long space_id, int op, int num_elements, long[][] coord2D)
throws HDF5Exception, HDF5LibraryException, NullPointerException {
if (coord2D == null) {
return -1;
}
HDFArray theArray = new HDFArray(coord2D);
byte[] coord = theArray.byteify();
int retVal = H5Sselect_elements(space_id, op, num_elements, coord);
coord = null;
theArray = null;
return retVal;
}
/**
* H5Sget_select_elem_npoints returns the number of element points in the current dataspace selection.
*
* @param spaceid
* Identifier of dataspace to release.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Sget_select_elem_npoints(long spaceid) throws HDF5LibraryException;
/**
* H5Sget_select_elem_pointlist returns an array of of element points in the current dataspace selection. The point
* coordinates have the same dimensionality (rank) as the dataspace they are located within, one coordinate per
* point.
*
* @param spaceid
* Identifier of dataspace to release.
* @param startpoint
* first point to retrieve
* @param numpoints
* number of points to retrieve
* @param buf
* returns points startblock to startblock+num-1, each points is <i>rank</i> longs.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public synchronized static native int H5Sget_select_elem_pointlist(long spaceid, long startpoint, long numpoints,
long[] buf) throws HDF5LibraryException, NullPointerException;
/**
* H5Sselect_hyperslab selects a hyperslab region to add to the current selected region for the dataspace specified
* by space_id. The start, stride, count, and block arrays must be the same size as the rank of the dataspace.
*
* @param space_id
* IN: Identifier of dataspace selection to modify
* @param op
* IN: Operation to perform on current selection.
* @param start
* IN: Offset of start of hyperslab
* @param stride
* IN: Hyperslab stride.
* @param count
* IN: Number of blocks included in hyperslab.
* @param block
* IN: Size of block in hyperslab.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static int H5Sselect_hyperslab(long space_id, int op, byte[] start, byte[] stride,
byte[] count, byte[] block) throws HDF5LibraryException, NullPointerException, IllegalArgumentException {
ByteBuffer startbb = ByteBuffer.wrap(start);
long[] lastart = (startbb.asLongBuffer()).array();
ByteBuffer stridebb = ByteBuffer.wrap(stride);
long[] lastride = (stridebb.asLongBuffer()).array();
ByteBuffer countbb = ByteBuffer.wrap(count);
long[] lacount = (countbb.asLongBuffer()).array();
ByteBuffer blockbb = ByteBuffer.wrap(block);
long[] lablock = (blockbb.asLongBuffer()).array();
return H5Sselect_hyperslab(space_id, op, lastart, lastride, lacount, lablock);
}
/**
* H5Sselect_hyperslab selects a hyperslab region to add to the current selected region for the dataspace specified
* by space_id. The start, stride, count, and block arrays must be the same size as the rank of the dataspace.
*
* @param space_id
* IN: Identifier of dataspace selection to modify
* @param op
* IN: Operation to perform on current selection.
* @param start
* IN: Offset of start of hyperslab
* @param stride
* IN: Hyperslab stride.
* @param count
* IN: Number of blocks included in hyperslab.
* @param block
* IN: Size of block in hyperslab.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native int H5Sselect_hyperslab(long space_id, int op, long[] start, long[] stride,
long[] count, long[] block) throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Scombine_hyperslab combines a hyperslab selection with the current selection for a dataspace,
* creating a new dataspace to return the generated selection.
* If the current selection is not a hyperslab, it is freed and the hyperslab
* parameters passed in are combined with the H5S_SEL_ALL hyperslab (ie. a
* selection composing the entire current extent). If STRIDE or BLOCK is
* NULL, they are assumed to be set to all '1'.
*
* @param space_id
* IN: Dataspace ID of selection to use
* @param op
* IN: Operation to perform on current selection.
* @param start
* IN: Offset of start of hyperslab
* @param stride
* IN: Hyperslab stride.
* @param count
* IN: Number of blocks included in hyperslab.
* @param block
* IN: Size of block in hyperslab.
*
* @return a dataspace ID on success / H5I_INVALID_HID on failure
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an input array is null.
* @exception IllegalArgumentException
* - an input array is invalid.
**/
public synchronized static native long H5Scombine_hyperslab(long space_id, int op, long[] start, long[] stride,
long[] count, long[] block) throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Smodify_select refine an existing hyperslab selection with an operation, using a second
* hyperslab. The first selection is modified to contain the result of
* space1 operated on by space2.
*
* @param space1_id
* ID of the destination dataspace
* @param op
* Operation to perform on current selection.
* @param space2_id
* ID of the source dataspace
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Smodify_select(long space1_id, int op, long space2_id) throws HDF5LibraryException;
/**
* H5Scombine_select combines two existing hyperslab selections with an operation, returning
* a new dataspace with the resulting selection. The dataspace extent from
* space1 is copied for the dataspace extent of the newly created dataspace.
*
* @param space1_id
* ID of the first dataspace
* @param op
* Operation to perform on current selection.
* @param space2_id
* ID of the second dataspace
*
* @return a dataspace ID on success / H5I_INVALID_HID on failure
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Scombine_select(long space1_id, int op, long space2_id) throws HDF5LibraryException;
/**
* H5Sis_regular_hyperslab retrieves a regular hyperslab selection for the dataspace specified
* by space_id.
*
* @param space_id
* IN: Identifier of dataspace selection to query
*
* @return a TRUE/FALSE for hyperslab selection if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Sis_regular_hyperslab(long space_id) throws HDF5LibraryException;
/**
* H5Sget_regular_hyperslab determines if a hyperslab selection is regular for the dataspace specified
* by space_id. The start, stride, count, and block arrays must be the same size as the rank of the dataspace.
*
* @param space_id
* IN: Identifier of dataspace selection to modify
* @param start
* OUT: Offset of start of hyperslab
* @param stride
* OUT: Hyperslab stride.
* @param count
* OUT: Number of blocks included in hyperslab.
* @param block
* OUT: Size of block in hyperslab.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - an output array is null.
* @exception IllegalArgumentException
* - an output array is invalid.
**/
public synchronized static native void H5Sget_regular_hyperslab(long space_id, long[] start, long[] stride, long[] count, long[] block) throws HDF5LibraryException, NullPointerException, IllegalArgumentException;
/**
* H5Sget_select_hyper_nblocks returns the number of hyperslab blocks in the current dataspace selection.
*
* @param spaceid
* Identifier of dataspace to release.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Sget_select_hyper_nblocks(long spaceid) throws HDF5LibraryException;
/**
* H5Sget_select_hyper_blocklist returns an array of hyperslab blocks. The block coordinates have the same
* dimensionality (rank) as the dataspace they are located within. The list of blocks is formatted as follows:
*
* <pre>
* <"start" coordinate>, immediately followed by
* <"opposite" corner coordinate>, followed by
* the next "start" and "opposite" coordinates,
* etc.
* until all of the selected blocks have been listed.
* </pre>
*
* @param spaceid
* Identifier of dataspace to release.
* @param startblock
* first block to retrieve
* @param numblocks
* number of blocks to retrieve
* @param buf
* returns blocks startblock to startblock+num-1, each block is <i>rank</i> * 2 (corners) longs.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public synchronized static native int H5Sget_select_hyper_blocklist(long spaceid, long startblock, long numblocks,
long[] buf) throws HDF5LibraryException, NullPointerException;
/**
* H5Sselect_project_intersection projects the intersection of the selections of src_space_id and
* src_intersect_space_id within the selection of src_space_id as a
* selection within the selection of dst_space_id.
*
* @param src_space_id
* Selection that is mapped to dst_space_id, and intersected with src_intersect_space_id
* @param dst_space_id
* Selection that is mapped to src_space_id
* @param src_intersect_space_id
* Selection whose intersection with src_space_id is projected to dst_space_id to obtain the result
*
* @return a dataspace with a selection equal to the intersection of
* src_intersect_space_id and src_space_id projected from src_space to dst_space on success
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Sselect_project_intersection(long src_space_id, long dst_space_id,
long src_intersect_space_id) throws HDF5LibraryException;
// /////// unimplemented ////////
///// Operations on dataspace selections /////
//
///// Operations on dataspace selection iterators /////
//public synchronized static native H5Ssel_iter_create(hid_t spaceid, size_t elmt_size, unsigned flags);
//public synchronized static native H5Ssel_iter_get_seq_list(hid_t sel_iter_id, size_t maxseq, size_t maxbytes, size_t *nseq,
// size_t *nbytes, hsize_t *off, size_t *len);
//public synchronized static native H5Ssel_iter_reset(hid_t sel_iter_id, hid_t space_id);
//public synchronized static native H5Ssel_iter_close(hid_t sel_iter_id);
// ////////////////////////////////////////////////////////////
// //
// H5T: Datatype Interface Functions //
// //
// ////////////////////////////////////////////////////////////
/**
* H5Tarray_create creates a new array datatype object.
*
* @param base_id
* IN: Datatype identifier for the array base datatype.
* @param ndims
* IN: Rank of the array.
* @param dim
* IN: Size of each array dimension.
*
* @return a valid datatype identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - dim is null.
**/
public static long H5Tarray_create(long base_id, int ndims, long[] dim) throws HDF5LibraryException,
NullPointerException {
long id = _H5Tarray_create2(base_id, ndims, dim);
if (id > 0) {
log.trace("OPEN_IDS: H5Tarray_create add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Tarray_create2(long base_id, int ndims, long[] dim)
throws HDF5LibraryException, NullPointerException;
/**
* H5Tclose releases a datatype.
*
* @param type_id
* IN: Identifier of datatype to release.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Tclose(long type_id) throws HDF5LibraryException {
if (type_id < 0)
return 0; // throw new HDF5LibraryException("Negative ID");;
log.trace("OPEN_IDS: H5Tclose remove {}", type_id);
OPEN_IDS.remove(type_id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
return _H5Tclose(type_id);
}
private synchronized static native int _H5Tclose(long type_id) throws HDF5LibraryException;
/**
* H5Tcommit saves a transient datatype as an immutable named datatype in a file.
*
* @param loc_id
* IN: Location identifier.
* @param name
* IN: Name given to committed datatype.
* @param type_id
* IN: Identifier of datatype to be committed.
* @param lcpl_id
* IN: Link creation property list.
* @param tcpl_id
* IN: Datatype creation property list.
* @param tapl_id
* IN: Datatype access property list.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native void H5Tcommit(long loc_id, String name, long type_id, long lcpl_id,
long tcpl_id, long tapl_id) throws HDF5LibraryException, NullPointerException;
/**
* H5Tcommit_anon commits a transient datatype (not immutable) to a file, turning it into a named datatype with the
* specified creation and property lists.
*
* @param loc_id
* IN: Location identifier.
* @param type_id
* IN: Identifier of datatype to be committed.
* @param tcpl_id
* IN: Datatype creation property list.
* @param tapl_id
* IN: Datatype access property list.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Tcommit_anon(long loc_id, long type_id, long tcpl_id, long tapl_id)
throws HDF5LibraryException;
/**
* H5Tcommitted queries a type to determine whether the type specified by the type identifier is a named type or a
* transient type.
*
* @param type_id
* IN: Identifier of datatype.
*
* @return true the datatype has been committed
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Tcommitted(long type_id) throws HDF5LibraryException;
/**
* H5Tcompiler_conv finds out whether the library's conversion function from type src_id to type dst_id is a
* compiler (hard) conversion.
*
* @param src_id
* IN: Identifier of source datatype.
* @param dst_id
* IN: Identifier of destination datatype.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Tcompiler_conv(long src_id, long dst_id) throws HDF5LibraryException;
/**
** H5Tconvert converts nelmts elements from the type specified by the src_id identifier to type dst_id.
*
* @param src_id
* IN: Identifier of source datatype.
* @param dst_id
* IN: Identifier of destination datatype.
* @param nelmts
* IN: Size of array buf.
* @param buf
* IN: Array containing pre- and post-conversion values.
* @param background
* IN: Optional background buffer.
* @param plist_id
* IN: Dataset transfer property list identifier.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public synchronized static native void H5Tconvert(long src_id, long dst_id, long nelmts, byte[] buf,
byte[] background, long plist_id) throws HDF5LibraryException, NullPointerException;
// int H5Tconvert(int src_id, int dst_id, long nelmts, Pointer buf, Pointer background, int plist_id);
/**
* H5Tcopy copies an existing datatype. The returned type is always transient and unlocked.
*
* @param type_id
* IN: Identifier of datatype to copy. Can be a datatype identifier, a predefined datatype (defined in
* H5Tpublic.h), or a dataset Identifier.
*
* @return a datatype identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Tcopy(long type_id) throws HDF5LibraryException {
long id = _H5Tcopy(type_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Tcopy add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Tcopy(long type_id) throws HDF5LibraryException;
/**
* H5Tcreate creates a new dataype of the specified class with the specified number of bytes.
*
* @param tclass
* IN: Class of datatype to create.
* @param size
* IN: The number of bytes in the datatype to create.
*
* @return datatype identifier
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Tcreate(int tclass, long size) throws HDF5LibraryException {
long id = _H5Tcreate(tclass, size);
if (id > 0) {
log.trace("OPEN_IDS: H5Tcreate add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Tcreate(int type, long size) throws HDF5LibraryException;
/**
* H5Tdecode reconstructs the HDF5 data type object and returns a new object handle for it.
*
* @param buf
* IN: Buffer for the data type object to be decoded.
*
* @return a new object handle
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public static long H5Tdecode(byte[] buf) throws HDF5LibraryException, NullPointerException {
long id = _H5Tdecode(buf);
if (id > 0) {
log.trace("OPEN_IDS: H5Tdecode add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Tdecode(byte[] buf) throws HDF5LibraryException, NullPointerException;
/**
* H5Tdetect_class determines whether the datatype specified in dtype_id contains any datatypes of the datatype
* class specified in dtype_class.
*
* @param type_id
* IN: Identifier of datatype to query.
* @param cls
* IN: Identifier of datatype cls.
*
* @return true if the datatype specified in dtype_id contains any datatypes of the datatype class
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Tdetect_class(long type_id, int cls) throws HDF5LibraryException;
/**
* H5Tencode converts a data type description into binary form in a buffer.
*
* @param obj_id
* IN: Identifier of the object to be encoded.
* @param buf
* OUT: Buffer for the object to be encoded into. If the provided buffer is NULL, only the size of buffer
* needed is returned.
* @param nalloc
* IN: The size of the allocated buffer.
*
* @return the size needed for the allocated buffer.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public synchronized static native int H5Tencode(long obj_id, byte[] buf, long nalloc) throws HDF5LibraryException,
NullPointerException;
// /**
// * H5Tencode converts a data type description into binary form in a buffer.
// *
// * @param obj_id IN: Identifier of the object to be encoded.
// *
// * @return the buffer for the object to be encoded into.
// *
// * @exception HDF5LibraryException - Error from the HDF-5 Library.
// **/
// public synchronized static native byte[] H5Tencode(int obj_id)
// throws HDF5LibraryException;
/**
* H5Tenum_create creates a new enumeration datatype based on the specified base datatype, parent_id, which must be
* an integer type.
*
* @param base_id
* IN: Identifier of the parent datatype to release.
*
* @return the datatype identifier for the new enumeration datatype
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Tenum_create(long base_id) throws HDF5LibraryException {
long id = _H5Tenum_create(base_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Tenum_create add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Tenum_create(long base_id) throws HDF5LibraryException;
/**
* H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype.
*
* @param type
* IN: Identifier of datatype.
* @param name
* IN: The name of the member
* @param value
* IN: The value of the member, data of the correct type
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native void H5Tenum_insert(long type, String name, byte[] value)
throws HDF5LibraryException, NullPointerException;
/**
* H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype.
*
* @param type
* IN: Identifier of datatype.
* @param name
* IN: The name of the member
* @param value
* IN: The value of the member, data of the correct type
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static int H5Tenum_insert(long type, String name, int[] value) throws HDF5LibraryException,
NullPointerException {
return H5Tenum_insert_int(type, name, value);
}
/**
* H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype.
*
* @param type
* IN: Identifier of datatype.
* @param name
* IN: The name of the member
* @param value
* IN: The value of the member, data of the correct type
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static int H5Tenum_insert(long type, String name, int value) throws HDF5LibraryException,
NullPointerException {
int[] val = { value };
return H5Tenum_insert_int(type, name, val);
}
private synchronized static native int H5Tenum_insert_int(long type, String name, int[] value)
throws HDF5LibraryException, NullPointerException;
/**
* H5Tenum_nameof finds the symbol name that corresponds to the specified value of the enumeration datatype type.
*
* @param type
* IN: Identifier of datatype.
* @param value
* IN: The value of the member, data of the correct
* @param size
* IN: The probable length of the name
*
* @return the symbol name.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - value is null.
**/
public synchronized static native String H5Tenum_nameof(long type, byte[] value, long size)
throws HDF5LibraryException, NullPointerException;
// int H5Tenum_nameof(int type, Pointer value, Buffer name/* out */, long size);
/**
* H5Tenum_nameof finds the symbol name that corresponds to the specified value of the enumeration datatype type.
*
* @param type
* IN: Identifier of datatype.
* @param value
* IN: The value of the member, data of the correct
* @param name
* OUT: The name of the member
* @param size
* IN: The max length of the name
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static int H5Tenum_nameof(long type, int[] value, String[] name, int size) throws HDF5LibraryException,
NullPointerException {
return H5Tenum_nameof_int(type, value, name, size);
}
private synchronized static native int H5Tenum_nameof_int(long type, int[] value, String[] name, int size)
throws HDF5LibraryException, NullPointerException;
/**
* H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype type.
*
* @param type
* IN: Identifier of datatype.
* @param name
* IN: The name of the member
* @param value
* OUT: The value of the member
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Tenum_valueof(long type, String name, byte[] value)
throws HDF5LibraryException, NullPointerException;
/**
* H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype type.
*
* @param type
* IN: Identifier of datatype.
* @param name
* IN: The name of the member
* @param value
* OUT: The value of the member
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static int H5Tenum_valueof(long type, String name, int[] value) throws HDF5LibraryException,
NullPointerException {
return H5Tenum_valueof_int(type, name, value);
}
private synchronized static native int H5Tenum_valueof_int(long type, String name, int[] value)
throws HDF5LibraryException, NullPointerException;
/**
* H5Tequal determines whether two datatype identifiers refer to the same datatype.
*
* @param type_id1
* IN: Identifier of datatype to compare.
* @param type_id2
* IN: Identifier of datatype to compare.
*
* @return true if the datatype identifiers refer to the same datatype, else false.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Tequal(long type_id1, long type_id2) throws HDF5LibraryException;
/**
* H5Tget_array_dims returns the sizes of the dimensions of the specified array datatype object.
*
* @param type_id
* IN: Datatype identifier of array object.
* @param dims
* OUT: Sizes of array dimensions.
*
* @return the non-negative number of dimensions of the array type
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - dims is null.
**/
public static int H5Tget_array_dims(long type_id, long[] dims) throws HDF5LibraryException, NullPointerException {
return H5Tget_array_dims2(type_id, dims);
}
/**
* H5Tget_array_dims2 returns the sizes of the dimensions of the specified array datatype object.
*
* @param type_id
* IN: Datatype identifier of array object.
* @param dims
* OUT: Sizes of array dimensions.
*
* @return the non-negative number of dimensions of the array type
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - dims is null.
**/
public synchronized static native int H5Tget_array_dims2(long type_id, long[] dims) throws HDF5LibraryException,
NullPointerException;
/**
* H5Tget_array_ndims returns the rank, the number of dimensions, of an array datatype object.
*
* @param type_id
* IN: Datatype identifier of array object.
*
* @return the rank of the array
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_array_ndims(long type_id) throws HDF5LibraryException;
/**
* H5Tget_class returns the datatype class identifier.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return datatype class identifier if successful; otherwise H5T_NO_CLASS(-1).
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_class(long type_id) throws HDF5LibraryException;
/**
* H5Tget_class_name returns the datatype class identifier.
*
* @param class_id
* IN: Identifier of class from H5Tget_class.
*
* @return class name if successful; otherwise H5T_NO_CLASS.
*
**/
public static String H5Tget_class_name(long class_id) {
String retValue = null;
if (HDF5Constants.H5T_INTEGER == class_id) /* integer types */
retValue = "H5T_INTEGER";
else if (HDF5Constants.H5T_FLOAT == class_id) /* floating-point types */
retValue = "H5T_FLOAT";
else if (HDF5Constants.H5T_TIME == class_id) /* date and time types */
retValue = "H5T_TIME";
else if (HDF5Constants.H5T_STRING == class_id) /* character string types */
retValue = "H5T_STRING";
else if (HDF5Constants.H5T_BITFIELD == class_id) /* bit field types */
retValue = "H5T_BITFIELD";
else if (HDF5Constants.H5T_OPAQUE == class_id) /* opaque types */
retValue = "H5T_OPAQUE";
else if (HDF5Constants.H5T_COMPOUND == class_id) /* compound types */
retValue = "H5T_COMPOUND";
else if (HDF5Constants.H5T_REFERENCE == class_id)/* reference types */
retValue = "H5T_REFERENCE";
else if (HDF5Constants.H5T_ENUM == class_id) /* enumeration types */
retValue = "H5T_ENUM";
else if (HDF5Constants.H5T_VLEN == class_id) /* Variable-Length types */
retValue = "H5T_VLEN";
else if (HDF5Constants.H5T_ARRAY == class_id) /* Array types */
retValue = "H5T_ARRAY";
else
retValue = "H5T_NO_CLASS";
return retValue;
}
/**
* H5Tget_create_plist returns a property list identifier for the datatype creation property list associated with
* the datatype specified by type_id.
*
* @param type_id
* IN: Identifier of datatype.
*
* @return a datatype property list identifier.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Tget_create_plist(long type_id) throws HDF5LibraryException {
long id = _H5Tget_create_plist(type_id);
if (id > 0) {
log.trace("OPEN_IDS: _H5Tget_create_plist add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Tget_create_plist(long type_id) throws HDF5LibraryException;
/**
* H5Tget_cset retrieves the character set type of a string datatype.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return a valid character set type if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_cset(long type_id) throws HDF5LibraryException;
/**
* H5Tset_cset the character set to be used.
*
* @param type_id
* IN: Identifier of datatype to modify.
* @param cset
* IN: Character set type.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tset_cset(long type_id, int cset) throws HDF5LibraryException;
/**
* H5Tget_ebias retrieves the exponent bias of a floating-point type.
*
* @param type_id
* Identifier of datatype to query.
*
* @return the bias if successful; otherwise 0.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_ebias(long type_id) throws HDF5LibraryException;
/**
* H5Tset_ebias sets the exponent bias of a floating-point type.
*
* @param type_id
* Identifier of datatype to set.
* @param ebias
* Exponent bias value.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Tset_ebias(long type_id, int ebias) throws HDF5LibraryException {
H5Tset_ebias(type_id, (long) ebias);
return 0;
}
/**
* H5Tget_ebias retrieves the exponent bias of a floating-point type.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return the bias
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Tget_ebias_long(long type_id) throws HDF5LibraryException;
/**
* H5Tset_ebias sets the exponent bias of a floating-point type.
*
* @param type_id
* IN: Identifier of datatype to set.
* @param ebias
* IN: Exponent bias value.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Tset_ebias(long type_id, long ebias) throws HDF5LibraryException;
/**
* H5Tget_fields retrieves information about the locations of the various bit fields of a floating point datatype.
*
* @param type_id
* IN: Identifier of datatype to query.
* @param fields
* OUT: location of size and bit-position.
* <ul>
* <li>fields[0] = spos OUT: location to return size of in bits.</li>
* <li>fields[1] = epos OUT: location to return exponent bit-position.</li>
* <li>fields[2] = esize OUT: location to return size of exponent in bits.</li>
* <li>fields[3] = mpos OUT: location to return mantissa bit-position.</li>
* <li>fields[4] = msize OUT: location to return size of mantissa in bits.</li>
* </ul>
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - fields is null.
* @exception IllegalArgumentException
* - fields array is invalid.
**/
public synchronized static native void H5Tget_fields(long type_id, long[] fields) throws HDF5LibraryException,
NullPointerException, IllegalArgumentException;
/**
* H5Tget_fields retrieves information about the locations of the various bit fields of a floating point datatype.
*
* @param type_id
* IN: Identifier of datatype to query.
* @param fields
* OUT: location of size and bit-position.
*
* <pre>
* fields[0] = spos OUT: location to return size of in bits.
* fields[1] = epos OUT: location to return exponent bit-position.
* fields[2] = esize OUT: location to return size of exponent in bits.
* fields[3] = mpos OUT: location to return mantissa bit-position.
* fields[4] = msize OUT: location to return size of mantissa in bits.
* </pre>
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - fields is null.
* @exception IllegalArgumentException
* - fields array is invalid.
**/
public static int H5Tget_fields(long type_id, int[] fields) throws HDF5LibraryException, NullPointerException,
IllegalArgumentException {
return H5Tget_fields_int(type_id, fields);
}
private synchronized static native int H5Tget_fields_int(long type_id, int[] fields) throws HDF5LibraryException,
NullPointerException, IllegalArgumentException;
/**
* H5Tset_fields sets the locations and sizes of the various floating point bit fields.
*
* @param type_id
* IN: Identifier of datatype to set.
* @param spos
* IN: Size position.
* @param epos
* IN: Exponent bit position.
* @param esize
* IN: Size of exponent in bits.
* @param mpos
* IN: Mantissa bit position.
* @param msize
* IN: Size of mantissa in bits.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Tset_fields(long type_id, long spos, long epos, long esize, long mpos,
long msize) throws HDF5LibraryException;
/**
* H5Tset_fields sets the locations and sizes of the various floating point bit fields.
*
* @param type_id
* Identifier of datatype to set.
* @param spos
* Size position.
* @param epos
* Exponent bit position.
* @param esize
* Size of exponent in bits.
* @param mpos
* Mantissa bit position.
* @param msize
* Size of mantissa in bits.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Tset_fields(long type_id, int spos, int epos, int esize, int mpos, int msize)
throws HDF5LibraryException {
H5Tset_fields(type_id, (long) spos, (long) epos, (long) esize, (long) mpos, (long) msize);
return 0;
}
/**
* H5Tget_inpad retrieves the internal padding type for unused bits in floating-point datatypes.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return a valid padding type if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_inpad(long type_id) throws HDF5LibraryException;
/**
* 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.
*
* @param type_id
* IN: Identifier of datatype to modify.
* @param inpad
* IN: Padding type.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tset_inpad(long type_id, int inpad) throws HDF5LibraryException;
/**
* H5Tget_member_class returns the class of datatype of the specified member.
*
* @param type_id
* IN: Datatype identifier of compound object.
* @param membno
* IN: Compound object member number.
*
* @return the class of the datatype of the field if successful;
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_member_class(long type_id, int membno) throws HDF5LibraryException;
/**
* H5Tget_member_index retrieves the index of a field of a compound datatype.
*
* @param type_id
* IN: Identifier of datatype to query.
* @param field_name
* IN: Field name of the field index to retrieve.
*
* @return if field is defined, the index; else negative.
**/
public synchronized static native int H5Tget_member_index(long type_id, String field_name);
/**
* H5Tget_member_name retrieves the name of a field of a compound datatype or an element of an enumeration datatype.
*
* @param type_id
* IN: Identifier of datatype to query.
* @param field_idx
* IN: Field index (0-based) of the field name to retrieve.
*
* @return a valid pointer to the name if successful; otherwise null.
**/
public synchronized static native String H5Tget_member_name(long type_id, int field_idx);
/**
* H5Tget_member_offset returns the byte offset of the specified member of the compound datatype. This is the byte
* offset in the HDF-5 file/library, NOT the offset of any Java object which might be mapped to this data item.
*
* @param type_id
* IN: Identifier of datatype to query.
* @param membno
* IN: Field index (0-based) of the field type to retrieve.
*
* @return the offset of the member.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Tget_member_offset(long type_id, int membno) throws HDF5LibraryException;
/**
* H5Tget_member_type returns the datatype of the specified member.
*
* @param type_id
* IN: Identifier of datatype to query.
* @param field_idx
* IN: Field index (0-based) of the field type to retrieve.
*
* @return the identifier of a copy of the datatype of the field if successful;
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Tget_member_type(long type_id, int field_idx) throws HDF5LibraryException {
long id = _H5Tget_member_type(type_id, field_idx);
if (id > 0) {
log.trace("OPEN_IDS: H5Tget_member_type add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Tget_member_type(long type_id, int field_idx)
throws HDF5LibraryException;
/**
* H5Tget_member_value returns the value of the enumeration datatype member memb_no.
*
* @param type_id
* IN: Datatype identifier for the enumeration datatype.
* @param membno
* IN: Number of the enumeration datatype member.
* @param value
* OUT: The value of the member
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - value is null.
**/
public synchronized static native void H5Tget_member_value(long type_id, int membno, byte[] value)
throws HDF5LibraryException, NullPointerException;
/**
* H5Tget_member_value returns the value of the enumeration datatype member memb_no.
*
* @param type_id
* IN: Identifier of datatype.
* @param membno
* IN: The name of the member
* @param value
* OUT: The value of the member
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - value is null.
**/
public static int H5Tget_member_value(long type_id, int membno, int[] value) throws HDF5LibraryException,
NullPointerException {
return H5Tget_member_value_int(type_id, membno, value);
}
private synchronized static native int H5Tget_member_value_int(long type_id, int membno, int[] value)
throws HDF5LibraryException, NullPointerException;
/**
* H5Tget_native_type returns the equivalent native datatype for the datatype specified in type_id.
*
* @param type_id
* IN: Identifier of datatype to query. Direction of search is assumed to be in ascending order.
*
* @return the native datatype identifier for the specified dataset datatype.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static long H5Tget_native_type(long type_id) throws HDF5LibraryException {
return H5Tget_native_type(type_id, HDF5Constants.H5T_DIR_ASCEND);
}
/**
* H5Tget_native_type returns the equivalent native datatype for the datatype specified in type_id.
*
* @param type_id
* IN: Identifier of datatype to query.
* @param direction
* IN: Direction of search.
*
* @return the native datatype identifier for the specified dataset datatype.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Tget_native_type(long type_id, int direction) throws HDF5LibraryException {
long id = _H5Tget_native_type(type_id, direction);
if (id > 0) {
log.trace("OPEN_IDS: H5Tget_native_type add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Tget_native_type(long tid, int direction) throws HDF5LibraryException;
/**
* H5Tget_nmembers retrieves the number of fields a compound datatype has.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return number of members datatype has if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_nmembers(long type_id) throws HDF5LibraryException;
/**
* H5Tget_norm retrieves the mantissa normalization of a floating-point datatype.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return a valid normalization type if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_norm(long type_id) throws HDF5LibraryException;
/**
* H5Tset_norm sets the mantissa normalization of a floating-point datatype.
*
* @param type_id
* IN: Identifier of datatype to set.
* @param norm
* IN: Mantissa normalization type.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tset_norm(long type_id, int norm) throws HDF5LibraryException;
/**
* H5Tget_offset retrieves the bit offset of the first significant bit.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return a positive offset value if successful; otherwise 0.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_offset(long type_id) throws HDF5LibraryException;
/**
* H5Tset_offset sets the bit offset of the first significant bit.
*
* @param type_id
* Identifier of datatype to set.
* @param offset
* Offset of first significant bit.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Tset_offset(long type_id, int offset) throws HDF5LibraryException {
H5Tset_offset(type_id, (long) offset);
return 0;
}
/**
* H5Tset_offset sets the bit offset of the first significant bit.
*
* @param type_id
* IN: Identifier of datatype to set.
* @param offset
* IN: Offset of first significant bit.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Tset_offset(long type_id, long offset) throws HDF5LibraryException;
/**
* H5Tget_order returns the byte order of an atomic datatype.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return a byte order constant if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_order(long type_id) throws HDF5LibraryException;
/**
* H5Tset_order sets the byte ordering of an atomic datatype.
*
* @param type_id
* IN: Identifier of datatype to set.
* @param order
* IN: Byte ordering constant.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tset_order(long type_id, int order) throws HDF5LibraryException;
/**
* H5Tget_pad retrieves the padding type of the least and most-significant bit padding.
*
* @param type_id
* IN: Identifier of datatype to query.
* @param pad
* OUT: locations to return least-significant and most-significant bit padding type.
*
* <pre>
* pad[0] = lsb // least-significant bit padding type
* pad[1] = msb // most-significant bit padding type
* </pre>
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - pad is null.
**/
public synchronized static native int H5Tget_pad(long type_id, int[] pad) throws HDF5LibraryException,
NullPointerException;
/**
* H5Tset_pad sets the least and most-significant bits padding types.
*
* @param type_id
* IN: Identifier of datatype to set.
* @param lsb
* IN: Padding type for least-significant bits.
* @param msb
* IN: Padding type for most-significant bits.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tset_pad(long type_id, int lsb, int msb) throws HDF5LibraryException;
/**
* H5Tget_precision returns the precision of an atomic datatype.
*
* @param type_id
* Identifier of datatype to query.
*
* @return the number of significant bits if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_precision(long type_id) throws HDF5LibraryException;
/**
* H5Tset_precision sets the precision of an atomic datatype.
*
* @param type_id
* Identifier of datatype to set.
* @param precision
* Number of bits of precision for datatype.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static int H5Tset_precision(long type_id, int precision) throws HDF5LibraryException {
H5Tset_precision(type_id, (long) precision);
return 0;
}
/**
* H5Tget_precision returns the precision of an atomic datatype.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return the number of significant bits if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Tget_precision_long(long type_id) throws HDF5LibraryException;
/**
* H5Tset_precision sets the precision of an atomic datatype.
*
* @param type_id
* IN: Identifier of datatype to set.
* @param precision
* IN: Number of bits of precision for datatype.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Tset_precision(long type_id, long precision) throws HDF5LibraryException;
/**
* H5Tget_sign retrieves the sign type for an integer type.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return a valid sign type if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_sign(long type_id) throws HDF5LibraryException;
/**
* H5Tset_sign sets the sign proprety for an integer type.
*
* @param type_id
* IN: Identifier of datatype to set.
* @param sign
* IN: Sign type.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tset_sign(long type_id, int sign) throws HDF5LibraryException;
/**
* H5Tget_size returns the size of a datatype in bytes.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return the size of the datatype in bytes
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5Tget_size(long type_id) throws HDF5LibraryException;
/**
* H5Tset_size sets the total size in bytes, size, for an atomic datatype (this operation is not permitted on
* compound datatypes).
*
* @param type_id
* IN: Identifier of datatype to change size.
* @param size
* IN: Size in bytes to modify datatype.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tset_size(long type_id, long size) throws HDF5LibraryException;
/**
* H5Tget_strpad retrieves the string padding method for a string datatype.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return a valid string padding type if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tget_strpad(long type_id) throws HDF5LibraryException;
/**
* H5Tset_strpad defines the storage mechanism for the string.
*
* @param type_id
* IN: Identifier of datatype to modify.
* @param strpad
* IN: String padding type.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tset_strpad(long type_id, int strpad) throws HDF5LibraryException;
/**
* H5Tget_super returns the type from which TYPE is derived.
*
* @param type
* IN: Identifier of datatype.
*
* @return the parent type
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Tget_super(long type) throws HDF5LibraryException {
long id = _H5Tget_super(type);
if (id > 0) {
log.trace("OPEN_IDS: H5Tget_super add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Tget_super(long type) throws HDF5LibraryException;
/**
* H5Tget_tag returns the tag associated with datatype type_id.
*
* @param type
* IN: Identifier of datatype.
*
* @return the tag
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native String H5Tget_tag(long type) throws HDF5LibraryException;
/**
* H5Tset_tag tags an opaque datatype type_id with a unique ASCII identifier tag.
*
* @param type
* IN: Datatype identifier for the opaque datatype to be tagged.
* @param tag
* IN: Descriptive ASCII string with which the opaque datatype is to be tagged.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tset_tag(long type, String tag) throws HDF5LibraryException;
/**
* H5Tinsert adds another member to the compound datatype type_id.
*
* @param type_id
* IN: Identifier of compound datatype to modify.
* @param name
* IN: Name of the field to insert.
* @param offset
* IN: Offset in memory structure of the field to insert.
* @param field_id
* IN: Datatype identifier of the field to insert.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public synchronized static native int H5Tinsert(long type_id, String name, long offset, long field_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Tis_variable_str determines whether the datatype identified in type_id is a variable-length string.
*
* @param type_id
* IN: Identifier of datatype to query.
*
* @return true if type_id is a variable-length string.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5Tis_variable_str(long type_id) throws HDF5LibraryException;
/**
* H5Tlock locks the datatype specified by the type_id identifier, making it read-only and non-destrucible.
*
* @param type_id
* IN: Identifier of datatype to lock.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tlock(long type_id) throws HDF5LibraryException;
/**
* H5Topen opens a named datatype at the location specified by loc_id and return an identifier for the datatype.
*
* @param loc_id
* IN: A file, group, or datatype identifier.
* @param name
* IN: A datatype name, defined within the file or group identified by loc_id.
* @param tapl_id
* IN: Datatype access property list.
*
* @return a named datatype identifier if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - name is null.
**/
public static long H5Topen(long loc_id, String name, long tapl_id) throws HDF5LibraryException,
NullPointerException {
long id = _H5Topen2(loc_id, name, tapl_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Topen add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Topen2(long loc_id, String name, long tapl_id)
throws HDF5LibraryException, NullPointerException;
/**
* H5Tpack recursively removes padding from within a compound datatype to make it more efficient (space-wise) to
* store that data.
* <P>
* <b>WARNING:</b> This call only affects the C-data, even if it succeeds, there may be no visible effect on Java
* objects.
*
* @param type_id
* IN: Identifier of datatype to modify.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Tpack(long type_id) throws HDF5LibraryException;
/**
* H5Treclaim reclaims buffer used for VL data.
*
* @param type_id
* Identifier of the datatype.
* @param space_id
* Identifier of the dataspace.
* @param xfer_plist_id
* Identifier of a transfer property list for this I/O operation.
* @param buf
* Buffer with data to be reclaimed.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
* @exception NullPointerException
* - buf is null.
**/
public synchronized static native void H5Treclaim(long type_id, long space_id, long xfer_plist_id, byte[] buf)
throws HDF5LibraryException, NullPointerException;
/**
* H5Tvlen_create creates a new variable-length (VL) dataype.
*
* @param base_id
* IN: Identifier of parent datatype.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public static long H5Tvlen_create(long base_id) throws HDF5LibraryException {
long id = _H5Tvlen_create(base_id);
if (id > 0) {
log.trace("OPEN_IDS: H5Tvlen_create add {}", id);
OPEN_IDS.add(id);
log.trace("OPEN_IDS: {}", OPEN_IDS.size());
}
return id;
}
private synchronized static native long _H5Tvlen_create(long base_id) throws HDF5LibraryException;
/**
* H5Tflush causes all buffers associated with a committed datatype to be immediately flushed to disk
* without removing the data from the cache.
*
* @param dtype_id
* IN: Identifier of the committed datatype to be flushed.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Tflush(long dtype_id) throws HDF5LibraryException;
/**
* H5Trefresh causes all buffers associated with a committed datatype to be cleared and immediately
* re-loaded with updated contents from disk. This function essentially closes the datatype, evicts
* all metadata associated with it from the cache, and then re-opens the datatype. The reopened datatype
* is automatically re-registered with the same ID.
*
* @param dtype_id
* IN: Identifier of the committed datatype to be refreshed.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5Trefresh(long dtype_id) throws HDF5LibraryException;
// /////// unimplemented ////////
// H5T_conv_t H5Tfind(int src_id, int dst_id, H5T_cdata_t *pcdata);
// public synchronized static native int H5Tregister(H5T_pers_t pers, String name, int src_id, int dst_id,
// H5T_conv_t func)
// throws HDF5LibraryException, NullPointerException;
// public synchronized static native int H5Tunregister(H5T_pers_t pers, String name, int src_id, int dst_id,
// H5T_conv_t func)
// throws HDF5LibraryException, NullPointerException;
// ////////////////////////////////////////////////////////////
// //
// H5VL: VOL Interface Functions //
// //
// ////////////////////////////////////////////////////////////
/// VOL Connector Functionality
/**
* H5VLregister_connector_by_name registers a new VOL connector as a member of the virtual object layer class.
*
* @param connector_name
* IN: name of the connector.
* @param vipl_id
* IN: VOL initialization property list which must be
* created with H5Pcreate(H5P_VOL_INITIALIZE) (or H5P_DEFAULT).
*
* @return a VOL connector ID
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5VLregister_connector_by_name(String connector_name, long vipl_id);
/**
* H5VLregister_connector_by_value registers a new VOL connector as a member of the virtual object layer class.
*
* @param connector_value
* IN: value of the connector.
* @param vipl_id
* IN: VOL initialization property list which must be
* created with H5Pcreate(H5P_VOL_INITIALIZE) (or H5P_DEFAULT).
*
* @return a VOL connector ID
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5VLregister_connector_by_value(int connector_value, long vipl_id);
/**
* H5VLis_connector_registered_by_name tests whether a VOL class has been registered.
*
* @param name
* IN: name of the connector.
*
* @return true if a VOL connector with that name has been registered
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5VLis_connector_registered_by_name(String name);
/**
* H5VLis_connector_registered_by_value tests whether a VOL class has been registered.
*
* @param connector_value
* IN: value of the connector.
*
* @return true if a VOL connector with that value has been registered
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native boolean H5VLis_connector_registered_by_value(int connector_value);
/**
* H5VLget_connector_id retrieves the ID for a registered VOL connector for a given object.
*
* @param object_id
* IN: Identifier of the object.
*
* @return a VOL connector ID
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5VLget_connector_id(long object_id);
/**
* H5VLget_connector_id_by_name retrieves the ID for a registered VOL connector.
*
* @param name
* IN: name of the connector.
*
* @return a VOL connector ID
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5VLget_connector_id_by_name(String name);
/**
* H5VLget_connector_id_by_value retrieves the ID for a registered VOL connector.
*
* @param connector_value
* IN: value of the connector.
*
* @return a VOL connector ID
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native long H5VLget_connector_id_by_value(int connector_value);
/**
* H5VLget_connector_name returns the connector name for the VOL associated with the
* object or file ID.
*
* @param object_id
* IN: Identifier of the object.
*
* @return the connector name
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native String H5VLget_connector_name(long object_id);
/**
* H5VLclose closes a VOL connector ID.
*
* @param connector_id
* IN: Identifier of the connector.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5VLclose(long connector_id);
/**
* H5VLunregister_connector removes a VOL connector ID from the library.
*
* @param connector_id
* IN: Identifier of the connector.
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native void H5VLunregister_connector(long connector_id);
// /////// unimplemented ////////
// hid_t H5VLregister_connector(const H5VL_class_t *cls, hid_t vipl_id);
// ////////////////////////////////////////////////////////////
// //
// H5Z: Filter Interface Functions //
// //
// ////////////////////////////////////////////////////////////
/**
* H5Zfilter_avail checks if a filter is available.
*
* @param filter
* IN: filter number.
*
* @return a non-negative(TRUE/FALSE) value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Zfilter_avail(int filter) throws HDF5LibraryException;
/**
* H5Zget_filter_info gets information about a pipeline data filter.
*
* @param filter
* IN: filter number.
*
* @return the filter information flags
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Zget_filter_info(int filter) throws HDF5LibraryException;
/**
* H5Zunregister unregisters a filter.
*
* @param filter
* IN: filter number.
*
* @return a non-negative value if successful
*
* @exception HDF5LibraryException
* - Error from the HDF-5 Library.
**/
public synchronized static native int H5Zunregister(int filter) throws HDF5LibraryException;
// /////// unimplemented ////////
// herr_t H5Zregister(const void *cls);
}
|