/usr/share/doc/netcdf-doc/netcdf-c.html is in netcdf-doc 1:4.1.3-7ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <html lang="en">
<head>
<title>NetCDF C Interface Guide</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="NetCDF C Interface Guide">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="top" href="#Top">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2005-2009 University Corporation for
Atmospheric Research
Permission is granted to make and distribute verbatim copies of this
manual provided that the copyright notice and these paragraphs are
preserved on all copies. The software and any accompanying written
materials are provided ``as is'' without warranty of any kind. UCAR
expressly disclaims all warranties of any kind, either expressed or
implied, including but not limited to the implied warranties of
merchantability and fitness for a particular purpose.
The Unidata Program Center is managed by the University
Corporation for Atmospheric Research and sponsored by the National
Science Foundation. Any opinions, findings, conclusions, or
recommendations expressed in this publication are those of the
author(s) and do not necessarily reflect the views of the National
Science Foundation.
Mention of any commercial company or product in this document
does not constitute an endorsement by the Unidata Program Center.
Unidata does not authorize any use of information from this
publication for advertising or publicity purposes.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<h1 class="settitle">NetCDF C Interface Guide</h1>
<div class="node">
<a name="Top"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a>,
Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
</div>
<h2 class="unnumbered">The NetCDF C Interface Guide</h2>
<p>This document describes the C interface to the netCDF library; it
applies to netCDF version 4.1.3 and was last updated on
30 June 2011.
<p>For a complete description of the netCDF format and utilities see
<a href="netcdf.html#Top">The NetCDF Users Guide</a>.
<ul class="menu">
<li><a accesskey="1" href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a>
<li><a accesskey="2" href="#Datasets">Datasets</a>
<li><a accesskey="3" href="#Groups">Groups</a>
<li><a accesskey="4" href="#Dimensions">Dimensions</a>
<li><a accesskey="5" href="#User-Defined-Data-Types">User Defined Data Types</a>
<li><a accesskey="6" href="#Variables">Variables</a>
<li><a accesskey="7" href="#Attributes">Attributes</a>
<li><a accesskey="8" href="#Summary-of-C-Interface">Summary of C Interface</a>
<li><a accesskey="9" href="#NetCDF-3-Transition-Guide">NetCDF 3 Transition Guide</a>
<li><a href="#NetCDF-2-C-Transition-Guide">NetCDF 2 C Transition Guide</a>
<li><a href="#NetCDF_002d3-Error-Codes">NetCDF-3 Error Codes</a>
<li><a href="#NetCDF_002d4-Error-Codes">NetCDF-4 Error Codes</a>
<li><a href="#DAP-Error-Codes">DAP Error Codes</a>
<li><a href="#Combined-Index">Combined Index</a>
</li></ul>
<p>--- The Detailed Node Listing ---
<p>Use of the NetCDF Library
</p>
<ul class="menu">
<li><a href="#Creating">Creating</a>: Creating a NetCDF Dataset
<li><a href="#Reading-Known">Reading Known </a>: Reading a NetCDF Dataset with Known Names
<li><a href="#Reading-Unknown">Reading Unknown </a>: Reading a netCDF Dataset with Unknown Names
<li><a href="#Adding">Adding</a>: Adding New Dimensions, Variables, Attributes
<li><a href="#Errors">Errors</a>: Error Handling
<li><a href="#Compiling">Compiling</a>: Compiling and Linking with the NetCDF Library
</li></ul>
<p>Datasets
</p>
<ul class="menu">
<li><a href="#Interface-Descriptions">Interface Descriptions</a>: What's in the Function Documentation
<li><a href="#parallel-access">parallel access</a>
<li><a href="#nc_005fstrerror">nc_strerror</a>: Get Error Messages
<li><a href="#nc_005finq_005flibvers">nc_inq_libvers</a>: Get netCDF library version
<li><a href="#nc_005fcreate">nc_create</a>: Create a Dataset
<li><a href="#nc_005f_005fcreate">nc__create</a>: Create a Dataset with Performance Tuning
<li><a href="#nc_005fcreate_005fpar">nc_create_par</a>
<li><a href="#nc_005fopen">nc_open</a>: Open a Dataset
<li><a href="#nc_005f_005fopen">nc__open</a>: Open a Dataset with Performance Tuning
<li><a href="#nc_005fopen_005fpar">nc_open_par</a>
<li><a href="#nc_005fredef">nc_redef</a>: Put a Dataset into Define Mode
<li><a href="#nc_005fenddef">nc_enddef</a>: Leave Define Mode
<li><a href="#nc_005f_005fenddef">nc__enddef</a>: Leave Define Mode with Performance Tuning
<li><a href="#nc_005fclose">nc_close</a>: Close a Dataset
<li><a href="#nc_005finq-Family">nc_inq Family</a>: Inquire about a Dataset
<li><a href="#nc_005fsync">nc_sync</a>: Synchronize a Dataset to Disk
<li><a href="#nc_005fabort">nc_abort</a>: Back Out of Recent Definitions
<li><a href="#nc_005fset_005ffill">nc_set_fill</a>: Set Fill Mode for Writes
<li><a href="#nc_005fset_005fdefault_005fformat">nc_set_default_format</a>: Change the default output format
<li><a href="#nc_005fset_005fchunk_005fcache">nc_set_chunk_cache</a>
<li><a href="#nc_005fget_005fchunk_005fcache">nc_get_chunk_cache</a>
</li></ul>
<p>Groups
</p>
<ul class="menu">
<li><a href="#nc_005finq_005fncid">nc_inq_ncid</a>
<li><a href="#nc_005finq_005fgrps">nc_inq_grps</a>
<li><a href="#nc_005finq_005fvarids">nc_inq_varids</a>
<li><a href="#nc_005finq_005fdimids">nc_inq_dimids</a>
<li><a href="#nc_005finq_005fgrpname">nc_inq_grpname</a>
<li><a href="#nc_005finq_005fgrpname_005ffull">nc_inq_grpname_full</a>
<li><a href="#nc_005finq_005fgrpname_005flen">nc_inq_grpname_len</a>
<li><a href="#nc_005finq_005fgrp_005fparent">nc_inq_grp_parent</a>
<li><a href="#nc_005finq_005fgrp_005fncid">nc_inq_grp_ncid</a>
<li><a href="#nc_005finq_005fgrp_005ffull_005fncid">nc_inq_grp_full_ncid</a>
<li><a href="#nc_005fdef_005fgrp">nc_def_grp</a>
</li></ul>
<p>Dimensions
</p>
<ul class="menu">
<li><a href="#Dimensions-Introduction">Dimensions Introduction</a>
<li><a href="#nc_005fdef_005fdim">nc_def_dim</a>: Create a Dimension
<li><a href="#nc_005finq_005fdimid">nc_inq_dimid</a>: Get a Dimension ID from Its Name
<li><a href="#nc_005finq_005fdim-Family">nc_inq_dim Family</a>: Inquire about a Dimension
<li><a href="#nc_005frename_005fdim">nc_rename_dim</a>: Rename a Dimension
<li><a href="#nc_005finq_005funlimdims">nc_inq_unlimdims</a>
</li></ul>
<p>User Defined Data Types
</p>
<ul class="menu">
<li><a href="#User-Defined-Types">User Defined Types</a>
<li><a href="#nc_005finq_005ftypeids">nc_inq_typeids</a>
<li><a href="#nc_005finq_005ftypeid">nc_inq_typeid</a>
<li><a href="#nc_005finq_005ftype">nc_inq_type</a>
<li><a href="#nc_005finq_005fuser_005ftype">nc_inq_user_type</a>
<li><a href="#Compound-Types">Compound Types</a>
<li><a href="#nc_005fdef_005fcompound">nc_def_compound</a>
<li><a href="#nc_005finsert_005fcompound">nc_insert_compound</a>
<li><a href="#nc_005finsert_005farray_005fcompound">nc_insert_array_compound</a>
<li><a href="#nc_005finq_005fcompound">nc_inq_compound</a>
<li><a href="#nc_005finq_005fcompound_005fname">nc_inq_compound_name</a>
<li><a href="#nc_005finq_005fcompound_005fsize">nc_inq_compound_size</a>
<li><a href="#nc_005finq_005fcompound_005fnfields">nc_inq_compound_nfields</a>
<li><a href="#nc_005finq_005fcompound_005ffield">nc_inq_compound_field</a>
<li><a href="#nc_005finq_005fcompound_005ffieldname">nc_inq_compound_fieldname</a>
<li><a href="#nc_005finq_005fcompound_005ffieldindex">nc_inq_compound_fieldindex</a>
<li><a href="#nc_005finq_005fcompound_005ffieldoffset">nc_inq_compound_fieldoffset</a>
<li><a href="#nc_005finq_005fcompound_005ffieldtype">nc_inq_compound_fieldtype</a>
<li><a href="#nc_005finq_005fcompound_005ffieldndims">nc_inq_compound_fieldndims</a>
<li><a href="#nc_005finq_005fcompound_005ffielddim_005fsizes">nc_inq_compound_fielddim_sizes</a>
<li><a href="#Variable-Length-Array">Variable Length Array</a>
<li><a href="#nc_005fdef_005fvlen">nc_def_vlen</a>
<li><a href="#nc_005finq_005fvlen">nc_inq_vlen</a>
<li><a href="#nc_005ffree_005fvlen">nc_free_vlen</a>
<li><a href="#nc_005ffree_005fvlens">nc_free_vlens</a>
<li><a href="#Opaque-Type">Opaque Type</a>
<li><a href="#nc_005fdef_005fopaque">nc_def_opaque</a>
<li><a href="#nc_005finq_005fopaque">nc_inq_opaque</a>
<li><a href="#Enum-Type">Enum Type</a>
<li><a href="#nc_005fdef_005fenum">nc_def_enum</a>
<li><a href="#nc_005finsert_005fenum">nc_insert_enum</a>
<li><a href="#nc_005finq_005fenum">nc_inq_enum</a>
<li><a href="#nc_005finq_005fenum_005fmember">nc_inq_enum_member</a>
<li><a href="#nc_005finq_005fenum_005fident">nc_inq_enum_ident</a>
</li></ul>
<p>Compound Types Introduction
</p>
<ul class="menu">
<li><a href="#nc_005fdef_005fcompound">nc_def_compound</a>
<li><a href="#nc_005finsert_005fcompound">nc_insert_compound</a>
<li><a href="#nc_005finq_005fcompound">nc_inq_compound</a>
<li><a href="#nc_005finq_005fcompound_005ffieldname">nc_inq_compound_fieldname</a>
<li><a href="#nc_005finq_005fcompound_005ffieldindex">nc_inq_compound_fieldindex</a>
<li><a href="#nc_005finq_005fcompound_005ffieldoffset">nc_inq_compound_fieldoffset</a>
<li><a href="#nc_005finq_005fcompound_005ffieldtype">nc_inq_compound_fieldtype</a>
</li></ul>
<p>Variables
</p>
<ul class="menu">
<li><a href="#Variable-Introduction">Variable Introduction</a>
<li><a href="#Variable-Types">Variable Types</a>
<li><a href="#NetCDF_002d3-Variable-Types">NetCDF-3 Variable Types</a>
<li><a href="#NetCDF_002d4-Atomic-Types">NetCDF-4 Atomic Types</a>
<li><a href="#nc_005fdef_005fvar">nc_def_var</a>: Create a Variable
<li><a href="#nc_005fdef_005fvar_005fchunking">nc_def_var_chunking</a>: Set chunking parameters
<li><a href="#nc_005finq_005fvar_005fchunking">nc_inq_var_chunking</a>: Learn about chunking parameters
<li><a href="#nc_005fset_005fvar_005fchunk_005fcache">nc_set_var_chunk_cache</a>
<li><a href="#nc_005fget_005fvar_005fchunk_005fcache">nc_get_var_chunk_cache</a>
<li><a href="#nc_005fdef_005fvar_005ffill">nc_def_var_fill</a>
<li><a href="#nc_005finq_005fvar_005ffill">nc_inq_var_fill</a>
<li><a href="#nc_005fdef_005fvar_005fdeflate">nc_def_var_deflate</a>: Set compression parameters
<li><a href="#nc_005finq_005fvar_005fdeflate">nc_inq_var_deflate</a>: Learn about compression parameters
<li><a href="#nc_005finq_005fvar_005fszip">nc_inq_var_szip</a>
<li><a href="#nc_005fdef_005fvar_005ffletcher32">nc_def_var_fletcher32</a>: Set checksum filter
<li><a href="#nc_005finq_005fvar_005ffletcher32">nc_inq_var_fletcher32</a>: Learn if checksum filter is set
<li><a href="#nc_005fdef_005fvar_005fendian">nc_def_var_endian</a>
<li><a href="#nc_005finq_005fvar_005fendian">nc_inq_var_endian</a>
<li><a href="#nc_005finq_005fvarid">nc_inq_varid</a>: Get a Variable ID from Its Name
<li><a href="#nc_005finq_005fvar">nc_inq_var</a>: Get Information about a Variable from Its ID
<li><a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a>: Write a Single Data Value
<li><a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a>: Write an Entire Variable
<li><a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a>: Write an Array of Values
<li><a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a>: Write a Subsampled Array of Values
<li><a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a>: Write a Mapped Array of Values
<li><a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a>: Read a Single Data Value
<li><a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a>: Read an Entire Variable
<li><a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a>: Read an Array of Values
<li><a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a>: Read a Subsampled Array of Values
<li><a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a>: Read a Mapped Array of Values
<li><a href="#Strings">Strings</a>: Reading and Writing Character String Values
<li><a href="#nc_005ffree_005fstring">nc_free_string</a>
<li><a href="#Fill-Values">Fill Values</a>: What's Written Where there's No Data?
<li><a href="#nc_005frename_005fvar">nc_rename_var</a>: Rename a Variable
<li><a href="#nc_005fcopy_005fvar">nc_copy_var</a>
<li><a href="#nc_005fvar_005fpar_005faccess">nc_var_par_access</a>
<li><a href="#nc_005fvar_005fubyte">nc_var_ubyte</a>
</li></ul>
<p>Reading and Writing Character String Values
</p>
<ul class="menu">
<li><a href="#Classic-Strings">Classic Strings</a>
<li><a href="#Arrays-of-Strings">Arrays of Strings</a>
</li></ul>
<p>Attributes
</p>
<ul class="menu">
<li><a href="#Attributes-Introduction">Attributes Introduction</a>
<li><a href="#nc_005fput_005fatt_005f-type">nc_put_att_ type</a>
<li><a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a>
<li><a href="#nc_005fget_005fatt_005f-type">nc_get_att_ type</a>
<li><a href="#nc_005fcopy_005fatt">nc_copy_att</a>
<li><a href="#nc_005frename_005fatt">nc_rename_att</a>
<li><a href="#nc_005fdel_005fatt">nc_del_att</a>
</ul>
<div class="node">
<a name="Use-of-the-NetCDF-Library"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Datasets">Datasets</a>,
Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">1 Use of the NetCDF Library</h2>
<p><a name="index-nc_005fcreate_002c-typical-use-1"></a><a name="index-nc_005fdef_005fdim_002c-typical-use-2"></a><a name="index-nc_005fdef_005fvar_002c-typical-use-3"></a><a name="index-nc_005fput_005fatt_002c-typical-use-4"></a><a name="index-nc_005fenddef_002c-typical-use-5"></a><a name="index-nc_005fput_005fvar_002c-typical-use-6"></a><a name="index-nc_005fclose_002c-typical-use-7"></a><a name="index-creating-a-dataset-8"></a><a name="index-abnormal-termination-9"></a><a name="index-call-sequence_002c-typical-10"></a><a name="index-templates_002c-code-11"></a><a name="index-code-templates-12"></a><a name="index-NC_005fSHARE_002c-and-buffering-13"></a>
You can use the netCDF library without knowing about all of the netCDF
interface. If you are creating a netCDF dataset, only a handful of
routines are required to define the necessary dimensions, variables,
and attributes, and to write the data to the netCDF dataset. (Even
less is needed if you use the ncgen utility to create the dataset
before running a program using netCDF library calls to write data.)
Similarly, if you are writing software to access data stored in a
particular netCDF object, only a small subset of the netCDF library is
required to open the netCDF dataset and access the data. Authors of
generic applications that access arbitrary netCDF datasets need to be
familiar with more of the netCDF library.
<p>In this chapter we provide templates of common sequences of netCDF
calls needed for common uses. For clarity we present only the names of
routines; omit declarations and error checking; omit the type-specific
suffixes of routine names for variables and attributes; indent
statements that are typically invoked multiple times; and use ... to
represent arbitrary sequences of other statements. Full parameter
lists are described in later chapters.
<ul class="menu">
<li><a accesskey="1" href="#Creating">Creating</a>: Creating a NetCDF Dataset
<li><a accesskey="2" href="#Reading-Known">Reading Known </a>: Reading a NetCDF Dataset with Known Names
<li><a accesskey="3" href="#Reading-Unknown">Reading Unknown </a>: Reading a netCDF Dataset with Unknown Names
<li><a accesskey="4" href="#Adding">Adding</a>: Adding New Dimensions, Variables, Attributes
<li><a accesskey="5" href="#Errors">Errors</a>: Error Handling
<li><a accesskey="6" href="#Compiling">Compiling</a>: Compiling and Linking with the NetCDF Library
</ul>
<div class="node">
<a name="Creating"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Reading-Known">Reading Known</a>,
Previous: <a rel="previous" accesskey="p" href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a>,
Up: <a rel="up" accesskey="u" href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a>
</div>
<h3 class="section">1.1 Creating a NetCDF Dataset</h3>
<p>Here is a typical sequence of netCDF calls used to create a new netCDF dataset:
<pre class="example"> nc_create /* create netCDF dataset: enter define mode */
...
nc_def_dim /* define dimensions: from name and length */
...
nc_def_var /* define variables: from name, type, ... */
...
nc_put_att /* put attribute: assign attribute values */
...
nc_enddef /* end definitions: leave define mode */
...
nc_put_var /* provide values for variables */
...
nc_close /* close: save new netCDF dataset */
</pre>
<p>Only one call is needed to create a netCDF dataset, at which point you
will be in the first of two netCDF modes. When accessing an open
netCDF dataset, it is either in define mode or data mode. In define
mode, you can create dimensions, variables, and new attributes, but
you cannot read or write variable data. In data mode, you can access
data and change existing attributes, but you are not permitted to
create new dimensions, variables, or attributes.
<p>One call to nc_def_dim is needed for each dimension
created. Similarly, one call to nc_def_var is needed for each variable
creation, and one call to a member of the nc_put_att family is needed
for each attribute defined and assigned a value. To leave define mode
and enter data mode, call nc_enddef.
<p>Once in data mode, you can add new data to variables, change old
values, and change values of existing attributes (so long as the
attribute changes do not require more storage space). Single values
may be written to a netCDF variable with one of the members of the
nc_put_var1 family, depending on what type of data you have to
write. All the values of a variable may be written at once with one of
the members of the nc_put_var family. Arrays or array cross-sections
of a variable may be written using members of the nc_put_vara
family. Subsampled array sections may be written using members of the
nc_put_vars family. Mapped array sections may be written using members
of the nc_put_varm family. (Subsampled and mapped access are general
forms of data access that are explained later.)
<p>Finally, you should explicitly close all netCDF datasets that have
been opened for writing by calling nc_close. By default, access to the
file system is buffered by the netCDF library. If a program terminates
abnormally with netCDF datasets open for writing, your most recent
modifications may be lost. This default buffering of data is disabled
by setting the NC_SHARE flag when opening the dataset. But even if
this flag is set, changes to attribute values or changes made in
define mode are not written out until nc_sync or nc_close is called.
<div class="node">
<a name="Reading-Known"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Reading-Unknown">Reading Unknown</a>,
Previous: <a rel="previous" accesskey="p" href="#Creating">Creating</a>,
Up: <a rel="up" accesskey="u" href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a>
</div>
<h3 class="section">1.2 Reading a NetCDF Dataset with Known Names</h3>
<p><a name="index-nc_005finq_005fdimid_002c-typical-use-14"></a><a name="index-nc_005finq_005fvarid_002c-typical-use-15"></a><a name="index-nc_005fget_005fatt_002c-typical-use-16"></a><a name="index-nc_005fget_005fvar_002c-typical-use-17"></a><a name="index-reading-netCDF-dataset-with-known-names-18"></a>
Here we consider the case where you know the names of not only the
netCDF datasets, but also the names of their dimensions, variables,
and attributes. (Otherwise you would have to do "inquire" calls.) The
order of typical C calls to read data from those variables in a netCDF
dataset is:
<pre class="example"> nc_open /* open existing netCDF dataset */
...
nc_inq_dimid /* get dimension IDs */
...
nc_inq_varid /* get variable IDs */
...
nc_get_att /* get attribute values */
...
nc_get_var /* get values of variables */
...
nc_close /* close netCDF dataset */
</pre>
<p>First, a single call opens the netCDF dataset, given the dataset name,
and returns a netCDF ID that is used to refer to the open netCDF
dataset in all subsequent calls.
<p>Next, a call to nc_inq_dimid for each dimension of interest gets the
dimension ID from the dimension name. Similarly, each required
variable ID is determined from its name by a call to nc_inq_varid Once
variable IDs are known, variable attribute values can be retrieved
using the netCDF ID, the variable ID, and the desired attribute name
as input to a member of the nc_get_att family (typically
nc_get_att_text or nc_get_att_double) for each desired
attribute. Variable data values can be directly accessed from the
netCDF dataset with calls to members of the nc_get_var1 family for
single values, the nc_get_var family for entire variables, or various
other members of the nc_get_vara, nc_get_vars, or nc_get_varm families
for array, subsampled or mapped access.
<p>Finally, the netCDF dataset is closed with nc_close. There is no need
to close a dataset open only for reading.
<div class="node">
<a name="Reading-Unknown"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Adding">Adding</a>,
Previous: <a rel="previous" accesskey="p" href="#Reading-Known">Reading Known</a>,
Up: <a rel="up" accesskey="u" href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a>
</div>
<h3 class="section">1.3 Reading a netCDF Dataset with Unknown Names</h3>
<p><a name="index-nc_005finq_002c-typical-use-19"></a><a name="index-nc_005finq_005fdim_002c-typical-use-20"></a><a name="index-nc_005finq_005fvar_002c-typical-use-21"></a><a name="index-nc_005finq_005fatt_002c-typical-use-22"></a><a name="index-nc_005fget_005fatt_002c-typical-use-23"></a><a name="index-nc_005fget_005fvar_002c-typical-use-24"></a><a name="index-reading-netCDF-dataset-with-unknown-names-25"></a>
It is possible to write programs (e.g., generic software) which do
such things as processing every variable, without needing to know in
advance the names of these variables. Similarly, the names of
dimensions and attributes may be unknown.
<p>Names and other information about netCDF objects may be obtained from
netCDF datasets by calling inquire functions. These return information
about a whole netCDF dataset, a dimension, a variable, or an
attribute. The following template illustrates how they are used:
<pre class="example"> nc_open /* open existing netCDF dataset */
...
nc_inq /* find out what is in it */
...
nc_inq_dim /* get dimension names, lengths */
...
nc_inq_var /* get variable names, types, shapes */
...
nc_inq_attname /* get attribute names */
...
nc_inq_att /* get attribute types and lengths */
...
nc_get_att /* get attribute values */
...
nc_get_var /* get values of variables */
...
nc_close /* close netCDF dataset */
</pre>
<p>As in the previous example, a single call opens the existing netCDF
dataset, returning a netCDF ID. This netCDF ID is given to the nc_inq
routine, which returns the number of dimensions, the number of
variables, the number of global attributes, and the ID of the
unlimited dimension, if there is one.
<p>All the inquire functions are inexpensive to use and require no I/O,
since the information they provide is stored in memory when a netCDF
dataset is first opened.
<p>Dimension IDs use consecutive integers, beginning at 0. Also
dimensions, once created, cannot be deleted. Therefore, knowing the
number of dimension IDs in a netCDF dataset means knowing all the
dimension IDs: they are the integers 0, 1, 2, ...up to the number of
dimensions. For each dimension ID, a call to the inquire function
nc_inq_dim returns the dimension name and length.
<p>Variable IDs are also assigned from consecutive integers 0, 1, 2,
... up to the number of variables. These can be used in nc_inq_var
calls to find out the names, types, shapes, and the number of
attributes assigned to each variable.
<p>Once the number of attributes for a variable is known, successive
calls to nc_inq_attname return the name for each attribute given the
netCDF ID, variable ID, and attribute number. Armed with the attribute
name, a call to nc_inq_att returns its type and length. Given the type
and length, you can allocate enough space to hold the attribute
values. Then a call to a member of the nc_get_att family returns the
attribute values.
<p>Once the IDs and shapes of netCDF variables are known, data values can
be accessed by calling a member of the nc_get_var1 family for single
values, or members of the nc_get_var, nc_get_vara, nc_get_vars, or
nc_get_varm for various kinds of array access.
<div class="node">
<a name="Adding"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Errors">Errors</a>,
Previous: <a rel="previous" accesskey="p" href="#Reading-Unknown">Reading Unknown</a>,
Up: <a rel="up" accesskey="u" href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a>
</div>
<h3 class="section">1.4 Adding New Dimensions, Variables, Attributes</h3>
<p><a name="index-nc_005fredef_002c-typical-use-26"></a><a name="index-nc_005fdef_005fdim_002c-typical-use-27"></a><a name="index-nc_005fput_005fatt_002c-typical-use-28"></a><a name="index-dimensions_002c-adding-29"></a><a name="index-variables_002c-adding-30"></a><a name="index-attributes_002c-adding-31"></a><a name="index-aborting-define-mode-32"></a><a name="index-aborting-definitions-33"></a><a name="index-adding-dimensions-34"></a><a name="index-adding-attributes-35"></a><a name="index-adding-variables-36"></a><a name="index-attributes_002c-deleting_002c-introduction-37"></a><a name="index-NC_005fSHARE-38"></a>
An existing netCDF dataset can be extensively altered. New dimensions,
variables, and attributes can be added or existing ones renamed, and
existing attributes can be deleted. Existing dimensions, variables,
and attributes can be renamed. The following code template lists a
typical sequence of calls to add new netCDF components to an existing
dataset:
<pre class="example"> nc_open /* open existing netCDF dataset */
...
nc_redef /* put it into define mode */
...
nc_def_dim /* define additional dimensions (if any) */
...
nc_def_var /* define additional variables (if any) */
...
nc_put_att /* define additional attributes (if any) */
...
nc_enddef /* check definitions, leave define mode */
...
nc_put_var /* provide values for new variables */
...
nc_close /* close netCDF dataset */
</pre>
<p>A netCDF dataset is first opened by the nc_open call. This call puts
the open dataset in data mode, which means existing data values can be
accessed and changed, existing attributes can be changed (so long as
they do not grow), but nothing can be added. To add new netCDF
dimensions, variables, or attributes you must enter define mode, by
calling nc_redef. In define mode, call nc_def_dim to define new
dimensions, nc_def_var to define new variables, and a member of the
nc_put_att family to assign new attributes to variables or enlarge old
attributes.
<p>You can leave define mode and reenter data mode, checking all the new
definitions for consistency and committing the changes to disk, by
calling nc_enddef. If you do not wish to reenter data mode, just call
nc_close, which will have the effect of first calling nc_enddef.
<p>Until the nc_enddef call, you may back out of all the redefinitions
made in define mode and restore the previous state of the netCDF
dataset by calling nc_abort. You may also use the nc_abort call to
restore the netCDF dataset to a consistent state if the call to
nc_enddef fails. If you have called nc_close from definition mode and
the implied call to nc_enddef fails, nc_abort will automatically be
called to close the netCDF dataset and leave it in its previous
consistent state (before you entered define mode).
<p>For netCDF-4/HDF5 format files, define mode is still important, but
the user does not have to called nc_enddef - it is called
automatically when needed. It may also be called by the user.
<p>In netCDF-4/HDF5 files, there are some settings which can only be
modified during the very first define mode of the file. For example
the compression level of a variable may be set only after the
nc_def_var call and before the next nc_enddef call, whether it is
called by the user explicitly, or when the user tries to read or write
some data.
<p>At most one process should have a netCDF dataset open for writing at
one time. The library is designed to provide limited support for
multiple concurrent readers with one writer, via disciplined use of
the nc_sync function and the NC_SHARE flag. If a writer makes changes
in define mode, such as the addition of new variables, dimensions, or
attributes, some means external to the library is necessary to prevent
readers from making concurrent accesses and to inform readers to call
nc_sync before the next access.
<div class="node">
<a name="Errors"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Compiling">Compiling</a>,
Previous: <a rel="previous" accesskey="p" href="#Adding">Adding</a>,
Up: <a rel="up" accesskey="u" href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a>
</div>
<h3 class="section">1.5 Error Handling</h3>
<p><a name="index-nc_005fstrerror_002c-introduction-39"></a><a name="index-error-handling-40"></a><a name="index-write-errors-41"></a>
The netCDF library provides the facilities needed to handle errors in
a flexible way. Each netCDF function returns an integer status
value. If the returned status value indicates an error, you may handle
it in any way desired, from printing an associated error message and
exiting to ignoring the error indication and proceeding (not
recommended!). For simplicity, the examples in this guide check the
error status and call a separate function, handle_err(), to handle any
errors. One possible definition of handle_err() can be found within the
documentation of nc_strerror (see <a href="#nc_005fstrerror">nc_strerror</a>).
<p>The nc_strerror function is available to convert a returned integer
error status into an error message string.
<p>Occasionally, low-level I/O errors may occur in a layer below the
netCDF library. For example, if a write operation causes you to exceed
disk quotas or to attempt to write to a device that is no longer
available, you may get an error from a layer below the netCDF library,
but the resulting write error will still be reflected in the returned
status value.
<div class="node">
<a name="Compiling"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Errors">Errors</a>,
Up: <a rel="up" accesskey="u" href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a>
</div>
<h3 class="section">1.6 Compiling and Linking with the NetCDF Library</h3>
<p><a name="index-linking-to-netCDF-library-42"></a><a name="index-compiling-with-netCDF-library-43"></a>
Details of how to compile and link a program that uses the netCDF C or
FORTRAN interfaces differ, depending on the operating system, the
available compilers, where the netCDF library and include files
are installed, and whether or not you are using shared libraries.
Nevertheless, we provide here examples of how to
compile and link a program that uses the netCDF library on a Unix
platform, so that you can adjust these examples to fit your
installation.
<p>Every C file that references netCDF functions or constants must
contain an appropriate #include statement before the first such
reference:
<pre class="example"> #include <netcdf.h>
</pre>
<p>Unless the netcdf.h file is installed in a standard directory where
the C compiler always looks, you must use the -I option when invoking
the compiler, to specify a directory where netcdf.h is installed, for
example:
<pre class="example"> cc -c -I/usr/local/netcdf/include myprogram.c
</pre>
<p>Alternatively, you could specify an absolute path name in the #include
statement, but then your program would not compile on another platform
where netCDF is installed in a different location.
<p>Unless the netCDF library is installed in a standard directory where
the linker always looks, you must use the -L and -l options to link an
object file that uses the netCDF library.
<p>If the netCDF library was configured with the –enable-shared
flag, and the operating system supports shared libraries, then it
should be possible to link an application program using a relatively
simple command. For example:
<pre class="example"> cc -o myprogram myprogram.o -L/usr/local/netcdf/lib -lnetcdf
</pre>
<p>It should be noted that on some operating systems, when using
shared libraries, the application itself may need to be compiled
using some form of PIC (position independent code)
flag; the particular flag will depend
on the C compiler used. You should try it first without
any PIC flag, and if that fails, then check with the
system administrator about the proper form of PIC flag to use.
<p>In addition, for some C compilers (e.g. Sun's cc compiler)
it is necessary to specify runtime paths to the relevant libnetcdf.so.
This can be accomplished in one of two ways.
<ol type=1 start=1>
<li>Add the path to the directory containing libnetcdf.so
to the LD_LIBRARY_PATH environment variable.
This path is searched at runtime to locate any needed shared library.
This might be accomplished, for example, by the following shell command
(assuming that libnetcdf.so is in /usr/local/netcdf/lib).
<pre class="example"> LD_LIBRARY_PATH="/usr/local/netcdf/lib:$LD_LIBRARY_PATH"
export LD_LIBRARY_PATH
</pre>
<li>Set the so-called runtime path when the application is linked
so that the absolute paths of all needed shared libraries is
included in the application binary.
For gcc under Linus, this is usually automatic.
For C compilers on Solaris (and probably other operating systems)
the runtime path must be specified at
link time. The command in this case might look like this.
<pre class="example"> cc -o myprogram myprogram.o -L/usr/local/netcdf/lib -lnetcdf -R/usr/local/netcdf/lib
</pre>
<p>Note that the -R flag is also C compiler dependent.
For gcc and Linux, for example, the specification is usually of this form.
<pre class="example"> cc ... -Wl,-rpath,/usr/local/netcdf/lib
</pre>
<p>Other compilers may use other flags to specify this. Check
with the local system administrator.
</ol>
<p>If shared libraries are not supported or are not being used for some
reason, then it is necessary to include all the dependent libraries in
the compile command. For example, for a netCDF-4 enabled library, it
will be necessary to link with two HDF5 libraries,
at least one compression library, and
(on some systems) the math library.
<pre class="example"> cc -o myprogram myprogram.o -L/usr/local/netcdf/lib -L/usr/local/hdf5/lib -lnetcdf -lhdf5_hl -lhdf5 -lz
</pre>
<p>Other configuration features (e.g. DAP support or parallel IO)
may require additional libraries.
<p>A complete list of necessary libraries can be obtained by
executing the “nc-config –libs” command.
For example:
<pre class="example"> ./nc-config --libs
</pre>
<p>might return something like this:
<pre class="example"> -L/tmp/install/spock/lib -lnetcdf -L/upc/share/stdinstall/local/spock/lib
-lhdf5_hl -lhdf5 -L/upc/share/stdinstall/local/spock/lib -lz -lm
-L/upc/share/stdinstall/local/spock/lib -lcurl -L/usr/kerberos/lib64
-L/upc/share/stdinstall/local/spock/lib
-lidn -lssl -lcrypto -lldap -lrt -lssl -lcrypto -ldl -lz -lz
</pre>
<p>Obviously there is some redundancy in this list, so it can be reduced
somewhat to produce this slightly simpler list.
<pre class="example"> -L/tmp/install/spock/lib -lnetcdf
-L/upc/share/stdinstall/local/spock/lib -lhdf5 -lhdf5_hl -lz -lcurl
-L/usr/kerberos/lib64 -lcrypto -lssl
-ldl -lidn -lldap -lm -lrt
</pre>
<div class="node">
<a name="Datasets"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Groups">Groups</a>,
Previous: <a rel="previous" accesskey="p" href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">2 Datasets</h2>
<p><a name="index-datasets_002c-overview-44"></a>
This chapter presents the interfaces of the netCDF functions that deal
with a netCDF dataset or the whole netCDF library.
<p>A netCDF dataset that has not yet been opened can only be referred to
by its dataset name. Once a netCDF dataset is opened, it is referred
to by a netCDF ID, which is a small non-negative integer returned when
you create or open the dataset. A netCDF ID is much like a file
descriptor in C or a logical unit number in FORTRAN. In any single
program, the netCDF IDs of distinct open netCDF datasets are
distinct. A single netCDF dataset may be opened multiple times and
will then have multiple distinct netCDF IDs; however at most one of
the open instances of a single netCDF dataset should permit
writing. When an open netCDF dataset is closed, the ID is no longer
associated with a netCDF dataset.
<p>Functions that deal with the netCDF library include:
<ul>
<li>Get version of library.
<li>Get error message corresponding to a returned error code.
</ul>
<p>The operations supported on a netCDF dataset as a single object are:
<ul>
<li>Create, given dataset name and whether to overwrite or not.
<li>Open for access, given dataset name and read or write intent.
<li>Put into define mode, to add dimensions, variables, or attributes.
<li>Take out of define mode, checking consistency of additions.
<li>Close, writing to disk if required.
<li>Inquire about the number of dimensions, number of variables, number of
global attributes, and ID of the unlimited dimension, if any.
<li>Synchronize to disk to make sure it is current.
<li>Set and unset nofill mode for optimized sequential writes.
<li>After a summary of conventions used in describing the netCDF
interfaces, the rest of this chapter presents a detailed description
of the interfaces for these operations.
</ul>
<ul class="menu">
<li><a accesskey="1" href="#Interface-Descriptions">Interface Descriptions</a>: What's in the Function Documentation
<li><a accesskey="2" href="#parallel-access">parallel access</a>
<li><a accesskey="3" href="#nc_005fstrerror">nc_strerror</a>: Get Error Messages
<li><a accesskey="4" href="#nc_005finq_005flibvers">nc_inq_libvers</a>: Get netCDF library version
<li><a accesskey="5" href="#nc_005fcreate">nc_create</a>: Create a Dataset
<li><a accesskey="6" href="#nc_005f_005fcreate">nc__create</a>: Create a Dataset with Performance Tuning
<li><a accesskey="7" href="#nc_005fcreate_005fpar">nc_create_par</a>
<li><a accesskey="8" href="#nc_005fopen">nc_open</a>: Open a Dataset
<li><a accesskey="9" href="#nc_005f_005fopen">nc__open</a>: Open a Dataset with Performance Tuning
<li><a href="#nc_005fopen_005fpar">nc_open_par</a>
<li><a href="#nc_005fredef">nc_redef</a>: Put a Dataset into Define Mode
<li><a href="#nc_005fenddef">nc_enddef</a>: Leave Define Mode
<li><a href="#nc_005f_005fenddef">nc__enddef</a>: Leave Define Mode with Performance Tuning
<li><a href="#nc_005fclose">nc_close</a>: Close a Dataset
<li><a href="#nc_005finq-Family">nc_inq Family</a>: Inquire about a Dataset
<li><a href="#nc_005fsync">nc_sync</a>: Synchronize a Dataset to Disk
<li><a href="#nc_005fabort">nc_abort</a>: Back Out of Recent Definitions
<li><a href="#nc_005fset_005ffill">nc_set_fill</a>: Set Fill Mode for Writes
<li><a href="#nc_005fset_005fdefault_005fformat">nc_set_default_format</a>: Change the default output format
<li><a href="#nc_005fset_005fchunk_005fcache">nc_set_chunk_cache</a>
<li><a href="#nc_005fget_005fchunk_005fcache">nc_get_chunk_cache</a>
</ul>
<div class="node">
<a name="Interface-Descriptions"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#parallel-access">parallel access</a>,
Previous: <a rel="previous" accesskey="p" href="#Datasets">Datasets</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.1 NetCDF Library Interface Descriptions</h3>
<p><a name="index-interface-descriptions-45"></a>
Each interface description for a particular netCDF function in this
and later chapters contains:
<ul>
<li>a description of the purpose of the function;
<li>a C function prototype that presents the type and order of the formal
parameters to the function;
<li>a description of each formal parameter in the C interface;
<li>a list of possible error conditions; and
<li>an example of a C program fragment calling the netCDF function (and
perhaps other netCDF functions).
</ul>
<p>The examples follow a simple convention for error handling, always
checking the error status returned from each netCDF function call and
calling a handle_error function in case an error was detected. For an
example of such a function, see <a href="#nc_005fstrerror">nc_strerror</a>.
<div class="node">
<a name="parallel-access"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fstrerror">nc_strerror</a>,
Previous: <a rel="previous" accesskey="p" href="#Interface-Descriptions">Interface Descriptions</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.2 Parallel Access for NetCDF Files</h3>
<p><a name="index-parallel-access-46"></a><a name="index-parallel-example-47"></a>
To use parallel access, open or create the file with nc_open_par
(see <a href="#nc_005fopen_005fpar">nc_open_par</a>) or nc_create_par (see <a href="#nc_005fcreate_005fpar">nc_create_par</a>).
<p>The mode flag NC_PNETCDF will be automatically turned on for classic
or 64-bit offset files opened or created with the parallel access
functions.
<p>The following example shows the creation of a file using parallel
access with a netCDF-4/HDF5 file, and how a program might write data
to such a file.
<pre class="example"> #include "netcdf.h"
#include <mpi.h>
#include <assert.h>
#include "hdf5.h"
#include <string.h>
#include <stdlib.h>
#define BAIL(e) do { \
printf("Bailing out in file %s, line %d, error:%s.\n", __FILE__, __LINE__, nc_strerror(e)); \
return e; \
} while (0)
#define FILE "test_par.nc"
#define NDIMS 2
#define DIMSIZE 24
#define QTR_DATA (DIMSIZE*DIMSIZE/4)
#define NUM_PROC 4
int
main(int argc, char **argv)
{
/* MPI stuff. */
int mpi_namelen;
char mpi_name[MPI_MAX_PROCESSOR_NAME];
int mpi_size, mpi_rank;
MPI_Comm comm = MPI_COMM_WORLD;
MPI_Info info = MPI_INFO_NULL;
/* Netcdf-4 stuff. */
int ncid, v1id, dimids[NDIMS];
size_t start[NDIMS], count[NDIMS];
int data[DIMSIZE*DIMSIZE], j, i, res;
/* Initialize MPI. */
MPI_Init(&argc,&argv);
MPI_Comm_size(MPI_COMM_WORLD, &mpi_size);
MPI_Comm_rank(MPI_COMM_WORLD, &mpi_rank);
MPI_Get_processor_name(mpi_name, &mpi_namelen);
printf("mpi_name: %s size: %d rank: %d\n", mpi_name,
mpi_size, mpi_rank);
/* Create a parallel netcdf-4 file. */
if ((res = nc_create_par(FILE, NC_NETCDF4|NC_MPIIO, comm,
info, &ncid)))
BAIL(res);
/* Create two dimensions. */
if ((res = nc_def_dim(ncid, "d1", DIMSIZE, dimids)))
BAIL(res);
if ((res = nc_def_dim(ncid, "d2", DIMSIZE, &dimids[1])))
BAIL(res);
/* Create one var. */
if ((res = nc_def_var(ncid, "v1", NC_INT, NDIMS, dimids, &v1id)))
BAIL(res);
if ((res = nc_enddef(ncid)))
BAIL(res);
/* Set up slab for this process. */
start[0] = mpi_rank * DIMSIZE/mpi_size;
start[1] = 0;
count[0] = DIMSIZE/mpi_size;
count[1] = DIMSIZE;
printf("mpi_rank=%d start[0]=%d start[1]=%d count[0]=%d count[1]=%d\n",
mpi_rank, start[0], start[1], count[0], count[1]);
/* Create phony data. We're going to write a 24x24 array of ints,
in 4 sets of 144. */
printf("mpi_rank*QTR_DATA=%d (mpi_rank+1)*QTR_DATA-1=%d\n",
mpi_rank*QTR_DATA, (mpi_rank+1)*QTR_DATA);
for (i=mpi_rank*QTR_DATA; i<(mpi_rank+1)*QTR_DATA; i++)
data[i] = mpi_rank;
/*if ((res = nc_var_par_access(ncid, v1id, NC_COLLECTIVE)))
BAIL(res);*/
if ((res = nc_var_par_access(ncid, v1id, NC_INDEPENDENT)))
BAIL(res);
/* Write slabs of phony data. */
if ((res = nc_put_vara_int(ncid, v1id, start, count,
&data[mpi_rank*QTR_DATA])))
BAIL(res);
/* Close the netcdf file. */
if ((res = nc_close(ncid)))
BAIL(res);
/* Shut down MPI. */
MPI_Finalize();
return 0;
}
</pre>
<div class="node">
<a name="nc_strerror"></a>
<a name="nc_005fstrerror"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005flibvers">nc_inq_libvers</a>,
Previous: <a rel="previous" accesskey="p" href="#parallel-access">parallel access</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.3 Get error message corresponding to error status: nc_strerror</h3>
<p><a name="index-nc_005fstrerror-48"></a><a name="index-handle_005ferr-49"></a><a name="index-error-codes-50"></a><a name="index-nc_005fstrerror_002c-example-51"></a>
The function nc_strerror returns a static reference to an error
message string corresponding to an integer netCDF error status or to a
system error number, presumably returned by a previous call to some
other netCDF function. The list of netCDF error status codes is
available in the appropriate include file for each language binding.
<h3 class="heading">Usage</h3>
<pre class="example"> const char * nc_strerror(int ncerr);
</pre>
<dl>
<dt><code>ncerr</code><dd>An error status that might have been returned from a previous call to
some netCDF function.
</dl>
<h3 class="heading">Errors</h3>
<p>If you provide an invalid integer error status that does not
correspond to any netCDF error message or or to any system error
message (as understood by the system strerror function), nc_strerror
returns a string indicating that there is no such error status.
<h3 class="heading">Example</h3>
<p>Here is an example of a simple error handling function that uses
nc_strerror to print the error message corresponding to the netCDF
error status returned from any netCDF function call and then exit:
<pre class="example"> #include <netcdf.h>
...
void handle_error(int status) {
if (status != NC_NOERR) {
fprintf(stderr, "%s\n", nc_strerror(status));
exit(-1);
}
}
</pre>
<div class="node">
<a name="nc_inq_libvers"></a>
<a name="nc_005finq_005flibvers"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fcreate">nc_create</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fstrerror">nc_strerror</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.4 Get netCDF library version: nc_inq_libvers</h3>
<p><a name="index-nc_005finq_005flibvers-52"></a><a name="index-version-of-netCDF_002c-discovering-53"></a><a name="index-netCDF-library-version-54"></a><a name="index-nc_005finq_005flibvers_002c-example-55"></a>
The function nc_inq_libvers returns a string identifying the version
of the netCDF library, and when it was built.
<h3 class="heading">Usage</h3>
<pre class="example"> const char * nc_inq_libvers(void);
</pre>
<h3 class="heading">Errors</h3>
<p>This function takes no arguments, and thus no errors are possible in
its invocation.
<h3 class="heading">Example</h3>
<p>Here is an example using nc_inq_libvers to print the version of the
netCDF library with which the program is linked:
<pre class="example"> #include <netcdf.h>
...
printf("%s\n", nc_inq_libvers());
</pre>
<div class="node">
<a name="nc_create"></a>
<a name="nc_005fcreate"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005f_005fcreate">nc__create</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005flibvers">nc_inq_libvers</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.5 Create a NetCDF Dataset: nc_create</h3>
<p><a name="index-nc_005fcreate-56"></a><a name="index-nc_005fcreate_002c-example-57"></a><a name="index-nc_005fcreate_002c-flags-58"></a><a name="index-NC_005fNOCLOBBER-59"></a><a name="index-NC_005fCLOBBER-60"></a><a name="index-NC_005fSHARE-61"></a><a name="index-NC_005f64BIT_005fOFFSET-62"></a><a name="index-HDF5-errors_002c-first-create-63"></a>
This function creates a new netCDF dataset, returning a netCDF ID that
can subsequently be used to refer to the netCDF dataset in other
netCDF function calls. The new netCDF dataset opened for write access
and placed in define mode, ready for you to add dimensions, variables,
and attributes.
<p>A creation mode flag specifies:
<ul>
<li>whether to overwrite any existing dataset with the same name,
<li>whether access to the dataset is shared,
<li>whether this file should be in netCDF classic format (the default),
the new 64-bit offset format (use NC_64BIT_OFFSET), or NC_NETCDF4 for
a netCDF-4/HDF5 file.
</ul>
<h3 class="heading">Usage</h3>
<p>NOTE: When creating a netCDF-4 file HDF5 error reporting is turned
off, if it is on. This doesn't stop the HDF5 error stack from
recording the errors, it simply stops their display to the user
through stderr.
<pre class="example"> int nc_create (const char* path, int cmode, int *ncidp);
</pre>
<dl>
<dt><code>path</code><dd>The file name of the new netCDF dataset.
<br><dt><code>cmode</code><dd>The creation mode flag. The following flags are available:
NC_NOCLOBBER, NC_SHARE, NC_64BIT_OFFSET, NC_NETCDF4, NC_CLASSIC_MODEL.
<p>Setting NC_NOCLOBBER means you do not want to clobber (overwrite) an
existing dataset; an error (NC_EEXIST) is returned if the specified
dataset already exists.
<p>The NC_SHARE flag is appropriate when one process may be writing the
dataset and one or more other processes reading the dataset
concurrently; it means that dataset accesses are not buffered and
caching is limited. Since the buffering scheme is optimized for
sequential access, programs that do not access data sequentially may
see some performance improvement by setting the NC_SHARE flag. This
flag is ignored for netCDF-4 files. (See below.)
<p>Setting NC_64BIT_OFFSET causes netCDF to create a 64-bit offset format
file, instead of a netCDF classic format file. The 64-bit offset
format imposes far fewer restrictions on very large (i.e. over 2 GB)
data files. See <a href="netcdf.html#Large-File-Support">Large File Support</a>.
<p>A zero value (defined for convenience as NC_CLOBBER) specifies the
default behavior: overwrite any existing dataset with the same file
name and buffer and cache accesses for efficiency. The dataset will be
in netCDF classic format. See <a href="netcdf.html#NetCDF-Classic-Format-Limitations">NetCDF Classic Format Limitations</a>.
<p>Setting NC_NETCDF4 causes netCDF to create a HDF5/NetCDF-4 file.
<p>Setting NC_CLASSIC_MODEL causes netCDF to enforce the classic data
model in this file. (This only has effect for netCDF-4/HDF5 files, as
classic and 64-bit offset files always use the classic model.) When
used with NC_NETCDF4, this flag ensures that the resulting
netCDF-4/HDF5 file may never contain any new constructs from the
enhanced data model. That is, it cannot contain groups, user defined
types, multiple unlimited dimensions, or new atomic types. The
advantage of this restriction is that such files are guaranteed to
work with existing netCDF software.
<br><dt><code>ncidp</code><dd>Pointer to location where returned netCDF ID is to be stored.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_create returns the value NC_NOERR if no errors occurred. Possible
causes of errors include:
<ul>
<li>Passing a dataset name that includes a directory that does not exist.
<li>Specifying a dataset name of a file that exists and also specifying
NC_NOCLOBBER.
<li>Specifying a meaningless value for the creation mode.
<li>Attempting to create a netCDF dataset in a directory where you don't
have permission to create files.
</ul>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_ENOMEM</code><dd>System out of memory.
<br><dt><code>NC_EHDFERR</code><dd>HDF5 error (netCDF-4 files only).
<br><dt><code>NC_EFILEMETA</code><dd>Error writing netCDF-4 file-level metadata in HDF5 file. (netCDF-4
files only).
</dl>
<h3 class="heading">Examples</h3>
<p>In this example we create a netCDF dataset named foo.nc; we want the
dataset to be created in the current directory only if a dataset with
that name does not already exist:
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
status = nc_create("foo.nc", NC_NOCLOBBER, &ncid);
if (status != NC_NOERR) handle_error(status);
</pre>
<p>In this example we create a netCDF dataset named foo_large.nc. It will
be in the 64-bit offset format.
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
status = nc_create("foo_large.nc", NC_NOCLOBBER|NC_64BIT_OFFSET, &ncid);
if (status != NC_NOERR) handle_error(status);
</pre>
<p>In this example we create a netCDF dataset named foo_HDF5.nc. It will
be in the HDF5 format.
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
status = nc_create("foo_HDF5.nc", NC_NOCLOBBER|NC_NETCDF4, &ncid);
if (status != NC_NOERR) handle_error(status);
</pre>
<p>In this example we create a netCDF dataset named
foo_HDF5_classic.nc. It will be in the HDF5 format, but will not allow
the use of any netCDF-4 advanced features. That is, it will conform to
the classic netCDF-3 data model.
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
status = nc_create("foo_HDF5_classic.nc", NC_NOCLOBBER|NC_NETCDF4|NC_CLASSIC_MODEL, &ncid);
if (status != NC_NOERR) handle_error(status);
</pre>
<p>A variant of nc_create, nc__create (note the double underscore) allows
users to specify two tuning parameters for the file that it is
creating. These tuning parameters are not written to the data file,
they are only used for so long as the file remains open after an
nc__create. See <a href="#nc_005f_005fcreate">nc__create</a>.
<div class="node">
<a name="nc__create"></a>
<a name="nc_005f_005fcreate"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fcreate_005fpar">nc_create_par</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fcreate">nc_create</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.6 Create a NetCDF Dataset With Performance Options: nc__create</h3>
<p><a name="index-nc_005f_005fcreate-64"></a><a name="index-nc_005f_005fcreate_002c-example-65"></a><a name="index-nc_005f_005fcreate_002c-flags-66"></a><a name="index-NC_005fNOCLOBBER-67"></a><a name="index-NC_005fCLOBBER-68"></a><a name="index-NC_005fSHARE-69"></a><a name="index-NC_005f64BIT_005fOFFSET-70"></a>
This function is a variant of nc_create, nc__create (note the double
underscore) allows users to specify two tuning parameters for the
file that it is creating. These tuning parameters are not written to
the data file, they are only used for so long as the file remains open
after an nc__create.
<p>This function creates a new netCDF dataset, returning a netCDF ID that
can subsequently be used to refer to the netCDF dataset in other
netCDF function calls. The new netCDF dataset opened for write access
and placed in define mode, ready for you to add dimensions, variables,
and attributes.
<p>A creation mode flag specifies whether to overwrite any existing
dataset with the same name and whether access to the dataset is
shared, and whether this file should be in netCDF classic format (the
default), or the new 64-bit offset format.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc__create(const char *path, int cmode, size_t initialsz,
size_t *bufrsizehintp, int *ncidp);
</pre>
<dl>
<dt><code>path</code><dd>The file name of the new netCDF dataset.
<br><dt><code>cmode</code><dd>The creation mode flag. The following flags are available:
NC_NOCLOBBER, NC_SHARE, and NC_64BIT_OFFSET, NC_NETCDF4, NC_CLASSIC_MODEL.
<p>Setting NC_NOCLOBBER means you do not want to clobber (overwrite) an
existing dataset; an error (NC_EEXIST) is returned if the specified
dataset already exists.
<p>The NC_SHARE flag is appropriate when one process may be writing the
dataset and one or more other processes reading the dataset
concurrently; it means that dataset accesses are not buffered and
caching is limited. Since the buffering scheme is optimized for
sequential access, programs that do not access data sequentially may
see some performance improvement by setting the NC_SHARE flag. This
flag is ignored for netCDF-4 files. (See below.)
<p>Setting NC_64BIT_OFFSET causes netCDF to create a 64-bit offset format
file, instead of a netCDF classic format file. The 64-bit offset
format imposes far fewer restrictions on very large (i.e. over 2 GB)
data files. See <a href="netcdf.html#Large-File-Support">Large File Support</a>.
<p>A zero value (defined for convenience as NC_CLOBBER) specifies the
default behavior: overwrite any existing dataset with the same file
name and buffer and cache accesses for efficiency. The dataset will be
in netCDF classic format. See <a href="netcdf.html#NetCDF-Classic-Format-Limitations">NetCDF Classic Format Limitations</a>.
<p>Setting NC_NETCDF4 causes netCDF to create a HDF5/NetCDF-4 file.
<p>Setting NC_CLASSIC_MODEL causes netCDF to enforce the classic data
model in this file. (This only has effect for netCDF-4/HDF5 files, as
classic and 64-bit offset files always use the classic model.) When
used with NC_NETCDF4, this flag ensures that the resulting
netCDF-4/HDF5 file may never contain any new constructs from the
enhanced data model. That is, it cannot contain groups, user defined
types, multiple unlimited dimensions, or new atomic types. The
advantage of this restriction is that such files are guaranteed to
work with existing netCDF software.
<br><dt><code>initialsz</code><dd>On some systems, and with custom I/O layers, it may be advantageous to
set the size of the output file at creation time. This parameter sets
the initial size of the file at creation time.
<br><dt><code>bufrsizehintp</code><dd>The argument referenced by bufrsizehintp controls a space versus time
tradeoff, memory allocated in the netcdf library versus number of system
calls.
<p>Because of internal requirements, the value may not be set to exactly
the value requested. The actual value chosen is returned by reference.
<p>Using the value NC_SIZEHINT_DEFAULT causes the library to choose a
default. How the system chooses the default depends on the system. On
many systems, the "preferred I/O block size" is available from the
stat() system call, struct stat member st_blksize. If this is
available it is used. Lacking that, twice the system pagesize is used.
<p>Lacking a call to discover the system pagesize, we just set default
bufrsize to 8192.
<p>The bufrsize is a property of a given open netcdf descriptor
ncid, it is not a persistent property of the netcdf dataset.
<br><dt><code>ncidp</code><dd>Pointer to location where returned netCDF ID is to be stored.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_create returns the value NC_NOERR if no errors occurred. Possible
causes of errors include:
<ul>
<li>Passing a dataset name that includes a directory that does not exist.
<li>Specifying a dataset name of a file that exists and also specifying
NC_NOCLOBBER.
<li>Specifying a meaningless value for the creation mode.
<li>Attempting to create a netCDF dataset in a directory where you don't
have permission to create files.
</ul>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_ENOMEM</code><dd>System out of memory.
<br><dt><code>NC_EHDFERR</code><dd>HDF5 error (netCDF-4 files only).
<br><dt><code>NC_EFILEMETA</code><dd>Error writing netCDF-4 file-level metadata in HDF5 file. (netCDF-4
files only).
</dl>
<h3 class="heading">Examples</h3>
<p>In this example we create a netCDF dataset named foo.nc; we want the
dataset to be created in the current directory only if a dataset with
that name does not already exist:
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
status = nc_create("foo.nc", NC_NOCLOBBER, &ncid);
if (status != NC_NOERR) handle_error(status);
</pre>
<p>In this example we create a netCDF dataset named foo_large.nc; we want the
dataset to be created in the current directory only if a dataset with
that name does not already exist. We also specify that bufrsize and
initial size for the file.
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
int intialsz = 2048;
int *bufrsize;
...
*bufrsize = 1024;
status = nc__create("foo.nc", NC_NOCLOBBER, initialsz, bufrsize, &ncid);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_create_par"></a>
<a name="nc_005fcreate_005fpar"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fopen">nc_open</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005f_005fcreate">nc__create</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.7 Create a NetCDF Dataset With Performance Options: nc_create_par</h3>
<p><a name="index-nc_005fcreate_005fpar-71"></a><a name="index-nc_005fcreate_005fpar_002c-example-72"></a><a name="index-nc_005fcreate_005fpar_002c-flags-73"></a><a name="index-NC_005fNOCLOBBER-74"></a><a name="index-NC_005fCLOBBER-75"></a><a name="index-NC_005fMPIIO-76"></a><a name="index-NC_005fMPIPOSIX-77"></a>
This function is a variant of nc_create, nc_create_par allows users to
open a file on a MPI/IO or MPI/Posix parallel file system.
<p>The parallel parameters are not written to the data file, they are
only used for so long as the file remains open after an nc_create_par.
<p>This function creates a new netCDF dataset, returning a netCDF ID that
can subsequently be used to refer to the netCDF dataset in other
netCDF function calls. The new netCDF dataset opened for write access
and placed in define mode, ready for you to add dimensions, variables,
and attributes.
<p>If the NC_NETCDF4 flag is used, the HDF5 library is used for parallel
I/O. If not, the parallel-netcdf library is used.
<p>When a file is created for parallel access, independent operations are
the default. To use independent access on a variable,
See <a href="#nc_005fvar_005fpar_005faccess">nc_var_par_access</a>.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_create_par(const char *path, int cmode, MPI_Comm comm,
MPI_Info info, int ncidp);
</pre>
<dl>
<dt><code>path</code><dd>The file name of the new netCDF dataset.
<br><dt><code>cmode</code><dd>Either the NC_MPIIO or NC_MPIPOSIX flags may be present if the
NC_NETCDF4 flag is used.
<p>The NC_SHARE flag is ignored.
<br><dt><code>comm</code><dd>The MPI_Comm object returned by the MPI layer.
<br><dt><code>info</code><dd>The MPI_Info object returned by the MPI layer, if MPI/IO
is being used, or 0 if MPI/Posix is being used.
<br><dt><code>ncidp</code><dd>Pointer to location where returned netCDF ID is to be stored.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EPARINIT</code><dd>Could not initialize parallel access at the HDF5 layer.
<br><dt><code>NC_EFILEMETA</code><dd>HDF5 layer cannot handle create or root group open.
<br><dt><code>NC_EEXIST</code><dd>Specifying a dataset name of a file that exists and also specifying
NC_NOCLOBBER.
<br><dt><code>NC_EINVAL</code><dd>Bad value for the creation mode.
<br><dt><code>NC_EHDFERR</code><dd>Unexpected error from the HDF5 layer.
</dl>
<h3 class="heading">Examples</h3>
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
*bufrsize = 1024;
status = nc__create("foo.nc", NC_NOCLOBBER, initialsz, bufrsize, &ncid);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_open"></a>
<a name="nc_005fopen"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005f_005fopen">nc__open</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fcreate_005fpar">nc_create_par</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.8 Open a NetCDF Dataset for Access: nc_open</h3>
<p><a name="index-nc_005fopen-78"></a><a name="index-nc_005fopen_002c-example-79"></a><a name="index-NC_005fNOWRITE-80"></a><a name="index-NC_005fWRITE-81"></a><a name="index-NC_005fSHARE_002c-in-nc_005fopen-82"></a><a name="index-HDF5-errors_002c-first-create-83"></a>
The function nc_open opens an existing netCDF dataset for access. It
determines the underlying file format automatically. Use the same call
to open a netCDF classic, 64-bit offset, or netCDF-4 file.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_open (const char *path, int omode, int *ncidp);
</pre>
<dl>
<dt><code>path</code><dd>File name for netCDF dataset to be opened.
When DAP support is enabled, then the path may be an OPeNDAP
URL rather than a file path.
<br><dt><code>omode</code><dd>A zero value (or NC_NOWRITE) specifies the default behavior: open the
dataset with read-only access, buffering and caching accesses for
efficiency
<p>Otherwise, the open mode is NC_WRITE, NC_SHARE, or
NC_WRITE|NC_SHARE. Setting the NC_WRITE flag opens the dataset with
read-write access. ("Writing" means any kind of change to the dataset,
including appending or changing data, adding or renaming dimensions,
variables, and attributes, or deleting attributes.)
<p>The NC_SHARE flag is only used for netCDF classic and 64-bit offset
files. It is appropriate when one process may be writing the
dataset and one or more other processes reading the dataset
concurrently; it means that dataset accesses are not buffered and
caching is limited. Since the buffering scheme is optimized for
sequential access, programs that do not access data sequentially may
see some performance improvement by setting the NC_SHARE flag.
<p>It is not necessary to pass any information about the format of the
file being opened. The file type will be detected automatically by the
netCDF library.
<p>If a the path is a DAP URL, then the open mode is read-only.
Setting NC_WRITE will be ignored.
<br><dt><code>ncidp</code><dd>Pointer to location where returned netCDF ID is to be stored.
</dl>
<h3 class="heading">Errors</h3>
<p>When opening a netCDF-4 file HDF5 error reporting is turned off, if
it is on. This doesn't stop the HDF5 error stack from recording the
errors, it simply stops their display to the user through stderr.
<p>nc_open returns the value NC_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
<ul>
<li>The specified netCDF dataset does not exist.
<li>A meaningless mode was specified.
</ul>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_NOMEM</code><dd>Out of memory.
<br><dt><code>NC_EHDFERR</code><dd>HDF5 error. (NetCDF-4 files only.)
<br><dt><code>NC_EDIMMETA</code><dd>Error in netCDF-4 dimension metadata. (NetCDF-4 files only.)
<br><dt><code>NC_ENOCOMPOIND</code><dd>(NetCDF-4 files only.)
</dl>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_open to open an existing netCDF dataset
named foo.nc for read-only, non-shared access:
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
status = nc_open("foo.nc", 0, &ncid);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc__open"></a>
<a name="nc_005f_005fopen"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fopen_005fpar">nc_open_par</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fopen">nc_open</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.9 Open a NetCDF Dataset for Access with Performance Tuning: nc__open</h3>
<p><a name="index-nc_005f_005fopen-84"></a><a name="index-nc_005f_005fopen_002c-example-85"></a><a name="index-NC_005fNOWRITE-86"></a><a name="index-NC_005fWRITE-87"></a><a name="index-NC_005fSHARE_002c-in-nc_005f_005fopen-88"></a>
A function opens a netCDF dataset for access with an additional
performance tuning parameter.
When DAP support is enabled, it is possible to open a DAP data source
through this interface, but it is deprecated because
all of the performance tuning parameters are ignored.
The standard nc_open interface should be used instead.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc__open(const char *path, int mode, size_t *bufrsizehintp, int *ncidp);
</pre>
<dl>
<dt><code>path</code><dd>File name for netCDF dataset to be opened.
<br><dt><code>omode</code><dd>A zero value (or NC_NOWRITE) specifies the default behavior: open the
dataset with read-only access, buffering and caching accesses for
efficiency
<p>Otherwise, the open mode is NC_WRITE, NC_SHARE, or
NC_WRITE|NC_SHARE. Setting the NC_WRITE flag opens the dataset with
read-write access. ("Writing" means any kind of change to the dataset,
including appending or changing data, adding or renaming dimensions,
variables, and attributes, or deleting attributes.) The NC_SHARE flag
is appropriate when one process may be writing the dataset and one or
more other processes reading the dataset concurrently; it means that
dataset accesses are not buffered and caching is limited. Since the
buffering scheme is optimized for sequential access, programs that do
not access data sequentially may see some performance improvement by
setting the NC_SHARE flag.
<br><dt><code>bufrsizehintp</code><dd>The argument referenced by bufrsizehintp controls a space versus time
tradeoff, memory allocated in the netcdf library versus number of system
calls.
<p>Because of internal requirements, the value may not be set to exactly
the value requested. The actual value chosen is returned by reference.
<p>Using the value NC_SIZEHINT_DEFAULT causes the library to choose a
default. How the system chooses the default depends on the system. On
many systems, the "preferred I/O block size" is available from the
stat() system call, struct stat member st_blksize. If this is
available it is used. Lacking that, twice the system pagesize is used.
<p>Lacking a call to discover the system pagesize, we just set default
bufrsize to 8192.
<p>The bufrsize is a property of a given open netcdf descriptor
ncid, it is not a persistent property of the netcdf dataset.
<br><dt><code>ncidp</code><dd>Pointer to location where returned netCDF ID is to be stored.
</dl>
<h3 class="heading">Errors</h3>
<p>nc__open returns the value NC_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
<ul>
<li>The specified netCDF dataset does not exist.
<li>A meaningless mode was specified.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc__open to open an existing netCDF dataset
named foo.nc for read-only, non-shared access:
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
size_t bufrsize;
...
*bufrsize = 1024;
status = nc_open("foo.nc", 0, &bufrsize, &ncid);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_open_par"></a>
<a name="nc_005fopen_005fpar"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fredef">nc_redef</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005f_005fopen">nc__open</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.10 Open a NetCDF Dataset for Parallel Access</h3>
<p><a name="index-nc_005fopen_005fpar-89"></a><a name="index-NC_005fNOWRITE-90"></a><a name="index-NC_005fWRITE-91"></a><a name="index-NC_005fNETCDF4-92"></a>
This function opens a netCDF-4 dataset for parallel access.
<p>For netcdf-4/HDF5 files, the HDF5 library parallel I/O is used. This
opens the file using either MPI-IO or MPI-POSIX.
<p>DAP access is not allowed with parallel I/O.
<p>When netCDF opens a file for parallel access, independent operations
are the default. To use independent access on a variable,
See <a href="#nc_005fvar_005fpar_005faccess">nc_var_par_access</a>.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_open_par(const char *path, int mode, MPI_Comm comm,
MPI_Info info, int *ncidp);
</pre>
<dl>
<dt><code>path</code><dd>File name for netCDF dataset to be opened.
<br><dt><code>omode</code><dd>Either the NC_MPIIO or NC_MPIPOSIX flags may be present for a
netCDF-4/HDF5 file.
<p>The flag NC_WRITE opens the dataset with read-write access. ("Writing"
means any kind of change to the dataset, including appending or
changing data, adding or renaming dimensions, variables, and
attributes, or deleting attributes.)
<p>All other flags are ignored or not allowed. The NC_NETCDF4 flag is not
required, as the file type is detected when the file is opened.
<br><dt><code>comm</code><dd>MPI_Comm object returned by the MPI layer.
<br><dt><code>info</code><dd>MPI_Info object returned by the MPI layer, or NULL if MPI-POSIX access
is desired.
<br><dt><code>ncidp</code><dd>Pointer to location where returned netCDF ID is to be stored.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><dd>The specified netCDF dataset does not exist.
<br><dt><dd>A meaningless mode was specified.
</dl>
<h3 class="heading">Example</h3>
<p>Here is an example (from nc_test4/tst_parallel2.c) using nc_open_par.
<pre class="example"> /* Reopen the file and check it. */
if (nc_open_par(file_name, NC_NOWRITE, comm, info, &ncid)) ERR;
/* Read all the slabs this process is responsible for. */
for (i = 0; i < NUM_SLABS / mpi_size; i++)
{
start[0] = NUM_SLABS / mpi_size * mpi_rank + i;
/* Read one slab of data. */
if (nc_get_vara_int(ncid, varid, start, count, data_in)) ERR;
}
</pre>
<div class="node">
<a name="nc_redef"></a>
<a name="nc_005fredef"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fenddef">nc_enddef</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fopen_005fpar">nc_open_par</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.11 Put Open NetCDF Dataset into Define Mode: nc_redef</h3>
<p><a name="index-nc_005fredef-93"></a><a name="index-nc_005fredef_002c-example-94"></a><a name="index-adding-dimensions-using-nc_005fredef-95"></a><a name="index-adding-variables-using-nc_005fredef-96"></a><a name="index-adding-attributes-using-nc_005fredef-97"></a>
The function nc_redef puts an open netCDF dataset into define mode, so
dimensions, variables, and attributes can be added or renamed and
attributes can be deleted.
<h3 class="heading">Usage</h3>
<p>For netCDF-4 files (i.e. files created with NC_NETCDF4 in the cmode,
see <a href="#nc_005fcreate">nc_create</a>), it is not necessary to call nc_redef unless the
file was also created with NC_STRICT_NC3. For straight-up netCDF-4
files, nc_redef is called automatically, as needed.
<p>For all netCDF-4 files, the root ncid must be used. This is the ncid
returned by nc_open and nc_create, and points to the root of the
hierarchy tree for netCDF-4 files.
<pre class="example"> int nc_redef(int ncid);
</pre>
<dl>
<dt><code>ncid</code><dd>netCDF ID, from a previous call to nc_open or nc_create.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_redef returns the value NC_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
<ul>
<li>The specified netCDF dataset is already in define mode. This error
code will only be returned for classic and 64-bit offset format files.
<li>The specified netCDF dataset was opened for read-only.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad ncid.
<br><dt><code>NC_EBADGRPID</code><dd>The ncid must refer to the root group of the file, that is, the group
returned by nc_open or nc_create. (see <a href="#nc_005fopen">nc_open</a> see <a href="#nc_005fcreate">nc_create</a>).
<br><dt><code>NC_EINDEFINE</code><dd>Already in define mode.
<br><dt><code>NC_EPERM</code><dd>File is read-only.
</dl>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_redef to open an existing netCDF dataset
named foo.nc and put it into define mode:
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
status = nc_open("foo.nc", NC_WRITE, &ncid); /* open dataset */
if (status != NC_NOERR) handle_error(status);
...
status = nc_redef(ncid); /* put in define mode */
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_enddef"></a>
<a name="nc_005fenddef"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005f_005fenddef">nc__enddef</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fredef">nc_redef</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.12 Leave Define Mode: nc_enddef</h3>
<p><a name="index-nc_005fenddef-98"></a><a name="index-nc_005fenddef_002c-example-99"></a>
The function nc_enddef takes an open netCDF dataset out of define
mode. The changes made to the netCDF dataset while it was in define
mode are checked and committed to disk if no problems
occurred. Non-record variables may be initialized to a "fill value" as
well. See <a href="#nc_005fset_005ffill">nc_set_fill</a>. The netCDF dataset is then placed in data
mode, so variable data can be read or written.
<p>It's not necessary to call nc_enddef for netCDF-4 files. With netCDF-4
files, nc_enddef is called when needed by the netcdf-4 library. User
calls to nc_enddef for netCDF-4 files still flush the metadata to
disk.
<p>This call may involve copying data under some circumstances. For a
more extensive discussion see <a href="netcdf.html#File-Structure-and-Performance">File Structure and Performance</a>.
<p>For netCDF-4/HDF5 format files there are some variable settings (the
compression, endianness, fletcher32 error correction, and fill value)
which must be set (if they are going to be set at all) between the
nc_def_var and the next nc_enddef. Once the nc_enddef is called, these
settings can no longer be changed for a variable.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_enddef(int ncid);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create. If you use a
group id, the enddef will apply to the entire file. That all, the
enddef will not just end define mode in one group, but in the entire file.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_enddef returns the value NC_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
<ul>
<li>The specified netCDF dataset is not in define mode.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
<li>The size of one or more variables exceed the size constraints for
whichever variant of the file format is in use).
See <a href="netcdf.html#Large-File-Support">Large File Support</a>.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_enddef to finish the definitions of a new
netCDF dataset named foo.nc and put it into data mode:
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
status = nc_create("foo.nc", NC_NOCLOBBER, &ncid);
if (status != NC_NOERR) handle_error(status);
... /* create dimensions, variables, attributes */
status = nc_enddef(ncid); /*leave define mode*/
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc__enddef"></a>
<a name="nc_005f_005fenddef"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fclose">nc_close</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fenddef">nc_enddef</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.13 Leave Define Mode with Performance Tuning: nc__enddef</h3>
<p><a name="index-nc_005f_005fenddef-100"></a><a name="index-nc_005f_005fenddef_002c-example-101"></a>
The function nc__enddef takes an open netCDF dataset out of define
mode. The changes made to the netCDF dataset while it was in define
mode are checked and committed to disk if no problems
occurred. Non-record variables may be initialized to a "fill value" as
well. See <a href="#nc_005fset_005ffill">nc_set_fill</a>. The netCDF dataset is then placed in data
mode, so variable data can be read or written.
<p>This call may involve copying data under some circumstances. For a
more extensive discussion see <a href="netcdf.html#File-Structure-and-Performance">File Structure and Performance</a>.
<p>Caution: this function exposes internals of the netcdf version 1 file
format. Users should use nc_enddef in most circumstances. This
function may not be available on future netcdf implementations.
<p>The current netcdf file format has three sections, the "header"
section, the data section for fixed size variables, and the data
section for variables which have an unlimited dimension (record
variables).
<p>The header begins at the beginning of the file. The index (offset) of
the beginning of the other two sections is contained in the
header. Typically, there is no space between the sections. This causes
copying overhead to accrue if one wishes to change the size of the
sections, as may happen when changing names of things, text attribute
values, adding attributes or adding variables. Also, for buffered i/o,
there may be advantages to aligning sections in certain ways.
<p>The minfree parameters allow one to control costs of future calls to
nc_redef, nc_enddef by requesting that minfree bytes be available at
the end of the section.
<p>The align parameters allow one to set the alignment of the beginning
of the corresponding sections. The beginning of the section is rounded
up to an index which is a multiple of the align parameter. The flag
value ALIGN_CHUNK tells the library to use the bufrsize (see above)
as the align parameter. It has nothing to do with the chunking
(multidimensional tiling) features of netCDF-4.
<p>The file format requires mod 4 alignment, so the align parameters
are silently rounded up to multiples of 4. The usual call,
<pre class="example"> nc_enddef(ncid);
</pre>
<p>is equivalent to
<pre class="example"> nc__enddef(ncid, 0, 4, 0, 4);
</pre>
<p>The file format does not contain a "record size" value, this is
calculated from the sizes of the record variables. This unfortunate
fact prevents us from providing minfree and alignment control of the
"records" in a netcdf file. If you add a variable which has an
unlimited dimension, the third section will always be copied with the
new variable added.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc__enddef(int ncid, size_t h_minfree, size_t v_align,
size_t v_minfree, size_t r_align);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>h_minfree</code><dd>Sets the pad at the end of the "header" section.
<br><dt><code>v_align</code><dd>Controls the alignment of the beginning of the data section for fixed
size variables.
<br><dt><code>v_minfree</code><dd>Sets the pad at the end of the data section for fixed size variables.
<br><dt><code>r_align</code><dd>Controls the alignment of the beginning of the data section for
variables which have an unlimited dimension (record variables).
</dl>
<h3 class="heading">Errors</h3>
<p>nc__enddef returns the value NC_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
<ul>
<li>The specified netCDF dataset is not in define mode.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
<li>The size of one or more variables exceed the size constraints for
whichever variant of the file format is in use).
See <a href="netcdf.html#Large-File-Support">Large File Support</a>.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_enddef to finish the definitions of a new
netCDF dataset named foo.nc and put it into data mode:
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
status = nc_create("foo.nc", NC_NOCLOBBER, &ncid);
if (status != NC_NOERR) handle_error(status);
... /* create dimensions, variables, attributes */
status = nc_enddef(ncid); /*leave define mode*/
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_close"></a>
<a name="nc_005fclose"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq-Family">nc_inq Family</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005f_005fenddef">nc__enddef</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.14 Close an Open NetCDF Dataset: nc_close</h3>
<p><a name="index-nc_005fclose-102"></a><a name="index-nc_005fclose_002c-example-103"></a><a name="index-nc_005fclose_002c-root-group-104"></a>
The function nc_close closes an open netCDF dataset.
<p>If the dataset in define mode, nc_enddef will be called before
closing. (In this case, if nc_enddef returns an error, nc_abort will
automatically be called to restore the dataset to the consistent state
before define mode was last entered.) After an open netCDF dataset is
closed, its netCDF ID may be reassigned to the next netCDF dataset
that is opened or created.
<h3 class="heading">Usage</h3>
<p>For netCDF-4 files, the ncid of the root group must be passed into
nc_close.
<pre class="example"> int nc_close(int ncid);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_close returns the value NC_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
<ul>
<li>Define mode was entered and the automatic call made to nc_enddef
failed.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Invalid id passed.
<br><dt><code>NC_EBADGRPID</code><dd>ncid did not contain the root group id of this file. (NetCDF-4 only).
</dl>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_close to finish the definitions of a new
netCDF dataset named foo.nc and release its netCDF ID:
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
status = nc_create("foo.nc", NC_NOCLOBBER, &ncid);
if (status != NC_NOERR) handle_error(status);
... /* create dimensions, variables, attributes */
status = nc_close(ncid); /* close netCDF dataset */
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_inq-Family"></a>
<a name="nc_005finq-Family"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fsync">nc_sync</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fclose">nc_close</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.15 Inquire about an Open NetCDF Dataset: nc_inq Family</h3>
<p><a name="index-nc_005finq-Family-105"></a><a name="index-nc_005finq_005fndims-106"></a><a name="index-nc_005finq_005fnvars-107"></a><a name="index-nc_005finq_005fnatts-108"></a><a name="index-nc_005finq_005funlimdim-109"></a><a name="index-nc_005finq_005fformat-110"></a><a name="index-nc_005finq_005fpath-111"></a><a name="index-attributes_002c-number-of-112"></a><a name="index-variables_002c-number-of-113"></a><a name="index-dimensions_002c-number-of-114"></a><a name="index-format-version-115"></a><a name="index-version_002c-format-116"></a><a name="index-path-117"></a><a name="index-file-path-118"></a><a name="index-file-name-119"></a><a name="index-URL-120"></a><a name="index-nc_005finq-Family_002c-example-121"></a>
Members of the nc_inq family of functions return information about an
open netCDF dataset, given its netCDF ID. Dataset inquire functions
may be called from either define mode or data mode. The first
function, nc_inq, returns values for the number of dimensions, the
number of variables, the number of global attributes, and the
dimension ID of the dimension defined with unlimited length, if
any. Most of the other functions in the family each return just one of these
items of information.
<p>For C, these functions include nc_inq, nc_inq_ndims, nc_inq_nvars,
nc_inq_natts, and nc_inq_unlimdim. An additional function,
nc_inq_format, returns the (rarely needed) format version. Another
function, nc_inq_path, returns the file name or URL with which a
file was opened or created.
<p>No I/O is performed when these functions are called, since the
required information is available in memory for each open netCDF
dataset.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq (int ncid, int *ndimsp, int *nvarsp, int *ngattsp,
int *unlimdimidp);
int nc_inq_ndims (int ncid, int *ndimsp);
int nc_inq_nvars (int ncid, int *nvarsp);
int nc_inq_natts (int ncid, int *ngattsp);
int nc_inq_unlimdim (int ncid, int *unlimdimidp);
int nc_inq_format (int ncid, int *formatp);
int nc_inq_path (int ncid, size_t *pathlenp, char *path);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>ndimsp</code><dd>Pointer to location for returned number of dimensions defined for this
netCDF dataset.
<br><dt><code>nvarsp</code><dd>Pointer to location for returned number of variables defined for this
netCDF dataset.
<br><dt><code>ngattsp</code><dd>Pointer to location for returned number of global attributes defined
for this netCDF dataset.
<br><dt><code>unlimdimidp</code><dd>Pointer to location for returned ID of the unlimited dimension, if
there is one for this netCDF dataset. If no unlimited length dimension
has been defined, -1 is returned.
<br><dt><code>formatp</code><dd>Pointer to location for returned format version, one of
NC_FORMAT_CLASSIC, NC_FORMAT_64BIT, NC_FORMAT_NETCDF4,
NC_FORMAT_NETCDF4_CLASSIC.
<br><dt><code>pathlenp</code><dd>Pointer to location for returned length of the string specifying the
path with which a file was opened or created. For data on remote
servers, this is the length of the URL string provided to open a
connection to the data. If NULL, this argument is ignored.
returned.
<br><dt><code>path</code><dd>Pointer to string large enough to contain the returned path with which
the specified open netCDF dataset was opened or created. If NULL,
this argument is ignored.
</dl>
<h3 class="heading">Errors</h3>
<p>All members of the nc_inq family return the value NC_NOERR if no
errors occurred. Otherwise, the returned status indicates an
error. Possible causes of errors include:
<ul>
<li>The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_inq to find out about a netCDF dataset
named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status, ncid, ndims, nvars, ngatts, unlimdimid;
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq(ncid, &ndims, &nvars, &ngatts, &unlimdimid);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_sync"></a>
<a name="nc_005fsync"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fabort">nc_abort</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq-Family">nc_inq Family</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.16 Synchronize an Open NetCDF Dataset to Disk: nc_sync</h3>
<p><a name="index-nc_005fsync-122"></a><a name="index-nc_005fsync_002c-example-123"></a>
The function nc_sync offers a way to synchronize the disk copy of a
netCDF dataset with in-memory buffers. There are two reasons you might
want to synchronize after writes:
<ul>
<li>To minimize data loss in case of abnormal termination, or
<li>To make data available to other processes for reading immediately
after it is written. But note that a process that already had the
dataset open for reading would not see the number of records increase
when the writing process calls nc_sync; to accomplish this, the
reading process must call nc_sync.
</ul>
<p>This function is backward-compatible with previous versions of the
netCDF library. The intent was to allow sharing of a netCDF dataset
among multiple readers and one writer, by having the writer call
nc_sync after writing and the readers call nc_sync before each
read. For a writer, this flushes buffers to disk. For a reader, it
makes sure that the next read will be from disk rather than from
previously cached buffers, so that the reader will see changes made by
the writing process (e.g., the number of records written) without
having to close and reopen the dataset. If you are only accessing a
small amount of data, it can be expensive in computer resources to
always synchronize to disk after every write, since you are giving up
the benefits of buffering.
<p>An easier way to accomplish sharing (and what is now recommended) is
to have the writer and readers open the dataset with the NC_SHARE
flag, and then it will not be necessary to call nc_sync at
all. However, the nc_sync function still provides finer granularity
than the NC_SHARE flag, if only a few netCDF accesses need to be
synchronized among processes.
<p>It is important to note that changes to the ancillary data, such as
attribute values, are not propagated automatically by use of the
NC_SHARE flag. Use of the nc_sync function is still required for this
purpose.
<p>Sharing datasets when the writer enters define mode to change the data
schema requires extra care. In previous releases, after the writer
left define mode, the readers were left looking at an old copy of the
dataset, since the changes were made to a new copy. The only way
readers could see the changes was by closing and reopening the
dataset. Now the changes are made in place, but readers have no
knowledge that their internal tables are now inconsistent with the new
dataset schema. If netCDF datasets are shared across redefinition,
some mechanism external to the netCDF library must be provided that
prevents access by readers during redefinition and causes the readers
to call nc_sync before any subsequent access.
<p>When calling nc_sync, the netCDF dataset must be in data mode. A
netCDF dataset in define mode is synchronized to disk only when
nc_enddef is called. A process that is reading a netCDF dataset that
another process is writing may call nc_sync to get updated with the
changes made to the data by the writing process (e.g., the number of
records written), without having to close and reopen the dataset.
<p>Data is automatically synchronized to disk when a netCDF dataset is
closed, or whenever you leave define mode.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_sync(int ncid);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_sync returns the value NC_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
<ul>
<li>The netCDF dataset is in define mode.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_sync to synchronize the disk writes of a
netCDF dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status;
int ncid;
...
status = nc_open("foo.nc", NC_WRITE, &ncid); /* open for writing */
if (status != NC_NOERR) handle_error(status);
... /* write data or change attributes */
status = nc_sync(ncid); /* synchronize to disk */
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_abort"></a>
<a name="nc_005fabort"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fset_005ffill">nc_set_fill</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fsync">nc_sync</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.17 Back Out of Recent Definitions: nc_abort</h3>
<p><a name="index-nc_005fabort-124"></a><a name="index-nc_005fabort_002c-example-125"></a><a name="index-backing-out-of-definitions-126"></a><a name="index-canceling-definitions-127"></a>
You no longer need to call this function, since it is called
automatically by nc_close in case the dataset is in define mode and
something goes wrong with committing the changes. The function
nc_abort just closes the netCDF dataset, if not in define mode. If the
dataset is being created and is still in define mode, the dataset is
deleted. If define mode was entered by a call to nc_redef, the netCDF
dataset is restored to its state before definition mode was entered
and the dataset is closed.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_abort(int ncid);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_abort returns the value NC_NOERR if no errors occurred. Otherwise,
the returned status indicates an error. Possible causes of errors
include:
<ul>
<li>When called from define mode while creating a netCDF dataset, deletion
of the dataset failed.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_abort to back out of redefinitions of a
dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int ncid, status, latid;
...
status = nc_open("foo.nc", NC_WRITE, &ncid);/* open for writing */
if (status != NC_NOERR) handle_error(status);
...
status = nc_redef(ncid); /* enter define mode */
if (status != NC_NOERR) handle_error(status);
...
status = nc_def_dim(ncid, "lat", 18L, &latid);
if (status != NC_NOERR) {
handle_error(status);
status = nc_abort(ncid); /* define failed, abort */
if (status != NC_NOERR) handle_error(status);
}
</pre>
<div class="node">
<a name="nc_set_fill"></a>
<a name="nc_005fset_005ffill"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fset_005fdefault_005fformat">nc_set_default_format</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fabort">nc_abort</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.18 Set Fill Mode for Writes: nc_set_fill</h3>
<p><a name="index-nc_005fset_005ffill-128"></a><a name="index-nc_005fset_005ffill_002c-example-129"></a><a name="index-write-fill-mode_002c-setting-130"></a>
This function is intended for advanced usage, to optimize writes under
some circumstances described below. The function nc_set_fill sets the
fill mode for a netCDF dataset open for writing and returns the
current fill mode in a return parameter. The fill mode can be
specified as either NC_FILL or NC_NOFILL. The default behavior
corresponding to NC_FILL is that data is pre-filled with fill values,
that is fill values are written when you create non-record variables
or when you write a value beyond data that has not yet been
written. This makes it possible to detect attempts to read data before
it was written. For more information on the use of fill values
see <a href="#Fill-Values">Fill Values</a>. For information about how to define your own fill
values see <a href="netcdf.html#Attribute-Conventions">Attribute Conventions</a>.
<p>The behavior corresponding to NC_NOFILL overrides the default behavior
of prefilling data with fill values. This can be used to enhance
performance, because it avoids the duplicate writes that occur when
the netCDF library writes fill values that are later overwritten with
data.
<p>A value indicating which mode the netCDF dataset was already in is
returned. You can use this value to temporarily change the fill mode
of an open netCDF dataset and then restore it to the previous mode.
<p>After you turn on NC_NOFILL mode for an open netCDF dataset, you must
be certain to write valid data in all the positions that will later be
read. Note that nofill mode is only a transient property of a netCDF
dataset open for writing: if you close and reopen the dataset, it will
revert to the default behavior. You can also revert to the default
behavior by calling nc_set_fill again to explicitly set the fill mode
to NC_FILL.
<p>There are three situations where it is advantageous to set nofill
mode:
<ol type=1 start=1>
<li>Creating and initializing a netCDF dataset. In this case, you should
set nofill mode before calling nc_enddef and then write completely all
non-record variables and the initial records of all the record
variables you want to initialize.
<li>Extending an existing record-oriented netCDF dataset. Set nofill mode
after opening the dataset for writing, then append the additional
records to the dataset completely, leaving no intervening unwritten
records.
<li>Adding new variables that you are going to initialize to an existing
netCDF dataset. Set nofill mode before calling nc_enddef then write
all the new variables completely.
</ol>
<p>If the netCDF dataset has an unlimited dimension and the last record
was written while in nofill mode, then the dataset may be shorter than
if nofill mode was not set, but this will be completely transparent if
you access the data only through the netCDF interfaces.
<p>The use of this feature may not be available (or even needed) in
future releases. Programmers are cautioned against heavy reliance upon
this feature.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_set_fill (int ncid, int fillmode, int *old_modep);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>fillmode</code><dd>Desired fill mode for the dataset, either NC_NOFILL or NC_FILL.
<br><dt><code>old_modep</code><dd>Pointer to location for returned current fill mode of the dataset
before this call, either NC_NOFILL or NC_FILL.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>The specified netCDF ID does not refer to an open netCDF dataset.
<br><dt><code>NC_EPERM</code><dd>The specified netCDF ID refers to a dataset open for read-only access.
<br><dt><code>NC_EINVAL</code><dd>The fill mode argument is neither NC_NOFILL nor NC_FILL.
</dl>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_set_fill to set nofill mode for subsequent
writes of a netCDF dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int ncid, status, old_fill_mode;
...
status = nc_open("foo.nc", NC_WRITE, &ncid); /* open for writing */
if (status != NC_NOERR) handle_error(status);
... /* write data with default prefilling behavior */
status = nc_set_fill(ncid, NC_NOFILL, &old_fill_mode); /* set nofill */
if (status != NC_NOERR) handle_error(status);
... /* write data with no prefilling */
</pre>
<div class="node">
<a name="nc_set_default_format"></a>
<a name="nc_005fset_005fdefault_005fformat"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fset_005fchunk_005fcache">nc_set_chunk_cache</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fset_005ffill">nc_set_fill</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.19 Set Default Creation Format: nc_set_default_format</h3>
<p><a name="index-nc_005fset_005fdefault_005fformat-131"></a><a name="index-nc_005fset_005fdefault_005fformat_002c-example-132"></a><a name="index-create-flag_002c-setting-default-133"></a>
This function is intended for advanced users.
<p>Starting in version 3.6, netCDF introduced a new data format, the
first change in the underlying binary data format since the netCDF
interface was released. The new format, 64-bit offset format, was
introduced to greatly relax the limitations on creating very large
files.
<p>Users are warned that creating files in the 64-bit offset format makes
them unreadable by the netCDF library prior to version 3.6.0. For
reasons of compatibility, users should continue to create files in
netCDF classic format.
<p>Users who do want to use 64-bit offset format files can create them
directory from nc_create, using the proper cmode flag.
(see <a href="#nc_005fcreate">nc_create</a>).
<p>The function nc_set_default_format allows the user to change the
format of the netCDF file to be created by future calls to nc_create
(or nc__create) without changing the cmode flag.
<p>This allows the user to convert a program to use 64-bit offset
formation without changing all calls the nc_create. See <a href="netcdf.html#Large-File-Support">Large File Support</a>.
<p>Once the default format is set, all future created files will be in
the desired format.
<p>Two constants are provided in the netcdf.h file to be used with this
function, NC_FORMAT_64BIT and NC_FORMAT_CLASSIC.
<p>If a non-NULL pointer is provided, it is assumed to point to an int,
where the existing default format will be written.
<p>Using nc_create with a cmode including NC_64BIT_OFFSET overrides the
default format, and creates a 64-bit offset file.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_set_default_format(int format, int *old_formatp);
</pre>
<dl>
<dt><code>format</code><dd>Valid formats include NC_FORMAT_CLASSIC (the default),
NC_FORMAT_64BIT, and, if –enable-netcdf-4 was used during configure,
NC_FORMAT_NETCDF4 and NC_FORMAT_NETCDF4_CLASSIC
<br><dt><code>old_formatp</code><dd>Either NULL (in which case it will be ignored), or a pointer to an int
where the existing default format (i.e. before being changed to the
new format) will be written. This allows you to get the existing
default format while setting a new default format.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EINVAL</code><dd>Invalid format. Valid formats include NC_FORMAT_CLASSIC,
NC_FORMAT_64BIT, and, if –enable-netcdf-4 was used during configure,
NC_FORMAT_NETCDF4 and NC_FORMAT_NETCDF4_CLASSIC. Trying to set the
default format to something else will result in an invalid argument
error.
</dl>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_set_default_format to create the same file
in four formats with the same nc_create call (from libsrc4/tst_utf8.c):
<pre class="example"> #include <netcdf.h>
...
int ncid, varid, dimids[NDIMS];
int f;
for (f = NC_FORMAT_CLASSIC; f < NC_FORMAT_NETCDF4_CLASSIC; f++)
{
if (nc_set_default_format(f, NULL)) ERR;
if (nc_create(FILE_NAME, NC_CLOBBER, &ncid)) ERR;
...
</pre>
<div class="node">
<a name="nc_set_chunk_cache"></a>
<a name="nc_005fset_005fchunk_005fcache"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fget_005fchunk_005fcache">nc_get_chunk_cache</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fset_005fdefault_005fformat">nc_set_default_format</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.20 Set HDF5 Chunk Cache for Future File Opens/Creates: nc_set_chunk_cache</h3>
<p><a name="index-nc_005fset_005fchunk_005fcache-134"></a><a name="index-HDF5-chunk-cache-135"></a>
This function changes the default chunk cache settings in the HDF5
library for all variables in the file. The settings apply for
subsequent file opens/creates. This function does not change the chunk
cache settings of already open files.
<p>For more information, see the documentation for the H5Pset_cache()
function in the HDF5 library at the HDF5 website:
<a href="http://hdfgroup.org/HDF5/">http://hdfgroup.org/HDF5/</a>.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_set_chunk_cache(size_t size, size_t nelems, float preemption);
</pre>
<dl>
<dt><code>size</code><dd>The total size of the raw data chunk cache, in bytes. This should be
big enough to hold multiple chunks of data.
<br><dt><code>nelems</code><dd>The number of chunk slots in the raw data chunk cache hash table. This
should be a prime number larger than the number of chunks that will be
in the cache.
<br><dt><code>preemption</code><dd>The preemtion value must be between 0 and 1 inclusive and indicates
how much chunks that have been fully read are favored for
preemption. A value of zero means fully read chunks are treated no
differently than other chunks (the preemption is strictly LRU) while a
value of one means fully read chunks are always preempted before other
chunks.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EINVAL</code><dd>Preemption must be between zero and one (inclusive).
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_files.c:
<pre class="example"> #include <netcdf.h>
...
#define NEW_CACHE_SIZE 32000000
#define NEW_CACHE_NELEMS 2000
#define NEW_CACHE_PREEMPTION .75
/* Change chunk cache. */
if (nc_set_chunk_cache(NEW_CACHE_SIZE, NEW_CACHE_NELEMS,
NEW_CACHE_PREEMPTION)) ERR;
/* Create a file with two dims, two vars, and two atts. */
if (nc_create(FILE_NAME, cflags|NC_CLOBBER, &ncid)) ERR;
...
</pre>
<div class="node">
<a name="nc_get_chunk_cache"></a>
<a name="nc_005fget_005fchunk_005fcache"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#nc_005fset_005fchunk_005fcache">nc_set_chunk_cache</a>,
Up: <a rel="up" accesskey="u" href="#Datasets">Datasets</a>
</div>
<h3 class="section">2.21 Get the HDF5 Chunk Cache Settings for Future File Opens/Creates: nc_get_chunk_cache</h3>
<p><a name="index-nc_005fget_005fchunk_005fcache-136"></a><a name="index-HDF5-chunk-cache-137"></a>
This function gets the chunk cache settings for the HDF5
library. The settings apply for subsequent file opens/creates.
<p>This affects the per-file chunk cache which the HDF5 layer
maintains. The chunk cache size can be tuned for better performance.
<p>For more information, see the documentation for the H5Pget_cache()
function in the HDF5 library at the HDF5 website:
<a href="http://hdfgroup.org/HDF5/">http://hdfgroup.org/HDF5/</a>.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_get_chunk_cache(size_t *sizep, size_t *nelemsp, float *preemptionp);
</pre>
<dl>
<dt><code>sizep</code><dd>The total size of the raw data chunk cache will be put here. If NULL,
will be ignored.
<br><dt><code>nelemsp</code><dd>The number of chunk slots in the raw data chunk cache hash table will
be put here. If NULL, will be ignored.
<br><dt><code>preemptionp</code><dd>The preemption will be put here. The preemtion value is between 0 and
1 inclusive and indicates how much chunks that have been fully read
are favored for preemption. A value of zero means fully read chunks
are treated no differently than other chunks (the preemption is
strictly LRU) while a value of one means fully read chunks are always
preempted before other chunks. If NULL, will be ignored.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_files.c:
<pre class="example"> #include <netcdf.h>
...
/* Retrieve the chunk cache settings, just for fun. */
if (nc_get_chunk_cache(&cache_size_in, &cache_nelems_in,
&cache_preemption_in)) ERR;
if (cache_size_in != NEW_CACHE_SIZE || cache_nelems_in != NEW_CACHE_NELEMS ||
cache_preemption_in != NEW_CACHE_PREEMPTION) ERR;
...
</pre>
<div class="node">
<a name="Groups"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Dimensions">Dimensions</a>,
Previous: <a rel="previous" accesskey="p" href="#Datasets">Datasets</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">3 Groups</h2>
<p><a name="index-groups_002c-overview-138"></a>
NetCDF-4 added support for hierarchical groups within netCDF
datasets.
<p>Groups are identified with a ncid, which identifies both the open
file, and the group within that file. When a file is opened with
nc_open or nc_create, the ncid for the root group of that file is
provided. Using that as a starting point, users can add new groups, or
list and navigate existing groups.
<p>All netCDF calls take a ncid which determines where the call will
take its action. For example, the nc_def_var function takes a ncid as
its first parameter. It will create a variable in whichever group
its ncid refers to. Use the root ncid provided by nc_create or
nc_open to create a variable in the root group. Or use nc_def_grp to
create a group and use its ncid to define a variable in the new
group.
<p>Variable are only visible in the group in which they are
defined. The same applies to attributes. “Global” attributes are
associated with the group whose ncid is used.
<p>Dimensions are visible in their groups, and all child groups.
<p>Group operations are only permitted on netCDF-4 files - that is, files
created with the HDF5 flag in nc_create. (see <a href="#nc_005fcreate">nc_create</a>). Groups
are not compatible with the netCDF classic data model, so files
created with the NC_CLASSIC_MODEL file cannot contain groups (except
the root group).
<ul class="menu">
<li><a accesskey="1" href="#nc_005finq_005fncid">nc_inq_ncid</a>
<li><a accesskey="2" href="#nc_005finq_005fgrps">nc_inq_grps</a>
<li><a accesskey="3" href="#nc_005finq_005fvarids">nc_inq_varids</a>
<li><a accesskey="4" href="#nc_005finq_005fdimids">nc_inq_dimids</a>
<li><a accesskey="5" href="#nc_005finq_005fgrpname">nc_inq_grpname</a>
<li><a accesskey="6" href="#nc_005finq_005fgrpname_005ffull">nc_inq_grpname_full</a>
<li><a accesskey="7" href="#nc_005finq_005fgrpname_005flen">nc_inq_grpname_len</a>
<li><a accesskey="8" href="#nc_005finq_005fgrp_005fparent">nc_inq_grp_parent</a>
<li><a accesskey="9" href="#nc_005finq_005fgrp_005fncid">nc_inq_grp_ncid</a>
<li><a href="#nc_005finq_005fgrp_005ffull_005fncid">nc_inq_grp_full_ncid</a>
<li><a href="#nc_005fdef_005fgrp">nc_def_grp</a>
</ul>
<div class="node">
<a name="nc_inq_ncid"></a>
<a name="nc_005finq_005fncid"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fgrps">nc_inq_grps</a>,
Previous: <a rel="previous" accesskey="p" href="#Groups">Groups</a>,
Up: <a rel="up" accesskey="u" href="#Groups">Groups</a>
</div>
<h3 class="section">3.1 Find a Group ID: nc_inq_ncid</h3>
<p><a name="index-nc_005finq_005fncid-139"></a>
Given an ncid and group name (NULL or "" gets root group), return
ncid of the named group.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_ncid(int ncid, const char *name, int *grp_ncid);
</pre>
<dl>
<dt><code>ncid</code><dd>The group id for this operation.
<br><dt><code>name</code><dd>A char array that holds the name of the desired group.
<br><dt><code>grp_ncid</code><dd>An int pointer that will receive the group id, if the group is found.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"> int root_ncid, child_ncid;
char file[] = "nc4_test.nc";
/* Open the file. */
if ((res = nc_open(file, NC_NOWRITE, &root_ncid)))
return res;
/* Get the ncid of an existing group. */
if ((res = nc_inq_ncid(root_ncid, "group1", &child_ncid)))
return res;
</pre>
<div class="node">
<a name="nc_inq_grps"></a>
<a name="nc_005finq_005fgrps"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fvarids">nc_inq_varids</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fncid">nc_inq_ncid</a>,
Up: <a rel="up" accesskey="u" href="#Groups">Groups</a>
</div>
<h3 class="section">3.2 Get a List of Groups in a Group: nc_inq_grps</h3>
<p><a name="index-nc_005finq_005fgrps-140"></a>
Given a location id, return the number of groups it contains, and an
array of their ncids.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_grps(int ncid, int *numgrps, int *ncids);
</pre>
<dl>
<dt><code>ncid</code><dd>The group id for this operation.
<br><dt><code>numgrps</code><dd>Pointer to an int which will get number of groups in this group. If
NULL, it's ignored.
<br><dt><code>ncids</code><dd>Pointer to a already allocated array of ints which will receive the
ids of all the groups in this group. If NULL, it's ignored. Call this
function with NULL for ncids parameter to find out how many groups
there are.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"> int root_ncid, numgrps;
int *ncids;
char file[] = "nc4_test.nc";
/* Open the file. */
if ((res = nc_open(file, NC_NOWRITE, &root_ncid)))
return res;
/* Get a list of ncids for the root group. (That is, find out of
there are any groups already defined. */
if ((res = nc_inq_grps(root_ncid, &numgrps, NULL)))
return res;
ncids = malloc(sizeof(int) * numgrps);
if ((res = nc_inq_grps(root_ncid, NULL, ncids)))
return res;
</pre>
<div class="node">
<a name="nc_inq_varids"></a>
<a name="nc_005finq_005fvarids"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fdimids">nc_inq_dimids</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fgrps">nc_inq_grps</a>,
Up: <a rel="up" accesskey="u" href="#Groups">Groups</a>
</div>
<h3 class="section">3.3 Find all the Variables in a Group: nc_inq_varids</h3>
<p><a name="index-nc_005finq_005fvarids-141"></a>
Find all varids for a location.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_inq_varids(int ncid, int *nvars, int *varids);
</pre>
<dl>
<dt><code>ncid</code><dd>The group id for this operation.
<br><dt><code>nvars</code><dd>The integer pointed to by this parameter will get the number of
variable IDs found.
<br><dt><code>varids</code><dd>An already allocated array to store the list of varids. Ignored if
NULL.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_vars.c.
<pre class="example"> int nvars_in, varids_in[2];
...
/* Open the file and make sure nc_inq_varids yeilds correct
* result. */
if (nc_open(FILE_NAME, NC_NOWRITE, &ncid)) ERR;
if (nc_inq_varids(ncid, &nvars_in, varids_in)) ERR;
</pre>
<div class="node">
<a name="nc_inq_dimids"></a>
<a name="nc_005finq_005fdimids"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fgrpname">nc_inq_grpname</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fvarids">nc_inq_varids</a>,
Up: <a rel="up" accesskey="u" href="#Groups">Groups</a>
</div>
<h3 class="section">3.4 Find all Dimensions Visible in a Group: nc_inq_dimids</h3>
<p><a name="index-nc_005finq_005fdimids-142"></a>
Find all dimids for a location. This finds all dimensions in a group,
or any of its parents.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_dimids(int ncid, int *ndims, int *dimids, int include_parents);
</pre>
<dl>
<dt><code>ncid</code><dd>The group id for this operation.
<br><dt><code>dimids</code><dd>An already allocated array of ints when the dimids of the visible
dimensions will be stashed. Use nc_inq_ndims to find out how many dims
are visible from this group. (see <a href="#nc_005finq-Family">nc_inq Family</a>).
<br><dt><code>include_parents</code><dd>If non-zero then all the dimensions in all parent groups will also be
retrieved.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_dims.c.
<pre class="example"> int ncid, dimid;
int ndims_in, dimids_in[MAX_DIMS];
...
/* Open the file and make sure nc_inq_dimids yeilds correct
* result. */
if (nc_open(FILE_NAME, NC_NOWRITE, &ncid)) ERR;
if (nc_inq_dimids(ncid, &ndims_in, dimids_in, 0)) ERR;
if (ndims_in != 1 || dimids_in[0] != 0) ERR;
</pre>
<div class="node">
<a name="nc_inq_grpname"></a>
<a name="nc_005finq_005fgrpname"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fgrpname_005ffull">nc_inq_grpname_full</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fdimids">nc_inq_dimids</a>,
Up: <a rel="up" accesskey="u" href="#Groups">Groups</a>
</div>
<h3 class="section">3.5 Find a Group's Name: nc_inq_grpname</h3>
<p><a name="index-nc_005finq_005fgrpname-143"></a>
Given a group ID find its name. (Root group is named
"/"). See <a href="#nc_005finq_005fgrpname_005ffull">nc_inq_grpname_full</a>.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_grpname(int ncid, char *name);
</pre>
<dl>
<dt><code>ncid</code><dd>The group id for this operation.
<br><dt><code>name</code><dd>Pointer to allocated space of correct length. The name of the
group will be copied there. The name will be less than NC_MAX_NAME,
not including a terminating NULL byte.
<br><dt><dd>
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_grps.c.
<pre class="example"> int grpid_in[MAX_SIBLING_GROUPS];
char name_in[NC_MAX_NAME + 1];
...
if (nc_inq_grpname(grpid_in[0], name_in)) ERR;
</pre>
<div class="node">
<a name="nc_inq_grpname_full"></a>
<a name="nc_005finq_005fgrpname_005ffull"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fgrpname_005flen">nc_inq_grpname_len</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fgrpname">nc_inq_grpname</a>,
Up: <a rel="up" accesskey="u" href="#Groups">Groups</a>
</div>
<h3 class="section">3.6 Find a Group's Full Name: nc_inq_grpname_full</h3>
<p><a name="index-nc_005finq_005fgrpname_005ffull-144"></a>
Given ncid, find complete name of group. (Root group is named "/", a
full "path" for each group is provided in the name, with groups
separated with a forward slash / as in Unix directory names. For
example "/group1/subgrp1/subsubgrp1")
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_grpname_full(int ncid, size_t *lenp, char *full_name);
</pre>
<dl>
<dt><code>ncid</code><dd>The group id for this operation.
<br><dt><code>lenp</code><dd>Pointer to a size_t which will get the length. (Note that this does
not include the NULL terminator byte.)
<br><dt><code>full_name</code><dd>Pointer to allocated space of correct length. The name of the
group will be copied there. To find the required length, call
nc_inq_grpname_len call this function with NULL for the full_name
parameter, or call (see <a href="#nc_005finq_005fgrpname_005flen">nc_inq_grpname_len</a>).
<br><dt><dd>
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from the test program libsrc4/tst_grps.c.
<pre class="example"> int grpid_in[MAX_SIBLING_GROUPS];
char full_name_in[NC_MAX_NAME * 10];
size_t len;
...
if (nc_inq_grpname_full(grpid_in[0], &len, full_name_in)) ERR;
</pre>
<div class="node">
<a name="nc_inq_grpname_len"></a>
<a name="nc_005finq_005fgrpname_005flen"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fgrp_005fparent">nc_inq_grp_parent</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fgrpname_005ffull">nc_inq_grpname_full</a>,
Up: <a rel="up" accesskey="u" href="#Groups">Groups</a>
</div>
<h3 class="section">3.7 Find the Length of a Group's Full Name: nc_inq_grpname_len</h3>
<p><a name="index-nc_005finq_005fgrpname_005flen-145"></a>
Given ncid, find len of the full name, as returned by
nc_inq_grpname_full See <a href="#nc_005finq_005fgrpname_005ffull">nc_inq_grpname_full</a>. (Root group is named "/", with length 1.)
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_grpname_len(int ncid, size_t *lenp);
</pre>
<dl>
<dt><code>ncid</code><dd>The group id for this operation.
<br><dt><code>lenp</code><dd>Pointer to an int where the length will be placed. Length does not
include NULL terminator.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_grps.c.
<pre class="example"> int ncid;
size_t len;
...
if (nc_inq_grpname_len(ncid, &len)) ERR;
</pre>
<div class="node">
<a name="nc_inq_grp_parent"></a>
<a name="nc_005finq_005fgrp_005fparent"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fgrp_005fncid">nc_inq_grp_ncid</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fgrpname_005flen">nc_inq_grpname_len</a>,
Up: <a rel="up" accesskey="u" href="#Groups">Groups</a>
</div>
<h3 class="section">3.8 Find a Group's Parent: nc_inq_grp_parent</h3>
<p><a name="index-nc_005finq_005fgrp_005fparent-146"></a>
Given ncid, find the ncid of the parent group.
<p>When used with the root group, this function returns the NC_ENOGRP
error (since the root group has no parent.)
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_grp_parent(int ncid, int *parent_ncid);
</pre>
<dl>
<dt><code>ncid</code><dd>The group id.
<br><dt><code>parent_ncid</code><dd>Pointer to an int. The ncid of the group will be copied there.
<br><dt><dd>
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENOGRP</code><dd>No parent group found (i.e. this is the root group).
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"> if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_grp(ncid, HENRY_VII, &henry_vii_id)) ERR;
if (nc_inq_grp_parent(henry_vii_id, &parent_ncid)) ERR;
if (parent_ncid != ncid) ERR;
if (nc_close(ncid)) ERR;
</pre>
<div class="node">
<a name="nc_inq_grp_ncid"></a>
<a name="nc_005finq_005fgrp_005fncid"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fgrp_005ffull_005fncid">nc_inq_grp_full_ncid</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fgrp_005fparent">nc_inq_grp_parent</a>,
Up: <a rel="up" accesskey="u" href="#Groups">Groups</a>
</div>
<h3 class="section">3.9 Find a Group by Name: nc_inq_grp_ncid</h3>
<p><a name="index-nc_005finq_005fgrp_005fparent-147"></a>
Given a group location id and the name of an immediate subgroup, find
the location id of the named subgroup.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_grp_ncid(int ncid, const char *grp_name, int *grp_ncid);
</pre>
<dl>
<dt><code>ncid</code><dd>The location id of the group in which to look.
<br><dt><code>grp_name</code><dd>The name of a subgroup.
<br><dt><code>grp_ncid</code><dd>A pointer to int which will get the group id of the named subgroup, if it is found.
</dl>
<h3 class="heading">Return Codes</h3>
<p>The following return codes may be returned by this function.
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_EINVAL</code><dd>No name provided or name longer than NC_MAX_NAME.
<br><dt><code>NC_ENOGRP</code><dd>Named subgroup not found.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from test program libsrc4/tst_grps.c.
<pre class="example"> /* Reopen and recheck. */
if (nc_open(FILE_NAME, NC_NOWRITE, &ncid)) ERR;
if (nc_inq_grp_ncid(ncid, SCI_FI, &g1id)) ERR;
</pre>
<div class="node">
<a name="nc_inq_grp_full_ncid"></a>
<a name="nc_005finq_005fgrp_005ffull_005fncid"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fgrp">nc_def_grp</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fgrp_005fncid">nc_inq_grp_ncid</a>,
Up: <a rel="up" accesskey="u" href="#Groups">Groups</a>
</div>
<h3 class="section">3.10 Find a Group by its Fully-qualified Name: nc_inq_grp_full_ncid</h3>
<p><a name="index-nc_005finq_005fgrp_005fparent-148"></a>
Given a fully qualified group name an an ncid, find the ncid of the
group id.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_grp_full_ncid(int ncid, char *full_name, int *grp_ncid);
</pre>
<dl>
<dt><code>ncid</code><dd>The group id to look in.
<br><dt><code>full_name</code><dd>The fully-qualified group name.
<br><dt><code>grp_ncid</code><dd>A pointer to int which will get the group id, if it is found.
</dl>
<h3 class="heading">Return Codes</h3>
<p>The following return codes may be returned by this function.
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_EINVAL</code><dd>No name provided or name longer than NC_MAX_NAME.
<br><dt><code>NC_ENOGRP</code><dd>Named group not found.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from test program libsrc4/tst_grps.c.
<pre class="example"> /* Reopen and recheck. */
if (nc_open(FILE_NAME, NC_NOWRITE, &ncid)) ERR;
if (nc_inq_grp_ncid(ncid, SCI_FI, &g1id)) ERR;
</pre>
<div class="node">
<a name="nc_def_grp"></a>
<a name="nc_005fdef_005fgrp"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fgrp_005ffull_005fncid">nc_inq_grp_full_ncid</a>,
Up: <a rel="up" accesskey="u" href="#Groups">Groups</a>
</div>
<h3 class="section">3.11 Create a New Group: nc_def_grp</h3>
<p><a name="index-nc_005fdef_005fgrp-149"></a>
Create a group. Its location id is returned in the new_ncid pointer.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_def_grp(int parent_ncid, const char *name, int *new_ncid);
</pre>
<dl>
<dt><code>parent_ncid</code><dd>The group id of the parent group.
<br><dt><code>name</code><dd>The name of the new group. A group cannot have the same name as a
variable within the same parent group.
<br><dt><code>new_ncid</code><dd>A pointer to an int. The ncid of the new group will be placed there.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENAMEINUSE</code><dd>That name is in use. Group names must be unique within a group, and
must not be the same as any variable or type in the group.
<br><dt><code>NC_EMAXNAME</code><dd>Name exceed max length NC_MAX_NAME.
<br><dt><code>NC_EBADNAME</code><dd>Name contains illegal characters.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
<br><dt><code>NC_EPERM</code><dd>Attempt to write to a read-only file.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"> int ncid, a1_ncid;
char grpname[] = "assimilation1";
/* Create a group. */
if ((res = nc_def_grp(ncid, grpname, &a1_ncid)))
return res;
</pre>
<div class="node">
<a name="Dimensions"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#User-Defined-Data-Types">User Defined Data Types</a>,
Previous: <a rel="previous" accesskey="p" href="#Groups">Groups</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">4 Dimensions</h2>
<ul class="menu">
<li><a accesskey="1" href="#Dimensions-Introduction">Dimensions Introduction</a>
<li><a accesskey="2" href="#nc_005fdef_005fdim">nc_def_dim</a>: Create a Dimension
<li><a accesskey="3" href="#nc_005finq_005fdimid">nc_inq_dimid</a>: Get a Dimension ID from Its Name
<li><a accesskey="4" href="#nc_005finq_005fdim-Family">nc_inq_dim Family</a>: Inquire about a Dimension
<li><a accesskey="5" href="#nc_005frename_005fdim">nc_rename_dim</a>: Rename a Dimension
<li><a accesskey="6" href="#nc_005finq_005funlimdims">nc_inq_unlimdims</a>
</ul>
<div class="node">
<a name="Dimensions-Introduction"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fdim">nc_def_dim</a>,
Previous: <a rel="previous" accesskey="p" href="#Dimensions">Dimensions</a>,
Up: <a rel="up" accesskey="u" href="#Dimensions">Dimensions</a>
</div>
<h3 class="section">4.1 Dimensions Introduction</h3>
<p>Dimensions for a netCDF dataset are defined when it is created, while
the netCDF dataset is in define mode. Additional dimensions may be
added later by reentering define mode. A netCDF dimension has a name
and a length. In a netCDF classic or 64-bit offset file, at most one
dimension can have the unlimited length, which means variables using
this dimension can grow along this dimension. In a netCDF-4 file
multiple unlimited dimensions are supported.
<p>There is a suggested limit (100) to the number of dimensions that can
be defined in a single netCDF dataset. The limit is the value of the
predefined macro NC_MAX_DIMS. The purpose of the limit is to make
writing generic applications simpler. They need only provide an array
of NC_MAX_DIMS dimensions to handle any netCDF dataset. The
implementation of the netCDF library does not enforce this advisory
maximum, so it is possible to use more dimensions, if necessary, but
netCDF utilities that assume the advisory maximums may not be able to
handle the resulting netCDF datasets.
<p>Ordinarily, the name and length of a dimension are fixed when the
dimension is first defined. The name may be changed later, but the
length of a dimension (other than the unlimited dimension) cannot be
changed without copying all the data to a new netCDF dataset with a
redefined dimension length.
<p>Dimension lengths in the C interface are type size_t rather than type
int to make it possible to access all the data in a netCDF dataset on
a platform that only supports a 16-bit int data type, for example
MSDOS. If dimension lengths were type int instead, it would not be
possible to access data from variables with a dimension length greater
than a 16-bit int can accommodate.
<p>A netCDF dimension in an open netCDF dataset is referred to by a small
integer called a dimension ID. In the C interface, dimension IDs are
0, 1, 2, ..., in the order in which the dimensions were defined.
<p>Operations supported on dimensions are:
<ul>
<li>Create a dimension, given its name and length.
<li>Get a dimension ID from its name.
<li>Get a dimension's name and length from its ID.
<li>Rename a dimension.
</ul>
<div class="node">
<a name="nc_def_dim"></a>
<a name="nc_005fdef_005fdim"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fdimid">nc_inq_dimid</a>,
Previous: <a rel="previous" accesskey="p" href="#Dimensions-Introduction">Dimensions Introduction</a>,
Up: <a rel="up" accesskey="u" href="#Dimensions">Dimensions</a>
</div>
<h3 class="section">4.2 Create a Dimension: nc_def_dim</h3>
<p><a name="index-nc_005fdef_005fdim-150"></a><a name="index-nc_005fdef_005fdim_002c-example-151"></a>
The function nc_def_dim adds a new dimension to an open netCDF dataset
in define mode. It returns (as an argument) a dimension ID, given the
netCDF ID, the dimension name, and the dimension length. At most one
unlimited length dimension, called the record dimension, may be
defined for each classic or 64-bit offset netCDF dataset. NetCDF-4
datasets may have multiple unlimited dimensions.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_def_dim (int ncid, const char *name, size_t len, int *dimidp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF group ID, from a previous call to nc_open, nc_create,
nc_def_grp, etc.
<br><dt><code>name</code><dd>Dimension name.
<br><dt><code>len</code><dd>Length of dimension; that is, number of values for this dimension as
an index to variables that use it. This should be either a positive
integer (of type size_t) or the predefined constant NC_UNLIMITED.
<br><dt><code>dimidp</code><dd>Pointer to location for returned dimension ID.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_def_dim returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<ul>
<li>The netCDF dataset is not in definition mode.
<li>The specified dimension name is the name of another existing
dimension.
<li>The specified length is not greater than zero.
<li>The specified length is unlimited, but there is already an unlimited
length dimension defined for this netCDF dataset.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_def_dim to create a dimension named lat of
length 18 and a unlimited dimension named rec in a new netCDF dataset
named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status, ncid, latid, recid;
...
status = nc_create("foo.nc", NC_NOCLOBBER, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_def_dim(ncid, "lat", 18L, &latid);
if (status != NC_NOERR) handle_error(status);
status = nc_def_dim(ncid, "rec", NC_UNLIMITED, &recid);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_inq_dimid"></a>
<a name="nc_005finq_005fdimid"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fdim-Family">nc_inq_dim Family</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fdef_005fdim">nc_def_dim</a>,
Up: <a rel="up" accesskey="u" href="#Dimensions">Dimensions</a>
</div>
<h3 class="section">4.3 Get a Dimension ID from Its Name: nc_inq_dimid</h3>
<p><a name="index-nc_005finq_005fdimid-152"></a><a name="index-nc_005finq_005fdimid_002c-example-153"></a>
The function nc_inq_dimid returns (as an argument) the ID of a netCDF
dimension, given the name of the dimension. If ndims is the number of
dimensions defined for a netCDF dataset, each dimension has an ID
between 0 and ndims-1.
<h3 class="heading">Usage</h3>
<p>When searching for a dimension, the specified group is searched, and
then its parent group, and then its grandparent group, etc., up to
the root group.
<pre class="example"> int nc_inq_dimid (int ncid, const char *name, int *dimidp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>name</code><dd>Dimension name.
<br><dt><code>dimidp</code><dd>Pointer to location for the returned dimension ID.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_inq_dimid returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<p>The name that was specified is not the name of a dimension in the
netCDF dataset. The specified netCDF ID does not refer to an open
netCDF dataset.
<h3 class="heading">Example</h3>
<p>Here is an example using nc_inq_dimid to determine the dimension ID of
a dimension named lat, assumed to have been defined previously in an
existing netCDF dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status, ncid, latid;
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid); /* open for reading */
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_dimid(ncid, "lat", &latid);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_inq_dim-Family"></a>
<a name="nc_005finq_005fdim-Family"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005frename_005fdim">nc_rename_dim</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fdimid">nc_inq_dimid</a>,
Up: <a rel="up" accesskey="u" href="#Dimensions">Dimensions</a>
</div>
<h3 class="section">4.4 Inquire about a Dimension: nc_inq_dim Family</h3>
<p><a name="index-nc_005finq_005fdim-Family-154"></a><a name="index-nc_005finq_005fdim-155"></a><a name="index-nc_005finq_005fdimid-156"></a><a name="index-nc_005finq_005fdimids-157"></a><a name="index-nc_005finq_005fdimlen-158"></a><a name="index-nc_005finq_005fdimname-159"></a><a name="index-nc_005finq_005fdim-Family_002c-example-160"></a>
This family of functions returns information about a netCDF
dimension. Information about a dimension includes its name and its
length. The length for the unlimited dimension, if any, is the number
of records written so far.
<p>The functions in this family include nc_inq_dim, nc_inq_dimname, and
nc_inq_dimlen. The function nc_inq_dim returns all the information
about a dimension; the other functions each return just one item of
information.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_dim (int ncid, int dimid, char* name, size_t* lengthp);
int nc_inq_dimname (int ncid, int dimid, char *name);
int nc_inq_dimlen (int ncid, int dimid, size_t *lengthp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>dimid</code><dd>Dimension ID, from a previous call to nc_inq_dimid or nc_def_dim.
<br><dt><code>name</code><dd>Returned dimension name. The caller must allocate space for the
returned name. The maximum possible length, in characters, of a
dimension name is given by the predefined constant NC_MAX_NAME. (This
doesn't include the null terminator, so declare your array to be size
NC_MAX_NAME+1). The returned character array will be null-terminated.
<br><dt><code>lengthp</code><dd>Pointer to location for returned length of dimension. For the
unlimited dimension, this is the number of records written so far.
</dl>
<h3 class="heading">Errors</h3>
<p>These functions return the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<ul>
<li>The dimension ID is invalid for the specified netCDF dataset.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_inq_dim to determine the length of a
dimension named lat, and the name and current maximum length of the
unlimited dimension for an existing netCDF dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status, ncid, latid, recid;
size_t latlength, recs;
char recname[NC_MAX_NAME+1];
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid); /* open for reading */
if (status != NC_NOERR) handle_error(status);
status = nc_inq_unlimdim(ncid, &recid); /* get ID of unlimited dimension */
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_dimid(ncid, "lat", &latid); /* get ID for lat dimension */
if (status != NC_NOERR) handle_error(status);
status = nc_inq_dimlen(ncid, latid, &latlength); /* get lat length */
if (status != NC_NOERR) handle_error(status);
/* get unlimited dimension name and current length */
status = nc_inq_dim(ncid, recid, recname, &recs);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_rename_dim"></a>
<a name="nc_005frename_005fdim"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005funlimdims">nc_inq_unlimdims</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fdim-Family">nc_inq_dim Family</a>,
Up: <a rel="up" accesskey="u" href="#Dimensions">Dimensions</a>
</div>
<h3 class="section">4.5 Rename a Dimension: nc_rename_dim</h3>
<p><a name="index-nc_005frename_005fdim-161"></a><a name="index-nc_005frename_005fdim_002c-example-162"></a>
The function nc_rename_dim renames an existing dimension in a netCDF
dataset open for writing. You cannot rename a dimension to have the
same name as another dimension.
<p>For netCDF classic and 64-bit offset files, if the new name is longer
than the old name, the netCDF dataset must be in define mode.
<p>For netCDF-4 files the dataset is switched to define more for the
rename, regardless of the name length.
<h3 class="heading">Usage</h3>
<p>int nc_rename_dim(int ncid, int dimid, const char* name);
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>dimid</code><dd>Dimension ID, from a previous call to nc_inq_dimid or nc_def_dim.
<br><dt><code>name</code><dd>New dimension name.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_rename_dim returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<ul>
<li>The new name is the name of another dimension.
<li>The dimension ID is invalid for the specified netCDF dataset.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
<li>The new name is longer than the old name and the netCDF dataset is not in define mode.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_rename_dim to rename the dimension lat to
latitude in an existing netCDF dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status, ncid, latid;
...
status = nc_open("foo.nc", NC_WRITE, &ncid); /* open for writing */
if (status != NC_NOERR) handle_error(status);
...
status = nc_redef(ncid); /* put in define mode to rename dimension */
if (status != NC_NOERR) handle_error(status);
status = nc_inq_dimid(ncid, "lat", &latid);
if (status != NC_NOERR) handle_error(status);
status = nc_rename_dim(ncid, latid, "latitude");
if (status != NC_NOERR) handle_error(status);
status = nc_enddef(ncid); /* leave define mode */
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_inq_unlimdims"></a>
<a name="nc_005finq_005funlimdims"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#nc_005frename_005fdim">nc_rename_dim</a>,
Up: <a rel="up" accesskey="u" href="#Dimensions">Dimensions</a>
</div>
<h3 class="section">4.6 Find All Unlimited Dimension IDs: nc_inq_unlimdims</h3>
<p><a name="index-nc_005finq_005funlimdims-163"></a>
In netCDF-4 files, it's possible to have multiple unlimited
dimensions. This function returns a list of the unlimited dimension
ids visible in a group.
<p>Dimensions are visible in a group if they have been defined in that
group, or any ancestor group.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_unlimdims(int ncid, int *nunlimdimsp, int *unlimdimidsp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF group ID, from a previous call to nc_open, nc_create,
nc_def_grp, etc.
<br><dt><code>nunlimdimsp</code><dd>A pointer to an int which will get the number of visible unlimited
dimensions. Ignored if NULL.
<br><dt><code>unlimdimidsp</code><dd>A pointer to an already allocated array of int which will get the ids
of all visible unlimited dimensions. Ignored if NULL. To allocate the
correct length for this array, call nc_inq_unlimdims with a NULL for
this parameter and use the nunlimdimsp parameter to get the number of
visible unlimited dimensions.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag HDF5. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"> int root_ncid, num_unlimdims, unlimdims[NC_MAX_DIMS];
char file[] = "nc4_test.nc";
int res;
/* Open the file. */
if ((res = nc_open(file, NC_NOWRITE, &root_ncid)))
return res;
/* Find out if there are any unlimited dimensions in the root
group. */
if ((res = nc_inq_unlimdims(root_ncid, &num_unlimdims, unlimdims)))
return res;
printf("nc_inq_unlimdims reports %d unlimited dimensions\n", num_unlimdims);
</pre>
<div class="node">
<a name="User-Defined-Data-Types"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Variables">Variables</a>,
Previous: <a rel="previous" accesskey="p" href="#Dimensions">Dimensions</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">5 User Defined Data Types</h2>
<p><a name="index-variable-length-array-type_002c-overview-164"></a><a name="index-user-defined-types-165"></a>
<ul class="menu">
<li><a accesskey="1" href="#User-Defined-Types">User Defined Types</a>
<li><a accesskey="2" href="#nc_005finq_005ftypeids">nc_inq_typeids</a>
<li><a accesskey="3" href="#nc_005finq_005ftypeid">nc_inq_typeid</a>
<li><a accesskey="4" href="#nc_005finq_005ftype">nc_inq_type</a>
<li><a accesskey="5" href="#nc_005finq_005fuser_005ftype">nc_inq_user_type</a>
<li><a accesskey="6" href="#Compound-Types">Compound Types</a>
<li><a accesskey="7" href="#nc_005fdef_005fcompound">nc_def_compound</a>
<li><a accesskey="8" href="#nc_005finsert_005fcompound">nc_insert_compound</a>
<li><a accesskey="9" href="#nc_005finsert_005farray_005fcompound">nc_insert_array_compound</a>
<li><a href="#nc_005finq_005fcompound">nc_inq_compound</a>
<li><a href="#nc_005finq_005fcompound_005fname">nc_inq_compound_name</a>
<li><a href="#nc_005finq_005fcompound_005fsize">nc_inq_compound_size</a>
<li><a href="#nc_005finq_005fcompound_005fnfields">nc_inq_compound_nfields</a>
<li><a href="#nc_005finq_005fcompound_005ffield">nc_inq_compound_field</a>
<li><a href="#nc_005finq_005fcompound_005ffieldname">nc_inq_compound_fieldname</a>
<li><a href="#nc_005finq_005fcompound_005ffieldindex">nc_inq_compound_fieldindex</a>
<li><a href="#nc_005finq_005fcompound_005ffieldoffset">nc_inq_compound_fieldoffset</a>
<li><a href="#nc_005finq_005fcompound_005ffieldtype">nc_inq_compound_fieldtype</a>
<li><a href="#nc_005finq_005fcompound_005ffieldndims">nc_inq_compound_fieldndims</a>
<li><a href="#nc_005finq_005fcompound_005ffielddim_005fsizes">nc_inq_compound_fielddim_sizes</a>
<li><a href="#Variable-Length-Array">Variable Length Array</a>
<li><a href="#nc_005fdef_005fvlen">nc_def_vlen</a>
<li><a href="#nc_005finq_005fvlen">nc_inq_vlen</a>
<li><a href="#nc_005ffree_005fvlen">nc_free_vlen</a>
<li><a href="#nc_005ffree_005fvlens">nc_free_vlens</a>
<li><a href="#Opaque-Type">Opaque Type</a>
<li><a href="#nc_005fdef_005fopaque">nc_def_opaque</a>
<li><a href="#nc_005finq_005fopaque">nc_inq_opaque</a>
<li><a href="#Enum-Type">Enum Type</a>
<li><a href="#nc_005fdef_005fenum">nc_def_enum</a>
<li><a href="#nc_005finsert_005fenum">nc_insert_enum</a>
<li><a href="#nc_005finq_005fenum">nc_inq_enum</a>
<li><a href="#nc_005finq_005fenum_005fmember">nc_inq_enum_member</a>
<li><a href="#nc_005finq_005fenum_005fident">nc_inq_enum_ident</a>
</ul>
<div class="node">
<a name="User-Defined-Types"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005ftypeids">nc_inq_typeids</a>,
Previous: <a rel="previous" accesskey="p" href="#User-Defined-Data-Types">User Defined Data Types</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.1 User Defined Types Introduction</h3>
<p><a name="index-user-defined-types_002c-overview-166"></a>
NetCDF-4 has added support for four different user defined data
types. User defined type may only be used in files created with the
NC_NETCDF4 and without NC_CLASSIC_MODEL.
<dl>
<dt><code>compound type</code><dd>Like a C struct, a compound type is a collection of types, including
other user defined types, in one package.
<br><dt><code>variable length array type</code><dd>The variable length array may be used to store ragged arrays.
<br><dt><code>opaque type</code><dd>This type has only a size per element, and no other type information.
<br><dt><code>enum type</code><dd>Like an enumeration in C, this type lets you assign text values to
integer values, and store the integer values.
</dl>
<p>Users may construct user defined type with the various nc_def_*
functions described in this section. They may learn about user defined
types by using the nc_inq_ functions defined in this section.
<p>Once types are constructed, define variables of the new type with
nc_def_var (see <a href="#nc_005fdef_005fvar">nc_def_var</a>). Write to them with nc_put_var1,
nc_put_var, nc_put_vara, or nc_put_vars (see <a href="#Variables">Variables</a>). Read data
of user-defined type with nc_get_var1, nc_get_var, nc_get_vara, or
nc_get_vars (see <a href="#Variables">Variables</a>).
<p>Create attributes of the new type with nc_put_att
(see <a href="#nc_005fput_005fatt_005f-type">nc_put_att_ type</a>). Read attributes of the new type with nc_get_att
(see <a href="#nc_005fget_005fatt_005f-type">nc_get_att_ type</a>).
<div class="node">
<a name="nc_inq_typeids"></a>
<a name="nc_005finq_005ftypeids"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005ftypeid">nc_inq_typeid</a>,
Previous: <a rel="previous" accesskey="p" href="#User-Defined-Types">User Defined Types</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.2 Learn the IDs of All Types in Group: nc_inq_typeids</h3>
<p><a name="index-nc_005finq_005ftypeids-167"></a>
Learn the number of types defined in a group, and their IDs.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_typeids(int ncid, int *ntypes, int *typeids);
</pre>
<dl>
<dt><code>ncid</code><dd>The group id.
<br><dt><code>ntypes</code><dd>A pointer to int which will get the number of types defined in the
group. If NULL, ignored.
<br><dt><code>typeids</code><dd>A pointer to an int array which will get the typeids. If NULL,
ignored.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
</dl>
<h3 class="heading">Example</h3>
<p>The following example is from the test program
libsrc4/tst_enums.c.
<pre class="example"> if (nc_open(FILE_NAME, NC_NOWRITE, &ncid)) ERR;
/* Get type info. */
if (nc_inq_typeids(ncid, &ntypes, typeids)) ERR;
if (ntypes != 1 || !typeids[0]) ERR;
</pre>
<div class="node">
<a name="nc_inq_typeid"></a>
<a name="nc_005finq_005ftypeid"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005ftype">nc_inq_type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005ftypeids">nc_inq_typeids</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.3 Find a Typeid from Group and Name: nc_inq_typeid</h3>
<p><a name="index-nc_005finq_005ftypeid-168"></a>
Given a group ID and a type name, find the ID of the type. If the type
is not found in the group, then the parents are searched. If still not
found, the entire file is searched.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_typeid(int ncid, const char *name, nc_type *typeidp);
</pre>
<dl>
<dt><code>ncid</code><dd>The group id.
<br><dt><code>name</code><dd>The name of a type.
<br><dt><code>typeidp</code><dd>A pointer to an int which will get the typeid.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad ncid.
<br><dt><code>NC_EBADTYPE</code><dd>Can't find type.
</dl>
<h3 class="heading">Example</h3>
<p>The following example is from the test program
libsrc4/tst_vars.c. It tests that the correct names are given for
atomic types.
<pre class="example"> /* Check inquire of atomic types */
if (nc_inq_type(ncid, NC_BYTE, name_in, &size_in)) ERR;
if (strcmp(name_in, "byte") || size_in != sizeof(char)) ERR;
if (nc_inq_type(ncid, NC_CHAR, name_in, &size_in)) ERR;
if (strcmp(name_in, "char") || size_in != sizeof(char)) ERR;
if (nc_inq_type(ncid, NC_SHORT, name_in, &size_in)) ERR;
if (strcmp(name_in, "short") || size_in != sizeof(short)) ERR;
if (nc_inq_type(ncid, NC_INT, name_in, &size_in)) ERR;
if (strcmp(name_in, "int") || size_in != sizeof(int)) ERR;
if (nc_inq_type(ncid, NC_FLOAT, name_in, &size_in)) ERR;
if (strcmp(name_in, "float") || size_in != sizeof(float)) ERR;
if (nc_inq_type(ncid, NC_DOUBLE, name_in, &size_in)) ERR;
if (strcmp(name_in, "double") || size_in != sizeof(double)) ERR;
if (nc_inq_type(ncid, NC_UBYTE, name_in, &size_in)) ERR;
if (strcmp(name_in, "ubyte") || size_in != sizeof(unsigned char)) ERR;
if (nc_inq_type(ncid, NC_USHORT, name_in, &size_in)) ERR;
if (strcmp(name_in, "ushort") || size_in != sizeof(unsigned short)) ERR;
if (nc_inq_type(ncid, NC_UINT, name_in, &size_in)) ERR;
if (strcmp(name_in, "uint") || size_in != sizeof(unsigned int)) ERR;
if (nc_inq_type(ncid, NC_INT64, name_in, &size_in)) ERR;
if (strcmp(name_in, "int64") || size_in != sizeof(long long)) ERR;
if (nc_inq_type(ncid, NC_UINT64, name_in, &size_in)) ERR;
if (strcmp(name_in, "uint64") || size_in != sizeof(unsigned long long)) ERR;
if (nc_inq_type(ncid, NC_STRING, name_in, &size_in)) ERR;
if (strcmp(name_in, "string") || size_in != 0) ERR;
if (xtype_in != NC_SHORT) ERR;
</pre>
<div class="node">
<a name="nc_inq_type"></a>
<a name="nc_005finq_005ftype"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fuser_005ftype">nc_inq_user_type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005ftypeid">nc_inq_typeid</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.4 Learn About a User Defined Type: nc_inq_type</h3>
<p><a name="index-nc_005finq_005ftype-169"></a>
Given an ncid and a typeid, get the information about a type. This
function will work on any type, including atomic and any user defined
type, whether compound, opaque, enumeration, or variable length array.
<p>For even more information about a user defined type <a href="#nc_005finq_005fuser_005ftype">nc_inq_user_type</a>.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_inq_type(int ncid, nc_type xtype, char *name, size_t *sizep);
</pre>
<dl>
<dt><code>ncid</code><dd>The ncid for the group containing the type (ignored for atomic types).
<br><dt><code>xtype</code><dd>The typeid for this type, as returned by nc_def_compound,
nc_def_opaque, nc_def_enum, nc_def_vlen, or nc_inq_var, or as found in
netcdf.h in the list of atomic types (NC_CHAR, NC_INT, etc.).
<br><dt><code>name</code><dd>If non-NULL, the name of the user defined type will be copied here. It
will be NC_MAX_NAME bytes or less. For atomic types, the type name
from CDL will be given.
<br><dt><code>sizep</code><dd>If non-NULL, the (in-memory) size of the type in bytes will be copied
here. VLEN type size is the size of nc_vlen_t. String size is returned
as the size of a character pointer. The size may be used to malloc
space for the data, no matter what the type.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad typeid.
<br><dt><code>NC_ENOTNC4</code><dd>Seeking a user-defined type in a netCDF-3 file.
<br><dt><code>NC_ESTRICTNC3</code><dd>Seeking a user-defined type in a netCDF-4 file for which classic model
has been turned on.
<br><dt><code>NC_EBADGRPID</code><dd>Bad group ID in ncid.
<br><dt><code>NC_EBADID</code><dd>Type ID not found.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from the test program tst_enums.c, and it uses all the
possible inquiry functions on an enum type.
<pre class="example"> /* Check it out. */
if (nc_inq_user_type(ncid, typeids[0], name_in, &base_size_in, &base_nc_type_in,
&nfields_in, &class_in)) ERR;
if (strcmp(name_in, TYPE_NAME) || base_size_in != sizeof(int) ||
base_nc_type_in != NC_INT || nfields_in != NUM_MEMBERS || class_in != NC_ENUM) ERR;
if (nc_inq_type(ncid, typeids[0], name_in, &base_size_in)) ERR;
if (strcmp(name_in, TYPE_NAME) || base_size_in != sizeof(int)) ERR;
if (nc_inq_enum(ncid, typeids[0], name_in, &base_nc_type, &base_size_in, &num_members)) ERR;
if (strcmp(name_in, TYPE_NAME) || base_nc_type != NC_INT || num_members != NUM_MEMBERS) ERR;
for (i = 0; i < NUM_MEMBERS; i++)
{
if (nc_inq_enum_member(ncid, typeid, i, name_in, &value_in)) ERR;
if (strcmp(name_in, member_name[i]) || value_in != member_value[i]) ERR;
if (nc_inq_enum_ident(ncid, typeid, member_value[i], name_in)) ERR;
if (strcmp(name_in, member_name[i])) ERR;
}
if (nc_close(ncid)) ERR;
</pre>
<div class="node">
<a name="nc_inq_user_type"></a>
<a name="nc_005finq_005fuser_005ftype"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Compound-Types">Compound Types</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005ftype">nc_inq_type</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.5 Learn About a User Defined Type: nc_inq_user_type</h3>
<p><a name="index-nc_005finq_005fuser_005ftype-170"></a>
Given an ncid and a typeid, get the information about a user defined
type. This function will work on any user defined type, whether
compound, opaque, enumeration, or variable length array.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_inq_user_type(int ncid, nc_type xtype, char *name, size_t *sizep,
nc_type *base_nc_typep, size_t *nfieldsp, int *classp);
</pre>
<dl>
<dt><code>ncid</code><dd>The ncid for the group containing the user defined type.
<br><dt><code>xtype</code><dd>The typeid for this type, as returned by nc_def_compound,
nc_def_opaque, nc_def_enum, nc_def_vlen, or nc_inq_var.
<br><dt><code>name</code><dd>If non-NULL, the name of the user defined type will be copied here. It
will be NC_MAX_NAME bytes or less.
<br><dt><code>sizep</code><dd>If non-NULL, the (in-memory) size of the type in bytes will be copied
here. VLEN type size is the size of nc_vlen_t. String size is returned
as the size of a character pointer. The size may be used to malloc
space for the data, no matter what the type.
<br><dt><code>nfieldsp</code><dd>If non-NULL, the number of fields will be copied here for enum and
compound types.
<br><dt><code>classp</code><dd>Return the class of the user defined type, NC_VLEN, NC_OPAQUE,
NC_ENUM, or NC_COMPOUND.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad typeid.
<br><dt><code>NC_EBADFIELDID</code><dd>Bad fieldid.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"> /* Create a file. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
/* Create an enum type. */
if (nc_def_enum(ncid, NC_INT, TYPE_NAME, &typeid)) ERR;
for (i = 0; i < NUM_MEMBERS; i++)
if (nc_insert_enum(ncid, typeid, member_name[i],
&member_value[i])) ERR;
/* Check it out. */
if (nc_inq_user_type(ncid, typeid, name_in, &base_size_in, &base_nc_type_in,
&nfields_in, &class_in)) ERR;
if (strcmp(name_in, TYPE_NAME) || base_size_in != sizeof(int) ||
base_nc_type_in != NC_INT || nfields_in != NUM_MEMBERS || class_in != NC_ENUM) ERR;
</pre>
<div class="node">
<a name="Compound-Types"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fcompound">nc_def_compound</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fuser_005ftype">nc_inq_user_type</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.6 Compound Types Introduction</h3>
<p><a name="index-compound-types_002c-overview-171"></a>
Compound data types can be defined for netCDF-4/HDF5 format files. A
compound datatype is similar to a struct in C and contains a collection
of one or more atomic or user-defined types. The netCDF-4 compound data
must comply with the properties and constraints of the HDF5 compound
data type in terms of which it is implemented.
<p>In summary these are:
<ul>
<li>It has a fixed total size.
<li>It consists of zero or more named members that
do not overlap with other members.
<li>Each member has a name distinct from other members.
<li>Each member has its own datatype.
<li>Each member is referenced by an index number between zero and
N-1, where N is the number of members in the compound datatype.
<li>Each member has a fixed byte offset, which is the first byte
(smallest byte address) of that member in the compound datatype.
<li>In addition to other other user-defined data types or atomic
datatypes, a member can be a small fixed-size array of any type
with up to four fixed-size “dimensions” (not associated with named
netCDF dimensions).
</ul>
<p>Currently there is an HDF5 restriction on total size of a
compound type to not larger than 2^16 = 65536 bytes. Attempts to
exceed this limit result in an NC_EHDFERR error.
<p>Compound types are not supported in classic or 64-bit offset format
files.
<p>To write data in a compound type, first use nc_def_compound to create the
type, multiple calls to nc_insert_compound to add to the compound type, and
then write data with the appropriate nc_put_var1, nc_put_vara,
nc_put_vars, or nc_put_varm call.
<p>To read data written in a compound type, you must know its
structure. Use the nc_inq_compound functions to learn about the compound
type.
<ul class="menu">
<li><a accesskey="1" href="#nc_005fdef_005fcompound">nc_def_compound</a>
<li><a accesskey="2" href="#nc_005finsert_005fcompound">nc_insert_compound</a>
<li><a accesskey="3" href="#nc_005finq_005fcompound">nc_inq_compound</a>
<li><a accesskey="4" href="#nc_005finq_005fcompound_005ffieldname">nc_inq_compound_fieldname</a>
<li><a accesskey="5" href="#nc_005finq_005fcompound_005ffieldindex">nc_inq_compound_fieldindex</a>
<li><a accesskey="6" href="#nc_005finq_005fcompound_005ffieldoffset">nc_inq_compound_fieldoffset</a>
<li><a accesskey="7" href="#nc_005finq_005fcompound_005ffieldtype">nc_inq_compound_fieldtype</a>
</ul>
<div class="node">
<a name="nc_def_compound"></a>
<a name="nc_005fdef_005fcompound"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finsert_005fcompound">nc_insert_compound</a>,
Previous: <a rel="previous" accesskey="p" href="#Compound-Types">Compound Types</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.7 Creating a Compound Type: nc_def_compound</h3>
<p><a name="index-nc_005fdef_005fcompound-172"></a>
Create a compound type. Provide an ncid, a name, and a total size (in
bytes) of one element of the completed compound type.
<p>After calling this function, fill out the type with repeated calls to
nc_insert_compound (see <a href="#nc_005finsert_005fcompound">nc_insert_compound</a>). Call
nc_insert_compound once for each field you wish to insert into the
compound type.
<p>Note that there does not seem to be a way to read such types into
structures in Fortran 90 (and there are no structures in Fortran 77).
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_def_compound(int ncid, size_t size, const char *name, nc_type *typeidp);
</pre>
<dl>
<dt><code>ncid</code><dd>The groupid where this compound type will be created.
<br><dt><code>size</code><dd>The size, in bytes, of the compound type.
<br><dt><code>name</code><dd>The name of the new compound type.
<br><dt><code>typeidp</code><dd>A pointer to an nc_type. The typeid of the new type will be placed there.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENAMEINUSE</code><dd>That name is in use.
<br><dt><code>NC_EMAXNAME</code><dd>Name exceeds max length NC_MAX_NAME.
<br><dt><code>NC_EBADNAME</code><dd>Name contains illegal characters.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag NC_NETCDF4. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
<br><dt><code>NC_EPERM</code><dd>Attempt to write to a read-only file.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"> struct s1
{
int i1;
int i2;
};
struct s1 data[DIM_LEN], data_in[DIM_LEN];
/* Create a file with a compound type. Write a little data. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_compound(ncid, sizeof(struct s1), SVC_REC, &typeid)) ERR;
if (nc_insert_compound(ncid, typeid, BATTLES_WITH_KLINGONS,
HOFFSET(struct s1, i1), NC_INT)) ERR;
if (nc_insert_compound(ncid, typeid, DATES_WITH_ALIENS,
HOFFSET(struct s1, i2), NC_INT)) ERR;
if (nc_def_dim(ncid, STARDATE, DIM_LEN, &dimid)) ERR;
if (nc_def_var(ncid, SERVICE_RECORD, typeid, 1, dimids, &varid)) ERR;
if (nc_put_var(ncid, varid, data)) ERR;
if (nc_close(ncid)) ERR;
</pre>
<div class="node">
<a name="nc_insert_compound"></a>
<a name="nc_005finsert_005fcompound"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finsert_005farray_005fcompound">nc_insert_array_compound</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fdef_005fcompound">nc_def_compound</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.8 Inserting a Field into a Compound Type: nc_insert_compound</h3>
<p><a name="index-nc_005finsert_005fcompound-173"></a>
Insert a named field into a compound type.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_insert_compound(int ncid, nc_type typeid, const char *name, size_t offset,
nc_type field_typeid);
</pre>
<dl>
<dt><code>ncid</code><dd>The groupid where a field for this compound type will be inserted.
<br><dt><code>typeid</code><dd>The typeid for this compound type, as returned by nc_def_compound, or
nc_inq_var.
<br><dt><code>name</code><dd>The name of the new field.
<br><dt><code>offset</code><dd>Offset in byte from the beginning of the compound type for this
field.
<br><dt><code>field_typeid</code><dd>The type of the field to be inserted.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENAMEINUSE</code><dd>That name is in use. Field names must be unique within a compound type.
<br><dt><code>NC_EMAXNAME</code><dd>Name exceed max length NC_MAX_NAME.
<br><dt><code>NC_EBADNAME</code><dd>Name contains illegal characters.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag NC_NETCDF4. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"></pre>
<div class="node">
<a name="nc_insert_array_compound"></a>
<a name="nc_005finsert_005farray_005fcompound"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fcompound">nc_inq_compound</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finsert_005fcompound">nc_insert_compound</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.9 Inserting an Array Field into a Compound Type: nc_insert_array_compound</h3>
<p><a name="index-nc_005finsert_005farray_005fcompound-174"></a>
Insert a named field into a compound type.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_insert_array_compound(int ncid, nc_type xtype, const char *name,
size_t offset, nc_type field_typeid,
int ndims, const int *dim_sizes);
</pre>
<dl>
<dt><code>ncid</code><dd>The ID of the file that contains the array type and the compound type.
<br><dt><code>xtype</code><dd>The typeid for this compound type, as returned by nc_def_compound, or
nc_inq_var.
<br><dt><code>name</code><dd>The name of the new field.
<br><dt><code>offset</code><dd>Offset in byte from the beginning of the compound type for this
field.
<br><dt><code>field_typeid</code><dd>The base type of the array to be inserted.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENAMEINUSE</code><dd>That name is in use. Field names must be unique within a compound type.
<br><dt><code>NC_EMAXNAME</code><dd>Name exceed max length NC_MAX_NAME.
<br><dt><code>NC_EBADNAME</code><dd>Name contains illegal characters.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag NC_NETCDF4. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode.
<br><dt><code>NC_ETYPEDEFINED</code><dd>Attempt to change type that has already been committed. The first time
the file leaves define mode, all defined types are committed, and
can't be changed. If you wish to add an array to a compound type, you
must do so before the compound type is committed.
</dl>
<h3 class="heading">Example</h3>
<p>This example comes from the test file libsrc4/tst_compounds.c, which
writes data about some Star Fleet officers who are known to use netCDF
data.
<pre class="example"> /* Since some aliens exists in different, or more than one,
* dimensions, StarFleet keeps track of the dimensional abilities
* of everyone on 7 dimensions. */
#define NUM_DIMENSIONS 7
struct dim_rec
{
int starfleet_id;
int abilities[NUM_DIMENSIONS];
};
struct dim_rec dim_data_out[DIM_LEN], dim_data_in[DIM_LEN];
/* Create some phoney data. */
for (i=0; i<DIM_LEN; i++)
{
/* snip */
/* Dimensional data. */
dim_data_out[i].starfleet_id = i;
for (j = 0; j < NUM_DIMENSIONS; j++)
dim_data_out[i].abilities[j] = j;
/* snip */
}
printf("*** testing compound variable containing an array of ints...");
{
nc_type field_typeid;
int dim_sizes[] = {NUM_DIMENSIONS};
/* Create a file with a compound type which contains an array of
* int. Write a little data. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_compound(ncid, sizeof(struct dim_rec), "SFDimRec", &typeid)) ERR;
if (nc_insert_compound(ncid, typeid, "starfleet_id",
HOFFSET(struct dim_rec, starfleet_id), NC_INT)) ERR;
if (nc_insert_array_compound(ncid, typeid, "abilities",
HOFFSET(struct dim_rec, abilities), NC_INT, 1, dim_sizes)) ERR;
if (nc_inq_compound_field(ncid, xtype, 1, name, &offset, &field_typeid,
&field_ndims, field_sizes)) ERR;
if (strcmp(name, "abilities") || offset != 4 || field_typeid != NC_INT ||
field_ndims != 1 || field_sizes[0] != dim_sizes[0]) ERR;
if (nc_def_dim(ncid, STARDATE, DIM_LEN, &dimid)) ERR;
if (nc_def_var(ncid, "dimension_data", typeid, 1, dimids, &varid)) ERR;
if (nc_put_var(ncid, varid, dim_data_out)) ERR;
if (nc_close(ncid)) ERR;
/* Open the file and take a look. */
if (nc_open(FILE_NAME, NC_WRITE, &ncid)) ERR;
if (nc_inq_var(ncid, 0, name, &xtype, &ndims, dimids, &natts)) ERR;
if (strcmp(name, "dimension_data") || ndims != 1 || natts != 0 || dimids[0] != 0) ERR;
if (nc_inq_compound(ncid, xtype, name, &size, &nfields)) ERR;
if (nfields != 2 || size != sizeof(struct dim_rec) || strcmp(name, "SFDimRec")) ERR;
if (nc_inq_compound_field(ncid, xtype, 1, name, &offset, &field_typeid,
&field_ndims, field_sizes)) ERR;
if (strcmp(name, "abilities") || offset != 4 || field_typeid != NC_INT ||
field_ndims != 1 || field_sizes[0] != NUM_DIMENSIONS) ERR;
if (nc_get_var(ncid, varid, dim_data_in)) ERR;
for (i=0; i<DIM_LEN; i++)
{
if (dim_data_in[i].starfleet_id != dim_data_out[i].starfleet_id) ERR;
for (j = 0; j < NUM_DIMENSIONS; j++)
if (dim_data_in[i].abilities[j] != dim_data_out[i].abilities[j]) ERR;
}
if (nc_close(ncid)) ERR;
}
</pre>
<div class="node">
<a name="nc_inq_compound"></a>
<a name="nc_005finq_005fcompound"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fcompound_005fname">nc_inq_compound_name</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finsert_005farray_005fcompound">nc_insert_array_compound</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.10 Learn About a Compound Type: nc_inq_compound</h3>
<p><a name="index-nc_005finq_005fcompound-175"></a>
Get the number of fields, len, and name of a compound type.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_compound(int ncid, nc_type xtype, char *name, size_t *sizep,
size_t *nfieldsp);
</pre>
<dl>
<dt><code>ncid</code><dd>The ID of any group in the file that contains the compound type.
<br><dt><code>xtype</code><dd>The typeid for this compound type, as returned by nc_def_compound, or
nc_inq_var.
<br><dt><code>name</code><dd>Pointer to an already allocated char array which will get the name, as
a null terminated string. It will have a maximum length of
NC_MAX_NAME + 1. Ignored if NULL.
<br><dt><code>sizep</code><dd>A pointer to a size_t. The size of the compound type will be put
here. Ignored if NULL.
<br><dt><code>nfieldsp</code><dd>A pointer to a size_t. The number of fields in the compound type will
be placed here. Ignored if NULL.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Couldn't find this ncid.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4/HDF5 file.
<br><dt><code>NC_ESTRICTNC3</code><dd>A netCDF-4/HDF5 file, but with CLASSIC_MODEL. No user defined types
are allowed in the classic model.
<br><dt><code>NC_EBADTYPE</code><dd>This type not a compound type.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad type id.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>The following example is from the test program
libsrc4/tst_compounds.c. See also the example for
See <a href="#nc_005finsert_005farray_005fcompound">nc_insert_array_compound</a>.
<pre class="example"> #define BATTLES_WITH_KLINGONS "Number_of_Battles_with_Klingons"
#define DATES_WITH_ALIENS "Dates_with_Alien_Hotties"
struct s1
{
int i1;
int i2;
};
/* Create a file with a compound type. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_compound(ncid, sizeof(struct s1), SVC_REC, &typeid)) ERR;
if (nc_inq_compound(ncid, typeid, name, &size, &nfields)) ERR;
if (nfields) ERR;
if (nc_insert_compound(ncid, typeid, BATTLES_WITH_KLINGONS,
HOFFSET(struct s1, i1), NC_INT)) ERR;
if (nc_insert_compound(ncid, typeid, DATES_WITH_ALIENS,
HOFFSET(struct s1, i2), NC_INT)) ERR;
/* Check the compound type. */
if (nc_inq_compound(ncid, xtype, name, &size, &nfields)) ERR;
if (nfields != 2 || size != 8 || strcmp(name, SVC_REC)) ERR;
if (nc_inq_compound_name(ncid, xtype, name)) ERR;
if (strcmp(name, SVC_REC)) ERR;
if (nc_inq_compound_size(ncid, xtype, &size)) ERR;
if (size != 8) ERR;
if (nc_inq_compound_nfields(ncid, xtype, &nfields)) ERR;
if (nfields != 2) ERR;
if (nc_inq_compound_field(ncid, xtype, 0, name, &offset, &field_xtype, &field_ndims, field_sizes)) ERR;
if (strcmp(name, BATTLES_WITH_KLINGONS) || offset != 0 || (field_xtype != NC_INT || field_ndims != 0)) ERR;
if (nc_inq_compound_field(ncid, xtype, 1, name, &offset, &field_xtype, &field_ndims, field_sizes)) ERR;
if (strcmp(name, DATES_WITH_ALIENS) || offset != 4 || field_xtype != NC_INT) ERR;
if (nc_inq_compound_fieldname(ncid, xtype, 1, name)) ERR;
if (strcmp(name, DATES_WITH_ALIENS)) ERR;
if (nc_inq_compound_fieldindex(ncid, xtype, BATTLES_WITH_KLINGONS, &fieldid)) ERR;
if (fieldid != 0) ERR;
if (nc_inq_compound_fieldoffset(ncid, xtype, 1, &offset)) ERR;
if (offset != 4) ERR;
if (nc_inq_compound_fieldtype(ncid, xtype, 1, &field_xtype)) ERR;
if (field_xtype != NC_INT) ERR;
</pre>
<div class="node">
<a name="nc_inq_compound_name"></a>
<a name="nc_005finq_005fcompound_005fname"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fcompound_005fsize">nc_inq_compound_size</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fcompound">nc_inq_compound</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.11 Learn the Name of a Compound Type: nc_inq_compound_name</h3>
<p><a name="index-nc_005finq_005fcompound_005fname-176"></a>
Get the name of a compound type.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_compound_name(int ncid, nc_type xtype, char *name);
</pre>
<dl>
<dt><code>ncid</code><dd>The groupid where this compound type exists.
<br><dt><code>xtype</code><dd>The typeid for this compound type.
<br><dt><code>name</code><dd>Pointer to an already allocated char array which will get the name, as
a null terminated string. It will have a maximum length of
NC_MAX_NAME+1.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad type id.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>See the example section for <a href="#nc_005finq_005fcompound">nc_inq_compound</a>.
<div class="node">
<a name="nc_inq_compound_size"></a>
<a name="nc_005finq_005fcompound_005fsize"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fcompound_005fnfields">nc_inq_compound_nfields</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fcompound_005fname">nc_inq_compound_name</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.12 Learn the Size of a Compound Type: nc_inq_compound_size</h3>
<p><a name="index-nc_005finq_005fcompound_005fsize-177"></a>
Get the len of a compound type.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_compound_size(int ncid, nc_type xtype, size_t *sizep);
</pre>
<dl>
<dt><code>ncid</code><dd>The groupid where this compound type exists.
<br><dt><code>xtype</code><dd>The typeid for this compound type.
<br><dt><code>size</code><dd>A pointer, which, if not NULL, get the size of the compound type.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad type id.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>See the example section for <a href="#nc_005finq_005fcompound">nc_inq_compound</a>.
<div class="node">
<a name="nc_inq_compound_nfields"></a>
<a name="nc_005finq_005fcompound_005fnfields"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fcompound_005ffield">nc_inq_compound_field</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fcompound_005fsize">nc_inq_compound_size</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.13 Learn the Number of Fields in a Compound Type: nc_inq_compound_nfields</h3>
<p><a name="index-nc_005finq_005fcompound_005fnfields-178"></a>
Get the number of fields of a compound type.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_inq_compound_nfields(int ncid, nc_type xtype, size_t *nfieldsp);
</pre>
<dl>
<dt><code>ncid</code><dd>The groupid where this compound type exists.
<br><dt><code>xtype</code><dd>The typeid for this compound type.
<br><dt><code>nfieldsp</code><dd>A pointer, which, if not NULL, get the number of fields of the
compound type.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad type id.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>See the example section for <a href="#nc_005finq_005fcompound">nc_inq_compound</a>.
<div class="node">
<a name="nc_inq_compound_field"></a>
<a name="nc_005finq_005fcompound_005ffield"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fcompound_005ffieldname">nc_inq_compound_fieldname</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fcompound_005fnfields">nc_inq_compound_nfields</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.14 Learn About a Field of a Compound Type: nc_inq_compound_field</h3>
<p><a name="index-nc_005finq_005fcompound_005ffield-179"></a>
Get information about one of the fields of a compound type.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_compound_field(int ncid, nc_type xtype, int fieldid, char *name,
size_t *offsetp, nc_type *field_typeidp, int *ndimsp,
int *dim_sizesp);
</pre>
<dl>
<dt><code>ncid</code><dd>The groupid where this compound type exists.
<br><dt><code>xtype</code><dd>The typeid for this compound type, as returned by nc_def_compound, or
nc_inq_var.
<br><dt><code>fieldid</code><dd>A zero-based index number specifying a field in the compound type.
<br><dt><code>name</code><dd>A pointer which, if non-NULL, will get the name of the field.
<br><dt><code>offsetp</code><dd>A pointer which, if non-NULL, will get the offset of the field.
<br><dt><code>field_typeid</code><dd>A pointer which, if non-NULL, will get the typeid of the field.
<br><dt><code>ndimsp</code><dd>A pointer which, if non-NULL, will get the number of dimensions of the field.
<br><dt><code>dim_sizesp</code><dd>A pointer which, if non-NULL, will get the dimension sizes of the field.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad type id.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>See the example section for <a href="#nc_005finq_005fcompound">nc_inq_compound</a>.
<div class="node">
<a name="nc_inq_compound_fieldname"></a>
<a name="nc_005finq_005fcompound_005ffieldname"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fcompound_005ffieldindex">nc_inq_compound_fieldindex</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fcompound_005ffield">nc_inq_compound_field</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.15 Find the Name of a Field in a Compound Type: nc_inq_compound_fieldname</h3>
<p><a name="index-nc_005finq_005fcompound_005ffieldname-180"></a>
Given the typeid and the fieldid, get the name.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_compound_fieldname(nc_type typeid, int fieldid, char *name);
</pre>
<dl>
<dt><code>typeid</code><dd>The typeid for this compound type, as returned by nc_def_compound, or
nc_inq_var.
<br><dt><code>fieldid</code><dd>The id of the field in the compound type. Fields are numbered starting
with 0 for the first inserted field.
<br><dt><code>name</code><dd>Pointer to an already allocated char array which will get the name, as
a null terminated string. It will have a maximum length of
NC_MAX_NAME+1.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad type id.
<br><dt><code>NC_EBADFIELDID</code><dd>Bad field id.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>See the example section for <a href="#nc_005finq_005fcompound">nc_inq_compound</a>.
<div class="node">
<a name="nc_inq_compound_fieldindex"></a>
<a name="nc_005finq_005fcompound_005ffieldindex"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fcompound_005ffieldoffset">nc_inq_compound_fieldoffset</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fcompound_005ffieldname">nc_inq_compound_fieldname</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.16 Get the FieldID of a Compound Type Field: nc_inq_compound_fieldindex</h3>
<p><a name="index-nc_005finq_005fcompound_005ffieldindex-181"></a>
Given the typeid and the name, get the fieldid.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_compound_fieldindex(nc_type typeid, const char *name, int *fieldidp);
</pre>
<dl>
<dt><code>typeid</code><dd>The typeid for this compound type, as returned by nc_def_compound, or
nc_inq_var.
<br><dt><code>name</code><dd>The name of the field.
<br><dt><code>fieldidp</code><dd>A pointer to an int which will get the field id of the named field.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad type id.
<br><dt><code>NC_EUNKNAME</code><dd>Can't find field of this name.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>See the example section for <a href="#nc_005finq_005fcompound">nc_inq_compound</a>.
<div class="node">
<a name="nc_inq_compound_fieldoffset"></a>
<a name="nc_005finq_005fcompound_005ffieldoffset"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fcompound_005ffieldtype">nc_inq_compound_fieldtype</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fcompound_005ffieldindex">nc_inq_compound_fieldindex</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.17 Get the Offset of a Field: nc_inq_compound_fieldoffset</h3>
<p><a name="index-nc_005finq_005fcompound_005ffieldoffset-182"></a>
Given the typeid and fieldid, get the offset.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_compound_fieldoffset(nc_type typeid, int fieldid,
size_t *offsetp);
</pre>
<dl>
<dt><code>typeid</code><dd>The typeid for this compound type, as returned by nc_def_compound, or
nc_inq_var.
<br><dt><code>fieldid</code><dd>The id of the field in the compound type. Fields are numbered starting
with 0 for the first inserted field.
<br><dt><code>offsetp</code><dd>A pointer to a size_t. The offset of the field will be placed there.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad typeid.
<br><dt><code>NC_EBADFIELDID</code><dd>Bad fieldid.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>See the example section for <a href="#nc_005finq_005fcompound">nc_inq_compound</a>.
<div class="node">
<a name="nc_inq_compound_fieldtype"></a>
<a name="nc_005finq_005fcompound_005ffieldtype"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fcompound_005ffieldndims">nc_inq_compound_fieldndims</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fcompound_005ffieldoffset">nc_inq_compound_fieldoffset</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.18 Find the Type of a Field: nc_inq_compound_fieldtype</h3>
<p><a name="index-nc_005finq_005fcompound_005ffieldtype-183"></a>
Given the typeid and the fieldid, get the type of that field.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_inq_compound_fieldtype(nc_type typeid, int fieldid, nc_type *field_typeidp);
</pre>
<dl>
<dt><code>typeid</code><dd>The typeid for this compound type, as returned by nc_def_compound, or
nc_inq_var.
<br><dt><code>fieldid</code><dd>The id of the field in the compound type. Fields are numbered starting
with 0 for the first inserted field.
<br><dt><code>field_typeidp</code><dd>Pointer to a nc_type which will get the typeid of the field.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad typeid.
<br><dt><code>NC_EBADFIELDID</code><dd>Bad fieldid.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>See the example section for <a href="#nc_005finq_005fcompound">nc_inq_compound</a>.
<div class="node">
<a name="nc_inq_compound_fieldndims"></a>
<a name="nc_005finq_005fcompound_005ffieldndims"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fcompound_005ffielddim_005fsizes">nc_inq_compound_fielddim_sizes</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fcompound_005ffieldtype">nc_inq_compound_fieldtype</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.19 Find the Number of Dimensions in an Array Field: nc_inq_compound_fieldndims</h3>
<p><a name="index-nc_005finq_005fcompound_005ffieldndims-184"></a>
Given the typeid and the fieldid, get the number of dimensions of that
field.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_compound_fieldndims(int ncid, nc_type xtype, int fieldid,
int *ndimsp);
</pre>
<dl>
<dt><code>ncid</code><dd>The file or group ID.
<br><dt><code>xtype</code><dd>The typeid for this compound type, as returned by nc_def_compound, or
nc_inq_var.
<br><dt><code>fieldid</code><dd>The id of the field in the compound type. Fields are numbered starting
with 0 for the first inserted field.
<br><dt><code>ndimsp</code><dd>Pointer to an int which will get the number of dimensions of the
field. Non-array fields have 0 dimensions.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad typeid.
<br><dt><code>NC_EBADFIELDID</code><dd>Bad fieldid.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>See the example section for <a href="#nc_005finq_005fcompound">nc_inq_compound</a>.
<div class="node">
<a name="nc_inq_compound_fielddim_sizes"></a>
<a name="nc_005finq_005fcompound_005ffielddim_005fsizes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Variable-Length-Array">Variable Length Array</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fcompound_005ffieldndims">nc_inq_compound_fieldndims</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.20 Find the Sizes of Dimensions in an Array Field: nc_inq_compound_fielddim_sizes</h3>
<p><a name="index-nc_005finq_005fcompound_005ffielddim_005fsizes-185"></a>
Given the xtype and the fieldid, get the sizes of dimensions for
that field. User must have allocated storage for the dim_sizes.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_compound_fielddim_sizes(int ncid, nc_type xtype, int fieldid,
int *dim_sizes);
</pre>
<dl>
<dt><code>ncid</code><dd>The file or group ID.
<br><dt><code>xtype</code><dd>The typeid for this compound type, as returned by nc_def_compound, or
nc_inq_var.
<br><dt><code>fieldid</code><dd>The id of the field in the compound type. Fields are numbered starting
with 0 for the first inserted field.
<br><dt><code>dim_sizesp</code><dd>Pointer to an array of int which will get the sizes of the dimensions
of the field. Non-array fields have 0 dimensions.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad typeid.
<br><dt><code>NC_EBADFIELDID</code><dd>Bad fieldid.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>See the example section for <a href="#nc_005finq_005fcompound">nc_inq_compound</a>.
<div class="node">
<a name="Variable-Length-Array"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fvlen">nc_def_vlen</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fcompound_005ffielddim_005fsizes">nc_inq_compound_fielddim_sizes</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.21 Variable Length Array Introduction</h3>
<p><a name="index-variable-length-arrays-186"></a><a name="index-VLEN-187"></a>
NetCDF-4 added support for a variable length array type. This is not
supported in classic or 64-bit offset files, or in netCDF-4 files
which were created with the NC_CLASSIC_MODEL flag.
<p>A variable length array is represented in C as a structure from HDF5,
the nc_vlen_t structure. It contains a len member, which contains the
length of that array, and a pointer to the array.
<p>So an array of VLEN in C is an array of nc_vlen_t structures.
<p>VLEN arrays are handled differently with respect to allocation of
memory. Generally, when reading data, it is up to the user to malloc
(and subsequently free) the memory needed to hold the data. It is up to
the user to ensure that enough memory is allocated.
<p>With VLENs, this is impossible. The user cannot know the size of an
array of VLEN until after reading the array. Therefore when reading
VLEN arrays, the netCDF library will allocate the memory for the data within
each VLEN.
<p>It is up to the user, however, to eventually free this memory. This is
not just a matter of one call to free, with the pointer to the array
of VLENs; each VLEN contains a pointer which must be freed.
<p>When dynamically allocating space to hold an array of VLEN, allocate
storage for an array of nc_vlen_t.
<p>Compression is permitted but may not be effective for VLEN data,
because the compression is applied to the nc_vlen_t structs, rather
than the actual data.
<div class="node">
<a name="nc_def_vlen"></a>
<a name="nc_005fdef_005fvlen"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fvlen">nc_inq_vlen</a>,
Previous: <a rel="previous" accesskey="p" href="#Variable-Length-Array">Variable Length Array</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.22 Define a Variable Length Array (VLEN): nc_def_vlen</h3>
<p><a name="index-nc_005fdef_005fvlen-188"></a><a name="index-VLEN_002c-defining-189"></a>
Use this function to define a variable length array type.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_def_vlen(int ncid, const char *name, nc_type base_typeid, nc_type *xtypep);
</pre>
<dl>
<dt><code>ncid</code><dd>The ncid of the file to create the VLEN type in.
<br><dt><code>name</code><dd>A name for the VLEN type.
<br><dt><code>base_typeid</code><dd>The typeid of the base type of the VLEN. For example, for a VLEN of
shorts, the base type is NC_SHORT. This can be a user defined type.
<br><dt><code>xtypep</code><dd>A pointer to an nc_type variable. The typeid of the new VLEN type will
be set here.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EMAXNAME</code><dd>NC_MAX_NAME exceeded.
<br><dt><code>NC_ENAMEINUSE</code><dd>Name is already in use.
<br><dt><code>NC_EBADNAME</code><dd>Attribute or variable name contains illegal characters.
<br><dt><code>NC_EBADID</code><dd>ncid invalid.
<br><dt><code>NC_EBADGRPID</code><dd>Group ID part of ncid was invalid.
<br><dt><code>NC_EINVAL</code><dd>Size is invalid.
<br><dt><code>NC_ENOMEM</code><dd>Out of memory.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"> #define DIM_LEN 3
#define ATT_NAME "att_name"
nc_vlen_t data[DIM_LEN];
int *phony;
/* Create phony data. */
for (i=0; i<DIM_LEN; i++)
{
if (!(phony = malloc(sizeof(int) * i+1)))
return NC_ENOMEM;
for (j=0; j<i+1; j++)
phony[j] = -99;
data[i].p = phony;
data[i].len = i+1;
}
/* Define a VLEN of NC_INT, and write an attribute of that
type. */
if (nc_def_vlen(ncid, "name1", NC_INT, &typeid)) ERR;
if (nc_put_att(ncid, NC_GLOBAL, ATT_NAME, typeid, DIM_LEN, data)) ERR;
</pre>
<div class="node">
<a name="nc_inq_vlen"></a>
<a name="nc_005finq_005fvlen"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005ffree_005fvlen">nc_free_vlen</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fdef_005fvlen">nc_def_vlen</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.23 Learning about a Variable Length Array (VLEN) Type: nc_inq_vlen</h3>
<p><a name="index-nc_005fdef_005fvlen-190"></a><a name="index-VLEN_002c-defining-191"></a>
Use this type to learn about a vlen.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_inq_vlen(int ncid, nc_type xtype, char *name, size_t *datum_sizep,
nc_type *base_nc_typep);
</pre>
<dl>
<dt><code>ncid</code><dd>The ncid of the file that contains the VLEN type.
<br><dt><code>xtype</code><dd>The type of the VLEN to inquire about.
<br><dt><code>name</code><dd>A pointer for storage for the types name. The name will be NC_MAX_NAME
characters or less.
<br><dt><code>datum_sizep</code><dd>A pointer to a size_t, this will get the size of one element of this
vlen.
<br><dt><code>base_nc_typep</code><dd>A pointer to an nc_type, this will get the type of the VLEN base
type. (In other words, what type is this a VLEN of?)
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPE</code><dd>Can't find the typeid.
<br><dt><code>NC_EBADID</code><dd>ncid invalid.
<br><dt><code>NC_EBADGRPID</code><dd>Group ID part of ncid was invalid.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"> if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_vlen(ncid, "name1", NC_INT, &typeid)) ERR;
if (nc_inq_vlen(ncid, typeid, name_in, &size_in, &base_nc_type_in)) ERR;
if (base_nc_type_in != NC_INT || (size_in != sizeof(int) || strcmp(name_in, VLEN_NAME))) ERR;
if (nc_inq_user_type(ncid, typeid, name_in, &size_in, &base_nc_type_in, NULL, &class_in)) ERR;
if (base_nc_type_in != NC_INT || (size_in != sizeof(int) || strcmp(name_in, VLEN_NAME))) ERR;
if (nc_inq_compound(ncid, typeid, name_in, &size_in, NULL) != NC_EBADTYPE) ERR;
if (nc_put_att(ncid, NC_GLOBAL, ATT_NAME, typeid, DIM_LEN, data)) ERR;
if (nc_close(ncid)) ERR;
</pre>
<div class="node">
<a name="nc_free_vlen"></a>
<a name="nc_005ffree_005fvlen"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005ffree_005fvlens">nc_free_vlens</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fvlen">nc_inq_vlen</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.24 Releasing Memory for a Variable Length Array (VLEN) Type: nc_free_vlen</h3>
<p><a name="index-nc_005ffree_005fvlen-192"></a><a name="index-VLEN_002c-defining-193"></a>
When a VLEN is read into user memory from the file, the HDF5 library
performs memory allocations for each of the variable length arrays
contained within the VLEN structure. This memory must be freed by the
user to avoid memory leaks.
<p>This violates the normal netCDF expectation that the user is
responsible for all memory allocation. But, with VLEN arrays, the
underlying HDF5 library allocates the memory for the user, and the user
is responsible for deallocating that memory.
<p>To save the user the trouble calling free() on each element of the
VLEN array (i.e. the array of arrays), the nc_free_vlen function is
provided.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_free_vlen(nc_vlen_t *vl);
</pre>
<dl>
<dt><code>vl</code><dd>A pointer to the variable length array structure which is to be freed.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPE</code><dd>Can't find the typeid.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from test program libsrc4/tst_vl.c.
<pre class="example"> /* Free the memory used in our phony data. */
for (i=0; i<DIM_LEN; i++)
if (nc_free_vlen(&data[i])) ERR;
</pre>
<div class="node">
<a name="nc_free_vlens"></a>
<a name="nc_005ffree_005fvlens"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Opaque-Type">Opaque Type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005ffree_005fvlen">nc_free_vlen</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.25 Releasing Memory for an Array of Variable Length Array (VLEN) Type: nc_free_vlen</h3>
<p><a name="index-nc_005ffree_005fvlen-194"></a><a name="index-VLEN_002c-defining-195"></a>
When a VLEN is read into user memory from the file, the HDF5 library
performs memory allocations for each of the variable length arrays
contained within the VLEN structure. This memory must be freed by the
user to avoid memory leaks.
<p>This violates the normal netCDF expectation that the user is
responsible for all memory allocation. But, with VLEN arrays, the
underlying HDF5 library allocates the memory for the user, and the user
is responsible for deallocating that memory.
<p>To save the user the trouble calling free() on each element of the
VLEN array (i.e. the array of arrays), the nc_free_vlens function is
provided. It frees all the vlens in an array.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_free_vlens(size_t len, nc_vlen_t vlens[])
</pre>
<dl>
<dt><code>len</code><dd>Length of the VLEN array to be freed.
<br><dt><code>vlens</code><dd>Array of VLENs to be freed.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
</dl>
<div class="node">
<a name="Opaque-Type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fopaque">nc_def_opaque</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005ffree_005fvlens">nc_free_vlens</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.26 Opaque Type Introduction</h3>
<p><a name="index-opaque-type-196"></a>
NetCDF-4 added support for the opaque type. This is not supported in
classic or 64-bit offset files.
<p>The opaque type is a type which is a collection of objects of a known
size. (And each object is the same size). Nothing is known to netCDF
about the contents of these blobs of data, except their size in bytes,
and the name of the type.
<p>To use an opaque type, first define it with <a href="#nc_005fdef_005fopaque">nc_def_opaque</a>. If
encountering an enum type in a new data file, use <a href="#nc_005finq_005fopaque">nc_inq_opaque</a>
to learn its name and size.
<div class="node">
<a name="nc_def_opaque"></a>
<a name="nc_005fdef_005fopaque"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fopaque">nc_inq_opaque</a>,
Previous: <a rel="previous" accesskey="p" href="#Opaque-Type">Opaque Type</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.27 Creating Opaque Types: nc_def_opaque</h3>
<p><a name="index-nc_005fdef_005fopaque-197"></a>
Create an opaque type. Provide a size and a name.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_def_opaque(int ncid, size_t size, const char *name, nc_type *typeidp);
</pre>
<dl>
<dt><code>ncid</code><dd>The groupid where the type will be created. The type may be used
anywhere in the file, no matter what group it is in.
<br><dt><code>size</code><dd>The size of each opaque object.
<br><dt><code>name</code><dd>The name for this type. Must be shorter than NC_MAX_NAME.
<br><dt><code>typeidp</code><dd>Pointer where the new typeid for this type is returned. Use this
typeid when defining variables of this type with <a href="#nc_005fdef_005fvar">nc_def_var</a>.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad typeid.
<br><dt><code>NC_EBADFIELDID</code><dd>Bad fieldid.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from the test program libsrc4/tst_opaques.c.
<pre class="example"> /* Create a file that has an opaque attribute. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_opaque(ncid, BASE_SIZE, TYPE_NAME, &xtype)) ERR;
</pre>
<div class="node">
<a name="nc_inq_opaque"></a>
<a name="nc_005finq_005fopaque"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Enum-Type">Enum Type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fdef_005fopaque">nc_def_opaque</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.28 Learn About an Opaque Type: nc_inq_opaque</h3>
<p><a name="index-nc_005finq_005fopaque-198"></a>
Given a typeid, get the information about an opaque type.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_opaque(int ncid, nc_type xtype, char *name, size_t *sizep);
</pre>
<dl>
<dt><code>ncid</code><dd>The ncid for the group containing the opaque type.
<br><dt><code>xtype</code><dd>The typeid for this opaque type, as returned by nc_def_compound, or
nc_inq_var.
<br><dt><code>name</code><dd>If non-NULL, the name of the opaque type will be copied here. It will
be NC_MAX_NAME bytes or less.
<br><dt><code>sizep</code><dd>If non-NULL, the size of the opaque type will be copied here.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad typeid.
<br><dt><code>NC_EBADFIELDID</code><dd>Bad fieldid.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from test program libsrc4/tst_opaques.c:
<pre class="example"> if (nc_def_opaque(ncid, BASE_SIZE, TYPE_NAME, &xtype)) ERR;
if (nc_inq_opaque(ncid, xtype, name_in, &base_size_in)) ERR;
if (strcmp(name_in, TYPE_NAME) || base_size_in != BASE_SIZE) ERR;
</pre>
<div class="node">
<a name="Enum-Type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fenum">nc_def_enum</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fopaque">nc_inq_opaque</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.29 Enum Type Introduction</h3>
<p><a name="index-enum-type-199"></a>
NetCDF-4 added support for the enum type. This is not supported in
classic or 64-bit offset files.
<div class="node">
<a name="nc_def_enum"></a>
<a name="nc_005fdef_005fenum"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finsert_005fenum">nc_insert_enum</a>,
Previous: <a rel="previous" accesskey="p" href="#Enum-Type">Enum Type</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.30 Creating a Enum Type: nc_def_enum</h3>
<p><a name="index-nc_005fdef_005fenum-200"></a>
Create an enum type. Provide an ncid, a name, and a base integer
type.
<p>After calling this function, fill out the type with repeated calls to
nc_insert_enum (see <a href="#nc_005finsert_005fenum">nc_insert_enum</a>). Call nc_insert_enum once for
each value you wish to make part of the enumeration.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_def_enum(int ncid, nc_type base_typeid, const char *name,
nc_type *typeidp);
</pre>
<dl>
<dt><code>ncid</code><dd>The groupid where this compound type will be created.
<br><dt><code>base_typeid</code><dd>The base integer type for this enum. Must be one of: NC_BYTE,
NC_UBYTE, NC_SHORT, NC_USHORT, NC_INT, NC_UINT, NC_INT64, NC_UINT64.
<br><dt><code>name</code><dd>The name of the new enum type.
<br><dt><code>typeidp</code><dd>A pointer to an nc_type. The typeid of the new type will be placed
there.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENAMEINUSE</code><dd>That name is in use.
<br><dt><code>NC_EMAXNAME</code><dd>Name exceeds max length NC_MAX_NAME.
<br><dt><code>NC_EBADNAME</code><dd>Name contains illegal characters.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag NC_NETCDF4. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
<br><dt><code>NC_EPERM</code><dd>Attempt to write to a read-only file.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode.
</dl>
<p>The following example, from libsrc4/tst_enums.c, shows the creation
and use of an enum type, including the use of a fill value.
<pre class="example"> int dimid, varid;
size_t num_members_in;
int class_in;
unsigned char value_in;
enum clouds { /* a C enumeration */
CLEAR=0,
CUMULONIMBUS=1,
STRATUS=2,
STRATOCUMULUS=3,
CUMULUS=4,
ALTOSTRATUS=5,
NIMBOSTRATUS=6,
ALTOCUMULUS=7,
CIRROSTRATUS=8,
CIRROCUMULUS=9,
CIRRUS=10,
MISSING=255};
struct {
char *name;
unsigned char value;
} cloud_types[] = {
{"Clear", CLEAR},
{"Cumulonimbus", CUMULONIMBUS},
{"Stratus", STRATUS},
{"Stratocumulus", STRATOCUMULUS},
{"Cumulus", CUMULUS},
{"Altostratus", ALTOSTRATUS},
{"Nimbostratus", NIMBOSTRATUS},
{"Altocumulus", ALTOCUMULUS},
{"Cirrostratus", CIRROSTRATUS},
{"Cirrocumulus", CIRROCUMULUS},
{"Cirrus", CIRRUS},
{"Missing", MISSING}
};
int var_dims[VAR2_RANK];
unsigned char att_val;
unsigned char cloud_data[DIM2_LEN] = {
CLEAR, STRATUS, CLEAR, CUMULONIMBUS, MISSING};
unsigned char cloud_data_in[DIM2_LEN];
if (nc_create(FILE_NAME, NC_CLOBBER | NC_NETCDF4, &ncid)) ERR;
/* Create an enum type. */
if (nc_def_enum(ncid, NC_UBYTE, TYPE2_NAME, &typeid)) ERR;
num_members = (sizeof cloud_types) / (sizeof cloud_types[0]);
for (i = 0; i < num_members; i++)
if (nc_insert_enum(ncid, typeid, cloud_types[i].name,
&cloud_types[i].value)) ERR;
/* Declare a station dimension */
if (nc_def_dim(ncid, DIM2_NAME, DIM2_LEN, &dimid)) ERR;
/* Declare a variable of the enum type */
var_dims[0] = dimid;
if (nc_def_var(ncid, VAR2_NAME, typeid, VAR2_RANK, var_dims, &varid)) ERR;
/* Create and write a variable attribute of the enum type */
att_val = MISSING;
if (nc_put_att(ncid, varid, ATT2_NAME, typeid, ATT2_LEN, &att_val)) ERR;
if (nc_enddef(ncid)) ERR;
/* Store some data of the enum type */
if(nc_put_var(ncid, varid, cloud_data)) ERR;
/* Write the file. */
if (nc_close(ncid)) ERR;
</pre>
<div class="node">
<a name="nc_insert_enum"></a>
<a name="nc_005finsert_005fenum"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fenum">nc_inq_enum</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fdef_005fenum">nc_def_enum</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.31 Inserting a Field into a Enum Type: nc_insert_enum</h3>
<p><a name="index-nc_005finsert_005fenum-201"></a>
Insert a named member into a enum type.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_insert_enum(int ncid, nc_type xtype, const char *identifier,
const void *value);
</pre>
<dl>
<dt><code>ncid</code><dd>The ncid of the group which contains the type.
<br><dt><code>typeid</code><dd>The typeid for this enum type, as returned by nc_def_enum, or
nc_inq_var.
<br><dt><code>identifier</code><dd>The identifier of the new member.
<br><dt><code>value</code><dd>The value that is to be associated with this member.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad group id.
<br><dt><code>NC_ENAMEINUSE</code><dd>That name is in use. Field names must be unique within a enum type.
<br><dt><code>NC_EMAXNAME</code><dd>Name exceed max length NC_MAX_NAME.
<br><dt><code>NC_EBADNAME</code><dd>Name contains illegal characters.
<br><dt><code>NC_ENOTNC4</code><dd>Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4
operations can only be performed on files defined with a create mode
which includes flag NC_NETCDF4. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see <a href="#nc_005fopen">nc_open</a>).
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_enums.c; also see the example in See <a href="#nc_005fdef_005fenum">nc_def_enum</a>.
<pre class="example"> char brady_name[NUM_BRADYS][NC_MAX_NAME + 1] = {"Mike", "Carol", "Greg", "Marsha",
"Peter", "Jan", "Bobby", "Whats-her-face",
"Alice"};
unsigned char brady_value[NUM_BRADYS] = {0, 1,2,3,4,5,6,7,8};
unsigned char data[BRADY_DIM_LEN] = {0, 4, 8};
unsigned char value_in;
/* Create a file. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
/* Create an enum type based on unsigned bytes. */
if (nc_def_enum(ncid, NC_UBYTE, BRADYS, &typeid)) ERR;
for (i = 0; i < NUM_BRADYS; i++)
if (nc_insert_enum(ncid, typeid, brady_name[i],
&brady_value[i])) ERR;
</pre>
<div class="node">
<a name="nc_inq_enum"></a>
<a name="nc_005finq_005fenum"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fenum_005fmember">nc_inq_enum_member</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finsert_005fenum">nc_insert_enum</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.32 Learn About a Enum Type: nc_inq_enum</h3>
<p><a name="index-nc_005finq_005fenum-202"></a>
Get information about a user-define enumeration type.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_inq_enum(int ncid, nc_type xtype, char *name, nc_type *base_nc_typep,
size_t *base_sizep, size_t *num_membersp);
</pre>
<dl>
<dt><code>ncid</code><dd>The group ID of the group which holds the enum type.
<br><dt><code>xtype</code><dd>The typeid for this enum type, as returned by nc_def_enum, or
nc_inq_var.
<br><dt><code>name</code><dd>Pointer to an already allocated char array which will get the name, as
a null terminated string. It will have a maximum length of
NC_MAX_NAME+1.
<br><dt><code>base_nc_typep</code><dd>If non-NULL, a pointer to a nc_type, which will get the base integer
type of this enum.
<br><dt><code>base_sizep</code><dd>If non-NULL, a size_t pointer, which will get the size (in bytes) of
the base integer type of this enum.
<br><dt><code>num_membersp</code><dd>If non-NULL, a size_t pointer which will get the number of members
defined for this enumeration type.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad type id.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_enums.c, and is a continuation of the
example above for nc_insert_enum. First an enum type is created, with
one element for each of the nine members of the Brady family on a
popular American television show which occupies far too much memory
space in my brain!
<p>In the example, the enum type is created, then checked using the
nc_inq_enum and nc_inq_enum_member functions. See <a href="#nc_005finq_005fenum_005fmember">nc_inq_enum_member</a>.
<pre class="example"> char brady_name[NUM_BRADYS][NC_MAX_NAME + 1] = {"Mike", "Carol", "Greg", "Marsha",
"Peter", "Jan", "Bobby", "Whats-her-face",
"Alice"};
unsigned char brady_value[NUM_BRADYS] = {0, 1,2,3,4,5,6,7,8};
unsigned char data[BRADY_DIM_LEN] = {0, 4, 8};
unsigned char value_in;
/* Create a file. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
/* Create an enum type based on unsigned bytes. */
if (nc_def_enum(ncid, NC_UBYTE, BRADYS, &typeid)) ERR;
for (i = 0; i < NUM_BRADYS; i++)
if (nc_insert_enum(ncid, typeid, brady_name[i],
&brady_value[i])) ERR;
/* Check it out. */
if (nc_inq_enum(ncid, typeid, name_in, &base_nc_type, &base_size_in, &num_members)) ERR;
if (strcmp(name_in, BRADYS) || base_nc_type != NC_UBYTE || base_size_in != 1 ||
num_members != NUM_BRADYS) ERR;
for (i = 0; i < NUM_BRADYS; i++)
{
if (nc_inq_enum_member(ncid, typeid, i, name_in, &value_in)) ERR;
if (strcmp(name_in, brady_name[i]) || value_in != brady_value[i]) ERR;
if (nc_inq_enum_ident(ncid, typeid, brady_value[i], name_in)) ERR;
if (strcmp(name_in, brady_name[i])) ERR;
}
</pre>
<div class="node">
<a name="nc_inq_enum_member"></a>
<a name="nc_005finq_005fenum_005fmember"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fenum_005fident">nc_inq_enum_ident</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fenum">nc_inq_enum</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.33 Learn the Name of a Enum Type: nc_inq_enum_member</h3>
<p><a name="index-nc_005finq_005fenum_005fmember-203"></a>
Get information about a member of an enum type.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_enum_member(int ncid, nc_type xtype, int idx, char *name,
void *value);
</pre>
<dl>
<dt><code>ncid</code><dd>The groupid where this enum type exists.
<br><dt><code>xtype</code><dd>The typeid for this enum type.
<br><dt><code>idx</code><dd>The zero-based index number for the member of interest.
<br><dt><code>name</code><dd>If non-NULL, a pointer to an already allocated char array which will
get the name, as a null terminated string. It will have a maximum
length of NC_MAX_NAME+1.
<br><dt><code>value</code><dd>If non-NULL, a pointer to storage of the correct integer type
(i.e. the base type of this enum type). It will get the value
associated with this member.
</dl>
<h3 class="heading">Errors</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad type id.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
</dl>
<h3 class="heading">Example</h3>
<p>This is the continuation of the example in <a href="#nc_005fdef_005fenum">nc_def_enum</a>. The file
is reopened and the cloud enum type is examined.
<pre class="example"> /* Reopen the file. */
if (nc_open(FILE_NAME, NC_NOWRITE, &ncid)) ERR;
if (nc_inq_user_type(ncid, typeid, name_in, &base_size_in, &base_nc_type_in,
&nfields_in, &class_in)) ERR;
if (strcmp(name_in, TYPE2_NAME) ||
base_size_in != sizeof(unsigned char) ||
base_nc_type_in != NC_UBYTE ||
nfields_in != num_members ||
class_in != NC_ENUM) ERR;
if (nc_inq_enum(ncid, typeid, name_in,
&base_nc_type_in, &base_size_in, &num_members_in)) ERR;
if (strcmp(name_in, TYPE2_NAME) ||
base_nc_type_in != NC_UBYTE ||
num_members_in != num_members) ERR;
for (i = 0; i < num_members; i++)
{
if (nc_inq_enum_member(ncid, typeid, i, name_in, &value_in)) ERR;
if (strcmp(name_in, cloud_types[i].name) ||
value_in != cloud_types[i].value) ERR;
if (nc_inq_enum_ident(ncid, typeid, cloud_types[i].value,
name_in)) ERR;
if (strcmp(name_in, cloud_types[i].name)) ERR;
}
if (nc_inq_varid(ncid, VAR2_NAME, &varid)) ERR;
if (nc_get_att(ncid, varid, ATT2_NAME, &value_in)) ERR;
if (value_in != MISSING) ERR;
if(nc_get_var(ncid, varid, cloud_data_in)) ERR;
for (i = 0; i < DIM2_LEN; i++) {
if (cloud_data_in[i] != cloud_data[i]) ERR;
}
if (nc_close(ncid)) ERR;
</pre>
<div class="node">
<a name="nc_inq_enum_ident"></a>
<a name="nc_005finq_005fenum_005fident"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fenum_005fmember">nc_inq_enum_member</a>,
Up: <a rel="up" accesskey="u" href="#User-Defined-Data-Types">User Defined Data Types</a>
</div>
<h3 class="section">5.34 Learn the Name of a Enum Type: nc_inq_enum_ident</h3>
<p><a name="index-nc_005finq_005fenum_005fident-204"></a>
Get the name which is associated with an enum member value.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_enum_ident(int ncid, nc_type xtype, long long value, char *identifier);
</pre>
<dl>
<dt><code>ncid</code><dd>The groupid where this enum type exists.
<br><dt><code>xtype</code><dd>The typeid for this enum type.
<br><dt><code>value</code><dd>The value for which an identifier is sought.
<br><dt><code>identifier</code><dd>If non-NULL, a pointer to an already allocated char array which will
get the identifier, as a null terminated string. It will have a
maximum length of NC_MAX_NAME+1.
</dl>
<h3 class="heading">Return Code</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADTYPEID</code><dd>Bad type id, or not an enum type.
<br><dt><code>NC_EHDFERR</code><dd>An error was reported by the HDF5 layer.
<br><dt><code>NC_EINVAL</code><dd>The value was not found in the enum.
</dl>
<h3 class="heading">Example</h3>
<p>See the example section for <a href="#nc_005finq_005fenum">nc_inq_enum</a> for a full example.
<div class="node">
<a name="Variables"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Attributes">Attributes</a>,
Previous: <a rel="previous" accesskey="p" href="#User-Defined-Data-Types">User Defined Data Types</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">6 Variables</h2>
<ul class="menu">
<li><a accesskey="1" href="#Variable-Introduction">Variable Introduction</a>
<li><a accesskey="2" href="#Variable-Types">Variable Types</a>
<li><a accesskey="3" href="#NetCDF_002d3-Variable-Types">NetCDF-3 Variable Types</a>
<li><a accesskey="4" href="#NetCDF_002d4-Atomic-Types">NetCDF-4 Atomic Types</a>
<li><a accesskey="5" href="#nc_005fdef_005fvar">nc_def_var</a>: Create a Variable
<li><a accesskey="6" href="#nc_005fdef_005fvar_005fchunking">nc_def_var_chunking</a>: Set chunking parameters
<li><a accesskey="7" href="#nc_005finq_005fvar_005fchunking">nc_inq_var_chunking</a>: Learn about chunking parameters
<li><a accesskey="8" href="#nc_005fset_005fvar_005fchunk_005fcache">nc_set_var_chunk_cache</a>
<li><a accesskey="9" href="#nc_005fget_005fvar_005fchunk_005fcache">nc_get_var_chunk_cache</a>
<li><a href="#nc_005fdef_005fvar_005ffill">nc_def_var_fill</a>
<li><a href="#nc_005finq_005fvar_005ffill">nc_inq_var_fill</a>
<li><a href="#nc_005fdef_005fvar_005fdeflate">nc_def_var_deflate</a>: Set compression parameters
<li><a href="#nc_005finq_005fvar_005fdeflate">nc_inq_var_deflate</a>: Learn about compression parameters
<li><a href="#nc_005finq_005fvar_005fszip">nc_inq_var_szip</a>
<li><a href="#nc_005fdef_005fvar_005ffletcher32">nc_def_var_fletcher32</a>: Set checksum filter
<li><a href="#nc_005finq_005fvar_005ffletcher32">nc_inq_var_fletcher32</a>: Learn if checksum filter is set
<li><a href="#nc_005fdef_005fvar_005fendian">nc_def_var_endian</a>
<li><a href="#nc_005finq_005fvar_005fendian">nc_inq_var_endian</a>
<li><a href="#nc_005finq_005fvarid">nc_inq_varid</a>: Get a Variable ID from Its Name
<li><a href="#nc_005finq_005fvar">nc_inq_var</a>: Get Information about a Variable from Its ID
<li><a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a>: Write a Single Data Value
<li><a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a>: Write an Entire Variable
<li><a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a>: Write an Array of Values
<li><a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a>: Write a Subsampled Array of Values
<li><a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a>: Write a Mapped Array of Values
<li><a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a>: Read a Single Data Value
<li><a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a>: Read an Entire Variable
<li><a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a>: Read an Array of Values
<li><a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a>: Read a Subsampled Array of Values
<li><a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a>: Read a Mapped Array of Values
<li><a href="#Strings">Strings</a>: Reading and Writing Character String Values
<li><a href="#nc_005ffree_005fstring">nc_free_string</a>
<li><a href="#Fill-Values">Fill Values</a>: What's Written Where there's No Data?
<li><a href="#nc_005frename_005fvar">nc_rename_var</a>: Rename a Variable
<li><a href="#nc_005fcopy_005fvar">nc_copy_var</a>
<li><a href="#nc_005fvar_005fpar_005faccess">nc_var_par_access</a>
<li><a href="#nc_005fvar_005fubyte">nc_var_ubyte</a>: Deprecated variable ``_ubyte'' functions
</ul>
<div class="node">
<a name="Variable-Introduction"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Variable-Types">Variable Types</a>,
Previous: <a rel="previous" accesskey="p" href="#Variables">Variables</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.1 Introduction</h3>
<p><a name="index-appending-data-to-variable-205"></a>
Variables for a netCDF dataset are defined when the dataset is
created, while the netCDF dataset is in define mode. Other variables
may be added later by reentering define mode. A netCDF variable has a
name, a type, and a shape, which are specified when it is defined. A
variable may also have values, which are established later in data
mode.
<p>Ordinarily, the name, type, and shape are fixed when the variable is
first defined. The name may be changed, but the type and shape of a
variable cannot be changed. However, a variable defined in terms of
the unlimited dimension can grow without bound in that dimension.
<p>A netCDF variable in an open netCDF dataset is referred to by a small
integer called a variable ID.
<p>Variable IDs reflect the order in which variables were defined within
a netCDF dataset. Variable IDs are 0, 1, 2,..., in the order in which
the variables were defined. A function is available for getting the
variable ID from the variable name and vice-versa.
<p>Attributes (see <a href="#Attributes">Attributes</a>) may be associated with a variable to
specify such properties as units.
<p>Operations supported on variables are:
<ul>
<li>Create a variable, given its name, data type, and shape.
<li>Get a variable ID from its name.
<li>Get a variable's name, data type, shape, and number of attributes from
its ID.
<li>Put a data value into a variable, given variable ID, indices, and
value.
<li>Put an array of values into a variable, given variable ID, corner
indices, edge lengths, and a block of values.
<li>Put a subsampled or mapped array-section of values into a variable,
given variable ID, corner indices, edge lengths, stride vector, index
mapping vector, and a block of values.
<li>Get a data value from a variable, given variable ID and indices.
<li>Get an array of values from a variable, given variable ID, corner
indices, and edge lengths.
<li>Get a subsampled or mapped array-section of values from a variable,
given variable ID, corner indices, edge lengths, stride vector, and
index mapping vector.
<li>Rename a variable.
</ul>
<div class="node">
<a name="Variable-Types"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#NetCDF_002d3-Variable-Types">NetCDF-3 Variable Types</a>,
Previous: <a rel="previous" accesskey="p" href="#Variable-Introduction">Variable Introduction</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.2 Language Types Corresponding to netCDF external data types</h3>
<p><a name="index-bit-lengths-of-data-types-206"></a>
NetCDF supported six atomic data types through version 3.6.0 (char,
byte, short, int, float, and double). Starting with version 4.0, many
new atomic and user defined data types are supported (unsigned int
types, strings, compound types, variable length arrays, enums,
opaque).
<p>The additional data types are only supported in netCDF-4/HDF5
files. To create netCDF-4/HDF5 files, use the HDF5 flag in
nc_create. (see <a href="#nc_005fcreate">nc_create</a>).
<div class="node">
<a name="NetCDF-3-Variable-Types"></a>
<a name="NetCDF_002d3-Variable-Types"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#NetCDF_002d4-Atomic-Types">NetCDF-4 Atomic Types</a>,
Previous: <a rel="previous" accesskey="p" href="#Variable-Types">Variable Types</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.3 NetCDF-3 Classic and 64-Bit Offset Data Types</h3>
<p><a name="index-bit-lengths-of-netcdf_002d3-data-types-207"></a>
NetCDF-3 classic and 64-bit offset files support 6 atomic data types,
and none of the user defined datatype introduced in NetCDF-4.
<p>The following table gives the netCDF-3 external data types and the
corresponding type constants for defining variables in the C
interface:
<p><table summary=""><tr align="left"><td valign="top" width="25%">Type </td><td valign="top" width="60%">C #define </td><td valign="top" width="15%">Bits
<p><br></td></tr><tr align="left"><td valign="top" width="25%">byte
</td><td valign="top" width="60%">NC_BYTE
</td><td valign="top" width="15%">8
<p><br></td></tr><tr align="left"><td valign="top" width="25%">char
</td><td valign="top" width="60%">NC_CHAR
</td><td valign="top" width="15%">8
<p><br></td></tr><tr align="left"><td valign="top" width="25%">short
</td><td valign="top" width="60%">NC_SHORT
</td><td valign="top" width="15%">16
<p><br></td></tr><tr align="left"><td valign="top" width="25%">int
</td><td valign="top" width="60%">NC_INT
</td><td valign="top" width="15%">32
<p><br></td></tr><tr align="left"><td valign="top" width="25%">float
</td><td valign="top" width="60%">NC_FLOAT
</td><td valign="top" width="15%">32
<p><br></td></tr><tr align="left"><td valign="top" width="25%">double
</td><td valign="top" width="60%">NC_DOUBLE
</td><td valign="top" width="15%">64
<br></td></tr></table>
<p>The first column gives the netCDF external data type, which is the
same as the CDL data type. The next column gives the corresponding C
pre-processor macro for use in netCDF functions (the pre-processor
macros are defined in the netCDF C header-file netcdf.h). The last
column gives the number of bits used in the external representation of
values of the corresponding type.
<div class="node">
<a name="NetCDF-4-Atomic-Types"></a>
<a name="NetCDF_002d4-Atomic-Types"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fvar">nc_def_var</a>,
Previous: <a rel="previous" accesskey="p" href="#NetCDF_002d3-Variable-Types">NetCDF-3 Variable Types</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.4 NetCDF-4 Atomic Types</h3>
<p><a name="index-bit-lengths-of-netcdf_002d4-data-types-208"></a>
NetCDF-4 files support all of the atomic data types from netCDF-3,
plus additional unsigned integer types, 64-bit integer types, and a
string type.
<p><table summary=""><tr align="left"><td valign="top" width="25%">Type </td><td valign="top" width="60%">C #define </td><td valign="top" width="15%">Bits
<p><br></td></tr><tr align="left"><td valign="top" width="25%">byte
</td><td valign="top" width="60%">NC_BYTE
</td><td valign="top" width="15%">8
<p><br></td></tr><tr align="left"><td valign="top" width="25%">unsigned byte
</td><td valign="top" width="60%">NC_UBYTE^
</td><td valign="top" width="15%">8
<p><br></td></tr><tr align="left"><td valign="top" width="25%">char
</td><td valign="top" width="60%">NC_CHAR
</td><td valign="top" width="15%">8
<p><br></td></tr><tr align="left"><td valign="top" width="25%">short
</td><td valign="top" width="60%">NC_SHORT
</td><td valign="top" width="15%">16
<p><br></td></tr><tr align="left"><td valign="top" width="25%">unsigned short
</td><td valign="top" width="60%">NC_USHORT^
</td><td valign="top" width="15%">16
<p><br></td></tr><tr align="left"><td valign="top" width="25%">int
</td><td valign="top" width="60%">NC_INT
</td><td valign="top" width="15%">32
<p><br></td></tr><tr align="left"><td valign="top" width="25%">unsigned int
</td><td valign="top" width="60%">NC_UINT^
</td><td valign="top" width="15%">32
<p><br></td></tr><tr align="left"><td valign="top" width="25%">unsigned long long
</td><td valign="top" width="60%">NC_UINT64^
</td><td valign="top" width="15%">64
<p><br></td></tr><tr align="left"><td valign="top" width="25%">long long
</td><td valign="top" width="60%">NC_INT64^
</td><td valign="top" width="15%">64
<p><br></td></tr><tr align="left"><td valign="top" width="25%">float
</td><td valign="top" width="60%">NC_FLOAT
</td><td valign="top" width="15%">32
<p><br></td></tr><tr align="left"><td valign="top" width="25%">double
</td><td valign="top" width="60%">NC_DOUBLE
</td><td valign="top" width="15%">64
<p><br></td></tr><tr align="left"><td valign="top" width="25%">char **
</td><td valign="top" width="60%">NC_STRING^
</td><td valign="top" width="15%">string length + 1
<br></td></tr></table>
<p>^This type was introduced in netCDF-4, and is not supported in netCDF
classic or 64-bit offset format files, or in netCDF-4 files if they
are created with the NC_CLASSIC_MODEL flags.
<div class="node">
<a name="nc_def_var"></a>
<a name="nc_005fdef_005fvar"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fvar_005fchunking">nc_def_var_chunking</a>,
Previous: <a rel="previous" accesskey="p" href="#NetCDF_002d4-Atomic-Types">NetCDF-4 Atomic Types</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.5 Create a Variable: <code>nc_def_var</code></h3>
<p><a name="index-nc_005fdef_005fvar-209"></a><a name="index-nc_005fdef_005fvar_002c-example-210"></a><a name="index-creating-variables-211"></a><a name="index-variables_002c-creating-212"></a>
The function nc_def_var adds a new variable to an open netCDF dataset
in define mode. It returns (as an argument) a variable ID, given the
netCDF ID, the variable name, the variable type, the number of
dimensions, and a list of the dimension IDs.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_def_var (int ncid, const char *name, nc_type xtype,
int ndims, const int dimids[], int *varidp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>name</code><dd>Variable name.
<br><dt><code>xtype</code><dd>One of the set of predefined netCDF external data types. The type of
this parameter, nc_type, is defined in the netCDF header file. The
valid netCDF external data types are NC_BYTE, NC_CHAR, NC_SHORT,
NC_INT, NC_FLOAT, and NC_DOUBLE. If the file is a NetCDF-4/HDF5 file,
the additional types NC_UBYTE, NC_USHORT, NC_UINT, NC_INT64,
NC_UINT64, and NC_STRING may be used, as well as a user defined type
ID.
<br><dt><code>ndims</code><dd>Number of dimensions for the variable. For example, 2 specifies a
matrix, 1 specifies a vector, and 0 means the variable is a scalar
with no dimensions. Must not be negative or greater than the
predefined constant NC_MAX_VAR_DIMS.
<br><dt><code>dimids</code><dd>Vector of ndims dimension IDs corresponding to the variable
dimensions. For classic model netCDF files, if the ID of the unlimited
dimension is included, it must be first. This argument is ignored if
ndims is 0. For expanded model netCDF4/HDF5 files, there may be any
number of unlimited dimensions, and they may be used in any element of
the dimids array.
<br><dt><code>varidp</code><dd>Pointer to location for the returned variable ID.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_def_var returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created with
NC_STRICT_NC3 flag. (see <a href="#nc_005fcreate">nc_create</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>Trying to create a var some place other than the root group in a
netCDF file with NC_STRICT_NC3 turned on.
<br><dt><code>NC_MAX_VARS</code><dd>Max number of variables exceeded in a classic or 64-bit offset file,
or an netCDF-4 file with NC_STRICT_NC3 on.
<br><dt><code>NC_EBADTYPE</code><dd>Bad type.
<br><dt><code>NC_EINVAL</code><dd>Number of dimensions to large.
<br><dt><code>NC_ENAMEINUSE</code><dd>Name already in use.
<br><dt><code>NC_EPERM</code><dd>Attempt to create object in read-only file.
</dl>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_def_var to create a variable named rh of
type double with three dimensions, time, lat, and lon in a new netCDF
dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status; /* error status */
int ncid; /* netCDF ID */
int lat_dim, lon_dim, time_dim; /* dimension IDs */
int rh_id; /* variable ID */
int rh_dimids[3]; /* variable shape */
...
status = nc_create("foo.nc", NC_NOCLOBBER, &ncid);
if (status != NC_NOERR) handle_error(status);
...
/* define dimensions */
status = nc_def_dim(ncid, "lat", 5L, &lat_dim);
if (status != NC_NOERR) handle_error(status);
status = nc_def_dim(ncid, "lon", 10L, &lon_dim);
if (status != NC_NOERR) handle_error(status);
status = nc_def_dim(ncid, "time", NC_UNLIMITED, &time_dim);
if (status != NC_NOERR) handle_error(status);
...
/* define variable */
rh_dimids[0] = time_dim;
rh_dimids[1] = lat_dim;
rh_dimids[2] = lon_dim;
status = nc_def_var (ncid, "rh", NC_DOUBLE, 3, rh_dimids, &rh_id);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_def_var_chunking"></a>
<a name="nc_005fdef_005fvar_005fchunking"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fvar_005fchunking">nc_inq_var_chunking</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fdef_005fvar">nc_def_var</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.6 Define Chunking Parameters for a Variable: <code>nc_def_var_chunking</code></h3>
<p><a name="index-nc_005fdef_005fvar_005fchunking-213"></a><a name="index-chunking-214"></a><a name="index-contiguous-215"></a><a name="index-variables_002c-chunking-216"></a><a name="index-variables_002c-contiguous-217"></a>
The function nc_def_var_chunking sets the chunking parameters for a
variable in a netCDF-4 file. It can set the chunk sizes to get chunked
storage, or it can set the contiguous flag to get contiguous storage.
<p>Variables that make use of one or more unlimited dimensions,
compression, or checksums must use chunking. Such variables are
created with default chunk sizes of 1 for each unlimited dimension and
the dimension length for other dimensions, except that if the
resulting chunks are too large, the default chunk sizes for non-record
dimensions are reduced.
<p>The total size of a chunk must be less than 4 GiB. That is, the product
of all chunksizes and the size of the data (or the size of nc_vlen_t
for VLEN types) must be less than 4 GiB.
<p>This function may only be called after the variable is defined, but
before nc_enddef is called. Once the chunking parameters are set for
a variable, they cannot be changed. This function can be used to
change the default chunking for record, compressed, or checksummed
variables before nc_enddef is called.
<p>Note that you cannot set chunking for scalar variables. Only non-scalar
variables can have chunking.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_def_var_chunking(int ncid, int varid, int storage, size_t *chunksizesp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>storage</code><dd>If NC_CONTIGUOUS, then contiguous storage is used for this
variable. Variables with chunking, compression, checksums, or one or
more unlimited dimensions cannot use contiguous storage.
<p>If NC_CHUNKED, then chunked storage is used for this variable.
Chunk sizes may be specified with the chunksizes parameter or
default sizes will be used if that parameter is NULL.
<p>By default contiguous storage is used for fix-sized variables when
conpression, chunking, and checksums are not used.
<br><dt><code>*chunksizes</code><dd>A pointer to an array list of chunk sizes. The array must have one
chunksize for each dimension of the variable.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_def_var_chunking returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
<p>Possible return codes include:
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EBADID</code><dd>Bad ncid.
<br><dt><code>NC_EINVAL</code><dd>Invalid input. This can occur if contiguous storage is set on a
variable which uses compression, checksums, or one or more unlimited
dimensions.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4 file.
<br><dt><code>NC_ENOTVAR</code><dd>Can't find this variable.
<br><dt><code>NC_ELATEDEF</code><dd>This variable has already been the subject of a nc_enddef call. In
netCDF-4 files nc_enddef will be called automatically for any data
read or write. Once nc_enddef has been called after the nc_def_var call
for a variable, it is impossible to set the chunking for that variable.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created with
NC_STRICT_NC3 flag. (see <a href="#nc_005fcreate">nc_create</a>).
<br><dt><code>NC_ESTRICTNC3</code><dd>Trying to create a var some place other than the root group in a
netCDF file with NC_STRICT_NC3 turned on.
<br><dt><code>NC_EPERM</code><dd>Attempt to create object in read-only file.
</dl>
<h3 class="heading">Example</h3>
<p>In this example from libsrc4/tst_vars2.c, chunksizes are set with
nc_var_def_chunking, and checked with nc_var_inq_chunking.
<pre class="example"> printf("**** testing chunking...");
{
#define NDIMS5 1
#define DIM5_NAME "D5"
#define VAR_NAME5 "V5"
#define DIM5_LEN 1000
int dimids[NDIMS5], dimids_in[NDIMS5];
int varid;
int ndims, nvars, natts, unlimdimid;
nc_type xtype_in;
char name_in[NC_MAX_NAME + 1];
int data[DIM5_LEN], data_in[DIM5_LEN];
size_t chunksize[NDIMS5] = {5};
size_t chunksize_in[NDIMS5];
int storage_in;
int i, d;
for (i = 0; i < DIM5_LEN; i++)
data[i] = i;
/* Create a netcdf-4 file with one dim and one var. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_dim(ncid, DIM5_NAME, DIM5_LEN, &dimids[0])) ERR;
if (nc_def_var(ncid, VAR_NAME5, NC_INT, NDIMS5, dimids, &varid)) ERR;
if (nc_def_var_chunking(ncid, varid, NC_CHUNKED, chunksize)) ERR;
if (nc_put_var_int(ncid, varid, data)) ERR;
/* Check stuff. */
if (nc_inq_var_chunking(ncid, varid, &storage_in, chunksize_in)) ERR;
for (d = 0; d < NDIMS5; d++)
if (chunksize[d] != chunksize_in[d]) ERR;
if (storage_in != NC_CHUNKED) ERR;
</pre>
<div class="node">
<a name="nc_inq_var_chunking"></a>
<a name="nc_005finq_005fvar_005fchunking"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fset_005fvar_005fchunk_005fcache">nc_set_var_chunk_cache</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fdef_005fvar_005fchunking">nc_def_var_chunking</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.7 Learn About Chunking Parameters for a Variable: <code>nc_inq_var_chunking</code></h3>
<p><a name="index-nc_005finq_005fvar_005fchunking-218"></a>
The function nc_inq_var_chunking returns the chunking settings for a
variable in a netCDF-4 file.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_var_chunking(int ncid, int varid, int *storagep, size_t *chunksizesp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>storagep</code><dd>Address of returned storage property, returned as NC_CONTIGUOUS if this
variable uses contiguous storage, or NC_CHUNKEDif it uses chunked
storage.
<br><dt><code>*chunksizesp</code><dd>A pointer to an array list of chunk sizes. The array must have
one chunksize for each dimension in the variable.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_inq_var_chunking returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
<p>Possible return codes include:
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4 file.
<br><dt><code>NC_ENOTVAR</code><dd>Can't find this variable.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_vars2.c in which a variable with
contiguous storage is created, and then checked with nc_inq_var_chunking:
<pre class="example"> printf("**** testing contiguous storage...");
{
#define NDIMS6 1
#define DIM6_NAME "D5"
#define VAR_NAME6 "V5"
#define DIM6_LEN 100
int dimids[NDIMS6], dimids_in[NDIMS6];
int varid;
int ndims, nvars, natts, unlimdimid;
nc_type xtype_in;
char name_in[NC_MAX_NAME + 1];
int data[DIM6_LEN], data_in[DIM6_LEN];
size_t chunksize_in[NDIMS6];
int storage_in;
int i, d;
for (i = 0; i < DIM6_LEN; i++)
data[i] = i;
/* Create a netcdf-4 file with one dim and one var. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_dim(ncid, DIM6_NAME, DIM6_LEN, &dimids[0])) ERR;
if (dimids[0] != 0) ERR;
if (nc_def_var(ncid, VAR_NAME6, NC_INT, NDIMS6, dimids, &varid)) ERR;
if (nc_def_var_chunking(ncid, varid, NC_CONTIGUOUS, NULL)) ERR;
if (nc_put_var_int(ncid, varid, data)) ERR;
/* Check stuff. */
if (nc_inq_var_chunking(ncid, 0, &storage_in, chunksize_in)) ERR;
if (storage_in != NC_CONTIGUOUS) ERR;
</pre>
<div class="node">
<a name="nc_set_var_chunk_cache"></a>
<a name="nc_005fset_005fvar_005fchunk_005fcache"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fget_005fvar_005fchunk_005fcache">nc_get_var_chunk_cache</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fvar_005fchunking">nc_inq_var_chunking</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.8 Set HDF5 Chunk Cache for a Variable: nc_set_var_chunk_cache</h3>
<p><a name="index-nc_005fset_005fvar_005fchunk_005fcache-219"></a><a name="index-HDF5-chunk-cache_002c-per_002dvariable-220"></a>
This function changes the chunk cache settings for a variable. The
change in cache size happens immediately. This is a property of the
open file - it does not persist the next time you open the file.
<p>For more information, see the documentation for the H5Pset_cache()
function in the HDF5 library at the HDF5 website:
<a href="http://hdfgroup.org/HDF5/">http://hdfgroup.org/HDF5/</a>.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_set_var_chunk_cache(int ncid, int varid, size_t size, size_t nelems,
float preemption);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>size</code><dd>The total size of the raw data chunk cache, in bytes. This should be
big enough to hold multiple chunks of data.
<br><dt><code>nelems</code><dd>The number of chunk slots in the raw data chunk cache hash table. This
should be a prime number larger than the number of chunks that will be
in the cache.
<br><dt><code>preemption</code><dd>The preemtion value must be between 0 and 1 inclusive and indicates
how much chunks that have been fully read are favored for
preemption. A value of zero means fully read chunks are treated no
differently than other chunks (the preemption is strictly LRU) while a
value of one means fully read chunks are always preempted before other
chunks.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EINVAL</code><dd>Preemption must be between zero and one (inclusive).
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_vars2.c:
<pre class="example"> #include <netcdf.h>
...
#define CACHE_SIZE 32000000
#define CACHE_NELEMS 1009
#define CACHE_PREEMPTION .75
...
/* Create a netcdf-4 file with one dim and one var. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_dim(ncid, DIM5_NAME, DIM5_LEN, &dimids[0])) ERR;
if (dimids[0] != 0) ERR;
if (nc_def_var(ncid, VAR_NAME5, NC_INT, NDIMS5, dimids, &varid)) ERR;
if (nc_def_var_chunking(ncid, varid, NC_CHUNKED, chunksize)) ERR;
if (nc_set_var_chunk_cache(ncid, varid, CACHE_SIZE, CACHE_NELEMS, CACHE_PREEMPTION)) ERR;
</pre>
<div class="node">
<a name="nc_get_var_chunk_cache"></a>
<a name="nc_005fget_005fvar_005fchunk_005fcache"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fvar_005ffill">nc_def_var_fill</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fset_005fvar_005fchunk_005fcache">nc_set_var_chunk_cache</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.9 Get the HDF5 Chunk Cache Settings for a Variable: nc_get_var_chunk_cache</h3>
<p><a name="index-nc_005fget_005fchunk_005fcache-221"></a><a name="index-HDF5-chunk-cache-222"></a>
This function gets the current chunk cache settings for a variable in
a netCDF-4/HDF5 file.
<p>For more information, see the documentation for the H5Pget_cache()
function in the HDF5 library at the HDF5 website:
<a href="http://hdfgroup.org/HDF5/">http://hdfgroup.org/HDF5/</a>.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_get_var_chunk_cache(int ncid, int varid, size_t *sizep, size_t *nelemsp,
float *preemptionp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>sizep</code><dd>The total size of the raw data chunk cache, in bytes, will be put
here. If NULL, will be ignored.
<br><dt><code>nelemsp</code><dd>The number of chunk slots in the raw data chunk cache hash table will
be put here. If NULL, will be ignored.
<br><dt><code>preemptionp</code><dd>The preemption will be put here. The preemtion value is between 0 and
1 inclusive and indicates how much chunks that have been fully read
are favored for preemption. A value of zero means fully read chunks
are treated no differently than other chunks (the preemption is
strictly LRU) while a value of one means fully read chunks are always
preempted before other chunks. If NULL, will be ignored.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_vars2.c:
<pre class="example"> #include <netcdf.h>
...
/* Create a netcdf-4 file with one dim and one var. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_dim(ncid, DIM5_NAME, DIM5_LEN, &dimids[0])) ERR;
if (nc_def_var(ncid, VAR_NAME5, NC_INT, NDIMS5, dimids, &varid)) ERR;
if (nc_def_var_chunking(ncid, varid, NC_CHUNKED, chunksize)) ERR;
if (nc_set_var_chunk_cache(ncid, varid, CACHE_SIZE, CACHE_NELEMS,
CACHE_PREEMPTION)) ERR;
...
if (nc_get_var_chunk_cache(ncid, varid, &cache_size_in, &cache_nelems_in,
&cache_preemption_in)) ERR;
if (cache_size_in != CACHE_SIZE || cache_nelems_in != CACHE_NELEMS ||
cache_preemption_in != CACHE_PREEMPTION) ERR;
...
</pre>
<div class="node">
<a name="nc_def_var_fill"></a>
<a name="nc_005fdef_005fvar_005ffill"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fvar_005ffill">nc_inq_var_fill</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fget_005fvar_005fchunk_005fcache">nc_get_var_chunk_cache</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.10 Define Fill Parameters for a Variable: <code>nc_def_var_fill</code></h3>
<p><a name="index-nc_005fdef_005fvar_005ffill-223"></a><a name="index-fill-224"></a><a name="index-variables_002c-fill-225"></a>
The function nc_def_var_fill sets the fill parameters for a
variable in a netCDF-4 file.
<p>This function must be called after the variable is defined, but before
nc_enddef is called.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_def_var_fill(int ncid, int varid, int no_fill, void *fill_value);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>no_fill</code><dd>Set no_fill mode on a variable. When this mode is on, fill values will
not be written for the variable. This is helpful in high performance
applications. For netCDF-4/HDF5 files (whether classic model or not),
this may only be changed after the variable is defined, but before it
is committed to disk (i.e. before the first nc_enddef after the
nc_def_var.) For classic and 64-bit offset file, the no_fill mode may
be turned on and off at any time.
<br><dt><code>*fill_value</code><dd>A pointer to a value which will be used as the fill value for the
variable. Must be the same type as the variable. This will be written
to a _FillValue attribute, created for this purpose. If NULL, this
argument will be ignored.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4 file.
<br><dt><code>NC_ENOTVAR</code><dd>Can't find this variable.
<br><dt><code>NC_ELATEDEF</code><dd>This variable has already been the subject of a nc_enddef call. In
netCDF-4 files nc_enddef will be called automatically for any data
read or write. Once enddef has been called, it is impossible to set
the fill for a variable.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created with
NC_STRICT_NC3 flag. (see <a href="#nc_005fcreate">nc_create</a>).
<br><dt><code>NC_EPERM</code><dd>Attempt to create object in read-only file.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_vars.c
<pre class="example"> int dimids[NDIMS];
size_t index[NDIMS];
int varid;
int no_fill;
unsigned short ushort_data = 42, ushort_data_in, fill_value_in;
/* Create a netcdf-4 file with one dim and 1 NC_USHORT var. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_dim(ncid, DIM7_NAME, DIM7_LEN, &dimids[0])) ERR;
if (nc_def_var(ncid, VAR7_NAME, NC_USHORT, NDIMS, dimids,
&varid)) ERR;
if (nc_def_var_fill(ncid, varid, 1, NULL)) ERR;
</pre>
<div class="node">
<a name="nc_inq_var_fill"></a>
<a name="nc_005finq_005fvar_005ffill"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fvar_005fdeflate">nc_def_var_deflate</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fdef_005fvar_005ffill">nc_def_var_fill</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.11 Learn About Fill Parameters for a Variable: <code>nc_inq_var_fill</code></h3>
<p><a name="index-nc_005finq_005fvar_005ffill-226"></a>
The function nc_inq_var_fill returns the fill settings for a
variable in a netCDF-4 file.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_var_fill(int ncid, int varid, int *no_fill, void *fill_value);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>*no_fill</code><dd>Pointer to an integer which will get a 1 if no_fill mode is set for
this variable. See <a href="#nc_005fdef_005fvar_005ffill">nc_def_var_fill</a>. This parameter will be ignored
if it is NULL.
<br><dt><code>*fill_value</code><dd>A pointer which will get the fill value for this variable. This
parameter will be ignored if it is NULL.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4 file.
<br><dt><code>NC_ENOTVAR</code><dd>Can't find this variable.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_vars.c
<pre class="example"> int dimids[NDIMS];
size_t index[NDIMS];
int varid;
int no_fill;
unsigned short ushort_data = 42, ushort_data_in, fill_value_in;
/* Create a netcdf-4 file with one dim and 1 NC_USHORT var. */
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_def_dim(ncid, DIM7_NAME, DIM7_LEN, &dimids[0])) ERR;
if (nc_def_var(ncid, VAR7_NAME, NC_USHORT, NDIMS, dimids,
&varid)) ERR;
if (nc_def_var_fill(ncid, varid, 1, NULL)) ERR;
/* Check stuff. */
if (nc_inq_var_fill(ncid, varid, &no_fill, &fill_value_in)) ERR;
if (!no_fill) ERR;
</pre>
<div class="node">
<a name="nc_def_var_deflate"></a>
<a name="nc_005fdef_005fvar_005fdeflate"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fvar_005fdeflate">nc_inq_var_deflate</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fvar_005ffill">nc_inq_var_fill</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.12 Define Compression Parameters for a Variable: <code>nc_def_var_deflate</code></h3>
<p><a name="index-nc_005fdef_005fvar_005fdeflate-227"></a><a name="index-deflate-228"></a><a name="index-variables_002c-setting-deflate-229"></a><a name="index-compression_002c-setting-parameters-230"></a>
The function nc_def_var_deflate sets the deflate parameters for a
variable in a netCDF-4 file.
<p>This function must be called after the variable is defined, but before
nc_enddef is called.
<p>This does not work with scalar variables.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_def_var_deflate(int ncid, int varid, int shuffle, int deflate,
int deflate_level);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>shuffle</code><dd>If non-zero, turn on the shuffle filter.
<br><dt><code>deflate</code><dd>If non-zero, turn on the deflate filter at the level specified by the
deflate_level parameter.
<br><dt><code>deflate_level</code><dd>If the deflate parameter is non-zero, set the deflate level to this
value. Must be between 0 and 9.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_def_var_deflate returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
<p>Possible return codes include:
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4 file.
<br><dt><code>NC_ENOTVAR</code><dd>Can't find this variable.
<br><dt><code>NC_ELATEDEF</code><dd>This variable has already been the subject of a nc_enddef call. In
netCDF-4 files nc_enddef will be called automatically for any data
read or write. Once enddef has been called, it is impossible to set
the deflate for a variable.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created with
NC_STRICT_NC3 flag. (see <a href="#nc_005fcreate">nc_create</a>).
<br><dt><code>NC_EPERM</code><dd>Attempt to create object in read-only file.
<br><dt><code>NC_EINVAL</code><dd>Invalid deflate_level. The deflate level must be between 0 and 9,
inclusive.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"></pre>
<div class="node">
<a name="nc_inq_var_deflate"></a>
<a name="nc_005finq_005fvar_005fdeflate"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fvar_005fszip">nc_inq_var_szip</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fdef_005fvar_005fdeflate">nc_def_var_deflate</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.13 Learn About Deflate Parameters for a Variable: <code>nc_inq_var_deflate</code></h3>
<p><a name="index-nc_005finq_005fvar_005fdeflate-231"></a>
The function nc_inq_var_deflate returns the deflate settings for a
variable in a netCDF-4 file.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_inq_var_deflate(int ncid, int varid, int *shufflep,
int *deflatep, int *deflate_levelp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>*shufflep</code><dd>If this pointer is non-NULL, the nc_inq_var_deflate function will
write a 1 if the shuffle filter is turned on for this variable, and a
0 otherwise.
<br><dt><code>*deflatep</code><dd>If this pointer is non-NULL, the nc_inq_var_deflate function will
write a 1 if the deflate filter is turned on for this variable, and a
0 otherwise.
<br><dt><code>*deflate_levelp</code><dd>If this pointer is non-NULL, and the deflate filter is in use for this
variable, the nc_inq_var_deflate function will write the deflate_level
here.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_inq_var_deflate returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
<p>Possible return codes include:
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4 file.
<br><dt><code>NC_ENOTVAR</code><dd>Can't find this variable.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"></pre>
<div class="node">
<a name="nc_inq_var_szip"></a>
<a name="nc_005finq_005fvar_005fszip"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fvar_005ffletcher32">nc_def_var_fletcher32</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fvar_005fdeflate">nc_inq_var_deflate</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.14 Learn About Szip Parameters for a Variable: <code>nc_inq_var_szip</code></h3>
<p><a name="index-nc_005finq_005fvar_005fszip-232"></a>
The function nc_inq_var_szip returns the szip settings for a
variable in a netCDF-4 file.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_var_szip(int ncid, int varid, int *options_maskp, int *pixels_per_blockp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>*options_maskp</code><dd>If this pointer is non-NULL, the nc_inq_var_szip function will
put the options_mask here.
<br><dt><code>*pixels_per_blockp</code><dd>If this pointer is non-NULL, the nc_inq_var_szip function will
write the bits per pixel here.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_inq_var_szip returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
<p>Possible return codes include:
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4 file.
<br><dt><code>NC_ENOTVAR</code><dd>Can't find this variable.
</dl>
<h3 class="heading">Example</h3>
<p>This example is from libsrc4/tst_vars3.c.
<pre class="example"> /* Make sure we have the szip settings we expect. */
if (nc_inq_var_szip(ncid, small_varid, &options_mask_in, &pixels_per_block_in)) ERR;
if (options_mask_in != 0 || pixels_per_block_in !=0) ERR;
if (nc_inq_var_szip(ncid, medium_varid, &options_mask_in, &pixels_per_block_in)) ERR;
if (!(options_mask_in & NC_SZIP_EC_OPTION_MASK) || pixels_per_block_in != 32) ERR;
if (nc_inq_var_szip(ncid, large_varid, &options_mask_in, &pixels_per_block_in)) ERR;
if (!(options_mask_in & NC_SZIP_NN_OPTION_MASK) || pixels_per_block_in != 16) ERR;
</pre>
<div class="node">
<a name="nc_def_var_fletcher32"></a>
<a name="nc_005fdef_005fvar_005ffletcher32"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fvar_005ffletcher32">nc_inq_var_fletcher32</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fvar_005fszip">nc_inq_var_szip</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.15 Define Checksum Parameters for a Variable: <code>nc_def_var_fletcher32</code></h3>
<p><a name="index-nc_005fdef_005fvar_005ffletcher32-233"></a><a name="index-checksum-234"></a><a name="index-fletcher32-235"></a><a name="index-variables_002c-fletcher32-236"></a><a name="index-variables_002c-checksum-237"></a>
The function nc_def_var_fletcher32 sets the checksum parameters for a
variable in a netCDF-4 file.
<p>This function may only be called after the variable is defined, but before
nc_enddef is called.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_def_var_fletcher32(int ncid, int varid, int checksum);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>checksum</code><dd>If this is NC_FLETCHER32, fletcher32 checksums will be turned on for this
variable.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_def_var_fletcher32 returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
<p>Possible return codes include:
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4 file.
<br><dt><code>NC_ENOTVAR</code><dd>Can't find this variable.
<br><dt><code>NC_ELATEDEF</code><dd>This variable has already been the subject of a nc_enddef call. In
netCDF-4 files nc_enddef will be called automatically for any data
read or write. Once enddef has been called, it is impossible to set
the checksum property for a variable.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created with
NC_STRICT_NC3 flag. (see <a href="#nc_005fcreate">nc_create</a>).
<br><dt><code>NC_EPERM</code><dd>Attempt to create object in read-only file.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"></pre>
<div class="node">
<a name="nc_inq_var_fletcher32"></a>
<a name="nc_005finq_005fvar_005ffletcher32"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdef_005fvar_005fendian">nc_def_var_endian</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fdef_005fvar_005ffletcher32">nc_def_var_fletcher32</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.16 Learn About Checksum Parameters for a Variable: <code>nc_inq_var_fletcher32</code></h3>
<p><a name="index-nc_005finq_005fvar_005ffletcher32-238"></a>
The function nc_inq_var_fletcher32 returns the checksum settings for a
variable in a netCDF-4 file.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_inq_var_fletcher32(int ncid, int varid, int *checksump);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>*checksump</code><dd>If not-NULL, the nc_inq_var_fletcher32 function will set the int pointed
at to NC_FLETCHER32 if the fletcher32 checksum filter is turned on for
this variable, and NC_NOCHECKSUM if it is not.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_inq_var_fletcher32 returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
<p>Possible return codes include:
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4 file.
<br><dt><code>NC_ENOTVAR</code><dd>Can't find this variable.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"></pre>
<div class="node">
<a name="nc_def_var_endian"></a>
<a name="nc_005fdef_005fvar_005fendian"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fvar_005fendian">nc_inq_var_endian</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fvar_005ffletcher32">nc_inq_var_fletcher32</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.17 Define Endianness of a Variable: <code>nc_def_var_endian</code></h3>
<p><a name="index-nc_005fdef_005fvar_005fendian-239"></a><a name="index-endianness-240"></a><a name="index-big_002dendian-241"></a><a name="index-little_002dendian-242"></a><a name="index-variables_002c-endian-243"></a>
The function nc_def_var_endian sets the endianness for a variable in a
netCDF-4 file.
<p>This function must be called after the variable is defined, but before
nc_enddef is called.
<p>By default, netCDF-4 variables are in native endianness. That is, they
are big-endian on a big-endian machine, and little-endian on a little
endian machine.
<p>In some cases a user might wish to change from native endianness to
either big or little-endianness. This function allows them to do that.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_def_var_endian(int ncid, int varid, int endian);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>endian</code><dd>Set to NC_ENDIAN_NATIVE for native endianness. (This is the
default). Set to NC_ENDIAN_LITTLE for little endian, or NC_ENDIAN_BIG
for big endian.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_def_var_endian returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
<p>Possible return codes include:
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4 file.
<br><dt><code>NC_ENOTVAR</code><dd>Can't find this variable.
<br><dt><code>NC_ELATEDEF</code><dd>This variable has already been the subject of a nc_enddef call. In
netCDF-4 files nc_enddef will be called automatically for any data
read or write. Once enddef has been called, it is impossible to set
the endianness of a variable.
<br><dt><code>NC_ENOTINDEFINE</code><dd>Not in define mode. This is returned for netCDF classic or 64-bit
offset files, or for netCDF-4 files, when they were been created with
NC_STRICT_NC3 flag, and the file is not in define mode. (see <a href="#nc_005fcreate">nc_create</a>).
<br><dt><code>NC_EPERM</code><dd>Attempt to create object in read-only file.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"></pre>
<div class="node">
<a name="nc_inq_var_endian"></a>
<a name="nc_005finq_005fvar_005fendian"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fvarid">nc_inq_varid</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fdef_005fvar_005fendian">nc_def_var_endian</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.18 Learn About Endian Parameters for a Variable: <code>nc_inq_var_endian</code></h3>
<p><a name="index-nc_005finq_005fvar_005fendian-244"></a>
The function nc_inq_var_endian returns the endianness settings for a
variable in a netCDF-4 file.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_inq_var_endian(int ncid, int varid, int *endianp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>*endianp</code><dd>If not-NULL, the nc_inq_var_endian function will set the int
pointed to this to NC_ENDIAN_LITTLE if this variable is stored in
little-endian format, NC_ENDIAN_BIG if it is stored in big-endian
format, and NC_ENDIAN_NATIVE if the endianness is not set, and the
variable is not created yet.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_inq_var_endian returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error.
<p>Possible return codes include:
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_BADID</code><dd>Bad ncid.
<br><dt><code>NC_ENOTNC4</code><dd>Not a netCDF-4 file.
<br><dt><code>NC_ENOTVAR</code><dd>Can't find this variable.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"></pre>
<div class="node">
<a name="nc_inq_varid"></a>
<a name="nc_005finq_005fvarid"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fvar">nc_inq_var</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fvar_005fendian">nc_inq_var_endian</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.19 Get a Variable ID from Its Name: nc_inq_varid</h3>
<p><a name="index-nc_005finq_005fvarid-245"></a><a name="index-nc_005finq_005fvarid_002c-example-246"></a><a name="index-variables_002c-inquiring-about-247"></a><a name="index-inquiring-about-variables-248"></a>
The function nc_inq_varid returns the ID of a netCDF variable, given
its name.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_varid (int ncid, const char *name, int *varidp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>name</code><dd>Variable name for which ID is desired.
<br><dt><code>varidp</code><dd>Pointer to location for returned variable ID.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_inq_varid returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<ul>
<li>The specified variable name is not a valid name for a variable in the
specified netCDF dataset.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_inq_varid to find out the ID of a variable
named rh in an existing netCDF dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status, ncid, rh_id;
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_inq_var"></a>
<a name="nc_005finq_005fvar"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fvarid">nc_inq_varid</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.20 Get Information about a Variable from Its ID: nc_inq_var</h3>
<p>family
<a name="index-nc_005finq_005fvar-249"></a>&findex nc_inq_vardimid
<a name="index-nc_005finq_005fvarname-250"></a><a name="index-nc_005finq_005fvartype-251"></a><a name="index-nc_005finq_005fvarndims-252"></a><a name="index-nc_005finq_005fvarnatts-253"></a><a name="index-nc_005finq_005fvar_002c-example-254"></a><a name="index-variables_002c-getting-name-255"></a>
A family of functions that returns information about a netCDF
variable, given its ID. Information about a variable includes its
name, type, number of dimensions, a list of dimension IDs describing
the shape of the variable, and the number of variable attributes that
have been assigned to the variable.
<p>The function nc_inq_var returns all the information about a netCDF
variable, given its ID. The other functions each return just one item
of information about a variable.
<p>These other functions include nc_inq_varname, nc_inq_vartype,
nc_inq_varndims, nc_inq_vardimid, and nc_inq_varnatts.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_var (int ncid, int varid, char *name, nc_type *xtypep,
int *ndimsp, int dimids[], int *nattsp);
int nc_inq_varname (int ncid, int varid, char *name);
int nc_inq_vartype (int ncid, int varid, nc_type *xtypep);
int nc_inq_varndims (int ncid, int varid, int *ndimsp);
int nc_inq_vardimid (int ncid, int varid, int dimids[]);
int nc_inq_varnatts (int ncid, int varid, int *nattsp);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>name</code><dd>Returned variable name. The caller must allocate space for the
returned name. The maximum possible length, in characters, of a
variable name is given by the predefined constant NC_MAX_NAME. (This
doesn't include the null terminator, so declare your array to be size
NC_MAX_NAME+1). The returned character array will be null-terminated.
<br><dt><code>xtypep</code><dd>Pointer to location for returned variable type, one of the set of
predefined netCDF external data types. The type of this parameter,
nc_type, is defined in the netCDF header file. The valid netCDF
external data types are NC_BYTE, NC_CHAR, NC_SHORT, NC_INT, NC_FLOAT,
and NC_DOUBLE.
<br><dt><code>ndimsp</code><dd>Pointer to location for returned number of dimensions the variable
was defined as using. For example, 2 indicates a matrix, 1 indicates a
vector, and 0 means the variable is a scalar with no dimensions.
<br><dt><code>dimids</code><dd>Returned vector of *ndimsp dimension IDs corresponding to the
variable dimensions. The caller must allocate enough space for a
vector of at least *ndimsp integers to be returned. The maximum
possible number of dimensions for a variable is given by the
predefined constant NC_MAX_VAR_DIMS.
<br><dt><code>nattsp</code><dd>Pointer to location for returned number of variable attributes
assigned to this variable.
</dl>
<p>These functions return the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<p>The variable ID is invalid for the specified netCDF dataset.
The specified netCDF ID does not refer to an open netCDF dataset.
<h3 class="heading">Example</h3>
<p>Here is an example using nc_inq_var to find out about a variable named
rh in an existing netCDF dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
nc_type rh_type; /* variable type */
int rh_ndims; /* number of dims */
int rh_dimids[NC_MAX_VAR_DIMS]; /* dimension IDs */
int rh_natts /* number of attributes */
...
status = nc_open ("foo.nc", NC_NOWRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
/* we don't need name, since we already know it */
status = nc_inq_var (ncid, rh_id, 0, &rh_type, &rh_ndims, rh_dimids,
&rh_natts);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_put_var1_-type"></a>
<a name="nc_005fput_005fvar1_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fvar">nc_inq_var</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.21 Write a Single Data Value: nc_put_var1_ <var>type</var></h3>
<p><a name="index-nc_005fput_005fvar1_005f-type-256"></a><a name="index-nc_005fput_005fvar1_005f-type_002c-example-257"></a><a name="index-writing-single-value-258"></a><a name="index-nc_005fput_005fvar1_005ftext-259"></a><a name="index-nc_005fput_005fvar1_005fuchar-260"></a><a name="index-nc_005fput_005fvar1_005fschar-261"></a><a name="index-nc_005fput_005fvar1_005fshort-262"></a><a name="index-nc_005fput_005fvar1_005fint-263"></a><a name="index-nc_005fput_005fvar1_005flong-264"></a><a name="index-nc_005fput_005fvar1_005ffloat-265"></a><a name="index-nc_005fput_005fvar1_005fdouble-266"></a><a name="index-nc_005fput_005fvar1_005fushort-267"></a><a name="index-nc_005fput_005fvar1_005fuint-268"></a><a name="index-nc_005fput_005fvar1_005flonglong-269"></a><a name="index-nc_005fput_005fvar1_005fulonglong-270"></a><a name="index-nc_005fput_005fvar1_005fstring-271"></a><a name="index-nc_005fput_005fvar1-272"></a>
The functions nc_put_var1_ <var>type</var> put a single data value of the
specified type into a variable of an open netCDF dataset that is in
data mode. Inputs are the netCDF ID, the variable ID, an index that
specifies which value to add or alter, and the data value. The value
is converted to the external data type of the variable, if necessary.
<p>The functions for types ubyte, ushort, uint, longlong, ulonglong, and
string are only available for netCDF-4/HDF5 files.
<p>The nc_put_var1() function will write a variable of any type,
including user defined type. For this function, the type of the data
in memory must match the type of the variable - no data conversion is
done.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_put_var1_text (int ncid, int varid, const size_t index[],
const char *tp);
int nc_put_var1_uchar (int ncid, int varid, const size_t index[],
const unsigned char *up);
int nc_put_var1_schar (int ncid, int varid, const size_t index[],
const signed char *cp);
int nc_put_var1_short (int ncid, int varid, const size_t index[],
const short *sp);
int nc_put_var1_int (int ncid, int varid, const size_t index[],
const int *ip);
int nc_put_var1_long (int ncid, int varid, const size_t index[],
const long *lp);
int nc_put_var1_float (int ncid, int varid, const size_t index[],
const float *fp);
int nc_put_var1_double(int ncid, int varid, const size_t index[],
const double *dp);
int nc_put_var1_ushort(int ncid, int varid, const size_t index[],
const unsigned short *sp);
int nc_put_var1_uint (int ncid, int varid, const size_t index[],
const unsigned int *ip);
int nc_put_var1_longlong(int ncid, int varid, const size_t index[],
const long long *ip);
int nc_put_var1_ulonglong(int ncid, int varid, const size_t index[],
const unsigned long long *ip);
int nc_put_var1_string(int ncid, int varid, const size_t index[],
const char **ip);
int nc_put_var1(int ncid, int varid, const size_t *indexp,
const void *op);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>index[]</code><dd>The index of the data value to be written. The indices are relative
to 0, so for example, the first data value of a two-dimensional
variable would have index (0,0). The elements of index must correspond
to the variable's dimensions. Hence, if the variable uses the
unlimited dimension, the first index would correspond to the unlimited
dimension.
<br><dt><code>tp</code><dt><code>up</code><dt><code>cp</code><dt><code>sp</code><dt><code>ip</code><dt><code>lp</code><dt><code>fp</code><dt><code>dp</code><dd>Pointer to the data value to be written. If the type of data values
differs from the netCDF variable type, type conversion will
occur. See <a href="netcdf.html#Type-Conversion">Type Conversion</a>.
</dl>
<h3 class="heading">Return Codes</h3>
<ul>
<li>NC_NOERR
No error.
<li>NC_EHDFERR
Error reported by HDF5 layer.
<li>NC_ENOTVAR
The variable ID is invalid for the specified netCDF dataset.
<li>NC_EINVALCOORDS
The specified indices were out of range for the rank of the specified
variable. For example, a negative index or an index that is larger
than the corresponding dimension length will cause an error.
<li>NC_ERANGE
The specified value is out of the range of values representable by the
external data type of the variable. (Does not apply to nc_put_var1()
function).
<li>NC_EINDEFINE
The specified netCDF is in define mode rather than data mode.
<li>NC_EBADID
The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_put_var1_double to set the (1,2,3) element
of the variable named rh to 0.5 in an existing netCDF dataset named
foo.nc. For simplicity in this example, we assume that we know that rh
is dimensioned with time, lat, and lon, so we want to set the value of
rh that corresponds to the second time value, the third lat value, and
the fourth lon value:
<pre class="example"> #include <netcdf.h>
...
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
static size_t rh_index[] = {1, 2, 3}; /* where to put value */
static double rh_val = 0.5; /* value to put */
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
status = nc_put_var1_double(ncid, rh_id, rh_index, &rh_val);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_put_var_-type"></a>
<a name="nc_005fput_005fvar_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.22 Write an Entire Variable: nc_put_var_ <var>type</var></h3>
<p><a name="index-nc_005fput_005fvar_005f-type-273"></a><a name="index-nc_005fput_005fvar_005f-type_002c-example-274"></a><a name="index-writing-entire-variable-275"></a><a name="index-entire-variable_002c-writing-276"></a><a name="index-variable_002c-writing-entire-277"></a><a name="index-nc_005fput_005fvar_005ftext-278"></a><a name="index-nc_005fput_005fvar_005fuchar-279"></a><a name="index-nc_005fput_005fvar_005fschar-280"></a><a name="index-nc_005fput_005fvar_005fshort-281"></a><a name="index-nc_005fput_005fvar_005fint-282"></a><a name="index-nc_005fput_005fvar_005flong-283"></a><a name="index-nc_005fput_005fvar_005ffloat-284"></a><a name="index-nc_005fput_005fvar_005fdouble-285"></a><a name="index-nc_005fput_005fvar_005fushort-286"></a><a name="index-nc_005fput_005fvar_005fuint-287"></a><a name="index-nc_005fput_005fvar_005flonglong-288"></a><a name="index-nc_005fput_005fvar_005fulonglong-289"></a><a name="index-nc_005fput_005fvar_005fstring-290"></a><a name="index-nc_005fput_005fvar-291"></a>
The nc_put_var_ <var>type</var> family of functions write all the values of a
variable into a netCDF variable of an open netCDF dataset. This is the
simplest interface to use for writing a value in a scalar variable or
whenever all the values of a multidimensional variable can all be
written at once. The values to be written are associated with the
netCDF variable by assuming that the last dimension of the netCDF
variable varies fastest in the C interface. The values are converted
to the external data type of the variable, if necessary.
<p>Take care when using the simplest forms of this interface with record
variables (variables that use the NC_UNLIMITED dimension) when you
don't specify how many records are to be written. If you try to write
all the values of a record variable into a netCDF file that has no
record data yet (hence has 0 records), nothing will be
written. Similarly, if you try to write all the values of a record
variable but there are more records in the file than you assume, more
in-memory data will be accessed than you supply, which may result in a
segmentation violation. To avoid such problems, it is better to use
the nc_put_vara interfaces for variables that use the
NC_UNLIMITED dimension. See <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a>.
<p>The functions for types ubyte, ushort, uint, longlong, ulonglong, and
string are only available for netCDF-4/HDF5 files.
<p>The nc_put_var() function will write a variable of any type,
including user defined type. For this function, the type of the data
in memory must match the type of the variable - no data conversion is
done.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_put_var_text (int ncid, int varid, const char *tp);
int nc_put_var_uchar (int ncid, int varid, const unsigned char *up);
int nc_put_var_schar (int ncid, int varid, const signed char *cp);
int nc_put_var_short (int ncid, int varid, const short *sp);
int nc_put_var_int (int ncid, int varid, const int *ip);
int nc_put_var_long (int ncid, int varid, const long *lp);
int nc_put_var_float (int ncid, int varid, const float *fp);
int nc_put_var_double(int ncid, int varid, const double *dp);
int nc_put_var_ushort(int ncid, int varid, const unsigned short *op);
int nc_put_var_uint (int ncid, int varid, const unsigned int *op);
int nc_put_var_longlong (int ncid, int varid, const long long *op);
int nc_put_var_ulonglong(int ncid, int varid, const unsigned long long *op);
int nc_put_var_string(int ncid, int varid, const char **op);
int nc_put_var (int ncid, int varid, const void *op);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>tp</code><dt><code>up</code><dt><code>cp</code><dt><code>sp</code><dt><code>ip</code><dt><code>lp</code><dt><code>fp</code><dt><code>dp</code><dd>Pointer to a block of contiguous data values to be written. The order in which
the data will be written to the netCDF variable is with the last
dimension of the specified variable varying fastest. If the type of
data values differs from the netCDF variable type, type conversion
will occur. See <a href="netcdf.html#Type-Conversion">Type Conversion</a>.
</dl>
<h3 class="heading">Return Codes</h3>
<ul>
<li>NC_NOERR
The variable ID is invalid for the specified netCDF dataset.
<li>NC_EHDFERR
Error reported by HDF5 layer.
<li>NC_ERANGE
One or more of the specified values are out of the range of values
representable by the external data type of the variable. (Does not
apply to nc_put_var() function).
<li>NC_EINDEFINE
The specified netCDF dataset is in define mode rather than data mode.
<li>NC_BADID
The specified netCDF ID does not refer to an open netCDF dataset.
<li>NC_ENOTVAR
Bad variable ID.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_put_var_double to add or change all the
values of the variable named rh to 0.5 in an existing netCDF dataset
named foo.nc. For simplicity in this example, we assume that we know
that rh is dimensioned with lat and lon, and that there are
five lat values and ten lon values.
<pre class="example"> #include <netcdf.h>
...
#define LATS 5
#define LONS 10
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
double rh_vals[LATS*LONS]; /* array to hold values */
int i;
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
for (i = 0; i < LATS*LONS; i++)
rh_vals[i] = 0.5;
/* write values into netCDF variable */
status = nc_put_var_double(ncid, rh_id, rh_vals);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_put_vara_-type"></a>
<a name="nc_005fput_005fvara_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.23 Write an Array of Values: nc_put_vara_ <var>type</var></h3>
<p><a name="index-nc_005fput_005fvara_005f-type-292"></a><a name="index-nc_005fput_005fvara_005f-type_002c-example-293"></a><a name="index-writing-array-section-294"></a><a name="index-array-section_002c-writing-295"></a><a name="index-nc_005fput_005fvara_005f-type-296"></a><a name="index-nc_005fput_005fvara_005ftext-297"></a><a name="index-nc_005fput_005fvara_005fuchar-298"></a><a name="index-nc_005fput_005fvara_005fschar-299"></a><a name="index-nc_005fput_005fvara_005fshort-300"></a><a name="index-nc_005fput_005fvara_005fint-301"></a><a name="index-nc_005fput_005fvara_005flong-302"></a><a name="index-nc_005fput_005fvara_005ffloat-303"></a><a name="index-nc_005fput_005fvara_005fdouble-304"></a><a name="index-nc_005fput_005fvara_005fushort-305"></a><a name="index-nc_005fput_005fvara_005fuint-306"></a><a name="index-nc_005fput_005fvara_005flonglong-307"></a><a name="index-nc_005fput_005fvara_005fulonglong-308"></a><a name="index-nc_005fput_005fvara_005fstring-309"></a><a name="index-nc_005fput_005fvara-310"></a>
The function nc_put_vara_ <var>type</var> writes values into a netCDF variable of
an open netCDF dataset. The part of the netCDF variable to write is
specified by giving a corner and a vector of edge lengths that refer
to an array section of the netCDF variable. The values to be written
are associated with the netCDF variable by assuming that the last
dimension of the netCDF variable varies fastest in the C
interface. The netCDF dataset must be in data mode.
<p>The functions for types ubyte, ushort, uint, longlong, ulonglong, and
string are only available for netCDF-4/HDF5 files.
<p>The nc_put_var() function will write a variable of any type,
including user defined type. For this function, the type of the data
in memory must match the type of the variable - no data conversion is
done.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_put_vara_ type (int ncid, int varid, const size_t start[],
const size_t count[], const type *valuesp);
int nc_put_vara_text (int ncid, int varid, const size_t start[],
const size_t count[], const char *tp);
int nc_put_vara_uchar (int ncid, int varid, const size_t start[],
const size_t count[], const unsigned char *up);
int nc_put_vara_schar (int ncid, int varid, const size_t start[],
const size_t count[], const signed char *cp);
int nc_put_vara_short (int ncid, int varid, const size_t start[],
const size_t count[], const short *sp);
int nc_put_vara_int (int ncid, int varid, const size_t start[],
const size_t count[], const int *ip);
int nc_put_vara_long (int ncid, int varid, const size_t start[],
const size_t count[], const long *lp);
int nc_put_vara_float (int ncid, int varid, const size_t start[],
const size_t count[], const float *fp);
int nc_put_vara_double(int ncid, int varid, const size_t start[],
const size_t count[], const double *dp);
int nc_put_vara_ushort(int ncid, int varid, const size_t *startp,
const size_t *countp, const unsigned short *op);
int nc_put_vara_uint (int ncid, int varid, const size_t *startp,
const size_t *countp, const unsigned int *op);
int nc_put_vara_longlong (int ncid, int varid, const size_t *startp,
const size_t *countp, const long long *op);
int nc_put_vara_ulonglong(int ncid, int varid, const size_t *startp,
const size_t *countp, const unsigned long long *op);
int nc_put_vara_string(int ncid, int varid, const size_t *startp,
const size_t *countp, const char **op);
int nc_put_vara (int ncid, int varid, const size_t *startp,
const size_t *countp, const void *op);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>start</code><dd>A vector of size_t integers specifying the index in the variable
where the first of the data values will be written. The indices are
relative to 0, so for example, the first data value of a variable
would have index (0, 0, ... , 0). The size of start must be the same
as the number of dimensions of the specified variable. The elements of
start must correspond to the variable's dimensions in order. Hence, if
the variable is a record variable, the first index would correspond to
the starting record number for writing the data values.
<br><dt><code>count</code><dd>A vector of size_t integers specifying the edge lengths along each
dimension of the block of data values to be written. To write a single
value, for example, specify count as (1, 1, ... , 1). The length of
count is the number of dimensions of the specified variable. The
elements of count correspond to the variable's dimensions. Hence, if
the variable is a record variable, the first element of count
corresponds to a count of the number of records to write.
<p>Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
<br><dt><code>tp</code><dt><code>up</code><dt><code>cp</code><dt><code>sp</code><dt><code>ip</code><dt><code>lp</code><dt><code>fp</code><dt><code>dp</code><dd>Pointer to a block of contiguous data values to be written. The order in which
the data will be written to the netCDF variable is with the last
dimension of the specified variable varying fastest. If the type of
data values differs from the netCDF variable type, type conversion
will occur. See <a href="netcdf.html#Type-Conversion">Type Conversion</a>.
</dl>
<h3 class="heading">Return Codes</h3>
<ul>
<li>NC_NOERR
No error.
<li>NC_EHDFERR
Error reported by HDF5 layer.
<li>NC_ENOTVAR
The variable ID is invalid for the specified netCDF dataset.
<li>NC_EINVALCOORDS
The specified corner indices were out of range for the rank of the
specified variable. For example, a negative index, or an index that is
larger than the corresponding dimension length will cause an error.
<li>NC_EEDGE
The specified edge lengths added to the specified corner would have
referenced data out of range for the rank of the specified
variable. For example, an edge length that is larger than the
corresponding dimension length minus the corner index will cause an
error.
<li>NC_ERANGE
One or more of the specified values are out of the range of values
representable by the external data type of the variable. (Does not
apply to the nc_put_vara() function).
<li>NC_EINDEFINE
The specified netCDF dataset is in define mode rather than data mode.
<li>NC_EBADID
The specified netCDF ID does not refer to an open netCDF dataset.
<li>NC_ECHAR
Attempt to convert to or from char.
<li>NC_ENOMEM
Out of memory.
<li>NC_EBADTYPE
Bad type.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_put_vara_double to add or change all the
values of the variable named rh to 0.5 in an existing netCDF dataset
named foo.nc. For simplicity in this example, we assume that we know
that rh is dimensioned with time, lat, and lon, and that there are
three time values, five lat values, and ten lon values.
<pre class="example"> #include <netcdf.h>
...
#define TIMES 3
#define LATS 5
#define LONS 10
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
static size_t start[] = {0, 0, 0}; /* start at first value */
static size_t count[] = {TIMES, LATS, LONS};
double rh_vals[TIMES*LATS*LONS]; /* array to hold values */
int i;
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
for (i = 0; i < TIMES*LATS*LONS; i++)
rh_vals[i] = 0.5;
/* write values into netCDF variable */
status = nc_put_vara_double(ncid, rh_id, start, count, rh_vals);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_put_vars_-type"></a>
<a name="nc_005fput_005fvars_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.24 Write a Subsampled Array of Values: nc_put_vars_ <var>type</var></h3>
<p><a name="index-nc_005fput_005fvars_005f-type-311"></a><a name="index-nc_005fput_005fvars_005f-type_002c-example-312"></a><a name="index-writing-subsampled-array-313"></a><a name="index-subsampled-array_002c-writing-314"></a><a name="index-nc_005fput_005fvars_005ftext-315"></a><a name="index-nc_005fput_005fvars_005fuchar-316"></a><a name="index-nc_005fput_005fvars_005fschar-317"></a><a name="index-nc_005fput_005fvars_005fshort-318"></a><a name="index-nc_005fput_005fvars_005fint-319"></a><a name="index-nc_005fput_005fvars_005flong-320"></a><a name="index-nc_005fput_005fvars_005ffloat-321"></a><a name="index-nc_005fput_005fvars_005fdouble-322"></a><a name="index-nc_005fput_005fvars_005fushort-323"></a><a name="index-nc_005fput_005fvars_005fuint-324"></a><a name="index-nc_005fput_005fvars_005flonglong-325"></a><a name="index-nc_005fput_005fvars_005fulonglong-326"></a><a name="index-nc_005fput_005fvars_005fstring-327"></a><a name="index-nc_005fput_005fvars-328"></a>
<p>Each member of the family of functions nc_put_vars_ <var>type</var> writes a
subsampled (strided) array section of values into a netCDF variable of
an open netCDF dataset. The subsampled array section is specified by
giving a corner, a vector of counts, and a stride vector. The netCDF
dataset must be in data mode.
<p>The functions for types ubyte, ushort, uint, longlong, ulonglong, and
string are only available for netCDF-4/HDF5 files.
<p>The nc_put_vars() function will write a variable of any type,
including user defined type. For this function, the type of the data
in memory must match the type of the variable - no data conversion is
done.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_put_vars_text (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const char *tp);
int nc_put_vars_uchar (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const unsigned char *up);
int nc_put_vars_schar (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const signed char *cp);
int nc_put_vars_short (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const short *sp);
int nc_put_vars_int (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const int *ip);
int nc_put_vars_long (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const long *lp);
int nc_put_vars_float (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const float *fp);
int nc_put_vars_double(int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const double *dp);
int nc_put_vars_ushort(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const unsigned short *op);
int nc_put_vars_uint (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const unsigned int *op);
int nc_put_vars_longlong (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const long long *op);
int nc_put_vars_ulonglong(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const unsigned long long *op);
int nc_put_vars_string(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const char **op);
int nc_put_vars (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const void *op);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>start</code><dd>A vector of size_t integers specifying the index in the variable
where the first of the data values will be written. The indices are
relative to 0, so for example, the first data value of a variable
would have index (0, 0, ... , 0). The elements of start correspond, in
order, to the variable's dimensions. Hence, if the variable is a
record variable, the first index corresponds to the starting record
number for writing the data values.
<br><dt><code>count</code><dd>A vector of size_t integers specifying the number of indices selected
along each dimension. To write a single value, for example, specify
count as (1, 1, ... , 1). The elements of count correspond, in order,
to the variable's dimensions. Hence, if the variable is a record
variable, the first element of count corresponds to a count of the
number of records to write.
<p>Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
<br><dt><code>stride</code><dd>A vector of ptrdiff_t integers that specifies the sampling interval
along each dimension of the netCDF variable. The elements of the
stride vector correspond, in order, to the netCDF variable's
dimensions (stride[0] gives the sampling interval along the most
slowly varying dimension of the netCDF variable). Sampling intervals
are specified in type-independent units of elements (a value of 1
selects consecutive elements of the netCDF variable along the
corresponding dimension, a value of 2 selects every other element,
etc.). A NULL stride argument is treated as (1, 1, ... , 1).
<br><dt><code>tp</code><dt><code>up</code><dt><code>cp</code><dt><code>sp</code><dt><code>ip</code><dt><code>lp</code><dt><code>fp</code><dt><code>dp</code><dd>Pointer to a block of contiguous data values to be written. The order in which
the data will be written to the netCDF variable is with the last
dimension of the specified variable varying fastest. If the type of
data values differs from the netCDF variable type, type conversion
will occur. See <a href="netcdf.html#Type-Conversion">Type Conversion</a>.
</dl>
<h3 class="heading">Return Codes</h3>
<ul>
<li>NC_NOERR
No error.
<li>NC_EHDFERR
Error reported by HDF5 layer.
<li>NC_ENOTVAR
The variable ID is invalid for the specified netCDF dataset.
<li>NC_EINVALCOORDS
The specified corner indices were out of range for the rank of the
specified variable. For example, a negative index, or an index that is
larger than the corresponding dimension length will cause an error.
<li>NC_EEDGE
The specified edge lengths added to the specified corner would have
referenced data out of range for the rank of the specified
variable. For example, an edge length that is larger than the
corresponding dimension length minus the corner index will cause an
error.
<li>NC_ERANGE
One or more of the specified values are out of the range of values
representable by the external data type of the variable. (Does not
apply to the nc_put_vars() function).
<li>NC_EINDEFINE
The specified netCDF dataset is in define mode rather than data mode.
<li>NC_EBADID
The specified netCDF ID does not refer to an open netCDF dataset.
<li>NC_ECHAR
Attempt to convert to or from char.
<li>NC_ENOMEM
Out of memory.
<li>NC_EBADTYPE
Bad type.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example of using nc_put_vars_float to write – from an
internal array – every other point of a netCDF variable named rh
which is described by the C declaration float rh[4][6] (note the size
of the dimensions):
<pre class="example"> #include <netcdf.h>
...
#define NDIM 2 /* rank of netCDF variable */
int ncid; /* netCDF ID */
int status; /* error status */
int rhid; /* variable ID */
static size_t start[NDIM] /* netCDF variable start point: */
= {0, 0}; /* first element */
static size_t count[NDIM] /* size of internal array: entire */
= {2, 3}; /* (subsampled) netCDF variable */
static ptrdiff_t stride[NDIM] /* variable subsampling intervals: */
= {2, 2}; /* access every other netCDF element */
float rh[2][3]; /* note subsampled sizes for */
/* netCDF variable dimensions */
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid(ncid, "rh", &rhid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_put_vars_float(ncid, rhid, start, count, stride, rh);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_put_varm_-type"></a>
<a name="nc_005fput_005fvarm_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.25 Write a Mapped Array of Values: nc_put_varm_ <var>type</var></h3>
<p><a name="index-nc_005fput_005fvarm_005f-type-329"></a><a name="index-nc_005fput_005fvarm_005f-type_002c-example-330"></a><a name="index-array_002c-writing-mapped-331"></a><a name="index-writing-mapped-array-332"></a><a name="index-mapped-array_002c-writing-333"></a><a name="index-nc_005fput_005fvarm_005ftext-334"></a><a name="index-nc_005fput_005fvarm_005fuchar-335"></a><a name="index-nc_005fput_005fvarm_005fschar-336"></a><a name="index-nc_005fput_005fvarm_005fshort-337"></a><a name="index-nc_005fput_005fvarm_005fint-338"></a><a name="index-nc_005fput_005fvarm_005flong-339"></a><a name="index-nc_005fput_005fvarm_005ffloat-340"></a><a name="index-nc_005fput_005fvarm_005fdouble-341"></a><a name="index-nc_005fput_005fvarm_005fushort-342"></a><a name="index-nc_005fput_005fvarm_005fuint-343"></a><a name="index-nc_005fput_005fvarm_005flonglong-344"></a><a name="index-nc_005fput_005fvarm_005fulonglong-345"></a><a name="index-nc_005fput_005fvarm_005fstring-346"></a><a name="index-nc_005fput_005fvarm-347"></a>
The nc_put_varm_ <var>type</var> family of functions writes a mapped array
section of values into a netCDF variable of an open netCDF
dataset. The mapped array section is specified by giving a corner, a
vector of counts, a stride vector, and an index mapping vector. The
index mapping vector is a vector of integers that specifies the
mapping between the dimensions of a netCDF variable and the in-memory
structure of the internal data array. No assumptions are made about
the ordering or length of the dimensions of the data array. The netCDF
dataset must be in data mode.
<p>The functions for types ubyte, ushort, uint, longlong, ulonglong, and
string are only available for netCDF-4/HDF5 files.
<p>The nc_put_varm() function will write a variable of any type,
including user defined type. For this function, the type of the data
in memory must match the type of the variable - no data conversion is
done.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_put_varm_text (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], const char *tp);
int nc_put_varm_uchar (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], const unsigned char *up);
int nc_put_varm_schar (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], const signed char *cp);
int nc_put_varm_short (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], const short *sp);
int nc_put_varm_int (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], const int *ip);
int nc_put_varm_long (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], const long *lp);
int nc_put_varm_float (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], const float *fp);
int nc_put_varm_double(int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], const double *dp);
int nc_put_varm_ushort(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, const unsigned short *op);
int nc_put_varm_uint (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, const unsigned int *op);
int nc_put_varm_longlong (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, const long long *op);
int nc_put_varm_ulonglong(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, const unsigned long long *op);
int nc_put_varm_string(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, const char **op);
int nc_put_varm (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, const void *op);
n</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>start</code><dd>A vector of size_t integers specifying the index in the variable
where the first of the data values will be written. The indices are
relative to 0, so for example, the first data value of a variable
would have index (0, 0, ... , 0). The elements of start correspond, in
order, to the variable's dimensions. Hence, if the variable is a
record variable, the first index corresponds to the starting record
number for writing the data values.
<br><dt><code>count</code><dd>A vector of size_t integers specifying the number of indices selected
along each dimension. To write a single value, for example, specify
count as (1, 1, ... , 1). The elements of count correspond, in order,
to the variable's dimensions. Hence, if the variable is a record
variable, the first element of count corresponds to a count of the
number of records to write.
<p>Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
<br><dt><code>stride</code><dd>A vector of ptrdiff_t integers that specifies the sampling interval
along each dimension of the netCDF variable. The elements of the
stride vector correspond, in order, to the netCDF variable's
dimensions (stride[0] gives the sampling interval along the most
slowly varying dimension of the netCDF variable). Sampling intervals
are specified in type-independent units of elements (a value of 1
selects consecutive elements of the netCDF variable along the
corresponding dimension, a value of 2 selects every other element,
etc.). A NULL stride argument is treated as (1, 1, ... , 1).
<br><dt><code>imap</code><dd>A vector of ptrdiff_t integers that specifies the mapping between the
dimensions of a netCDF variable and the in-memory structure of the
internal data array. The elements of the index mapping vector
correspond, in order, to the netCDF variable's dimensions (imap[0]
gives the distance between elements of the internal array
corresponding to the most slowly varying dimension of the netCDF
variable). Distances between elements are specified in
type-independent units of elements (the distance between internal
elements that occupy adjacent memory locations is 1 and not the
element's byte-length as in netCDF 2). A NULL argument means the
memory-resident values have the same structure as the associated
netCDF variable.
<br><dt><code>tp</code><dt><code>up</code><dt><code>cp</code><dt><code>sp</code><dt><code>ip</code><dt><code>lp</code><dt><code>fp</code><dt><code>dp</code><dd>Pointer to the location used for computing where the data values will
be found; the data should be of the type appropriate for the function
called. If the type of data values differs from the netCDF variable
type, type conversion will occur. See <a href="netcdf.html#Type-Conversion">Type Conversion</a>.
</dl>
<h3 class="heading">Return Codes</h3>
<ul>
<li>NC_NOERR
No error.
<li>NC_EHDFERR
Error reported by HDF5 layer.
<li>NC_ENOTVAR
The variable ID is invalid for the specified netCDF dataset.
<li>NC_EINVALCOORDS
The specified corner indices were out of range for the rank of the
specified variable. For example, a negative index, or an index that is
larger than the corresponding dimension length will cause an error.
<li>NC_EEDGE
The specified edge lengths added to the specified corner would have
referenced data out of range for the rank of the specified
variable. For example, an edge length that is larger than the
corresponding dimension length minus the corner index will cause an
error.
<li>NC_ERANGE
One or more of the specified values are out of the range of values
representable by the external data type of the variable. (Does not
apply to the nc_put_vars() function).
<li>NC_EINDEFINE
The specified netCDF dataset is in define mode rather than data mode.
<li>NC_EBADID
The specified netCDF ID does not refer to an open netCDF dataset.
<li>NC_ECHAR
Attempt to convert to or from char.
<li>NC_ENOMEM
Out of memory.
</ul>
<h3 class="heading">Example</h3>
<p>The following imap vector maps in the trivial way a 4x3x2 netCDF
variable and an internal array of the same shape:
<pre class="example"> float a[4][3][2]; /* same shape as netCDF variable */
int imap[3] = {6, 2, 1};
/* netCDF dimension inter-element distance */
/* ---------------- ---------------------- */
/* most rapidly varying 1 */
/* intermediate 2 (=imap[2]*2) */
/* most slowly varying 6 (=imap[1]*3) */
</pre>
<p>Using the imap vector above with nc_put_varm_float obtains the same
result as simply using nc_put_var_float.
<p>Here is an example of using nc_put_varm_float to write – from a
transposed, internal array – a netCDF variable named rh which is
described by the C declaration float rh[6][4] (note the size and order
of the dimensions):
<pre class="example"> #include <netcdf.h>
...
#define NDIM 2 /* rank of netCDF variable */
int ncid; /* netCDF ID */
int status; /* error status */
int rhid; /* variable ID */
static size_t start[NDIM] /* netCDF variable start point: */
= {0, 0}; /* first element */
static size_t count[NDIM] /* size of internal array: entire netCDF */
= {6, 4}; /* variable; order corresponds to netCDF */
/* variable -- not internal array */
static ptrdiff_t stride[NDIM]/* variable subsampling intervals: */
= {1, 1}; /* sample every netCDF element */
static ptrdiff_t imap[NDIM] /* internal array inter-element distances; */
= {1, 6}; /* would be {4, 1} if not transposing */
float rh[4][6]; /* note transposition of netCDF variable */
/* dimensions */
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid(ncid, "rh", &rhid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_put_varm_float(ncid, rhid, start, count, stride, imap, rh);
if (status != NC_NOERR) handle_error(status);
</pre>
<p>Here is another example of using nc_put_varm_float to write – from a
transposed, internal array – a subsample of the same netCDF variable,
by writing every other point of the netCDF variable:
<pre class="example"> #include <netcdf.h>
...
#define NDIM 2 /* rank of netCDF variable */
int ncid; /* netCDF ID */
int status; /* error status */
int rhid; /* variable ID */
static size_t start[NDIM] /* netCDF variable start point: */
= {0, 0}; /* first element */
static size_t count[NDIM] /* size of internal array: entire */
= {3, 2}; /* (subsampled) netCDF variable; order of */
/* dimensions corresponds to netCDF */
/* variable -- not internal array */
static ptrdiff_t stride[NDIM] /* variable subsampling intervals: */
= {2, 2}; /* sample every other netCDF element */
static ptrdiff_t imap[NDIM] /* internal array inter-element distances; */
= {1, 3}; /* would be {2, 1} if not transposing */
float rh[2][3]; /* note transposition of (subsampled) */
/* netCDF variable dimensions */
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid(ncid, "rh", &rhid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_put_varm_float(ncid, rhid, start, count, stride, imap, rh);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_get_var1_-type"></a>
<a name="nc_005fget_005fvar1_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.26 Read a Single Data Value: nc_get_var1_ <var>type</var></h3>
<p><a name="index-nc_005fget_005fvar1_005f-type-348"></a><a name="index-nc_005fget_005fvar1_005f-type_002c-example-349"></a><a name="index-reading-single-value-350"></a><a name="index-single-value_002c-reading-351"></a><a name="index-nc_005fget_005fvar1_005ftext-352"></a><a name="index-nc_005fget_005fvar1_005fuchar-353"></a><a name="index-nc_005fget_005fvar1_005fschar-354"></a><a name="index-nc_005fget_005fvar1_005fshort-355"></a><a name="index-nc_005fget_005fvar1_005fint-356"></a><a name="index-nc_005fget_005fvar1_005flong-357"></a><a name="index-nc_005fget_005fvar1_005ffloat-358"></a><a name="index-nc_005fget_005fvar1_005fdouble-359"></a><a name="index-nc_005fget_005fvar1_005fushort-360"></a><a name="index-nc_005fget_005fvar1_005fuint-361"></a><a name="index-nc_005fget_005fvar1_005flonglong-362"></a><a name="index-nc_005fget_005fvar1_005fulonglong-363"></a><a name="index-nc_005fget_005fvar1_005fstring-364"></a><a name="index-nc_005fget_005fvar1-365"></a>
The functions nc_get_var1_ <var>type</var> get a single data value from a
variable of an open netCDF dataset that is in data mode. Inputs are
the netCDF ID, the variable ID, a multidimensional index that
specifies which value to get, and the address of a location into which
the data value will be read. The value is converted from the external
data type of the variable, if necessary.
<p>The functions for types ubyte, ushort, uint, longlong, ulonglong, and
string are only available for netCDF-4/HDF5 files.
<p>The nc_get_var1() function will read a variable of any type,
including user defined type. For this function, the type of the data
in memory must match the type of the variable - no data conversion is
done.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_get_var1_text (int ncid, int varid, const size_t index[],
char *tp);
int nc_get_var1_uchar (int ncid, int varid, const size_t index[],
unsigned char *up);
int nc_get_var1_schar (int ncid, int varid, const size_t index[],
signed char *cp);
int nc_get_var1_short (int ncid, int varid, const size_t index[],
short *sp);
int nc_get_var1_int (int ncid, int varid, const size_t index[],
int *ip);
int nc_get_var1_long (int ncid, int varid, const size_t index[],
long *lp);
int nc_get_var1_float (int ncid, int varid, const size_t index[],
float *fp);
int nc_get_var1_double(int ncid, int varid, const size_t index[],
double *dp);
int nc_get_var1_ushort(int ncid, int varid, const size_t *indexp,
unsigned short *ip);
int nc_get_var1_uint (int ncid, int varid, const size_t *indexp,
unsigned int *ip);
int nc_get_var1_longlong (int ncid, int varid, const size_t *indexp,
long long *ip);
int nc_get_var1_ulonglong(int ncid, int varid, const size_t *indexp,
unsigned long long *ip);
int nc_get_var1_string(int ncid, int varid, const size_t *indexp,
char **ip);
int nc_get_var1 (int ncid, int varid, const size_t *indexp,
void *ip);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>index[]</code><dd>The index of the data value to be read. The indices are relative to
0, so for example, the first data value of a two-dimensional variable
would have index (0,0). The elements of index must correspond to the
variable's dimensions. Hence, if the variable is a record variable,
the first index is the record number.
<br><dt><code>tp</code><dt><code>up</code><dt><code>cp</code><dt><code>sp</code><dt><code>ip</code><dt><code>lp</code><dt><code>fp</code><dt><code>dp</code><dd>Pointer to the location into which the data value is read. If the type
of data value differs from the netCDF variable type, type conversion
will occur. See <a href="netcdf.html#Type-Conversion">Type Conversion</a>.
</dl>
<h3 class="heading">Return Codes</h3>
<ul>
<li>NC_NOERR
No error.
<li>NC_EHDFERR
Error reported by HDF5 layer.
<li>NC_ENOTVAR
The variable ID is invalid for the specified netCDF dataset.
<li>NC_EINVALCOORDS
The specified corner indices were out of range for the rank of the
specified variable. For example, a negative index, or an index that is
larger than the corresponding dimension length will cause an error.
<li>NC_EEDGE
The specified edge lengths added to the specified corner would have
referenced data out of range for the rank of the specified
variable. For example, an edge length that is larger than the
corresponding dimension length minus the corner index will cause an
error.
<li>NC_ERANGE
One or more of the specified values are out of the range of values
representable by the external data type of the variable. (Does not
apply to the nc_put_vars() function).
<li>NC_EINDEFINE
The specified netCDF is in define mode rather than data mode.
<li>NC_EBADID
The specified netCDF ID does not refer to an open netCDF dataset.
<li>NC_ECHAR
Attempt to convert to or from char.
<li>NC_ENOMEM
Out of memory.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_get_var1_double to get the (1,2,3) element
of the variable named rh in an existing netCDF dataset named
foo.nc. For simplicity in this example, we assume that we know that rh
is dimensioned with time, lat, and lon, so we want to get the value of
rh that corresponds to the second time value, the third lat value, and
the fourth lon value:
<pre class="example"> #include <netcdf.h>
...
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
static size_t rh_index[] = {1, 2, 3}; /* where to get value from */
double rh_val; /* where to put it */
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
status = nc_get_var1_double(ncid, rh_id, rh_index, &rh_val);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_get_var_-type"></a>
<a name="nc_005fget_005fvar_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.27 Read an Entire Variable nc_get_var_ <var>type</var></h3>
<p><a name="index-nc_005fget_005fvar_005f-type-366"></a><a name="index-nc_005fget_005fvar_005f-type_002c-example-367"></a><a name="index-reading-entire-variable-368"></a><a name="index-entire-variable_002c-reading-369"></a><a name="index-nc_005fget_005fvar_005ftext-370"></a><a name="index-nc_005fget_005fvar_005fuchar-371"></a><a name="index-nc_005fget_005fvar_005fschar-372"></a><a name="index-nc_005fget_005fvar_005fshort-373"></a><a name="index-nc_005fget_005fvar_005fint-374"></a><a name="index-nc_005fget_005fvar_005flong-375"></a><a name="index-nc_005fget_005fvar_005ffloat-376"></a><a name="index-nc_005fget_005fvar_005fdouble-377"></a><a name="index-nc_005fget_005fvar_005fushort-378"></a><a name="index-nc_005fget_005fvar_005fuint-379"></a><a name="index-nc_005fget_005fvar_005flonglong-380"></a><a name="index-nc_005fget_005fvar_005fulonglong-381"></a><a name="index-nc_005fget_005fvar_005fstring-382"></a><a name="index-nc_005fget_005fvar-383"></a>
The members of the nc_get_var_ <var>type</var> family of functions read all the
values from a netCDF variable of an open netCDF dataset. This is the
simplest interface to use for reading the value of a scalar variable
or when all the values of a multidimensional variable can be read at
once. The values are read into consecutive locations with the last
dimension varying fastest. The netCDF dataset must be in data mode.
<p>Take care when using the simplest forms of this interface with record
variables (variables that use the NC_UNLIMITED dimension) when you
don't specify how many records are to be read. If you try to read all
the values of a record variable into an array but there are more
records in the file than you assume, more data will be read than you
expect, which may cause a segmentation violation. To avoid such
problems, it is better to use the nc_get_vara interfaces for
variables that use the NC_UNLIMITED dimension. See <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a>.
<p>The functions for types ubyte, ushort, uint, longlong, ulonglong, and
string are only available for netCDF-4/HDF5 files.
<p>The nc_get_var() function will read a variable of any type,
including user defined type. For this function, the type of the data
in memory must match the type of the variable - no data conversion is
done.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_get_var_text (int ncid, int varid, char *tp);
int nc_get_var_uchar (int ncid, int varid, unsigned char *up);
int nc_get_var_schar (int ncid, int varid, signed char *cp);
int nc_get_var_short (int ncid, int varid, short *sp);
int nc_get_var_int (int ncid, int varid, int *ip);
int nc_get_var_long (int ncid, int varid, long *lp);
int nc_get_var_float (int ncid, int varid, float *fp);
int nc_get_var_double(int ncid, int varid, double *dp);
int nc_get_var_ushort(int ncid, int varid, unsigned short *ip);
int nc_get_var_uint (int ncid, int varid, unsigned int *ip);
int nc_get_var_longlong (int ncid, int varid, long long *ip);
int nc_get_var_ulonglong(int ncid, int varid, unsigned long long *ip);
int nc_get_var_string(int ncid, int varid, char **ip);
int nc_get_var (int ncid, int varid, void *ip);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>tp</code><dt><code>up</code><dt><code>cp</code><dt><code>sp</code><dt><code>ip</code><dt><code>lp</code><dt><code>fp</code><dt><code>dp</code><dd>Pointer to a block of contiguous locations in memory into which the data values are read. If the type
of data value differs from the netCDF variable type, type conversion
will occur. See <a href="netcdf.html#Type-Conversion">Type Conversion</a>.
</dl>
<h3 class="heading">Return Codes</h3>
<ul>
<li>NC_NOERR
No error.
<li>NC_EHDFERR
Error reported by HDF5 layer.
<li>NC_ENOTVAR
The variable ID is invalid for the specified netCDF dataset.
<li>NC_EINVALCOORDS
The specified corner indices were out of range for the rank of the
specified variable. For example, a negative index, or an index that is
larger than the corresponding dimension length will cause an error.
<li>NC_EEDGE
The specified edge lengths added to the specified corner would have
referenced data out of range for the rank of the specified
variable. For example, an edge length that is larger than the
corresponding dimension length minus the corner index will cause an
error.
<li>NC_ERANGE
One or more of the specified values are out of the range of values
representable by the external data type of the variable. (Does not
apply to the nc_put_vars() function).
<li>NC_EINDEFINE
The specified netCDF is in define mode rather than data mode.
<li>NC_EBADID
The specified netCDF ID does not refer to an open netCDF dataset.
<li>NC_ECHAR
Attempt to convert to or from char.
<li>NC_ENOMEM
Out of memory.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_get_var_double to read all the values of
the variable named rh from an existing netCDF dataset named
foo.nc. For simplicity in this example, we assume that we know that rh
is dimensioned with lat and lon, and that there are five lat values
and ten lon values.
<pre class="example"> #include <netcdf.h>
...
#define LATS 5
#define LONS 10
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
double rh_vals[LATS*LONS]; /* array to hold values */
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
/* read values from netCDF variable */
status = nc_get_var_double(ncid, rh_id, rh_vals);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_get_vara_-type"></a>
<a name="nc_005fget_005fvara_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.28 Read an Array of Values: nc_get_vara_ <var>type</var></h3>
<p><a name="index-nc_005fget_005fvara_005f-type-384"></a><a name="index-nc_005fget_005fvara_005f-type_002c-example-385"></a><a name="index-array-section_002c-reading-mapped-386"></a><a name="index-array-section_002c-writing-mapped-387"></a><a name="index-nc_005fget_005fvara_005ftext-388"></a><a name="index-nc_005fget_005fvara_005fuchar-389"></a><a name="index-nc_005fget_005fvara_005fschar-390"></a><a name="index-nc_005fget_005fvara_005fshort-391"></a><a name="index-nc_005fget_005fvara_005fint-392"></a><a name="index-nc_005fget_005fvara_005flong-393"></a><a name="index-nc_005fget_005fvara_005ffloat-394"></a><a name="index-nc_005fget_005fvara_005fdouble-395"></a><a name="index-nc_005fget_005fvara_005fushort-396"></a><a name="index-nc_005fget_005fvara_005fuint-397"></a><a name="index-nc_005fget_005fvara_005flonglong-398"></a><a name="index-nc_005fget_005fvara_005fulonglong-399"></a><a name="index-nc_005fget_005fvara_005fstring-400"></a><a name="index-nc_005fget_005fvara-401"></a>
The members of the nc_get_vara_ <var>type</var> family of functions read an array
of values from a netCDF variable of an open netCDF dataset. The array
is specified by giving a corner and a vector of edge lengths. The
values are read into consecutive locations with the last dimension
varying fastest. The netCDF dataset must be in data mode.
<p>The functions for types ubyte, ushort, uint, longlong, ulonglong, and
string are only available for netCDF-4/HDF5 files.
<p>The nc_get_vara() function will write a variable of any type,
including user defined type. For this function, the type of the data
in memory must match the type of the variable - no data conversion is
done.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_get_vara_text (int ncid, int varid, const size_t start[],
const size_t count[], char *tp);
int nc_get_vara_uchar (int ncid, int varid, const size_t start[],
const size_t count[], unsigned char *up);
int nc_get_vara_schar (int ncid, int varid, const size_t start[],
const size_t count[], signed char *cp);
int nc_get_vara_short (int ncid, int varid, const size_t start[],
const size_t count[], short *sp);
int nc_get_vara_int (int ncid, int varid, const size_t start[],
const size_t count[], int *ip);
int nc_get_vara_long (int ncid, int varid, const size_t start[],
const size_t count[], long *lp);
int nc_get_vara_float (int ncid, int varid, const size_t start[],
const size_t count[], float *fp);
int nc_get_vara_double(int ncid, int varid, const size_t start[],
const size_t count[], double *dp);
int nc_get_vara_ushort(int ncid, int varid, const size_t *startp,
const size_t *countp, unsigned short *ip);
int nc_get_vara_uint (int ncid, int varid, const size_t *startp,
const size_t *countp, unsigned int *ip);
int nc_get_vara_longlong(int ncid, int varid, const size_t *startp,
const size_t *countp, long long *ip);
int nc_get_vara_ulonglong(int ncid, int varid, const size_t *startp,
const size_t *countp, unsigned long long *ip);
int nc_get_vara_string(int ncid, int varid, const size_t *startp,
const size_t *countp, char **ip);
int nc_get_vara (int ncid, int varid, const size_t start[],
const size_t count[], void *ip);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>start</code><dd>A vector of size_t integers specifying the index in the variable
where the first of the data values will be read. The indices are
relative to 0, so for example, the first data value of a variable
would have index (0, 0, ... , 0). The length of start must be the same
as the number of dimensions of the specified variable. The elements of
start correspond, in order, to the variable's dimensions. Hence, if
the variable is a record variable, the first index would correspond to
the starting record number for reading the data values.
<br><dt><code>count</code><dd>A vector of size_t integers specifying the edge lengths along each
dimension of the block of data values to be read. To read a single
value, for example, specify count as (1, 1, ... , 1). The length of
count is the number of dimensions of the specified variable. The
elements of count correspond, in order, to the variable's
dimensions. Hence, if the variable is a record variable, the first
element of count corresponds to a count of the number of records to
read.
<p>Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
<br><dt><code>tp</code><dt><code>up</code><dt><code>cp</code><dt><code>sp</code><dt><code>ip</code><dt><code>lp</code><dt><code>fp</code><dt><code>dp</code><dd>Pointer to a block of contiguous locations in memory into which the data values are read.
If the type
of data value differs from the netCDF variable type, type conversion
will occur. See <a href="netcdf.html#Type-Conversion">Type Conversion</a>.
</dl>
<h3 class="heading">Return Codes</h3>
<ul>
<li>NC_NOERR
No error.
<li>NC_ENOTVAR
The variable ID is invalid for the specified netCDF dataset.
<li>NC_EINVALCOORDS
The specified corner indices were out of range for the rank of the
specified variable. For example, a negative index or an index that is
larger than the corresponding dimension length will cause an error.
<li>NC_EEDGE
The specified edge lengths added to the specified corner would have
referenced data out of range for the rank of the specified
variable. For example, an edge length that is larger than the
corresponding dimension length minus the corner index will cause an
error.
<li>NC_ERANGE
One or more of the values are out of the range of values representable
by the desired type. (Does not apply to nc_get_vara() function).
<li>NC_EINDEFINE
The specified netCDF is in define mode rather than data mode.
<li>NC_EBADID
The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_get_vara_double to read all the values of
the variable named rh from an existing netCDF dataset named
foo.nc. For simplicity in this example, we assume that we know that rh
is dimensioned with time, lat, and lon, and that there are three time
values, five lat values, and ten lon values.
<pre class="example"> #include <netcdf.h>
...
#define TIMES 3
#define LATS 5
#define LONS 10
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
static size_t start[] = {0, 0, 0}; /* start at first value */
static size_t count[] = {TIMES, LATS, LONS};
double rh_vals[TIMES*LATS*LONS]; /* array to hold values */
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
/* read values from netCDF variable */
status = nc_get_vara_double(ncid, rh_id, start, count, rh_vals);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_get_vars_-type"></a>
<a name="nc_005fget_005fvars_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.29 Read a Subsampled Array of Values: nc_get_vars_ <var>type</var></h3>
<p><a name="index-nc_005fget_005fvars_005f-type-402"></a><a name="index-nc_005fget_005fvars_005f-type_002c-example-403"></a><a name="index-array-section_002c-writing-subsampled-404"></a><a name="index-array-section_002c-reading-subsampled-405"></a><a name="index-nc_005fget_005fvars_005ftext-406"></a><a name="index-nc_005fget_005fvars_005fuchar-407"></a><a name="index-nc_005fget_005fvars_005fschar-408"></a><a name="index-nc_005fget_005fvars_005fshort-409"></a><a name="index-nc_005fget_005fvars_005fint-410"></a><a name="index-nc_005fget_005fvars_005flong-411"></a><a name="index-nc_005fget_005fvars_005ffloat-412"></a><a name="index-nc_005fget_005fvars_005fdouble-413"></a><a name="index-nc_005fget_005fvars_005fushort-414"></a><a name="index-nc_005fget_005fvars_005fuint-415"></a><a name="index-nc_005fget_005fvars_005flonglong-416"></a><a name="index-nc_005fget_005fvars_005fulonglong-417"></a><a name="index-nc_005fget_005fvars_005fstring-418"></a><a name="index-nc_005fget_005fvars-419"></a>
The nc_get_vars_ <var>type</var> family of functions read a subsampled (strided)
array section of values from a netCDF variable of an open netCDF
dataset. The subsampled array section is specified by giving a corner,
a vector of edge lengths, and a stride vector. The values are read
with the last dimension of the netCDF variable varying fastest. The
netCDF dataset must be in data mode.
<p>The functions for types ubyte, ushort, uint, longlong, ulonglong, and
string are only available for netCDF-4/HDF5 files.
<p>The nc_get_vars() function will read a variable of any type,
including user defined type. For this function, the type of the data
in memory must match the type of the variable - no data conversion is
done.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_get_vars_text (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
char *tp);
int nc_get_vars_uchar (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
unsigned char *up);
int nc_get_vars_schar (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
signed char *cp);
int nc_get_vars_short (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
short *sp);
int nc_get_vars_int (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
int *ip);
int nc_get_vars_long (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
long *lp);
int nc_get_vars_float (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
float *fp);
int nc_get_vars_double(int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
double *dp)
int nc_get_vars_ushort(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
unsigned short *ip);
int nc_get_vars_uint (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
unsigned int *ip);
int nc_get_vars_longlong (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
long long *ip);
int nc_get_vars_ulonglong(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
unsigned long long *ip);
int nc_get_vars_string(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
char **ip);
int nc_get_vars (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
void *ip);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>start</code><dd>A vector of size_t integers specifying the index in the variable
where the first of the data values will be read. The indices are
relative to 0, so for example, the first data value of a variable
would have index (0, 0, ... , 0). The elements of start correspond, in
order, to the variable's dimensions. Hence, if the variable is a
record variable, the first index corresponds to the starting record
number for reading the data values.
<br><dt><code>count</code><dd>A vector of size_t integers specifying the number of indices selected
along each dimension. To read a single value, for example, specify
count as (1, 1, ... , 1). The elements of count correspond, in order,
to the variable's dimensions. Hence, if the variable is a record
variable, the first element of count corresponds to a count of the
number of records to read.
<p>Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
<br><dt><code>stride</code><dd>A vector of ptrdiff_t integers specifying, for each dimension, the
interval between selected indices. The elements of the stride vector
correspond, in order, to the variable's dimensions. A value of 1
accesses adjacent values of the netCDF variable in the corresponding
dimension; a value of 2 accesses every other value of the netCDF
variable in the corresponding dimension; and so on. A NULL stride
argument is treated as (1, 1, ... , 1).
<br><dt><code>tp</code><dt><code>up</code><dt><code>cp</code><dt><code>sp</code><dt><code>ip</code><dt><code>lp</code><dt><code>fp</code><dt><code>dp</code><dd>Pointer to a block of contiguous locations in memory into which the data values are read.
If the type
of data value differs from the netCDF variable type, type conversion
will occur. See <a href="netcdf.html#Type-Conversion">Type Conversion</a>.
</dl>
<h3 class="heading">Return Codes</h3>
<ul>
<li>NC_NOERR
No error.
<li>NC_EHDFERR
Error reported by HDF5 layer.
<li>NC_ENOTVAR
The variable ID is invalid for the specified netCDF dataset.
<li>NC_EINVALCOORDS
The specified corner indices were out of range for the rank of the
specified variable. For example, a negative index, or an index that is
larger than the corresponding dimension length will cause an error.
<li>NC_EEDGE
The specified edge lengths added to the specified corner would have
referenced data out of range for the rank of the specified
variable. For example, an edge length that is larger than the
corresponding dimension length minus the corner index will cause an
error.
<li>NC_ERANGE
One or more of the specified values are out of the range of values
representable by the external data type of the variable. (Does not
apply to the nc_get_vars() function).
<li>NC_EINDEFINE
The specified netCDF is in define mode rather than data mode.
<li>NC_EBADID
The specified netCDF ID does not refer to an open netCDF dataset.
<li>NC_ECHAR
Attempt to convert to or from char.
<li>NC_ENOMEM
Out of memory.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example that uses nc_get_vars_double to read every other
value in each dimension of the variable named rh from an existing
netCDF dataset named foo.nc. For simplicity in this example, we assume
that we know that rh is dimensioned with time, lat, and lon, and that
there are three time values, five lat values, and ten lon values.
<pre class="example"> #include <netcdf.h>
...
#define TIMES 3
#define LATS 5
#define LONS 10
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
static size_t start[] = {0, 0, 0}; /* start at first value */
static size_t count[] = {TIMES, LATS, LONS};
static ptrdiff_t stride[] = {2, 2, 2};/* every other value */
double data[TIMES][LATS][LONS]; /* array to hold values */
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
/* read subsampled values from netCDF variable into array */
status = nc_get_vars_double(ncid, rh_id, start, count, stride,
&data[0][0][0]);
if (status != NC_NOERR) handle_error(status);
...
</pre>
<div class="node">
<a name="nc_get_varm_-type"></a>
<a name="nc_005fget_005fvarm_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Strings">Strings</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.30 Read a Mapped Array of Values: nc_get_varm_ <var>type</var></h3>
<p><a name="index-nc_005fget_005fvarm_005f-type-420"></a><a name="index-nc_005fget_005fvarm_005f-type_002c-example-421"></a><a name="index-writing-mapped-array-section-422"></a><a name="index-mapped-array-section_002c-writing-423"></a><a name="index-nc_005fget_005fvarm_005ftext-424"></a><a name="index-nc_005fget_005fvarm_005fuchar-425"></a><a name="index-nc_005fget_005fvarm_005fschar-426"></a><a name="index-nc_005fget_005fvarm_005fshort-427"></a><a name="index-nc_005fget_005fvarm_005fint-428"></a><a name="index-nc_005fget_005fvarm_005flong-429"></a><a name="index-nc_005fget_005fvarm_005ffloat-430"></a><a name="index-nc_005fget_005fvarm_005fdouble-431"></a><a name="index-nc_005fget_005fvarm_005fushort-432"></a><a name="index-nc_005fget_005fvarm_005fuint-433"></a><a name="index-nc_005fget_005fvarm_005flonglong-434"></a><a name="index-nc_005fget_005fvarm_005fulonglong-435"></a><a name="index-nc_005fget_005fvarm_005fstring-436"></a><a name="index-nc_005fget_005fvarm-437"></a>
<p>The nc_get_varm_ <var>type</var> family of functions reads a mapped array section
of values from a netCDF variable of an open netCDF dataset. The mapped
array section is specified by giving a corner, a vector of edge
lengths, a stride vector, and an index mapping vector. The index
mapping vector is a vector of integers that specifies the mapping
between the dimensions of a netCDF variable and the in-memory
structure of the internal data array. No assumptions are made about
the ordering or length of the dimensions of the data array. The netCDF
dataset must be in data mode.
<p>The functions for types ubyte, ushort, uint, longlong, ulonglong, and
string are only available for netCDF-4/HDF5 files.
<p>The nc_get_varm() function will read a variable of any type,
including user defined type. For this function, the type of the data
in memory must match the type of the variable - no data conversion is
done.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_get_varm_text (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], char *tp);
int nc_get_varm_uchar (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], unsigned char *up);
int nc_get_varm_schar (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], signed char *cp);
int nc_get_varm_short (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], short *sp);
int nc_get_varm_int (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], int *ip);
int nc_get_varm_long (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], long *lp);
int nc_get_varm_float (int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], float *fp);
int nc_get_varm_double(int ncid, int varid, const size_t start[],
const size_t count[], const ptrdiff_t stride[],
const ptrdiff_t imap[], double *dp);
int nc_get_varm_ushort(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, unsigned short *ip);
int nc_get_varm_uint (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, unsigned int *ip);
int nc_get_varm_longlong (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, long long *ip);
int nc_get_varm_ulonglong(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, unsigned long long *ip);
int nc_get_varm_string(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, char **ip);
int nc_get_varm (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, void *ip);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>start</code><dd>A vector of size_t integers specifying the index in the variable
where the first of the data values will be read. The indices are
relative to 0, so for example, the first data value of a variable
would have index (0, 0, ... , 0). The elements of start correspond, in
order, to the variable's dimensions. Hence, if the variable is a
record variable, the first index corresponds to the starting record
number for reading the data values.
<br><dt><code>count</code><dd>A vector of size_t integers specifying the number of indices selected
along each dimension. To read a single value, for example, specify
count as (1, 1, ... , 1). The elements of count correspond, in order,
to the variable's dimensions. Hence, if the variable is a record
variable, the first element of count corresponds to a count of the
number of records to read.
<p>Note: setting any element of the count array to zero causes the
function to exit without error, and without doing anything.
<br><dt><code>stride</code><dd>A vector of ptrdiff_t integers specifying, for each dimension, the
interval between selected indices. The elements of the stride vector
correspond, in order, to the variable's dimensions. A value of 1
accesses adjacent values of the netCDF variable in the corresponding
dimension; a value of 2 accesses every other value of the netCDF
variable in the corresponding dimension; and so on. A NULL stride
argument is treated as (1, 1, ... , 1).
<br><dt><code>imap</code><dd>A vector of integers that specifies the mapping between the
dimensions of a netCDF variable and the in-memory structure of the
internal data array. imap[0] gives the distance between elements of
the internal array corresponding to the most slowly varying dimension
of the netCDF variable. imap[n-1] (where n is the rank of the netCDF
variable) gives the distance between elements of the internal array
corresponding to the most rapidly varying dimension of the netCDF
variable. Intervening imap elements correspond to other dimensions of
the netCDF variable in the obvious way. Distances between elements are
specified in type-independent units of elements (the distance between
internal elements that occupy adjacent memory locations is 1 and not
the element's byte-length as in netCDF 2).
<br><dt><code>tp</code><dt><code>up</code><dt><code>cp</code><dt><code>sp</code><dt><code>ip</code><dt><code>lp</code><dt><code>fp</code><dt><code>dp</code><dd>Pointer to the location used for computing where the data values are
read; the data should be of the type appropriate for the function
called. If the type of data value differs from the netCDF variable
type, type conversion will occur. See <a href="netcdf.html#Type-Conversion">Type Conversion</a>.
</dl>
<h3 class="heading">Return Codes</h3>
<ul>
<li>NC_NOERR
No error.
<li>NC_EHDFERR
Error reported by HDF5 layer.
<li>NC_ENOTVAR
The variable ID is invalid for the specified netCDF dataset.
<li>NC_EINVALCOORDS
The specified corner indices were out of range for the rank of the
specified variable. For example, a negative index, or an index that is
larger than the corresponding dimension length will cause an error.
<li>NC_EEDGE
The specified edge lengths added to the specified corner would have
referenced data out of range for the rank of the specified
variable. For example, an edge length that is larger than the
corresponding dimension length minus the corner index will cause an
error.
<li>NC_ERANGE
One or more of the specified values are out of the range of values
representable by the external data type of the variable. (Does not
apply to the nc_get_vars() function).
<li>NC_EINDEFINE
The specified netCDF is in define mode rather than data mode.
<li>NC_EBADID
The specified netCDF ID does not refer to an open netCDF dataset.
<li>NC_ECHAR
Attempt to convert to or from char.
<li>NC_ENOMEM
Out of memory.
</ul>
<h3 class="heading">Example</h3>
<p>The following imap vector maps in the trivial way a 4x3x2 netCDF
variable and an internal array of the same shape:
<pre class="example"> float a[4][3][2]; /* same shape as netCDF variable */
size_t imap[3] = {6, 2, 1};
/* netCDF dimension inter-element distance */
/* ---------------- ---------------------- */
/* most rapidly varying 1 */
/* intermediate 2 (=imap[2]*2) */
/* most slowly varying 6 (=imap[1]*3) */
</pre>
<p>Using the imap vector above with nc_get_varm_float obtains the same
result as simply using nc_get_var_float.
<p>Here is an example of using nc_get_varm_float to transpose a netCDF
variable named rh which is described by the C declaration float
rh[6][4] (note the size and order of the dimensions):
<pre class="example"> #include <netcdf.h>
...
#define NDIM 2 /* rank of netCDF variable */
int ncid; /* netCDF ID */
int status; /* error status */
int rhid; /* variable ID */
static size_t start[NDIM] /* netCDF variable start point: */
= {0, 0}; /* first element */
static size_t count[NDIM] /* size of internal array: entire netCDF */
= {6, 4}; /* variable; order corresponds to netCDF */
/* variable -- not internal array */
static ptrdiff_t stride[NDIM] /* variable subsampling intervals: */
= {1, 1}; /* sample every netCDF element */
static ptrdiff_t imap[NDIM] /* internal array inter-element distances; */
= {1, 6}; /* would be {4, 1} if not transposing */
float rh[4][6]; /* note transposition of netCDF variable */
/* dimensions */
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid(ncid, "rh", &rhid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_get_varm_float(ncid, rhid, start, count, stride, imap, rh);
if (status != NC_NOERR) handle_error(status);
</pre>
<p>Here is another example of using nc_get_varm_float to simultaneously
transpose and subsample the same netCDF variable, by accessing every
other point of the netCDF variable:
<pre class="example"> #include <netcdf.h>
...
#define NDIM 2 /* rank of netCDF variable */
int ncid; /* netCDF ID */
int status; /* error status */
int rhid; /* variable ID */
static size_t start[NDIM] /* netCDF variable start point: */
= {0, 0}; /* first element */
static size_t count[NDIM] /* size of internal array: entire */
= {3, 2}; /* (subsampled) netCDF variable; order of */
/* dimensions corresponds to netCDF */
/* variable -- not internal array */
static ptrdiff_t stride[NDIM]/* variable subsampling intervals: */
= {2, 2}; /* sample every other netCDF element */
static ptrdiff_t imap[NDIM] /* internal array inter-element distances; */
= {1, 3}; /* would be {2, 1} if not transposing */
float rh[2][3]; /* note transposition of (subsampled) */
/* netCDF variable dimensions */
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid(ncid, "rh", &rhid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_get_varm_float(ncid, rhid, start, count, stride, imap, rh);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="Strings"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005ffree_005fstring">nc_free_string</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.31 Reading and Writing Character String Values</h3>
<p><a name="index-attributes_002c-array-of-strings-438"></a><a name="index-string-arrays-439"></a>
Prior to version 4.0, strings could only be stored as simple arrays of
characters. Users may still wish to store strings this way, as it
ensures maximum compatibility with other software.
<p>Starting in netCDF-4.0, the atomic string type allows a new way to
store strings, as a variable length array in the underlying HDF5
layer. This allows arrays of strings to be stored compactly.
<p>For more information of classic models strings <a href="#Classic-Strings">Classic Strings</a>. For more information on the netCDF-4.0 string type
<a href="#Arrays-of-Strings">Arrays of Strings</a>.
<ul class="menu">
<li><a accesskey="1" href="#Classic-Strings">Classic Strings</a>
<li><a accesskey="2" href="#Arrays-of-Strings">Arrays of Strings</a>
</ul>
<div class="node">
<a name="Classic-Strings"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Arrays-of-Strings">Arrays of Strings</a>,
Previous: <a rel="previous" accesskey="p" href="#Strings">Strings</a>,
Up: <a rel="up" accesskey="u" href="#Strings">Strings</a>
</div>
<h4 class="subsection">6.31.1 Reading and Writing Character String Values in the Classic Model</h4>
<p><a name="index-strings-in-classic-model-440"></a><a name="index-attributes_002c-character-string-441"></a><a name="index-byte_002c-zero-442"></a><a name="index-zero-byte-443"></a><a name="index-writing-character_002dstring-data-444"></a><a name="index-character_002dstring-data_002c-writing-445"></a>
Character strings are not a primitive netCDF external data type, in
part because FORTRAN does not support the abstraction of
variable-length character strings (the FORTRAN LEN function returns
the static length of a character string, not its dynamic length). As a
result, a character string cannot be written or read as a single
object in the netCDF interface. Instead, a character string must be
treated as an array of characters, and array access must be used to
read and write character strings as variable data in netCDF
datasets. Furthermore, variable-length strings are not supported by
the netCDF interface except by convention; for example, you may treat
a zero byte as terminating a character string, but you must explicitly
specify the length of strings to be read from and written to netCDF
variables.
<p>Character strings as attribute values are easier to use, since the
strings are treated as a single unit for access. However, the value of
a character-string attribute is still an array of characters with an
explicit length that must be specified when the attribute is defined.
<p>When you define a variable that will have character-string values, use
a character-position dimension as the most quickly varying dimension
for the variable (the last dimension for the variable in C). The
length of the character-position dimension will be the maximum string
length of any value to be stored in the character-string
variable. Space for maximum-length strings will be allocated in the
disk representation of character-string variables whether you use the
space or not. If two or more variables have the same maximum length,
the same character-position dimension may be used in defining the
variable shapes.
<p>To write a character-string value into a character-string variable,
use either entire variable access or array access. The latter requires
that you specify both a corner and a vector of edge lengths. The
character-position dimension at the corner should be zero for C. If
the length of the string to be written is n, then the vector of edge
lengths will specify n in the character-position dimension, and one
for all the other dimensions:(1, 1, ... , 1, n).
<p>In C, fixed-length strings may be written to a netCDF dataset without
the terminating zero byte, to save space. Variable-length strings
should be written with a terminating zero byte so that the intended
length of the string can be determined when it is later read.
<p>Here is an example that defines a record variable, tx, for character
strings and stores a character-string value into the third record
using nc_put_vara_text. In this example, we assume the string variable
and data are to be added to an existing netCDF dataset named foo.nc
that already has an unlimited record dimension time.
<pre class="example"> #include <netcdf.h>
...
int ncid; /* netCDF ID */
int chid; /* dimension ID for char positions */
int timeid; /* dimension ID for record dimension */
int tx_id; /* variable ID */
#define TDIMS 2 /* rank of tx variable */
int tx_dims[TDIMS]; /* variable shape */
size_t tx_start[TDIMS];
size_t tx_count[TDIMS];
static char tx_val[] =
"example string"; /* string to be put */
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
status = nc_redef(ncid); /* enter define mode */
if (status != NC_NOERR) handle_error(status);
...
/* define character-position dimension for strings of max length 40 */
status = nc_def_dim(ncid, "chid", 40L, &chid);
if (status != NC_NOERR) handle_error(status);
...
/* define a character-string variable */
tx_dims[0] = timeid;
tx_dims[1] = chid; /* character-position dimension last */
status = nc_def_var (ncid, "tx", NC_CHAR, TDIMS, tx_dims, &tx_id);
if (status != NC_NOERR) handle_error(status);
...
status = nc_enddef(ncid); /* leave define mode */
if (status != NC_NOERR) handle_error(status);
...
/* write tx_val into tx netCDF variable in record 3 */
tx_start[0] = 3; /* record number to write */
tx_start[1] = 0; /* start at beginning of variable */
tx_count[0] = 1; /* only write one record */
tx_count[1] = strlen(tx_val) + 1; /* number of chars to write */
status = nc_put_vara_text(ncid, tx_id, tx_start, tx_count, tx_val);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="Arrays-of-Strings"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Classic-Strings">Classic Strings</a>,
Up: <a rel="up" accesskey="u" href="#Strings">Strings</a>
</div>
<h4 class="subsection">6.31.2 Reading and Writing Arrays of Strings</h4>
<p><a name="index-NC_005fSTRING_002c-using-446"></a>
In netCDF-4, the NC_STRING type is introduced. It can store arrays of
strings compactly.
<p>By using the NC_STRING type, arrays of strings (char **) can be read
and written to the file.
<p>This allows attributes to hold more than one string. Since attributes
are one-dimensional, using the classic model, an attribute could only
hold one string, as an array of char. With the NC_STRING type, an
array of strings can be stored in one attribute.
<p>When reading data of type NC_STRING, the HDF5 layer will allocate
memory to hold the data. It is up to the user to free this memory with
the nc_free_string function. See <a href="#nc_005ffree_005fstring">nc_free_string</a>.
<pre class="example"> int ncid, varid, i, dimids[NDIMS];
char *data[DIM_LEN] = {"Let but your honour know",
"Whom I believe to be most strait in virtue",
"That, in the working of your own affections",
"Had time cohered with place or place with wishing",
"Or that the resolute acting of your blood",
"Could have attain'd the effect of your own purpose",
"Whether you had not sometime in your life",
"Err'd in this point which now you censure him",
"And pull'd the law upon you."};
char *data_in[DIM_LEN];
printf("*** testing string attribute...");
{
size_t att_len;
int ndims, nvars, natts, unlimdimid;
nc_type att_type;
if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
if (nc_put_att(ncid, NC_GLOBAL, ATT_NAME, NC_STRING, DIM_LEN, data)) ERR;
if (nc_inq(ncid, &ndims, &nvars, &natts, &unlimdimid)) ERR;
if (ndims != 0 || nvars != 0 || natts != 1 || unlimdimid != -1) ERR;
if (nc_inq_att(ncid, NC_GLOBAL, ATT_NAME, &att_type, &att_len)) ERR;
if (att_type != NC_STRING || att_len != DIM_LEN) ERR;
if (nc_close(ncid)) ERR;
nc_exit();
/* Check it out. */
if (nc_open(FILE_NAME, NC_NOWRITE, &ncid)) ERR;
if (nc_inq(ncid, &ndims, &nvars, &natts, &unlimdimid)) ERR;
if (ndims != 0 || nvars != 0 || natts != 1 || unlimdimid != -1) ERR;
if (nc_inq_att(ncid, NC_GLOBAL, ATT_NAME, &att_type, &att_len)) ERR;
if (att_type != NC_STRING || att_len != DIM_LEN) ERR;
if (nc_get_att(ncid, NC_GLOBAL, ATT_NAME, data_in)) ERR;
for (i=0; i<att_len; i++)
if (strcmp(data_in[i], data[i])) ERR;
if (nc_free_string(att_len, (char **)data_in)) ERR;
if (nc_close(ncid)) ERR;
nc_exit();
}
</pre>
<div class="node">
<a name="nc_free_string"></a>
<a name="nc_005ffree_005fstring"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Fill-Values">Fill Values</a>,
Previous: <a rel="previous" accesskey="p" href="#Strings">Strings</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.32 Releasing Memory for a NC_STRING: nc_free_string</h3>
<p><a name="index-nc_005ffree_005fstring-447"></a><a name="index-NC_005fSTRING_002c-freeing-448"></a>
When a STRING is read into user memory from the file, the HDF5 library
performs memory allocations for each of the variable length character
arrays contained within the STRING structure. This memory must be
freed by the user to avoid memory leaks.
<p>This violates the normal netCDF expectation that the user is
responsible for all memory allocation. But, with NC_STRING arrays, the
underlying HDF5 library allocates the memory for the user, and the user
is responsible for deallocating that memory.
<p>To save the user the trouble calling free() on each element of the
NC_STRING array (i.e. the array of arrays), the nc_free_string
function is provided.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_free_string(size_t len, char **data);
</pre>
<dl>
<dt><code>len</code><dd>The number of character arrays in the array.
<br><dt><code>**data</code><dd>The pointer to the data array.
</dl>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
</dl>
<h3 class="heading">Example</h3>
<pre class="example"> if (nc_get_att(ncid, NC_GLOBAL, ATT_NAME, data_in)) ERR;
...
if (nc_free_string(att_len, (char **)data_in)) ERR;
</pre>
<div class="node">
<a name="Fill-Values"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005frename_005fvar">nc_rename_var</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005ffree_005fstring">nc_free_string</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.33 Fill Values</h3>
<p><a name="index-fill-values-449"></a><a name="index-byte-vs_002e-char-fill-values-450"></a>
What happens when you try to read a value that was never written in an
open netCDF dataset? You might expect that this should always be an
error, and that you should get an error message or an error status
returned. You do get an error if you try to read data from a netCDF
dataset that is not open for reading, if the variable ID is invalid
for the specified netCDF dataset, or if the specified indices are not
properly within the range defined by the dimension lengths of the
specified variable. Otherwise, reading a value that was not written
returns a special fill value used to fill in any undefined values when
a netCDF variable is first written.
<p>You may ignore fill values and use the entire range of a netCDF
external data type, but in this case you should make sure you write
all data values before reading them. If you know you will be writing
all the data before reading it, you can specify that no prefilling of
variables with fill values will occur by calling nc_set_fill before
writing. This may provide a significant performance gain for netCDF
writes.
<p>The variable attribute _FillValue may be used to specify the fill
value for a variable. Their are default fill values for each type,
defined in the include file netcdf.h: NC_FILL_CHAR, NC_FILL_BYTE,
NC_FILL_SHORT, NC_FILL_INT, NC_FILL_FLOAT, and NC_FILL_DOUBLE.
<p>The netCDF byte and character types have different default fill
values. The default fill value for characters is the zero byte, a
useful value for detecting the end of variable-length C character
strings. If you need a fill value for a byte variable, it is
recommended that you explicitly define an appropriate _FillValue
attribute, as generic utilities such as ncdump will not assume a
default fill value for byte variables.
<p>Type conversion for fill values is identical to type conversion for
other values: attempting to convert a value from one type to another
type that can't represent the value results in a range error. Such
errors may occur on writing or reading values from a larger type (such
as double) to a smaller type (such as float), if the fill value for
the larger type cannot be represented in the smaller type.
<div class="node">
<a name="nc_rename_var"></a>
<a name="nc_005frename_005fvar"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fcopy_005fvar">nc_copy_var</a>,
Previous: <a rel="previous" accesskey="p" href="#Fill-Values">Fill Values</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.34 Rename a Variable: nc_rename_var</h3>
<p><a name="index-nc_005frename_005fvar-451"></a><a name="index-nc_005frename_005fvar_002c-example-452"></a><a name="index-renaming-variable-453"></a><a name="index-variable_002c-renaming-454"></a>
The function nc_rename_var changes the name of a netCDF variable in an
open netCDF dataset. If the new name is longer than the old name, the
netCDF dataset must be in define mode. You cannot rename a variable to
have the name of any existing variable.
<h3 class="heading">Usage</h3>
<p>int nc_rename_var(int ncid, int varid, const char* name);
<p>ncid
NetCDF ID, from a previous call to nc_open or nc_create.
<p>varid
Variable ID.
<p>name
New name for the specified variable.
<h3 class="heading">Errors</h3>
<p>nc_rename_var returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<p>The new name is in use as the name of another variable.
The variable ID is invalid for the specified netCDF dataset.
The specified netCDF ID does not refer to an open netCDF dataset.
<h3 class="heading">Example</h3>
<p>Here is an example using nc_rename_var to rename the variable rh to
rel_hum in an existing netCDF dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_redef(ncid); /* put in define mode to rename variable */
if (status != NC_NOERR) handle_error(status);
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
status = nc_rename_var (ncid, rh_id, "rel_hum");
if (status != NC_NOERR) handle_error(status);
status = nc_enddef(ncid); /* leave define mode */
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_copy_var"></a>
<a name="nc_005fcopy_005fvar"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fvar_005fpar_005faccess">nc_var_par_access</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005frename_005fvar">nc_rename_var</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.35 Copy a Variable from One File to Another: nc_copy_var</h3>
<p><a name="index-nc_005fcopy_005fvar-455"></a><a name="index-variable_002c-copying-456"></a>
This function will copy a variable from one file to another.
<p>It works even if the files are different formats, (i.e. classic
vs. netCDF-4/HDF5.)
<p>If you're copying into a netCDF-3 file, from a netCDF-4 file, you must
be copying a var of one of the six netCDF-3 types. Similarly for the
attributes.
<p>For large netCDF-3 files, this can be a very inefficient way to copy
data from one file to another, because adding a new variable to the
target file may require more space in the header and thus result in
moving data for other variables in the target file. This is not a problem
for netCDF-4 files, which support efficient addition of variables
without moving data for other variables.
<h3 class="heading">Usage</h3>
<pre class="example"> nc_copy_var(int ncid_in, int varid_in, int ncid_out)
</pre>
<ul>
<li>ncid_in
The file ID for the file that contains the variable to be copied.
<li>varid_in
The variable ID for the variable to be copied.
<li>ncid_out
The file ID for the file where the variable should be copied to.
</ul>
<h3 class="heading">Return Codes</h3>
<ul>
<li>NC_NOERR
No error.
<li>NC_EBADID
Bad ncid.
<li>NC_EBADVAR
Bad varid.
<li>NC_EHDFERR
HDF5 layer error.
<li>NC_ENOMEM
Out of memory.
<li>NC_ERANGE
One or more values out of range.
</ul>
<h3 class="heading">Example</h3>
<pre class="example"></pre>
<div class="node">
<a name="nc_var_par_access"></a>
<a name="nc_005fvar_005fpar_005faccess"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fvar_005fubyte">nc_var_ubyte</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fcopy_005fvar">nc_copy_var</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.36 Change between Collective and Independent Parallel Access: nc_var_par_access</h3>
<p><a name="index-nc_005fvar_005fpar_005faccess-457"></a><a name="index-nc_005fvar_005fpar_005faccess_002c-example-458"></a>
The function nc_var_par_access changes whether read/write operations
on a parallel file system are performed collectively or independently
(the default) on the variable. This function can only be called if the
file was created with nc_create_par (see <a href="#nc_005fcreate_005fpar">nc_create_par</a>) or
opened with nc_open_par (see <a href="#nc_005fopen_005fpar">nc_open_par</a>).
<p>Calling this function affects only the open file - information about
whether a variable is to be accessed collectively or independently is
not written to the data file. Every time you open a file on a parallel
file system, all variables default to independent operations. The
change a variable to collective I/O lasts only as long as that file is
open.
<p>The variable can be changed from collective to independent, and back,
as often as desired.
<p>Note that classic and 64-bit offset files are access using the
parallel-netcdf library, which does not allow per-variable setting of
the parallel access mode. For these files, calling nc_var_par_access
sets the access for all of the variables in the file.
<h3 class="heading">Usage</h3>
<p>int nc_var_par_access(int ncid, int varid, int access);
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open_par (see <a href="#nc_005fopen_005fpar">nc_open_par</a>) or
nc_create_par (see <a href="#nc_005fcreate_005fpar">nc_create_par</a>).
<br><dt><code>varid</code><dd>Variable ID.
<br><dt><code>access</code><dd>NC_INDEPENDENT to set this variable to independent
operations.NC_COLLECTIVE to set it to collective operations.
</dl>
<h3 class="heading">Return Values</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
</dl>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_var_par_access:
<pre class="example"> #include <netcdf.h>
...
int ncid, v1id, dimids[NDIMS];
int data[DIMSIZE*DIMSIZE], j, i, res;
...
/* Create a parallel netcdf-4 file. */
if ((res = nc_create_par(FILE, NC_NETCDF4|NC_MPIIO, comm, info, &ncid)))
BAIL(res);
/* Create two dimensions. */
if ((res = nc_def_dim(ncid, "d1", DIMSIZE, dimids)))
BAIL(res);
if ((res = nc_def_dim(ncid, "d2", DIMSIZE, &dimids[1])))
BAIL(res);
/* Create one var. */
if ((res = nc_def_var(ncid, "v1", NC_INT, NDIMS, dimids, &v1id)))
BAIL(res);
if ((res = nc_enddef(ncid)))
BAIL(res);
/* Tell HDF5 to use independent parallel access for this var. */
if ((res = nc_var_par_access(ncid, v1id, NC_INDEPENDENT)))
BAIL(res);
/* Write slabs of phony data. */
if ((res = nc_put_vara_int(ncid, v1id, start, count,
&data[mpi_rank*QTR_DATA])))
BAIL(res);
</pre>
<div class="node">
<a name="nc_var_ubyte"></a>
<a name="nc_005fvar_005fubyte"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#nc_005fvar_005fpar_005faccess">nc_var_par_access</a>,
Up: <a rel="up" accesskey="u" href="#Variables">Variables</a>
</div>
<h3 class="section">6.37 Deprecated “_ubyte” variable functions</h3>
<p><a name="index-nc_005fput_005fvar1_005fubyte-459"></a><a name="index-nc_005fput_005fvar_005fubyte-460"></a><a name="index-nc_005fput_005fvara_005fubyte-461"></a><a name="index-nc_005fput_005fvars_005fubyte-462"></a><a name="index-nc_005fput_005fvarm_005fubyte-463"></a><a name="index-nc_005fget_005fvar1_005fubyte-464"></a><a name="index-nc_005fget_005fvar_005fubyte-465"></a><a name="index-nc_005fget_005fvara_005fubyte-466"></a><a name="index-nc_005fget_005fvars_005fubyte-467"></a><a name="index-nc_005fget_005fvarm_005fubyte-468"></a>
Note: the following functions are also defined but deprecated, as they
are identical in arguments and behavior to the corresponding functions
with “uchar” substituted for “ubyte” in the function name.
<pre class="example"> int nc_put_var1_ubyte (int ncid, int varid, const size_t index[],
const unsigned char *up);
int nc_put_var_ubyte (int ncid, int varid, const unsigned char *op);
int nc_put_vara_ubyte (int ncid, int varid, const size_t *startp,
const size_t *countp, const unsigned char *op);
int nc_put_vars_ubyte (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const unsigned char *op);
int nc_put_varm_ubyte (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, const unsigned char *op);
int nc_get_var1_ubyte (int ncid, int varid, const size_t *indexp,
unsigned char *ip);
int nc_get_var_ubyte (int ncid, int varid, unsigned char *ip);
int nc_get_vara_ubyte (int ncid, int varid, const size_t *startp,
const size_t *countp, unsigned char *ip);
int nc_get_vars_ubyte (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
unsigned char *ip);
int nc_get_varm_ubyte (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imapp, unsigned char *ip);
</pre>
<div class="node">
<a name="Attributes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Summary-of-C-Interface">Summary of C Interface</a>,
Previous: <a rel="previous" accesskey="p" href="#Variables">Variables</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">7 Attributes</h2>
<ul class="menu">
<li><a accesskey="1" href="#Attributes-Introduction">Attributes Introduction</a>
<li><a accesskey="2" href="#nc_005fput_005fatt_005f-type">nc_put_att_ type</a>
<li><a accesskey="3" href="#nc_005finq_005fatt-Family">nc_inq_att Family</a>
<li><a accesskey="4" href="#nc_005fget_005fatt_005f-type">nc_get_att_ type</a>
<li><a accesskey="5" href="#nc_005fcopy_005fatt">nc_copy_att</a>
<li><a accesskey="6" href="#nc_005frename_005fatt">nc_rename_att</a>
<li><a accesskey="7" href="#nc_005fdel_005fatt">nc_del_att</a>
<li><a accesskey="8" href="#nc_005fatt_005fubyte">nc_att_ubyte</a>: Deprecated attribute ``_ubyte'' functions
</ul>
<div class="node">
<a name="Attributes-Introduction"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fput_005fatt_005f-type">nc_put_att_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#Attributes">Attributes</a>,
Up: <a rel="up" accesskey="u" href="#Attributes">Attributes</a>
</div>
<h3 class="section">7.1 Introduction</h3>
<p><a name="index-attributes_002c-introduction-469"></a><a name="index-attributes_002c-operations-on-470"></a>
Attributes may be associated with each netCDF variable to specify such
properties as units, special values, maximum and minimum valid values,
scaling factors, and offsets. Attributes for a netCDF dataset are
defined when the dataset is first created, while the netCDF dataset is
in define mode. Additional attributes may be added later by reentering
define mode. A netCDF attribute has a netCDF variable to which it is
assigned, a name, a type, a length, and a sequence of one or more
values. An attribute is designated by its variable ID and name. When
an attribute name is not known, it may be designated by its variable
ID and number in order to determine its name, using the function
nc_inq_attname.
<p>The attributes associated with a variable are typically defined
immediately after the variable is created, while still in define
mode. The data type, length, and value of an attribute may be changed
even when in data mode, as long as the changed attribute requires no
more space than the attribute as originally defined.
<p>It is also possible to have attributes that are not associated with
any variable. These are called global attributes and are identified by
using NC_GLOBAL as a variable pseudo-ID. Global attributes are usually
related to the netCDF dataset as a whole and may be used for purposes
such as providing a title or processing history for a netCDF dataset.
<p>Operations supported on attributes are:
<ul>
<li>Create an attribute, given its variable ID, name, data type, length, and value.
<li>Get attribute's data type and length from its variable ID and name.
<li>Get attribute's value from its variable ID and name.
<li>Copy attribute from one netCDF variable to another.
<li>Get name of attribute from its number.
<li>Rename an attribute.
<li>Delete an attribute.
</ul>
<div class="node">
<a name="nc_put_att_-type"></a>
<a name="nc_005fput_005fatt_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005finq_005fatt-Family">nc_inq_att Family</a>,
Previous: <a rel="previous" accesskey="p" href="#Attributes-Introduction">Attributes Introduction</a>,
Up: <a rel="up" accesskey="u" href="#Attributes">Attributes</a>
</div>
<h3 class="section">7.2 Create an Attribute: nc_put_att_ <var>type</var></h3>
<p><a name="index-nc_005fput_005fatt_005f-type-471"></a><a name="index-nc_005fput_005fatt_005f-type_002c-example-472"></a><a name="index-attributes_002c-creating-473"></a><a name="index-attributes_002c-writing-474"></a><a name="index-writing-attributes-475"></a>
The function nc_put_att_ <var>type</var> adds or changes a variable attribute or
global attribute of an open netCDF dataset. If this attribute is new,
or if the space required to store the attribute is greater than
before, the netCDF dataset must be in define mode.
<h3 class="heading">Usage</h3>
<p>With netCDF-4 files, nc_put_att will notice if you are writing a
_Fill_Value_ attribute, and will tell the HDF5 layer to use the
specified fill value for that variable.
<p>Although it's possible to create attributes of all types, text and
double attributes are adequate for most purposes.
<p>Use the nc_put_att function to create attributes of any type,
including user-defined types. We recommend using the type safe versions
of this function whenever possible.
<pre class="example"> int nc_put_att_text (int ncid, int varid, const char *name,
size_t len, const char *tp);
int nc_put_att_uchar (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const unsigned char *up);
int nc_put_att_schar (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const signed char *cp);
int nc_put_att_short (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const short *sp);
int nc_put_att_int (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const int *ip);
int nc_put_att_long (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const long *lp);
int nc_put_att_float (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const float *fp);
int nc_put_att_double (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const double *dp);
int nc_put_att_ushort (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const unsigned short *op);
int nc_put_att_uint (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const unsigned int *op);
int nc_put_att_longlong (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const long long *op);
int nc_put_att_ulonglong (int ncid, int varid, const char *name, nc_type xtype,
size_t len,
const unsigned long long *op);
int nc_put_att_string (int ncid, int varid, const char *name, size_t len,
const char **op);
int nc_put_att (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const void *op);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID of the variable to which the attribute will be assigned or
NC_GLOBAL for a global attribute.
<br><dt><code>name</code><dd>Attribute name. Attribute name conventions are assumed by
some netCDF generic applications, e.g., ‘<samp><span class="samp">units</span></samp>’ as the name for a string
attribute that gives the units for a netCDF variable. For examples of
attribute conventions see <a href="netcdf.html#Attribute-Conventions">Attribute Conventions</a>.
<br><dt><code>xtype</code><dd>One of the set of predefined netCDF external data types. The type of
this parameter, nc_type, is defined in the netCDF header file. The
valid netCDF external data types are NC_BYTE, NC_CHAR, NC_SHORT,
NC_INT, NC_FLOAT, and NC_DOUBLE. Although it's possible to create
attributes of all types, NC_CHAR and NC_DOUBLE attributes are adequate
for most purposes.
<br><dt><code>len</code><dd>Number of values provided for the attribute.
<br><dt><code>tp, up, cp, sp, ip, lp, fp, or dp</code><dd>Pointer to one or more values. If the type of values differs from the
netCDF attribute type specified as xtype, type conversion will
occur. See <a href="netcdf.html#Type-Conversion">Type Conversion</a>.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_put_att_ <var>type</var> returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<ul>
<li>The variable ID is invalid for the specified netCDF dataset.
<li>The specified netCDF type is invalid.
<li>The specified length is negative.
<li>The specified open netCDF dataset is in data mode and the specified
attribute would expand.
<li>The specified open netCDF dataset is in data mode and the specified
attribute does not already exist.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
<li>The number of attributes for this variable exceeds NC_MAX_ATTRS.
</ul>
<h3 class="heading">Return Codes</h3>
<dl>
<dt><code>NC_NOERR</code><dd>No error.
<br><dt><code>NC_EINVAL</code><dd>Trying to set global _FillValue. (NetCDF-4 files only).
<br><dt><code>NC_ENOTVAR</code><dd>Couldn't find varid.
<br><dt><code>NC_EBADTYPE</code><dd>Fill value must be same type as variable. (NetCDF-4 files only).
<br><dt><code>NC_ENOMEM</code><dd>Out of memory
<br><dt><code>NC_EFILLVALUE</code><dd>Fill values must be written while the file is still in initial define
mode, that is, after the file is created, but before it leaves define
mode for the first time. NC_EFILLVALUE is returned when the user
attempts to set the fill value after it's too late.
</dl>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_put_att_double to add a variable attribute
named valid_range for a netCDF variable named rh and a global
attribute named title to an existing netCDF dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
static double rh_range[] = {0.0, 100.0};/* attribute vals */
static char title[] = "example netCDF dataset";
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_redef(ncid); /* enter define mode */
if (status != NC_NOERR) handle_error(status);
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
status = nc_put_att_double (ncid, rh_id, "valid_range",
NC_DOUBLE, 2, rh_range);
if (status != NC_NOERR) handle_error(status);
status = nc_put_att_text (ncid, NC_GLOBAL, "title",
strlen(title), title)
if (status != NC_NOERR) handle_error(status);
...
status = nc_enddef(ncid); /* leave define mode */
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_inq_att-Family"></a>
<a name="nc_005finq_005fatt-Family"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fget_005fatt_005f-type">nc_get_att_ type</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fput_005fatt_005f-type">nc_put_att_ type</a>,
Up: <a rel="up" accesskey="u" href="#Attributes">Attributes</a>
</div>
<h3 class="section">7.3 Get Information about an Attribute: nc_inq_att Family</h3>
<p><a name="index-nc_005finq_005fatt-Family-476"></a><a name="index-nc_005finq_005fatt-Family_002c-example-477"></a><a name="index-attributes_002c-ID-478"></a><a name="index-attributes_002c-getting-information-about-479"></a><a name="index-attributes_002c-inquiring-about-480"></a><a name="index-attributes_002c-finding-length-481"></a><a name="index-length-of-attributes-482"></a><a name="index-inquiring-about-attributes-483"></a>
This family of functions returns information about a netCDF
attribute. All but one of these functions require the variable ID and
attribute name; the exception is nc_inq_attname. Information about an
attribute includes its type, length, name, and number. See the
nc_get_att family for getting attribute values.
<p>The function nc_inq_attname gets the name of an attribute, given its
variable ID and number. This function is useful in generic
applications that need to get the names of all the attributes
associated with a variable, since attributes are accessed by name
rather than number in all other attribute functions. The number of an
attribute is more volatile than the name, since it can change when
other attributes of the same variable are deleted. This is why an
attribute number is not called an attribute ID.
<p>The function nc_inq_att returns the attribute's type and length. The
other functions each return just one item of information about an
attribute.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_inq_att (int ncid, int varid, const char *name,
nc_type *xtypep, size_t *lenp);
int nc_inq_atttype(int ncid, int varid, const char *name,
nc_type *xtypep);
int nc_inq_attlen (int ncid, int varid, const char *name, size_t *lenp);
int nc_inq_attname(int ncid, int varid, int attnum, char *name);
int nc_inq_attid (int ncid, int varid, const char *name, int *attnump);
</pre>
<dl>
<dt><code>ncid</code><a name="index-ncid-484"></a><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><a name="index-varid-485"></a><dd>Variable ID of the attribute's variable, or NC_GLOBAL for a global
attribute.
<br><dt><code>name</code><a name="index-name-486"></a><dd>Attribute name. For nc_inq_attname, this is a pointer to the location
for the returned attribute name.
<br><dt><code>xtypep</code><a name="index-xtypep-487"></a><dd>Pointer to location for returned attribute type, one of the set of
predefined netCDF external data types. The type of this parameter,
nc_type, is defined in the netCDF header file. The valid netCDF
external data types are NC_BYTE, NC_CHAR, NC_SHORT, NC_INT, NC_FLOAT,
and NC_DOUBLE. If this parameter is given as '0' (a null pointer), no
type will be returned so no variable to hold the type needs to be
declared.
<br><dt><code>lenp</code><a name="index-lenp-488"></a><dd>Pointer to location for returned number of values currently stored in
the attribute. For attributes of type NC_CHAR, you should not assume
that this includes a trailing zero byte; it doesn't if the attribute
was stored without a trailing zero byte, for example from a FORTRAN
program. Before using the value as a C string, make sure it is
null-terminated. If this parameter is given as '0' (a null pointer),
no length will be returned so no variable to hold this information
needs to be declared.
<br><dt><code>attnum</code><a name="index-attnum-489"></a><dd>For nc_inq_attname, attribute number. The attributes for each
variable are numbered from 0 (the first attribute) to natts-1, where
natts is the number of attributes for the variable, as returned from a
call to nc_inq_varnatts.
<br><dt><code>attnump</code><a name="index-attnump-490"></a><dd>For nc_inq_attid, pointer to location for returned attribute number
that specifies which attribute this is for this variable (or which
global attribute). If you already know the attribute name, knowing its
number is not very useful, because accessing information about an
attribute requires its name.
</dl>
<h3 class="heading">Errors</h3>
<p>Each function returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<ul>
<li>The variable ID is invalid for the specified netCDF dataset.
<li>The specified attribute does not exist.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
<li>For nc_inq_attname, the specified attribute number is negative or more
than the number of attributes defined for the specified variable.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_inq_att to find out the type and length of
a variable attribute named valid_range for a netCDF variable named rh
and a global attribute named title in an existing netCDF dataset named
foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
nc_type vr_type, t_type; /* attribute types */
size_t vr_len, t_len; /* attribute lengths */
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_att (ncid, rh_id, "valid_range", &vr_type, &vr_len);
if (status != NC_NOERR) handle_error(status);
status = nc_inq_att (ncid, NC_GLOBAL, "title", &t_type, &t_len);
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_get_att_-type"></a>
<a name="nc_005fget_005fatt_005f-type"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fcopy_005fatt">nc_copy_att</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005finq_005fatt-Family">nc_inq_att Family</a>,
Up: <a rel="up" accesskey="u" href="#Attributes">Attributes</a>
</div>
<h3 class="section">7.4 Get Attribute's Values:nc_get_att_ <var>type</var></h3>
<p><a name="index-nc_005fget_005fatt_005f-type-491"></a><a name="index-nc_005fget_005fatt_005f-type_002c-example-492"></a><a name="index-attributes_002c-reading-493"></a><a name="index-reading-attributes-494"></a>
Members of the nc_get_att_ <var>type</var> family of functions get the value(s)
of a netCDF attribute, given its variable ID and name.
<p>The nc_get_att() functions works for any type of attribute, and must
be used to get attributes of user-defined type. We recommend that they
type safe versions of this function be used where possible.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_get_att_text (int ncid, int varid, const char *name, char *tp);
int nc_get_att_uchar (int ncid, int varid, const char *name, unsigned char *up);
int nc_get_att_schar (int ncid, int varid, const char *name, signed char *cp);
int nc_get_att_short (int ncid, int varid, const char *name, short *sp);
int nc_get_att_int (int ncid, int varid, const char *name, int *ip);
int nc_get_att_long (int ncid, int varid, const char *name, long *lp);
int nc_get_att_float (int ncid, int varid, const char *name, float *fp);
int nc_get_att_double (int ncid, int varid, const char *name, double *dp);
int nc_get_att_ushort (int ncid, int varid, const char *name, unsigned short *ip);
int nc_get_att_uint (int ncid, int varid, const char *name, unsigned int *ip);
int nc_get_att_longlong (int ncid, int varid, const char *name, long long *ip);
int nc_get_att_ulonglong (int ncid, int varid, const char *name, unsigned long long *ip);
int nc_get_att_string (int ncid, int varid, const char *name, char **ip);
int nc_get_att (int ncid, int varid, const char *name, void *ip);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>Variable ID of the attribute's variable, or NC_GLOBAL for a global attribute.
<br><dt><code>name</code><dd>Attribute name.
<br><dt><code>tp</code><dt><code>up</code><dt><code>cp</code><dt><code>sp</code><dt><code>ip</code><dt><code>lp</code><dt><code>fp</code><dt><code>dp</code><dd>Pointer to location for returned attribute value(s). All elements of
the vector of attribute values are returned, so you must allocate
enough space to hold them. For attributes of type NC_CHAR, you should
not assume that the returned values include a trailing zero byte; they
won't if the attribute was stored without a trailing zero byte, for
example from a FORTRAN program. Before using the value as a C string,
make sure it is null-terminated. If you don't know how much space to
reserve, call nc_inq_attlen first to find out the length of the
attribute.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_get_att_ <var>type</var> returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<ul>
<li>The variable ID is invalid for the specified netCDF dataset.
<li>The specified attribute does not exist.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
<li>One or more of the attribute values are out of the range of values
representable by the desired type.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_get_att_double to determine the values of
a variable attribute named valid_range for a netCDF variable named rh
and a global attribute named title in an existing netCDF dataset named
foo.nc. In this example, it is assumed that we don't know how many
values will be returned, but that we do know the types of the
attributes. Hence, to allocate enough space to store them, we must
first inquire about the length of the attributes.
<pre class="example"> #include <netcdf.h>
...
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
int vr_len, t_len; /* attribute lengths */
double *vr_val; /* ptr to attribute values */
char *title; /* ptr to attribute values */
extern char *malloc(); /* memory allocator */
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
/* find out how much space is needed for attribute values */
status = nc_inq_attlen (ncid, rh_id, "valid_range", &vr_len);
if (status != NC_NOERR) handle_error(status);
status = nc_inq_attlen (ncid, NC_GLOBAL, "title", &t_len);
if (status != NC_NOERR) handle_error(status);
/* allocate required space before retrieving values */
vr_val = (double *) malloc(vr_len * sizeof(double));
title = (char *) malloc(t_len + 1); /* + 1 for trailing null */
/* get attribute values */
status = nc_get_att_double(ncid, rh_id, "valid_range", vr_val);
if (status != NC_NOERR) handle_error(status);
status = nc_get_att_text(ncid, NC_GLOBAL, "title", title);
if (status != NC_NOERR) handle_error(status);
title[t_len] = '\0'; /* null terminate */
...
</pre>
<div class="node">
<a name="nc_copy_att"></a>
<a name="nc_005fcopy_005fatt"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005frename_005fatt">nc_rename_att</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fget_005fatt_005f-type">nc_get_att_ type</a>,
Up: <a rel="up" accesskey="u" href="#Attributes">Attributes</a>
</div>
<h3 class="section">7.5 Copy Attribute from One NetCDF to Another: nc_copy_att</h3>
<p><a name="index-nc_005fcopy_005fatt-495"></a><a name="index-nc_005fcopy_005fatt_002c-example-496"></a><a name="index-attributes_002c-copying-497"></a><a name="index-copying-attributes-498"></a>
The function nc_copy_att copies an attribute from one open netCDF
dataset to another. It can also be used to copy an attribute from one
variable to another within the same netCDF.
<p>If used to copy an attribute of user-defined type, then that
user-defined type must already be defined in the target file. In the
case of user-defined attributes, enddef/redef is called for
ncid_in and ncid_out if they are in define mode. (This is the ensure
that all user-defined types are committed to the file(s) before the
copy is attempted.)
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_copy_att (int ncid_in, int varid_in, const char *name,
int ncid_out, int varid_out);
</pre>
<dl>
<dt><code>ncid_in</code><dd>The netCDF ID of an input netCDF dataset from which the attribute
will be copied, from a previous call to nc_open or nc_create.
<br><dt><code>varid_in</code><dd>ID of the variable in the input netCDF dataset from which the
attribute will be copied, or NC_GLOBAL for a global attribute.
<br><dt><code>name</code><dd>Name of the attribute in the input netCDF dataset to be copied.
<br><dt><code>ncid_out</code><dd>The netCDF ID of the output netCDF dataset to which the attribute
will be copied, from a previous call to nc_open or nc_create. It is
permissible for the input and output netCDF IDs to be the same. The
output netCDF dataset should be in define mode if the attribute to be
copied does not already exist for the target variable, or if it would
cause an existing target attribute to grow.
<br><dt><code>varid_out</code><dd>ID of the variable in the output netCDF dataset to which the
attribute will be copied, or NC_GLOBAL to copy to a global attribute.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_copy_att returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<ul>
<li>The input or output variable ID is invalid for the specified netCDF
dataset.
<li>The specified attribute does not exist.
<li>The output netCDF is not in define mode and the attribute is new for
the output dataset is larger than the existing attribute.
<li>The input or output netCDF ID does not refer to an open netCDF
dataset.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_copy_att to copy the variable attribute
units from the variable rh in an existing netCDF dataset named foo.nc
to the variable avgrh in another existing netCDF dataset named bar.nc,
assuming that the variable avgrh already exists, but does not yet have
a units attribute:
<pre class="example"> #include <netcdf.h>
...
int status; /* error status */
int ncid1, ncid2; /* netCDF IDs */
int rh_id, avgrh_id; /* variable IDs */
...
status = nc_open("foo.nc", NC_NOWRITE, ncid1);
if (status != NC_NOERR) handle_error(status);
status = nc_open("bar.nc", NC_WRITE, ncid2);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid1, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
status = nc_inq_varid (ncid2, "avgrh", &avgrh_id);
if (status != NC_NOERR) handle_error(status);
...
status = nc_redef(ncid2); /* enter define mode */
if (status != NC_NOERR) handle_error(status);
/* copy variable attribute from "rh" to "avgrh" */
status = nc_copy_att(ncid1, rh_id, "units", ncid2, avgrh_id);
if (status != NC_NOERR) handle_error(status);
...
status = nc_enddef(ncid2); /* leave define mode */
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_rename_att"></a>
<a name="nc_005frename_005fatt"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fdel_005fatt">nc_del_att</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005fcopy_005fatt">nc_copy_att</a>,
Up: <a rel="up" accesskey="u" href="#Attributes">Attributes</a>
</div>
<h3 class="section">7.6 Rename an Attribute: nc_rename_att</h3>
<p><a name="index-nc_005frename_005fatt-499"></a><a name="index-nc_005frename_005fatt_002c-example-500"></a><a name="index-attributes_002c-renaming-501"></a><a name="index-renaming-attributes-502"></a>
The function nc_rename_att changes the name of an attribute. If the
new name is longer than the original name, the netCDF dataset must be
in define mode. You cannot rename an attribute to have the same name
as another attribute of the same variable.
<h3 class="heading">Usage</h3>
<pre class="example"> int nc_rename_att (int ncid, int varid, const char* name,
const char* newname);
</pre>
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create
<br><dt><code>varid</code><dd>ID of the attribute's variable, or NC_GLOBAL for a global attribute
<br><dt><code>name</code><dd>The current attribute name.
<br><dt><code>newname</code><dd>The new name to be assigned to the specified attribute. If the new
name is longer than the current name, the netCDF dataset must be in
define mode.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_rename_att returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<ul>
<li>The specified variable ID is not valid.
<li>The new attribute name is already in use for another attribute of the
specified variable.
<li>The specified netCDF dataset is in data mode and the new name is
longer than the old name.
<li>The specified attribute does not exist.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_rename_att to rename the variable
attribute units to Units for a variable rh in an existing netCDF
dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable id */
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
/* rename attribute */
status = nc_rename_att(ncid, rh_id, "units", "Units");
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_del_att"></a>
<a name="nc_005fdel_005fatt"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#nc_005fatt_005fubyte">nc_att_ubyte</a>,
Previous: <a rel="previous" accesskey="p" href="#nc_005frename_005fatt">nc_rename_att</a>,
Up: <a rel="up" accesskey="u" href="#Attributes">Attributes</a>
</div>
<h3 class="section">7.7 Delete an Attribute: nc_del_att</h3>
<p><a name="index-nc_005fdel_005fatt-503"></a><a name="index-nc_005fdel_005fatt_002c-example-504"></a><a name="index-attributes_002c-deleting-505"></a><a name="index-deleting-attributes-506"></a>
The function nc_del_att deletes a netCDF attribute from an open netCDF
dataset. The netCDF dataset must be in define mode.
<h3 class="heading">Usage</h3>
<p>int nc_del_att (int ncid, int varid, const char* name);
<dl>
<dt><code>ncid</code><dd>NetCDF ID, from a previous call to nc_open or nc_create.
<br><dt><code>varid</code><dd>ID of the attribute's variable, or NC_GLOBAL for a global attribute.
<br><dt><code>name</code><dd>The name of the attribute to be deleted.
</dl>
<h3 class="heading">Errors</h3>
<p>nc_del_att returns the value NC_NOERR if no errors
occurred. Otherwise, the returned status indicates an error. Possible
causes of errors include:
<ul>
<li>The specified variable ID is not valid.
<li>The specified netCDF dataset is in data mode.
<li>The specified attribute does not exist.
<li>The specified netCDF ID does not refer to an open netCDF dataset.
</ul>
<h3 class="heading">Example</h3>
<p>Here is an example using nc_del_att to delete the variable attribute
Units for a variable rh in an existing netCDF dataset named foo.nc:
<pre class="example"> #include <netcdf.h>
...
int status; /* error status */
int ncid; /* netCDF ID */
int rh_id; /* variable ID */
...
status = nc_open("foo.nc", NC_WRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
/* delete attribute */
status = nc_redef(ncid); /* enter define mode */
if (status != NC_NOERR) handle_error(status);
status = nc_del_att(ncid, rh_id, "Units");
if (status != NC_NOERR) handle_error(status);
status = nc_enddef(ncid); /* leave define mode */
if (status != NC_NOERR) handle_error(status);
</pre>
<div class="node">
<a name="nc_att_ubyte"></a>
<a name="nc_005fatt_005fubyte"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#nc_005fdel_005fatt">nc_del_att</a>,
Up: <a rel="up" accesskey="u" href="#Attributes">Attributes</a>
</div>
<p><a name="index-nc_005fput_005fatt_005fubyte-507"></a><a name="index-nc_005fget_005fatt_005fubyte-508"></a>
Note: the following functions are also defined but deprecated, as they
are identical in arguments and behavior to the corresponding functions
with “uchar” substituted for “ubyte” in the function name.
<pre class="example"> int nc_put_att_ubyte (int ncid, int varid, const char *name, nc_type xtype,
size_t len, const unsigned char *op);
int nc_get_att_ubyte (int ncid, int varid, const char *name, unsigned char *ip);
</pre>
<div class="node">
<a name="Summary-of-C-Interface"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#NetCDF-3-Transition-Guide">NetCDF 3 Transition Guide</a>,
Previous: <a rel="previous" accesskey="p" href="#Attributes">Attributes</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix A Summary of C Interface</h2>
<p><a name="index-API_002c-C-summary-509"></a><a name="index-C-API-summary-510"></a>
<pre class="example"> const char* nc_inq_libvers (void);
const char* nc_strerror (int ncerr);
int nc_create (const char *path, int cmode, int *ncidp);
int nc_open (const char *path, int mode, int *ncidp);
int nc_set_fill (int ncid, int fillmode, int *old_modep);
int nc_redef (int ncid);
int nc_enddef (int ncid);
int nc_sync (int ncid);
int nc_abort (int ncid);
int nc_close (int ncid);
int nc_inq (int ncid, int *ndimsp, int *nvarsp,
int *ngattsp, int *unlimdimidp);
int nc_inq_ndims (int ncid, int *ndimsp);
int nc_inq_nvars (int ncid, int *nvarsp);
int nc_inq_natts (int ncid, int *ngattsp);
int nc_inq_unlimdim (int ncid, int *unlimdimidp);
int nc_def_dim (int ncid, const char *name, size_t len,
int *idp);
int nc_inq_dimid (int ncid, const char *name, int *idp);
int nc_inq_dim (int ncid, int dimid, char *name, size_t *lenp);
int nc_inq_dimname (int ncid, int dimid, char *name);
int nc_inq_dimlen (int ncid, int dimid, size_t *lenp);
int nc_rename_dim (int ncid, int dimid, const char *name);
int nc_def_var (int ncid, const char *name, nc_type xtype,
int ndims, const int *dimidsp, int *varidp);
int nc_inq_var (int ncid, int varid, char *name,
nc_type *xtypep, int *ndimsp, int *dimidsp,
int *nattsp);
int nc_inq_varid (int ncid, const char *name, int *varidp);
int nc_inq_varname (int ncid, int varid, char *name);
int nc_inq_vartype (int ncid, int varid, nc_type *xtypep);
int nc_inq_varndims (int ncid, int varid, int *ndimsp);
int nc_inq_vardimid (int ncid, int varid, int *dimidsp);
int nc_inq_varnatts (int ncid, int varid, int *nattsp);
int nc_rename_var (int ncid, int varid, const char *name);
int nc_put_var_text (int ncid, int varid, const char *op);
int nc_get_var_text (int ncid, int varid, char *ip);
int nc_put_var_uchar (int ncid, int varid, const unsigned char *op);
int nc_get_var_uchar (int ncid, int varid, unsigned char *ip);
int nc_put_var_schar (int ncid, int varid, const signed char *op);
int nc_get_var_schar (int ncid, int varid, signed char *ip);
int nc_put_var_short (int ncid, int varid, const short *op);
int nc_get_var_short (int ncid, int varid, short *ip);
int nc_put_var_int (int ncid, int varid, const int *op);
int nc_get_var_int (int ncid, int varid, int *ip);
int nc_put_var_long (int ncid, int varid, const long *op);
int nc_get_var_long (int ncid, int varid, long *ip);
int nc_put_var_float (int ncid, int varid, const float *op);
int nc_get_var_float (int ncid, int varid, float *ip);
int nc_put_var_double (int ncid, int varid, const double *op);
int nc_get_var_double (int ncid, int varid, double *ip);
int nc_put_var1_text (int ncid, int varid, const size_t *indexp,
const char *op);
int nc_get_var1_text (int ncid, int varid, const size_t *indexp,
char *ip);
int nc_put_var1_uchar (int ncid, int varid, const size_t *indexp,
const unsigned char *op);
int nc_get_var1_uchar (int ncid, int varid, const size_t *indexp,
unsigned char *ip);
int nc_put_var1_schar (int ncid, int varid, const size_t *indexp,
const signed char *op);
int nc_get_var1_schar (int ncid, int varid, const size_t *indexp,
signed char *ip);
int nc_put_var1_short (int ncid, int varid, const size_t *indexp,
const short *op);
int nc_get_var1_short (int ncid, int varid, const size_t *indexp,
short *ip);
int nc_put_var1_int (int ncid, int varid, const size_t *indexp,
const int *op);
int nc_get_var1_int (int ncid, int varid, const size_t *indexp,
int *ip);
int nc_put_var1_long (int ncid, int varid, const size_t *indexp,
const long *op);
int nc_get_var1_long (int ncid, int varid, const size_t *indexp,
long *ip);
int nc_put_var1_float (int ncid, int varid, const size_t *indexp,
const float *op);
int nc_get_var1_float (int ncid, int varid, const size_t *indexp,
float *ip);
int nc_put_var1_double(int ncid, int varid, const size_t *indexp,
const double *op);
int nc_get_var1_double(int ncid, int varid, const size_t *indexp,
double *ip);
int nc_put_vara_text (int ncid, int varid, const size_t *startp,
const size_t *countp, const char *op);
int nc_get_vara_text (int ncid, int varid, const size_t *startp,
const size_t *countp, char *ip);
int nc_put_vara_uchar (int ncid, int varid, const size_t *startp,
const size_t *countp, const unsigned char *op);
int nc_get_vara_uchar (int ncid, int varid, const size_t *startp,
const size_t *countp, unsigned char *ip);
int nc_put_vara_schar (int ncid, int varid, const size_t *startp,
const size_t *countp, const signed char *op);
int nc_get_vara_schar (int ncid, int varid, const size_t *startp,
const size_t *countp, signed char *ip);
int nc_put_vara_short (int ncid, int varid, const size_t *startp,
const size_t *countp, const short *op);
int nc_get_vara_short (int ncid, int varid, const size_t *startp,
const size_t *countp, short *ip);
int nc_put_vara_int (int ncid, int varid, const size_t *startp,
const size_t *countp, const int *op);
int nc_get_vara_int (int ncid, int varid, const size_t *startp,
const size_t *countp, int *ip);
int nc_put_vara_long (int ncid, int varid, const size_t *startp,
const size_t *countp, const long *op);
int nc_get_vara_long (int ncid, int varid, const size_t *startp,
const size_t *countp, long *ip);
int nc_put_vara_float (int ncid, int varid, const size_t *startp,
const size_t *countp, const float *op);
int nc_get_vara_float (int ncid, int varid, const size_t *startp,
const size_t *countp, float *ip);
int nc_put_vara_double(int ncid, int varid, const size_t *startp,
const size_t *countp, const double *op);
int nc_get_vara_double(int ncid, int varid, const size_t *startp,
const size_t *countp, double *ip);
int nc_put_vars_text (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const char *op);
int nc_get_vars_text (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
char *ip);
int nc_put_vars_uchar (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const unsigned char *op);
int nc_get_vars_uchar (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
unsigned char *ip);
int nc_put_vars_schar (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const signed char *op);
int nc_get_vars_schar (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
signed char *ip);
int nc_put_vars_short (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const short *op);
int nc_get_vars_short (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
short *ip);
int nc_put_vars_int (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const int *op);
int nc_get_vars_int (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
int *ip);
int nc_put_vars_long (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const long *op);
int nc_get_vars_long (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
long *ip);
int nc_put_vars_float (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const float *op);
int nc_get_vars_float (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
float *ip);
int nc_put_vars_double(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const double *op);
int nc_get_vars_double(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
double *ip);
int nc_put_varm_text (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, const char *op);
int nc_get_varm_text (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, char *ip);
int nc_put_varm_uchar (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, const unsigned char *op);
int nc_get_varm_uchar (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, unsigned char *ip);
int nc_put_varm_schar (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, const signed char *op);
int nc_get_varm_schar (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, signed char *ip);
int nc_put_varm_short (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, const short *op);
int nc_get_varm_short (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, short *ip);
int nc_put_varm_int (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, const int *op);
int nc_get_varm_int (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, int *ip);
int nc_put_varm_long (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, const long *op);
int nc_get_varm_long (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, long *ip);
int nc_put_varm_float (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, const float *op);
int nc_get_varm_float (int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, float *ip);
int nc_put_varm_double(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t *imapp, const double *op);
int nc_get_varm_double(int ncid, int varid, const size_t *startp,
const size_t *countp, const ptrdiff_t *stridep,
const ptrdiff_t * imap, double *ip);
int nc_inq_att (int ncid, int varid, const char *name,
nc_type *xtypep, size_t *lenp);
int nc_inq_attid (int ncid, int varid, const char *name, int *idp);
int nc_inq_atttype (int ncid, int varid, const char *name,
nc_type *xtypep);
int nc_inq_attlen (int ncid, int varid, const char *name,
size_t *lenp);
int nc_inq_attname (int ncid, int varid, int attnum, char *name);
int nc_copy_att (int ncid_in, int varid_in, const char *name,
int ncid_out, int varid_out);
int nc_rename_att (int ncid, int varid, const char *name,
const char *newname);
int nc_del_att (int ncid, int varid, const char *name);
int nc_put_att_text (int ncid, int varid, const char *name, size_t len,
const char *op);
int nc_get_att_text (int ncid, int varid, const char *name, char *ip);
int nc_put_att_uchar (int ncid, int varid, const char *name,
nc_type xtype, size_t len, const unsigned char *op);
int nc_get_att_uchar (int ncid, int varid, const char *name,
unsigned char *ip);
int nc_put_att_schar (int ncid, int varid, const char *name,
nc_type xtype, size_t len, const signed char *op);
int nc_get_att_schar (int ncid, int varid, const char *name,
signed char *ip);
int nc_put_att_short (int ncid, int varid, const char *name,
nc_type xtype, size_t len, const short *op);
int nc_get_att_short (int ncid, int varid, const char *name, short *ip);
int nc_put_att_int (int ncid, int varid, const char *name,
nc_type xtype,size_t len, const int *op);
int nc_get_att_int (int ncid, int varid, const char *name, int *ip);
int nc_put_att_long (int ncid, int varid, const char *name,
nc_type xtype, size_t len, const long *op);
int nc_get_att_long (int ncid, int varid, const char *name, long *ip);
int nc_put_att_float (int ncid, int varid, const char *name,
nc_type xtype, size_t len, const float *op);
int nc_get_att_float (int ncid, int varid, const char *name, float *ip);
int nc_put_att_double (int ncid, int varid, const char *name,
nc_type xtype, size_t len, const double *op);
int nc_get_att_double (int ncid, int varid, const char *name,
double *ip);
</pre>
<div class="node">
<a name="NetCDF-3-Transition-Guide"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#NetCDF-2-C-Transition-Guide">NetCDF 2 C Transition Guide</a>,
Previous: <a rel="previous" accesskey="p" href="#Summary-of-C-Interface">Summary of C Interface</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix B NetCDF 3 to NetCDF 4 Transition Guide</h2>
<h3 class="section">B.1 Introduction</h3>
<p>The release of netCDF-4 represents a substantial increase in the
capabilities of the netCDF C and Fortran APIs.
<p>The netCDF-4.0 release (June, 2008) allows the use of the popular HDF5
data format as a storage layer. The HDF5 format has many features, and
only a subset of them are exposed in the netCDF-4 API. This represents
a deliberate selection process by netCDF-4 developers to
choose the most useful features of the HDF5 model, while retaining the
simplicity of the netCDF APIs.
<p>Despite many new features, full backward compatibility is assured (and
extensively tested). Existing software and data files will continue to
work with netCDF-4.0, just as with previous releases of the netCDF
library.
<p>The use of netCDF-4 files allows the use of the expanded data model,
including user-defined types, groups, the new unsigned, 64-bit, and
string types.
<p>Using netCDF-4 files also allows the use of such features as endianness
control, per-variable data compression, chunking, parallel I/O, and
checksums. These features fit neatly within the classic netCDF data
model.
<p>Although the expanded data model offers many exciting new features, we
expect and encourage users to proceed with care - it also allows the
creation of needlessly, even horribly complex files. This would
decrease interoperability and increase the work of the poor
programmers trying to use the data file.
<p>There are many netCDF-4 features which fit comfortably within the
classic netCDF model. Existing programs can be very quickly converted
to use features such as compression, endianness control, and
chunking. This allows users to gain immediate performance pay off,
with minimal software development effort.
<h3 class="section">B.2 NetCDF-4 and HDF5</h3>
<p>NetCDF-4 depends on HDF5 to deliver the new features of the expanded
data model, as well as the features required to support the classic
data model.
<p>NetCDF-4 users must have at least HDF5 version 1.8.1 (and at least
zlib-1.2.3) to use HDF5 with netCDF-4.0. If these packages are not
found when netCDF is built, then the netCDF library may still be built
(without the –enable-netcdf-4 option), but will not allow users to
create netCDF-4/HDF5 files, or use the expanded data model. Only
classic and 64-bit offset format netCDF files will be created or
readable. (see <a href="netcdf-install.html#Configure">Configure</a>).
<p>The HDF5 files created by netCDF-4 will be readable (and writable) by
any HDF5 application. However, netCDF-4.0 cannot read any HDF5 file,
only those created by netCDF-4.
<h3 class="section">B.3 Backward Compatibility</h3>
<p>In the context of netCDF, backward compatibility has several
meanings.
<dl>
<dt><code>Data Compatibility</code><dd>NetCDF-4 provides backward compatibility for existing data. All netCDF
data files remain readable and writable to the netCDF library. When a file is
opened, the library detects the underlying format of the file; this is
transparent to the programmer and user.
<br><dt><code>Code Compatibility</code><dd>NetCDF-4 provides backward compatibility for existing
software. Programs using the 4.0 release can use it as a drop-in
replacement for netCDF-3.x. Existing programs will continue to create
netCDF classic or 64-bit offset files.
<br><dt><code>Model Compatibility</code><dd>NetCDF-4 introduces an expanded model of a netCDF data file
(include such new elements as groups, user-defined types,
multiple-unlimited dimensions, etc.) This expanded model is a super-set
of the classic netCDF model. Everything that works in the classic
model works in the expanded model as well. (The reverse is not true -
code using the expanded data model will fail if run on classic model
netCDF files.)
</dl>
<h3 class="section">B.4 The Classic and the Expanded NetCDF Data Models</h3>
<p>The classic netCDF data model consists of variables, dimensions, and
attributes.
<p>The netCDF-4.0 release introduces an expanded data model, which offers
many new features. These features will only work on files which have
been created with the NC_NETCDF4 flag, and without the
NC_CLASSIC_MODEL flag (see <a href="#nc_005fcreate">nc_create</a>).
<dl>
<dt><code>New Types</code><dd>New data types are introduced: NC_UBYTE, NC_USHORT, NC_UINT, NC_INT64,
NC_UINT64, and NC_STRING. These types many be used for attributes and
variables. See <a href="#nc_005fdef_005fvar">nc_def_var</a>.
<br><dt><code>Groups</code><dd>NetCDF objects may now be organizes into a hierarchical set of
groups. Groups are organized much line a UNIX file system, with each
group capable of containing more groups. Within each group a
classic model netCDF “file” exists, with its own dimensions,
variables, and attributes. See <a href="#nc_005fdef_005fgrp">nc_def_grp</a>.
<br><dt><code>User Defined Types</code><dd>NetCDF-4 allows the user to define new data types, including a
compound type (see <a href="#nc_005fdef_005fcompound">nc_def_compound</a>), a variable length array type
(see <a href="#nc_005fdef_005fvlen">nc_def_vlen</a>), an enumerated type (see <a href="#nc_005fdef_005fenum">nc_def_enum</a>), and
an opaque type (see <a href="#nc_005fdef_005fopaque">nc_def_opaque</a>).
<br><dt><code>Multiple Unlimited Dimensions</code><dd>NetCDF-4/HDF5 data files may use multiple unlimited dimensions with a
file, and even within a variable.
</dl>
<h3 class="section">B.5 Using NetCDF-4.0 with the Classic and 64-bit Offset Formats</h3>
<p>Prior to the 4.0 release, two underlying data formats were available
for the netCDF user, the classic, and the 64-bit offset format. (The
64-bit offset format was introduced in the 3.6.0 release, and allows
the use of larger variables and files).
<p>Software using netCDF, relinked against the netCDF-4.0 library, will
continue to work exactly as before. Since the default create mode in
nc_create is to create a classic format file, using unmodified
netCDF-3 code with the netCDF-4 library will result in the exact same
output - a classic netCDF file or 64-bit offset file.
<p>When writing or reading classic and 64-bit offset files, the
netCDF-4.0 library relies on the core netCDF-3.x code.
<h3 class="section">B.6 Creating a NetCDF-4/HDF5 File</h3>
<p>The extra features of netCDF-4 can only be accessed by adding the
NC_NETCDF4 flag to the create mode of nc_create. Files created with the
NC_NETCDF4 flag can have multiple unlimited dimensions, use the new
atomic types, use compound and opaque types, and take advantage of the
other features of netCDF-4. (see <a href="#nc_005fcreate">nc_create</a>).
<h3 class="section">B.7 Using NetCDF-4.0 with the Classic Model</h3>
<p>By changing your nc_create call to create a netCDF-4/HDF5 file you
gain access to many new features - perhaps too many! Using groups or
user-defined types will make the file unreadable to existing netCDF
applications, until they are updated to handle the new netCDF-4 model.
<p>Using the NC_CLASSIC_MODEL flag with the NC_NETCDF4 flag tells the
library to create a netCDF-4/HDF5 file which must abide by the rules
of the classic netCDF data model. Such a file many not contain groups,
user defined types, multiple unlimited dimensions, etc.
<p>But a classic model file is guaranteed to be compatible with existing
netCDF software, once relinked to the netCDF 4.0 library.
<p>Some features of netCDF-4 are transparent to the user when the file is
read. For example, a netCDF-4/HDF5 file may contain compressed
data. When such a file is read, the decompression of the data takes
place transparently. This means that data may use the data compression
feature, and still conform to the classic netCDF data model, and thus
retain compatibility with existing netCDF software
(see <a href="#nc_005fdef_005fvar_005fdeflate">nc_def_var_deflate</a>). The same applies for control of
endianness (see <a href="#nc_005fdef_005fvar_005fendian">nc_def_var_endian</a>), chunking
(see <a href="#nc_005fdef_005fvar_005fchunking">nc_def_var_chunking</a>), checksums
(see <a href="#nc_005fdef_005fvar_005ffletcher32">nc_def_var_fletcher32</a>), and parallel I/O, if netCDF-4 was
built on a system with the MPI libraries.
<p>To use these feature, change your nc_create calls to use the
NC_NETCDF4 and NC_CLASSIC_MODEL flags. Then call the appropriate
nc_dev_var_* function after the variable is defined, but before the
next call to nc_enddef.
<h3 class="section">B.8 Use of the Expanded Model Impacts Fortran Portability</h3>
<p>Using expanded model features impacts portability for Fortran
programmers.
<p>Fortran compilers do not always agree as to how data should be laid
out in memory. This makes handling compound and variable length array
types compiler and platform dependant.
<p>(This is also true for C, but the clever HDF5 configuration has solved
this problem for C. Alas, not for Fortran.)
<p>Despite this, Fortran programs can take advantage of the new data
model. The portability challenge is no different from that which
Fortran programmers already deal with when doing data I/O.
<h3 class="section">B.9 The C++ API Does Not Handle Expanded Model in this Release</h3>
<p>Unfortunately, the C++ API does not support the netCDF-4 expanded data
model. A new C++ API is being developed and may be built by
adventurous users using the –enable-cxx4 option to configure
(see <a href="netcdf-install.html#Configure">Configure</a>).
<div class="node">
<a name="NetCDF-2-C-Transition-Guide"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#NetCDF_002d3-Error-Codes">NetCDF-3 Error Codes</a>,
Previous: <a rel="previous" accesskey="p" href="#NetCDF-3-Transition-Guide">NetCDF 3 Transition Guide</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix C NetCDF 2 to NetCDF 3 C Transition Guide</h2>
<p><a name="index-backward-compatibility-with-v2-API-511"></a><a name="index-zero-length-edge-512"></a><a name="index-zero-valued-count-vector-513"></a><a name="index-XDR-library-514"></a><a name="index-netCDF-2-transition-guide-515"></a><a name="index-transition-guide_002c-netCDF-2-516"></a>
<h3 class="section">C.1 Overview of C interface changes</h3>
<p>NetCDF version 3 includes a complete rewrite of the netCDF library. It
is about twice as fast as the previous version. The netCDF file format
is unchanged, so files written with version 3 can be read with version
2 code and vice versa.
<p>The core library is now written in ANSI C. For example, prototypes are
used throughout as well as const qualifiers where appropriate. You
must have an ANSI C compiler to compile this version.
<p>Rewriting the library offered an opportunity to implement improved C
and FORTRAN interfaces that provide some significant benefits:
<p>type safety, by eliminating the need to use generic void* pointers;
<p>automatic type conversions, by eliminating the undesirable coupling
between the language-independent external netCDF types (NC_BYTE, ...,
NC_DOUBLE) and language-dependent internal data types (char, ...,
double);
<p>support for future enhancements, by eliminating obstacles to the clean
addition of support for packed data and multithreading;
<p>more standard error behavior, by uniformly communicating an error
status back to the calling program in the return value of each
function.
<p>It is not necessary to rewrite programs that use the version 2 C
interface, because the netCDF-3 library includes a backward
compatibility interface that supports all the old functions, globals,
and behavior. We are hoping that the benefits of the new interface
will be an incentive to use it in new netCDF applications. It is
possible to convert old applications to the new interface
incrementally, replacing netCDF-2 calls with the corresponding
netCDF-3 calls one at a time. If you want to check that only netCDF-3
calls are used in an application, a preprocessor macro (NO_NETCDF_2)
is available for that purpose.
<p>Other changes in the implementation of netCDF result in improved
portability, maintainability, and performance on most platforms. A
clean separation between I/O and type layers facilitates
platform-specific optimizations. The new library no longer uses a
vendor-provided XDR library, which simplifies linking programs that
use netCDF and speeds up data access significantly in most cases.
<h3 class="section">C.2 The New C Interface</h3>
<p>First, here's an example of C code that uses the netCDF-2 interface:
<pre class="example"> void *bufferp;
nc_type xtype;
ncvarinq(ncid, varid, ..., &xtype, ...
...
/* allocate bufferp based on dimensions and type */
...
if (ncvarget(ncid, varid, start, count, bufferp) == -1) {
fprintf(stderr, "Can't get data, error code = %d\n",ncerr);
/* deal with it */
...
}
switch(xtype) {
/* deal with the data, according to type */
...
case NC_FLOAT:
fanalyze((float *)bufferp);
break;
case NC_DOUBLE:
danalyze((double *)bufferp);
break;
}
</pre>
<p>Here's how you might handle this with the new netCDF-3 C interface:
<pre class="example"> /*
* I want to use doubles for my analysis.
*/
double dbuf[NDOUBLES];
int status;
/* So, I use the function that gets the data as doubles. */
status = nc_get_vara_double(ncid, varid, start, count, dbuf)
if (status != NC_NOERR) {
fprintf(stderr, "Can't get data: %s\n", nc_strerror(status));
/* deal with it */
...
}
danalyze(dbuf);
</pre>
<p>The example above illustrates changes in function names, data type
conversion, and error handling, discussed in detail in the sections
below.
<h3 class="section">C.3 Function Naming Conventions</h3>
<p>The netCDF-3 C library employs a new naming convention, intended to
make netCDF programs more readable. For example, the name of the
function to rename a variable is now nc_rename_var instead of the
previous ncvarrename.
<p>All netCDF-3 C function names begin with the nc_ prefix. The second
part of the name is a verb, like get, put, inq (for inquire), or
open. The third part of the name is typically the object of the verb:
for example dim, var, or att for functions dealing with dimensions,
variables, or attributes. To distinguish the various I/O operations
for variables, a single character modifier is appended to var:
<dl>
<dt>var<dd>entire variable access
<br><dt>var1<dd>single value access
<br><dt>vara<dd>array or array section access
<br><dt>vars<dd>strided access to a subsample of values
<br><dt>varm<dd>mapped access to values not contiguous in memory
</dl>
<p>At the end of the name for variable and attribute functions, there is
a component indicating the type of the final argument: text, uchar,
schar, short, int, long, float, or double. This part of the function
name indicates the type of the data container you are using in your
program: character string, unsigned char, signed char, and so on.
<p>Also, all macro names in the public C interface begin with the prefix
NC_. For example, the macro which was formerly MAX_NC_NAME is now
NC_MAX_NAME, and the former FILL_FLOAT is now NC_FILL_FLOAT.
<p>As previously mentioned, all the old names are still supported for
backward compatibility.
<h3 class="section">C.4 Type Conversion</h3>
<p>With the new interface, users need not be aware of the external type
of numeric variables, since automatic conversion to or from any
desired numeric type is now available. You can use this feature to
simplify code, by making it independent of external types. The
elimination of void* pointers provides detection of type errors at
compile time that could not be detected with the previous
interface. Programs may be made more robust with the new interface,
because they need not be changed to accommodate a change to the
external type of a variable.
<p>If conversion to or from an external numeric type is necessary, it is
handled by the library. This automatic conversion and separation of
external data representation from internal data types will become even
more important in netCDF version 4, when new external types will be
added for packed data for which there is no natural corresponding
internal type, for example, arrays of 11-bit values.
<p>Converting from one numeric type to another may result in an error if
the target type is not capable of representing the converted
value. (In netCDF-2, such overflows can only happen in the XDR layer.)
For example, a float may not be able to hold data stored externally as
an NC_DOUBLE (an IEEE floating-point number). When accessing an array
of values, an NC_ERANGE error is returned if one or more values are
out of the range of representable values, but other values are
converted properly.
<p>Note that mere loss of precision in type conversion does not return an
error. Thus, if you read double precision values into an int, for
example, no error results unless the magnitude of the double precision
value exceeds the representable range of ints on your
platform. Similarly, if you read a large integer into a float
incapable of representing all the bits of the integer in its mantissa,
this loss of precision will not result in an error. If you want to
avoid such precision loss, check the external types of the variables
you access to make sure you use an internal type that has a compatible
precision.
<p>The new interface distinguishes arrays of characters intended to
represent text strings from arrays of 8-bit bytes intended to
represent small integers. The interface supports the internal types
text, uchar, and schar, intended for text strings, unsigned byte
values, and signed byte values.
<p>The _uchar and _schar functions were introduced in netCDF-3 to
eliminate an ambiguity, and support both signed and unsigned byte
data. In netCDF-2, whether the external NC_BYTE type represented
signed or unsigned values was left up to the user. In netcdf-3, we
treat NC_BYTE as signed for the purposes of conversion to short, int,
long, float, or double. (Of course, no conversion takes place when the
internal type is signed char.) In the _uchar functions, we treat
NC_BYTE as if it were unsigned. Thus, no NC_ERANGE error can occur
converting between NC_BYTE and unsigned char. The _uchar and _schar
functions will behave differently when writing data or attribute
values to a larger type, because the type conversion is from unsigned
or signed to the larger type, respectively.
<h3 class="section">C.5 Error handling</h3>
<p>The new interface handles errors differently than netCDF-2. In the old
interface, the default behavior when an error was detected was to
print an error message and exit. To get control of error handling, you
had to set flag bits in a global variable, ncopts, and to determine
the cause of an error, you had to test the value of another global
variable ncerr.
<p>In the new interface, functions return an integer status that
indicates not only success or failure, but also the cause of the
error. The global variables ncerr and ncopt have been eliminated. The
library will never try to print anything, nor will it call exit
(unless you are using the netCDF version 2 compatibility
functions). You will have to check the function return status and do
this yourself. We eliminated these globals in the interest of
supporting parallel (multiprocessor) execution cleanly, as well as
reducing the number of assumptions about the environment where netCDF
is used. The new behavior should provide better support for using
netCDF as a hidden layer in applications that have their own GUI
interface.
<h3 class="section">C.6 NC_LONG and NC_INT</h3>
<p>Where the netCDF-2 interface used NC_LONG to
identify an external data type corresponding to 32-bit integers, the
new interface uses NC_INT instead. NC_LONG is defined to have the same
value as NC_INT for backward compatibility, but it should not be used
in new code. With new 64-bit platforms using long for 64-bit integers,
we would like to reduce the confusion caused by this name clash. Note
that there is still no netCDF external data type corresponding to
64-bit integers.
<h3 class="section">C.7 What's Missing?</h3>
<p>The new C interface omits three "record I/O" functions, ncrecput,
ncrecget, and ncrecinq, from the netCDF-2 interface, although these
functions are still supported via the netCDF-2 compatibility
interface.
<p>This means you may have to replace one record-oriented call with
multiple type-specific calls, one for each record variable. For
example, a single call to ncrecput can always be replaced by multiple
calls to the appropriate nc_put_var functions, one call for each
variable accessed. The record-oriented functions were omitted, because
there is no simple way to provide type-safety and automatic type
conversion for such an interface.
<p>There is no function corresponding to the nctypelen function from the
version 2 interface. The separation of internal and external types and
the new type-conversion interfaces make nctypelen unnecessary. Since
users read into and write out of native types, the sizeof operator is
perfectly adequate to determine how much space to allocate for a
value.
<p>In the previous library, there was no checking that the characters
used in the name of a netCDF object were compatible with CDL
restrictions. The ncdump and ncgen utilities now properly escape and
handle escaped special characters in names, so that all valid netCDF
names are representable in CDL.
<h3 class="section">C.8 Other Changes</h3>
<p>There are two new functions in netCDF-3 that don't
correspond to any netCDF-2 functions: nc_inq_libvers and
nc_strerror. The version of the netCDF library in use is returned as a
string by nc_inq_libvers. An error message corresponding to the status
returned by a netCDF function call is returned as a string by the
nc_strerror function.
<p>A new NC_SHARE flag is available for use in an nc_open or nc_create
call, to suppress the default buffering of accesses. The use of
NC_SHARE for concurrent access to a netCDF dataset means you don't
have to call nc_sync after every access to make sure that disk updates
are synchronous. It is important to note that changes to ancillary
data, such as attribute values, are not propagated automatically by
use of the NC_SHARE flag. Use of the nc_sync function is still
required for this purpose.
<p>The version 2 interface had a single inquiry function, ncvarinq for
getting the name, type, and shape of a variable. Similarly, only a
single inquiry function was available for getting information about a
dimension, an attribute, or a netCDF dataset. When you only wanted a
subset of this information, you had to provide NULL arguments as
placeholders for the unneeded information. The new interface includes
additional inquire functions that return each item separately, so
errors are less likely from miscounting arguments.
<p>The previous implementation returned an error when 0-valued count
components were specified in ncvarput and ncvarget calls. This
restriction has been removed, so that now functions in the nc_put_var
and nc_get_var families may be called with 0-valued count components,
resulting in no data being accessed. Although this may seem useless,
it simplifies some programs to not treat 0-valued counts as a special
case.
<p>The previous implementation returned an error when the same dimension
was used more than once in specifying the shape of a variable in
ncvardef. This restriction is relaxed in the netCDF-3 implementation,
because an auto-correlation matrix is a good example where using the
same dimension twice makes sense.
<p>In the new interface, units for the imap argument to the nc_put_varm
and nc_get_varm families of functions are now in terms of the number
of data elements of the desired internal type, not in terms of bytes
as in the netCDF version-2 mapped access interfaces.
<p>Following is a table of netCDF-2 function names and names of the
corresponding netCDF-3 functions. For parameter lists of netCDF-2
functions, see the netCDF-2 User's Guide.
<dl>
<dt><code>ncabort</code><dd>nc_abort
<br><dt><code>ncattcopy</code><dd>nc_copy_att
<br><dt><code>ncattdel</code><dd>nc_del_att
<br><dt><code>ncattget</code><dd>nc_get_att_double, nc_get_att_float, nc_get_att_int, nc_get_att_long,
nc_get_att_schar, nc_get_att_short, nc_get_att_text, nc_get_att_uchar
<br><dt><code>ncattinq</code><dd>nc_inq_att, nc_inq_attid, nc_inq_attlen, nc_inq_atttype
<br><dt><code>ncattname</code><dd>nc_inq_attname
<br><dt><code>ncattput</code><dd>nc_put_att_double, nc_put_att_float, nc_put_att_int, nc_put_att_long,
nc_put_att_schar, nc_put_att_short, nc_put_att_text, nc_put_att_uchar
<br><dt><code>ncattrename</code><dd>nc_rename_att
<br><dt><code>ncclose</code><dd>nc_close
<br><dt><code>nccreate</code><dd>nc_create
<br><dt><code>ncdimdef</code><dd>nc_def_dim
<br><dt><code>ncdimid</code><dd>nc_inq_dimid
<br><dt><code>ncdiminq</code><dd>nc_inq_dim, nc_inq_dimlen, nc_inq_dimname
<br><dt><code>ncdimrename</code><dd>nc_rename_dim
<br><dt><code>ncendef</code><dd>nc_enddef
<br><dt><code>ncinquire</code><dd>nc_inq, nc_inq_natts, nc_inq_ndims, nc_inq_nvars, nc_inq_unlimdim
<br><dt><code>ncopen</code><dd>nc_open
<br><dt><code>ncrecget</code><dd>(none)
<br><dt><code>ncrecinq</code><dd>(none)
<br><dt><code>ncrecput</code><dd>(none)
<br><dt><code>ncredef</code><dd>nc_redef
<br><dt><code>ncsetfill</code><dd>nc_set_fill
<br><dt><code>ncsync</code><dd>nc_sync
<br><dt><code>nctypelen</code><dd>(none)
<br><dt><code>ncvardef</code><dd>nc_def_var
<br><dt><code>ncvarget</code><dd>nc_get_vara_double, nc_get_vara_float, nc_get_vara_int,
nc_get_vara_long, nc_get_vara_schar, nc_get_vara_short,
nc_get_vara_text, nc_get_vara_uchar
<br><dt><code>ncvarget1</code><dd>nc_get_var1_double, nc_get_var1_float, nc_get_var1_int,
nc_get_var1_long, nc_get_var1_schar, nc_get_var1_short,
nc_get_var1_text, nc_get_var1_uchar
<br><dt><code>ncvargetg</code><dd>nc_get_varm_double, nc_get_varm_float, nc_get_varm_int,
nc_get_varm_long, nc_get_varm_schar, nc_get_varm_short,
nc_get_varm_text, nc_get_varm_uchar, nc_get_vars_double,
nc_get_vars_float, nc_get_vars_int, nc_get_vars_long,
nc_get_vars_schar, nc_get_vars_short, nc_get_vars_text,
nc_get_vars_uchar
<br><dt><code>ncvarid</code><dd>nc_inq_varid
<br><dt><code>ncvarinq</code><dd>nc_inq_var, nc_inq_vardimid, nc_inq_varname, nc_inq_varnatts,
nc_inq_varndims, nc_inq_vartype
<br><dt><code>ncvarput</code><dd>nc_put_vara_double, nc_put_vara_float, nc_put_vara_int,
nc_put_vara_long, nc_put_vara_schar, nc_put_vara_short,
nc_put_vara_text, nc_put_vara_uchar
<br><dt><code>ncvarput1</code><dd>nc_put_var1_double, nc_put_var1_float, nc_put_var1_int,
nc_put_var1_long, nc_put_var1_schar, nc_put_var1_short,
nc_put_var1_text, nc_put_var1_uchar
<br><dt><code>ncvarputg</code><dd>nc_put_varm_double, nc_put_varm_float, nc_put_varm_int,
nc_put_varm_long, nc_put_varm_schar, nc_put_varm_short,
nc_put_varm_text, nc_put_varm_uchar, nc_put_vars_double,
nc_put_vars_float, nc_put_vars_int, nc_put_vars_long,
nc_put_vars_schar, nc_put_vars_short, nc_put_vars_text,
nc_put_vars_uchar
<br><dt><code>ncvarrename</code><dd>nc_rename_var
<br><dt><code>(none)</code><dd>nc_inq_libvers
<br><dt><code>(none)</code><dd>nc_strerror
</dl>
<div class="node">
<a name="NetCDF-3-Error-Codes"></a>
<a name="NetCDF_002d3-Error-Codes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#NetCDF_002d4-Error-Codes">NetCDF-4 Error Codes</a>,
Previous: <a rel="previous" accesskey="p" href="#NetCDF-2-C-Transition-Guide">NetCDF 2 C Transition Guide</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix D NetCDF-3 Error Codes</h2>
<p><a name="index-error-codes_002c-netcdf_002d3-517"></a><a name="index-netcdf_002d3-error-codes-518"></a>
<pre class="example"> #define NC_NOERR 0 /* No Error */
#define NC_EBADID (-33) /* Not a netcdf id */
#define NC_ENFILE (-34) /* Too many netcdfs open */
#define NC_EEXIST (-35) /* netcdf file exists && NC_NOCLOBBER */
#define NC_EINVAL (-36) /* Invalid Argument */
#define NC_EPERM (-37) /* Write to read only */
#define NC_ENOTINDEFINE (-38) /* Operation not allowed in data mode */
#define NC_EINDEFINE (-39) /* Operation not allowed in define mode */
#define NC_EINVALCOORDS (-40) /* Index exceeds dimension bound */
#define NC_EMAXDIMS (-41) /* NC_MAX_DIMS exceeded */
#define NC_ENAMEINUSE (-42) /* String match to name in use */
#define NC_ENOTATT (-43) /* Attribute not found */
#define NC_EMAXATTS (-44) /* NC_MAX_ATTRS exceeded */
#define NC_EBADTYPE (-45) /* Not a netcdf data type */
#define NC_EBADDIM (-46) /* Invalid dimension id or name */
#define NC_EUNLIMPOS (-47) /* NC_UNLIMITED in the wrong index */
#define NC_EMAXVARS (-48) /* NC_MAX_VARS exceeded */
#define NC_ENOTVAR (-49) /* Variable not found */
#define NC_EGLOBAL (-50) /* Action prohibited on NC_GLOBAL varid */
#define NC_ENOTNC (-51) /* Not a netcdf file */
#define NC_ESTS (-52) /* In Fortran, string too short */
#define NC_EMAXNAME (-53) /* NC_MAX_NAME exceeded */
#define NC_EUNLIMIT (-54) /* NC_UNLIMITED size already in use */
#define NC_ENORECVARS (-55) /* nc_rec op when there are no record vars */
#define NC_ECHAR (-56) /* Attempt to convert between text & numbers */
#define NC_EEDGE (-57) /* Edge+start exceeds dimension bound */
#define NC_ESTRIDE (-58) /* Illegal stride */
#define NC_EBADNAME (-59) /* Attribute or variable name
contains illegal characters */
/* N.B. following must match value in ncx.h */
#define NC_ERANGE (-60) /* Math result not representable */
#define NC_ENOMEM (-61) /* Memory allocation (malloc) failure */
#define NC_EVARSIZE (-62) /* One or more variable sizes violate
format constraints */
#define NC_EDIMSIZE (-63) /* Invalid dimension size */
#define NC_ETRUNC (-64) /* File likely truncated or possibly corrupted */
</pre>
<div class="node">
<a name="NetCDF-4-Error-Codes"></a>
<a name="NetCDF_002d4-Error-Codes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#DAP-Error-Codes">DAP Error Codes</a>,
Previous: <a rel="previous" accesskey="p" href="#NetCDF_002d3-Error-Codes">NetCDF-3 Error Codes</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix E NetCDF-4 Error Codes</h2>
<p><a name="index-error-codes_002c-netcdf_002d4-519"></a><a name="index-netcdf_002d4-error-codes-520"></a>
NetCDF-4 uses all error codes from NetCDF-3 (see <a href="#NetCDF_002d3-Error-Codes">NetCDF-3 Error Codes</a>). The following additional error codes were added for new
errors unique to netCDF-4.
<pre class="example"> #define NC_EHDFERR (-101)
#define NC_ECANTREAD (-102)
#define NC_ECANTWRITE (-103)
#define NC_ECANTCREATE (-104)
#define NC_EFILEMETA (-105)
#define NC_EDIMMETA (-106)
#define NC_EATTMETA (-107)
#define NC_EVARMETA (-108)
#define NC_ENOCOMPOUND (-109)
#define NC_EATTEXISTS (-110)
#define NC_ENOTNC4 (-111) /* Attempting netcdf-4 operation on netcdf-3 file. */
#define NC_ESTRICTNC3 (-112) /* Attempting netcdf-4 operation on strict nc3 netcdf-4 file. */
#define NC_EBADGRPID (-113) /* Bad group id. Bad! */
#define NC_EBADTYPEID (-114) /* Bad type id. */
#define NC_EBADFIELDID (-115) /* Bad field id. */
#define NC_EUNKNAME (-116)
</pre>
<div class="node">
<a name="DAP-Error-Codes"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Combined-Index">Combined Index</a>,
Previous: <a rel="previous" accesskey="p" href="#NetCDF_002d4-Error-Codes">NetCDF-4 Error Codes</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Appendix F DAP Error Codes</h2>
<p><a name="index-error-codes_002c-DAP-521"></a><a name="index-DAP-error-codes-522"></a>
If the DAP client is enabled, then the following additional
error codes may occur.
<pre class="example"> #define NC_EDAP (-66) /* Generic DAP error */
#define NC_ECURL (-67) /* Generic libcurl error */
#define NC_EIO (-68) /* Generic IO error */
#define NC_ENODATA (-69) /* Attempt to access variable with no data */
#define NC_EDAPSVC (-70) /* DAP Server side error */
#define NC_EDAS (-71) /* Malformed or inaccessible DAS */
#define NC_EDDS (-72) /* Malformed or inaccessible DDS */
#define NC_EDATADDS (-73) /* Malformed or inaccessible DATADDS */
#define NC_EDAPURL (-74) /* Malformed DAP URL */
#define NC_EDAPCONSTRAINT (-75) /* Malformed DAP Constraint*/
#define NC_EDAP (-66) /* Generic DAP error */
#define NC_ECURL (-67) /* Generic libcurl error */
#define NC_EIO (-68) /* Generic IO error */
#define NC_ENODATA (-69) /* Attempt to access variable with no data */
#define NC_EDAPSVC (-70) /* DAP Server side error */
#define NC_EDAS (-71) /* Malformed or inaccessible DAS */
#define NC_EDDS (-72) /* Malformed or inaccessible DDS */
#define NC_EDATADDS (-73) /* Malformed or inaccessible DATADDS */
#define NC_EDAPURL (-74) /* Malformed DAP URL */
#define NC_EDAPCONSTRAINT (-75) /* Malformed DAP Constraint*/
</pre>
<div class="node">
<a name="Combined-Index"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#DAP-Error-Codes">DAP Error Codes</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">7 Index</h2>
<ul class="index-cp" compact>
<li><a href="#index-abnormal-termination-9">abnormal termination</a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-aborting-define-mode-32">aborting define mode</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-aborting-definitions-33">aborting definitions</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-adding-attributes-35">adding attributes</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-adding-attributes-using-nc_005fredef-97">adding attributes using nc_redef</a>: <a href="#nc_005fredef">nc_redef</a></li>
<li><a href="#index-adding-dimensions-34">adding dimensions</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-adding-dimensions-using-nc_005fredef-95">adding dimensions using nc_redef</a>: <a href="#nc_005fredef">nc_redef</a></li>
<li><a href="#index-adding-variables-36">adding variables</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-adding-variables-using-nc_005fredef-96">adding variables using nc_redef</a>: <a href="#nc_005fredef">nc_redef</a></li>
<li><a href="#index-API_002c-C-summary-509">API, C summary</a>: <a href="#Summary-of-C-Interface">Summary of C Interface</a></li>
<li><a href="#index-appending-data-to-variable-205">appending data to variable</a>: <a href="#Variable-Introduction">Variable Introduction</a></li>
<li><a href="#index-array-section_002c-reading-mapped-386">array section, reading mapped</a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-array-section_002c-reading-subsampled-405">array section, reading subsampled</a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-array-section_002c-writing-295">array section, writing</a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-array-section_002c-writing-mapped-387">array section, writing mapped</a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-array-section_002c-writing-subsampled-404">array section, writing subsampled</a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-array_002c-writing-mapped-331">array, writing mapped</a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-attnum-489"><code>attnum</code></a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-attnump-490"><code>attnump</code></a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-attributes_002c-adding-31">attributes, adding</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-attributes_002c-array-of-strings-438">attributes, array of strings</a>: <a href="#Strings">Strings</a></li>
<li><a href="#index-attributes_002c-character-string-441">attributes, character string</a>: <a href="#Classic-Strings">Classic Strings</a></li>
<li><a href="#index-attributes_002c-copying-497">attributes, copying</a>: <a href="#nc_005fcopy_005fatt">nc_copy_att</a></li>
<li><a href="#index-attributes_002c-creating-473">attributes, creating</a>: <a href="#nc_005fput_005fatt_005f-type">nc_put_att_ type</a></li>
<li><a href="#index-attributes_002c-deleting-505">attributes, deleting</a>: <a href="#nc_005fdel_005fatt">nc_del_att</a></li>
<li><a href="#index-attributes_002c-deleting_002c-introduction-37">attributes, deleting, introduction</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-attributes_002c-finding-length-481">attributes, finding length</a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-attributes_002c-getting-information-about-479">attributes, getting information about</a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-attributes_002c-ID-478">attributes, ID</a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-attributes_002c-inquiring-about-480">attributes, inquiring about</a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-attributes_002c-introduction-469">attributes, introduction</a>: <a href="#Attributes-Introduction">Attributes Introduction</a></li>
<li><a href="#index-attributes_002c-number-of-112">attributes, number of</a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-attributes_002c-operations-on-470">attributes, operations on</a>: <a href="#Attributes-Introduction">Attributes Introduction</a></li>
<li><a href="#index-attributes_002c-reading-493">attributes, reading</a>: <a href="#nc_005fget_005fatt_005f-type">nc_get_att_ type</a></li>
<li><a href="#index-attributes_002c-renaming-501">attributes, renaming</a>: <a href="#nc_005frename_005fatt">nc_rename_att</a></li>
<li><a href="#index-attributes_002c-writing-474">attributes, writing</a>: <a href="#nc_005fput_005fatt_005f-type">nc_put_att_ type</a></li>
<li><a href="#index-backing-out-of-definitions-126">backing out of definitions</a>: <a href="#nc_005fabort">nc_abort</a></li>
<li><a href="#index-backward-compatibility-with-v2-API-511">backward compatibility with v2 API</a>: <a href="#NetCDF-2-C-Transition-Guide">NetCDF 2 C Transition Guide</a></li>
<li><a href="#index-big_002dendian-241">big-endian</a>: <a href="#nc_005fdef_005fvar_005fendian">nc_def_var_endian</a></li>
<li><a href="#index-bit-lengths-of-data-types-206">bit lengths of data types</a>: <a href="#Variable-Types">Variable Types</a></li>
<li><a href="#index-bit-lengths-of-netcdf_002d3-data-types-207">bit lengths of netcdf-3 data types</a>: <a href="#NetCDF_002d3-Variable-Types">NetCDF-3 Variable Types</a></li>
<li><a href="#index-bit-lengths-of-netcdf_002d4-data-types-208">bit lengths of netcdf-4 data types</a>: <a href="#NetCDF_002d4-Atomic-Types">NetCDF-4 Atomic Types</a></li>
<li><a href="#index-byte-vs_002e-char-fill-values-450">byte vs. char fill values</a>: <a href="#Fill-Values">Fill Values</a></li>
<li><a href="#index-byte_002c-zero-442">byte, zero</a>: <a href="#Classic-Strings">Classic Strings</a></li>
<li><a href="#index-C-API-summary-510">C API summary</a>: <a href="#Summary-of-C-Interface">Summary of C Interface</a></li>
<li><a href="#index-call-sequence_002c-typical-10">call sequence, typical</a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-canceling-definitions-127">canceling definitions</a>: <a href="#nc_005fabort">nc_abort</a></li>
<li><a href="#index-character_002dstring-data_002c-writing-445">character-string data, writing</a>: <a href="#Classic-Strings">Classic Strings</a></li>
<li><a href="#index-checksum-234">checksum</a>: <a href="#nc_005fdef_005fvar_005ffletcher32">nc_def_var_fletcher32</a></li>
<li><a href="#index-chunking-214">chunking</a>: <a href="#nc_005fdef_005fvar_005fchunking">nc_def_var_chunking</a></li>
<li><a href="#index-code-templates-12">code templates</a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-compiling-with-netCDF-library-43">compiling with netCDF library</a>: <a href="#Compiling">Compiling</a></li>
<li><a href="#index-compound-types_002c-overview-171">compound types, overview</a>: <a href="#Compound-Types">Compound Types</a></li>
<li><a href="#index-compression_002c-setting-parameters-230">compression, setting parameters</a>: <a href="#nc_005fdef_005fvar_005fdeflate">nc_def_var_deflate</a></li>
<li><a href="#index-contiguous-215">contiguous</a>: <a href="#nc_005fdef_005fvar_005fchunking">nc_def_var_chunking</a></li>
<li><a href="#index-copying-attributes-498">copying attributes</a>: <a href="#nc_005fcopy_005fatt">nc_copy_att</a></li>
<li><a href="#index-create-flag_002c-setting-default-133">create flag, setting default</a>: <a href="#nc_005fset_005fdefault_005fformat">nc_set_default_format</a></li>
<li><a href="#index-creating-a-dataset-8">creating a dataset</a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-creating-variables-211">creating variables</a>: <a href="#nc_005fdef_005fvar">nc_def_var</a></li>
<li><a href="#index-DAP-error-codes-522">DAP error codes</a>: <a href="#DAP-Error-Codes">DAP Error Codes</a></li>
<li><a href="#index-datasets_002c-overview-44">datasets, overview</a>: <a href="#Datasets">Datasets</a></li>
<li><a href="#index-deflate-228">deflate</a>: <a href="#nc_005fdef_005fvar_005fdeflate">nc_def_var_deflate</a></li>
<li><a href="#index-deleting-attributes-506">deleting attributes</a>: <a href="#nc_005fdel_005fatt">nc_del_att</a></li>
<li><a href="#index-dimensions_002c-adding-29">dimensions, adding</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-dimensions_002c-number-of-114">dimensions, number of</a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-endianness-240">endianness</a>: <a href="#nc_005fdef_005fvar_005fendian">nc_def_var_endian</a></li>
<li><a href="#index-entire-variable_002c-reading-369">entire variable, reading</a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-entire-variable_002c-writing-276">entire variable, writing</a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-enum-type-199">enum type</a>: <a href="#Enum-Type">Enum Type</a></li>
<li><a href="#index-error-codes-50">error codes</a>: <a href="#nc_005fstrerror">nc_strerror</a></li>
<li><a href="#index-error-codes_002c-DAP-521">error codes, DAP</a>: <a href="#DAP-Error-Codes">DAP Error Codes</a></li>
<li><a href="#index-error-codes_002c-netcdf_002d3-517">error codes, netcdf-3</a>: <a href="#NetCDF_002d3-Error-Codes">NetCDF-3 Error Codes</a></li>
<li><a href="#index-error-codes_002c-netcdf_002d4-519">error codes, netcdf-4</a>: <a href="#NetCDF_002d4-Error-Codes">NetCDF-4 Error Codes</a></li>
<li><a href="#index-error-handling-40">error handling</a>: <a href="#Errors">Errors</a></li>
<li><a href="#index-file-name-119">file name</a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-file-path-118">file path</a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-fill-224">fill</a>: <a href="#nc_005fdef_005fvar_005ffill">nc_def_var_fill</a></li>
<li><a href="#index-fill-values-449">fill values</a>: <a href="#Fill-Values">Fill Values</a></li>
<li><a href="#index-fletcher32-235">fletcher32</a>: <a href="#nc_005fdef_005fvar_005ffletcher32">nc_def_var_fletcher32</a></li>
<li><a href="#index-format-version-115">format version</a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-groups_002c-overview-138">groups, overview</a>: <a href="#Groups">Groups</a></li>
<li><a href="#index-handle_005ferr-49"><code>handle_err</code></a>: <a href="#nc_005fstrerror">nc_strerror</a></li>
<li><a href="#index-HDF5-chunk-cache-222">HDF5 chunk cache</a>: <a href="#nc_005fget_005fvar_005fchunk_005fcache">nc_get_var_chunk_cache</a></li>
<li><a href="#index-HDF5-chunk-cache-137">HDF5 chunk cache</a>: <a href="#nc_005fget_005fchunk_005fcache">nc_get_chunk_cache</a></li>
<li><a href="#index-HDF5-chunk-cache-135">HDF5 chunk cache</a>: <a href="#nc_005fset_005fchunk_005fcache">nc_set_chunk_cache</a></li>
<li><a href="#index-HDF5-chunk-cache_002c-per_002dvariable-220">HDF5 chunk cache, per-variable</a>: <a href="#nc_005fset_005fvar_005fchunk_005fcache">nc_set_var_chunk_cache</a></li>
<li><a href="#index-HDF5-errors_002c-first-create-83">HDF5 errors, first create</a>: <a href="#nc_005fopen">nc_open</a></li>
<li><a href="#index-HDF5-errors_002c-first-create-63">HDF5 errors, first create</a>: <a href="#nc_005fcreate">nc_create</a></li>
<li><a href="#index-inquiring-about-attributes-483">inquiring about attributes</a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-inquiring-about-variables-248">inquiring about variables</a>: <a href="#nc_005finq_005fvarid">nc_inq_varid</a></li>
<li><a href="#index-interface-descriptions-45">interface descriptions</a>: <a href="#Interface-Descriptions">Interface Descriptions</a></li>
<li><a href="#index-length-of-attributes-482">length of attributes</a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-lenp-488"><code>lenp</code></a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-linking-to-netCDF-library-42">linking to netCDF library</a>: <a href="#Compiling">Compiling</a></li>
<li><a href="#index-little_002dendian-242">little-endian</a>: <a href="#nc_005fdef_005fvar_005fendian">nc_def_var_endian</a></li>
<li><a href="#index-mapped-array-section_002c-writing-423">mapped array section, writing</a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-mapped-array_002c-writing-333">mapped array, writing</a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-name-486"><code>name</code></a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-NC_005f64BIT_005fOFFSET-70"><code>NC_64BIT_OFFSET</code></a>: <a href="#nc_005f_005fcreate">nc__create</a></li>
<li><a href="#index-NC_005f64BIT_005fOFFSET-62"><code>NC_64BIT_OFFSET</code></a>: <a href="#nc_005fcreate">nc_create</a></li>
<li><a href="#index-nc_005f_005fcreate-64"><code>nc__create</code></a>: <a href="#nc_005f_005fcreate">nc__create</a></li>
<li><a href="#index-nc_005f_005fcreate_002c-example-65">nc__create, example</a>: <a href="#nc_005f_005fcreate">nc__create</a></li>
<li><a href="#index-nc_005f_005fcreate_002c-flags-66">nc__create, flags</a>: <a href="#nc_005f_005fcreate">nc__create</a></li>
<li><a href="#index-nc_005f_005fenddef-100"><code>nc__enddef</code></a>: <a href="#nc_005f_005fenddef">nc__enddef</a></li>
<li><a href="#index-nc_005f_005fenddef_002c-example-101">nc__enddef, example</a>: <a href="#nc_005f_005fenddef">nc__enddef</a></li>
<li><a href="#index-nc_005f_005fopen-84"><code>nc__open</code></a>: <a href="#nc_005f_005fopen">nc__open</a></li>
<li><a href="#index-nc_005f_005fopen_002c-example-85">nc__open, example</a>: <a href="#nc_005f_005fopen">nc__open</a></li>
<li><a href="#index-nc_005fabort-124"><code>nc_abort</code></a>: <a href="#nc_005fabort">nc_abort</a></li>
<li><a href="#index-nc_005fabort_002c-example-125">nc_abort, example</a>: <a href="#nc_005fabort">nc_abort</a></li>
<li><a href="#index-NC_005fCLOBBER-75"><code>NC_CLOBBER</code></a>: <a href="#nc_005fcreate_005fpar">nc_create_par</a></li>
<li><a href="#index-NC_005fCLOBBER-68"><code>NC_CLOBBER</code></a>: <a href="#nc_005f_005fcreate">nc__create</a></li>
<li><a href="#index-NC_005fCLOBBER-60"><code>NC_CLOBBER</code></a>: <a href="#nc_005fcreate">nc_create</a></li>
<li><a href="#index-nc_005fclose-102"><code>nc_close</code></a>: <a href="#nc_005fclose">nc_close</a></li>
<li><a href="#index-nc_005fclose_002c-example-103">nc_close, example</a>: <a href="#nc_005fclose">nc_close</a></li>
<li><a href="#index-nc_005fclose_002c-root-group-104">nc_close, root group</a>: <a href="#nc_005fclose">nc_close</a></li>
<li><a href="#index-nc_005fclose_002c-typical-use-7"><code>nc_close, typical use</code></a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-nc_005fcopy_005fatt-495"><code>nc_copy_att</code></a>: <a href="#nc_005fcopy_005fatt">nc_copy_att</a></li>
<li><a href="#index-nc_005fcopy_005fatt_002c-example-496">nc_copy_att, example</a>: <a href="#nc_005fcopy_005fatt">nc_copy_att</a></li>
<li><a href="#index-nc_005fcopy_005fvar-455"><code>nc_copy_var</code></a>: <a href="#nc_005fcopy_005fvar">nc_copy_var</a></li>
<li><a href="#index-nc_005fcreate-56"><code>nc_create</code></a>: <a href="#nc_005fcreate">nc_create</a></li>
<li><a href="#index-nc_005fcreate_002c-example-57">nc_create, example</a>: <a href="#nc_005fcreate">nc_create</a></li>
<li><a href="#index-nc_005fcreate_002c-flags-58">nc_create, flags</a>: <a href="#nc_005fcreate">nc_create</a></li>
<li><a href="#index-nc_005fcreate_002c-typical-use-1"><code>nc_create, typical use</code></a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-nc_005fcreate_005fpar-71"><code>nc_create_par</code></a>: <a href="#nc_005fcreate_005fpar">nc_create_par</a></li>
<li><a href="#index-nc_005fcreate_005fpar_002c-example-72">nc_create_par, example</a>: <a href="#nc_005fcreate_005fpar">nc_create_par</a></li>
<li><a href="#index-nc_005fcreate_005fpar_002c-flags-73">nc_create_par, flags</a>: <a href="#nc_005fcreate_005fpar">nc_create_par</a></li>
<li><a href="#index-nc_005fdef_005fcompound-172"><code>nc_def_compound</code></a>: <a href="#nc_005fdef_005fcompound">nc_def_compound</a></li>
<li><a href="#index-nc_005fdef_005fdim-150"><code>nc_def_dim</code></a>: <a href="#nc_005fdef_005fdim">nc_def_dim</a></li>
<li><a href="#index-nc_005fdef_005fdim_002c-example-151">nc_def_dim, example</a>: <a href="#nc_005fdef_005fdim">nc_def_dim</a></li>
<li><a href="#index-nc_005fdef_005fdim_002c-typical-use-27"><code>nc_def_dim, typical use</code></a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-nc_005fdef_005fdim_002c-typical-use-2"><code>nc_def_dim, typical use</code></a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-nc_005fdef_005fenum-200"><code>nc_def_enum</code></a>: <a href="#nc_005fdef_005fenum">nc_def_enum</a></li>
<li><a href="#index-nc_005fdef_005fgrp-149"><code>nc_def_grp</code></a>: <a href="#nc_005fdef_005fgrp">nc_def_grp</a></li>
<li><a href="#index-nc_005fdef_005fopaque-197"><code>nc_def_opaque</code></a>: <a href="#nc_005fdef_005fopaque">nc_def_opaque</a></li>
<li><a href="#index-nc_005fdef_005fvar-209"><code>nc_def_var</code></a>: <a href="#nc_005fdef_005fvar">nc_def_var</a></li>
<li><a href="#index-nc_005fdef_005fvar_002c-example-210">nc_def_var, example</a>: <a href="#nc_005fdef_005fvar">nc_def_var</a></li>
<li><a href="#index-nc_005fdef_005fvar_002c-typical-use-3"><code>nc_def_var, typical use</code></a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-nc_005fdef_005fvar_005fchunking-213"><code>nc_def_var_chunking</code></a>: <a href="#nc_005fdef_005fvar_005fchunking">nc_def_var_chunking</a></li>
<li><a href="#index-nc_005fdef_005fvar_005fdeflate-227"><code>nc_def_var_deflate</code></a>: <a href="#nc_005fdef_005fvar_005fdeflate">nc_def_var_deflate</a></li>
<li><a href="#index-nc_005fdef_005fvar_005fendian-239"><code>nc_def_var_endian</code></a>: <a href="#nc_005fdef_005fvar_005fendian">nc_def_var_endian</a></li>
<li><a href="#index-nc_005fdef_005fvar_005ffill-223"><code>nc_def_var_fill</code></a>: <a href="#nc_005fdef_005fvar_005ffill">nc_def_var_fill</a></li>
<li><a href="#index-nc_005fdef_005fvar_005ffletcher32-233"><code>nc_def_var_fletcher32</code></a>: <a href="#nc_005fdef_005fvar_005ffletcher32">nc_def_var_fletcher32</a></li>
<li><a href="#index-nc_005fdef_005fvlen-190"><code>nc_def_vlen</code></a>: <a href="#nc_005finq_005fvlen">nc_inq_vlen</a></li>
<li><a href="#index-nc_005fdef_005fvlen-188"><code>nc_def_vlen</code></a>: <a href="#nc_005fdef_005fvlen">nc_def_vlen</a></li>
<li><a href="#index-nc_005fdel_005fatt-503"><code>nc_del_att</code></a>: <a href="#nc_005fdel_005fatt">nc_del_att</a></li>
<li><a href="#index-nc_005fdel_005fatt_002c-example-504">nc_del_att, example</a>: <a href="#nc_005fdel_005fatt">nc_del_att</a></li>
<li><a href="#index-nc_005fenddef-98"><code>nc_enddef</code></a>: <a href="#nc_005fenddef">nc_enddef</a></li>
<li><a href="#index-nc_005fenddef_002c-example-99">nc_enddef, example</a>: <a href="#nc_005fenddef">nc_enddef</a></li>
<li><a href="#index-nc_005fenddef_002c-typical-use-5"><code>nc_enddef, typical use</code></a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-nc_005ffree_005fstring-447"><code>nc_free_string</code></a>: <a href="#nc_005ffree_005fstring">nc_free_string</a></li>
<li><a href="#index-nc_005ffree_005fvlen-194"><code>nc_free_vlen</code></a>: <a href="#nc_005ffree_005fvlens">nc_free_vlens</a></li>
<li><a href="#index-nc_005ffree_005fvlen-192"><code>nc_free_vlen</code></a>: <a href="#nc_005ffree_005fvlen">nc_free_vlen</a></li>
<li><a href="#index-nc_005fget_005fatt_002c-typical-use-23"><code>nc_get_att, typical use</code></a>: <a href="#Reading-Unknown">Reading Unknown</a></li>
<li><a href="#index-nc_005fget_005fatt_002c-typical-use-16"><code>nc_get_att, typical use</code></a>: <a href="#Reading-Known">Reading Known</a></li>
<li><a href="#index-nc_005fget_005fatt_005f-type-491"><code>nc_get_att_ type</code></a>: <a href="#nc_005fget_005fatt_005f-type">nc_get_att_ type</a></li>
<li><a href="#index-nc_005fget_005fatt_005f-type_002c-example-492">nc_get_att_ type, example</a>: <a href="#nc_005fget_005fatt_005f-type">nc_get_att_ type</a></li>
<li><a href="#index-nc_005fget_005fatt_005fubyte-508"><code>nc_get_att_ubyte</code></a>: <a href="#nc_005fatt_005fubyte">nc_att_ubyte</a></li>
<li><a href="#index-nc_005fget_005fchunk_005fcache-221"><code>nc_get_chunk_cache</code></a>: <a href="#nc_005fget_005fvar_005fchunk_005fcache">nc_get_var_chunk_cache</a></li>
<li><a href="#index-nc_005fget_005fchunk_005fcache-136"><code>nc_get_chunk_cache</code></a>: <a href="#nc_005fget_005fchunk_005fcache">nc_get_chunk_cache</a></li>
<li><a href="#index-nc_005fget_005fvar-383"><code>nc_get_var</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_002c-typical-use-24"><code>nc_get_var, typical use</code></a>: <a href="#Reading-Unknown">Reading Unknown</a></li>
<li><a href="#index-nc_005fget_005fvar_002c-typical-use-17"><code>nc_get_var, typical use</code></a>: <a href="#Reading-Known">Reading Known</a></li>
<li><a href="#index-nc_005fget_005fvar1-365"><code>nc_get_var1</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005f-type-348"><code>nc_get_var1_ type</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005f-type_002c-example-349">nc_get_var1_ type, example</a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005fdouble-359"><code>nc_get_var1_double</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005ffloat-358"><code>nc_get_var1_float</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005fint-356"><code>nc_get_var1_int</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005flong-357"><code>nc_get_var1_long</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005flonglong-362"><code>nc_get_var1_longlong</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005fschar-354"><code>nc_get_var1_schar</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005fshort-355"><code>nc_get_var1_short</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005fstring-364"><code>nc_get_var1_string</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005ftext-352"><code>nc_get_var1_text</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005fubyte-464"><code>nc_get_var1_ubyte</code></a>: <a href="#nc_005fvar_005fubyte">nc_var_ubyte</a></li>
<li><a href="#index-nc_005fget_005fvar1_005fuchar-353"><code>nc_get_var1_uchar</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005fuint-361"><code>nc_get_var1_uint</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005fulonglong-363"><code>nc_get_var1_ulonglong</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar1_005fushort-360"><code>nc_get_var1_ushort</code></a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005f-type-366"><code>nc_get_var_ type</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005f-type_002c-example-367">nc_get_var_ type, example</a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005fdouble-377"><code>nc_get_var_double</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005ffloat-376"><code>nc_get_var_float</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005fint-374"><code>nc_get_var_int</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005flong-375"><code>nc_get_var_long</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005flonglong-380"><code>nc_get_var_longlong</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005fschar-372"><code>nc_get_var_schar</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005fshort-373"><code>nc_get_var_short</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005fstring-382"><code>nc_get_var_string</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005ftext-370"><code>nc_get_var_text</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005fubyte-465"><code>nc_get_var_ubyte</code></a>: <a href="#nc_005fvar_005fubyte">nc_var_ubyte</a></li>
<li><a href="#index-nc_005fget_005fvar_005fuchar-371"><code>nc_get_var_uchar</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005fuint-379"><code>nc_get_var_uint</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005fulonglong-381"><code>nc_get_var_ulonglong</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvar_005fushort-378"><code>nc_get_var_ushort</code></a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-nc_005fget_005fvara-401"><code>nc_get_vara</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005f-type-384"><code>nc_get_vara_ type</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005f-type_002c-example-385">nc_get_vara_ type, example</a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005fdouble-395"><code>nc_get_vara_double</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005ffloat-394"><code>nc_get_vara_float</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005fint-392"><code>nc_get_vara_int</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005flong-393"><code>nc_get_vara_long</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005flonglong-398"><code>nc_get_vara_longlong</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005fschar-390"><code>nc_get_vara_schar</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005fshort-391"><code>nc_get_vara_short</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005fstring-400"><code>nc_get_vara_string</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005ftext-388"><code>nc_get_vara_text</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005fubyte-466"><code>nc_get_vara_ubyte</code></a>: <a href="#nc_005fvar_005fubyte">nc_var_ubyte</a></li>
<li><a href="#index-nc_005fget_005fvara_005fuchar-389"><code>nc_get_vara_uchar</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005fuint-397"><code>nc_get_vara_uint</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005fulonglong-399"><code>nc_get_vara_ulonglong</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvara_005fushort-396"><code>nc_get_vara_ushort</code></a>: <a href="#nc_005fget_005fvara_005f-type">nc_get_vara_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm-437"><code>nc_get_varm</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005f-type-420"><code>nc_get_varm_ type</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005f-type_002c-example-421">nc_get_varm_ type, example</a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005fdouble-431"><code>nc_get_varm_double</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005ffloat-430"><code>nc_get_varm_float</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005fint-428"><code>nc_get_varm_int</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005flong-429"><code>nc_get_varm_long</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005flonglong-434"><code>nc_get_varm_longlong</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005fschar-426"><code>nc_get_varm_schar</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005fshort-427"><code>nc_get_varm_short</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005fstring-436"><code>nc_get_varm_string</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005ftext-424"><code>nc_get_varm_text</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005fubyte-468"><code>nc_get_varm_ubyte</code></a>: <a href="#nc_005fvar_005fubyte">nc_var_ubyte</a></li>
<li><a href="#index-nc_005fget_005fvarm_005fuchar-425"><code>nc_get_varm_uchar</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005fuint-433"><code>nc_get_varm_uint</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005fulonglong-435"><code>nc_get_varm_ulonglong</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvarm_005fushort-432"><code>nc_get_varm_ushort</code></a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-nc_005fget_005fvars-419"><code>nc_get_vars</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005f-type-402"><code>nc_get_vars_ type</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005f-type_002c-example-403">nc_get_vars_ type, example</a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005fdouble-413"><code>nc_get_vars_double</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005ffloat-412"><code>nc_get_vars_float</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005fint-410"><code>nc_get_vars_int</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005flong-411"><code>nc_get_vars_long</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005flonglong-416"><code>nc_get_vars_longlong</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005fschar-408"><code>nc_get_vars_schar</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005fshort-409"><code>nc_get_vars_short</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005fstring-418"><code>nc_get_vars_string</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005ftext-406"><code>nc_get_vars_text</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005fubyte-467"><code>nc_get_vars_ubyte</code></a>: <a href="#nc_005fvar_005fubyte">nc_var_ubyte</a></li>
<li><a href="#index-nc_005fget_005fvars_005fuchar-407"><code>nc_get_vars_uchar</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005fuint-415"><code>nc_get_vars_uint</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005fulonglong-417"><code>nc_get_vars_ulonglong</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005fget_005fvars_005fushort-414"><code>nc_get_vars_ushort</code></a>: <a href="#nc_005fget_005fvars_005f-type">nc_get_vars_ type</a></li>
<li><a href="#index-nc_005finq-Family-105"><code>nc_inq Family</code></a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-nc_005finq-Family_002c-example-121">nc_inq Family, example</a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-nc_005finq_002c-typical-use-19"><code>nc_inq, typical use</code></a>: <a href="#Reading-Unknown">Reading Unknown</a></li>
<li><a href="#index-nc_005finq_005fatt-Family-476"><code>nc_inq_att Family</code></a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-nc_005finq_005fatt-Family_002c-example-477">nc_inq_att Family, example</a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-nc_005finq_005fatt_002c-typical-use-22"><code>nc_inq_att, typical use</code></a>: <a href="#Reading-Unknown">Reading Unknown</a></li>
<li><a href="#index-nc_005finq_005fcompound-175"><code>nc_inq_compound</code></a>: <a href="#nc_005finq_005fcompound">nc_inq_compound</a></li>
<li><a href="#index-nc_005finq_005fcompound_005ffield-179"><code>nc_inq_compound_field</code></a>: <a href="#nc_005finq_005fcompound_005ffield">nc_inq_compound_field</a></li>
<li><a href="#index-nc_005finq_005fcompound_005ffielddim_005fsizes-185"><code>nc_inq_compound_fielddim_sizes</code></a>: <a href="#nc_005finq_005fcompound_005ffielddim_005fsizes">nc_inq_compound_fielddim_sizes</a></li>
<li><a href="#index-nc_005finq_005fcompound_005ffieldindex-181"><code>nc_inq_compound_fieldindex</code></a>: <a href="#nc_005finq_005fcompound_005ffieldindex">nc_inq_compound_fieldindex</a></li>
<li><a href="#index-nc_005finq_005fcompound_005ffieldname-180"><code>nc_inq_compound_fieldname</code></a>: <a href="#nc_005finq_005fcompound_005ffieldname">nc_inq_compound_fieldname</a></li>
<li><a href="#index-nc_005finq_005fcompound_005ffieldndims-184"><code>nc_inq_compound_fieldndims</code></a>: <a href="#nc_005finq_005fcompound_005ffieldndims">nc_inq_compound_fieldndims</a></li>
<li><a href="#index-nc_005finq_005fcompound_005ffieldoffset-182"><code>nc_inq_compound_fieldoffset</code></a>: <a href="#nc_005finq_005fcompound_005ffieldoffset">nc_inq_compound_fieldoffset</a></li>
<li><a href="#index-nc_005finq_005fcompound_005ffieldtype-183"><code>nc_inq_compound_fieldtype</code></a>: <a href="#nc_005finq_005fcompound_005ffieldtype">nc_inq_compound_fieldtype</a></li>
<li><a href="#index-nc_005finq_005fcompound_005fname-176"><code>nc_inq_compound_name</code></a>: <a href="#nc_005finq_005fcompound_005fname">nc_inq_compound_name</a></li>
<li><a href="#index-nc_005finq_005fcompound_005fnfields-178"><code>nc_inq_compound_nfields</code></a>: <a href="#nc_005finq_005fcompound_005fnfields">nc_inq_compound_nfields</a></li>
<li><a href="#index-nc_005finq_005fcompound_005fsize-177"><code>nc_inq_compound_size</code></a>: <a href="#nc_005finq_005fcompound_005fsize">nc_inq_compound_size</a></li>
<li><a href="#index-nc_005finq_005fdim-155"><code>nc_inq_dim</code></a>: <a href="#nc_005finq_005fdim-Family">nc_inq_dim Family</a></li>
<li><a href="#index-nc_005finq_005fdim-Family-154"><code>nc_inq_dim Family</code></a>: <a href="#nc_005finq_005fdim-Family">nc_inq_dim Family</a></li>
<li><a href="#index-nc_005finq_005fdim-Family_002c-example-160">nc_inq_dim Family, example</a>: <a href="#nc_005finq_005fdim-Family">nc_inq_dim Family</a></li>
<li><a href="#index-nc_005finq_005fdim_002c-typical-use-20"><code>nc_inq_dim, typical use</code></a>: <a href="#Reading-Unknown">Reading Unknown</a></li>
<li><a href="#index-nc_005finq_005fdimid-156"><code>nc_inq_dimid</code></a>: <a href="#nc_005finq_005fdim-Family">nc_inq_dim Family</a></li>
<li><a href="#index-nc_005finq_005fdimid-152"><code>nc_inq_dimid</code></a>: <a href="#nc_005finq_005fdimid">nc_inq_dimid</a></li>
<li><a href="#index-nc_005finq_005fdimid_002c-example-153">nc_inq_dimid, example</a>: <a href="#nc_005finq_005fdimid">nc_inq_dimid</a></li>
<li><a href="#index-nc_005finq_005fdimid_002c-typical-use-14"><code>nc_inq_dimid, typical use</code></a>: <a href="#Reading-Known">Reading Known</a></li>
<li><a href="#index-nc_005finq_005fdimids-157"><code>nc_inq_dimids</code></a>: <a href="#nc_005finq_005fdim-Family">nc_inq_dim Family</a></li>
<li><a href="#index-nc_005finq_005fdimids-142"><code>nc_inq_dimids</code></a>: <a href="#nc_005finq_005fdimids">nc_inq_dimids</a></li>
<li><a href="#index-nc_005finq_005fdimlen-158"><code>nc_inq_dimlen</code></a>: <a href="#nc_005finq_005fdim-Family">nc_inq_dim Family</a></li>
<li><a href="#index-nc_005finq_005fdimname-159"><code>nc_inq_dimname</code></a>: <a href="#nc_005finq_005fdim-Family">nc_inq_dim Family</a></li>
<li><a href="#index-nc_005finq_005fenum-202"><code>nc_inq_enum</code></a>: <a href="#nc_005finq_005fenum">nc_inq_enum</a></li>
<li><a href="#index-nc_005finq_005fenum_005fident-204"><code>nc_inq_enum_ident</code></a>: <a href="#nc_005finq_005fenum_005fident">nc_inq_enum_ident</a></li>
<li><a href="#index-nc_005finq_005fenum_005fmember-203"><code>nc_inq_enum_member</code></a>: <a href="#nc_005finq_005fenum_005fmember">nc_inq_enum_member</a></li>
<li><a href="#index-nc_005finq_005fformat-110"><code>nc_inq_format</code></a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-nc_005finq_005fgrp_005fparent-148"><code>nc_inq_grp_parent</code></a>: <a href="#nc_005finq_005fgrp_005ffull_005fncid">nc_inq_grp_full_ncid</a></li>
<li><a href="#index-nc_005finq_005fgrp_005fparent-147"><code>nc_inq_grp_parent</code></a>: <a href="#nc_005finq_005fgrp_005fncid">nc_inq_grp_ncid</a></li>
<li><a href="#index-nc_005finq_005fgrp_005fparent-146"><code>nc_inq_grp_parent</code></a>: <a href="#nc_005finq_005fgrp_005fparent">nc_inq_grp_parent</a></li>
<li><a href="#index-nc_005finq_005fgrpname-143"><code>nc_inq_grpname</code></a>: <a href="#nc_005finq_005fgrpname">nc_inq_grpname</a></li>
<li><a href="#index-nc_005finq_005fgrpname_005ffull-144"><code>nc_inq_grpname_full</code></a>: <a href="#nc_005finq_005fgrpname_005ffull">nc_inq_grpname_full</a></li>
<li><a href="#index-nc_005finq_005fgrpname_005flen-145"><code>nc_inq_grpname_len</code></a>: <a href="#nc_005finq_005fgrpname_005flen">nc_inq_grpname_len</a></li>
<li><a href="#index-nc_005finq_005fgrps-140"><code>nc_inq_grps</code></a>: <a href="#nc_005finq_005fgrps">nc_inq_grps</a></li>
<li><a href="#index-nc_005finq_005flibvers-52"><code>nc_inq_libvers</code></a>: <a href="#nc_005finq_005flibvers">nc_inq_libvers</a></li>
<li><a href="#index-nc_005finq_005flibvers_002c-example-55">nc_inq_libvers, example</a>: <a href="#nc_005finq_005flibvers">nc_inq_libvers</a></li>
<li><a href="#index-nc_005finq_005fnatts-108"><code>nc_inq_natts</code></a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-nc_005finq_005fncid-139"><code>nc_inq_ncid</code></a>: <a href="#nc_005finq_005fncid">nc_inq_ncid</a></li>
<li><a href="#index-nc_005finq_005fndims-106"><code>nc_inq_ndims</code></a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-nc_005finq_005fnvars-107"><code>nc_inq_nvars</code></a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-nc_005finq_005fopaque-198"><code>nc_inq_opaque</code></a>: <a href="#nc_005finq_005fopaque">nc_inq_opaque</a></li>
<li><a href="#index-nc_005finq_005fpath-111"><code>nc_inq_path</code></a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-nc_005finq_005ftype-169"><code>nc_inq_type</code></a>: <a href="#nc_005finq_005ftype">nc_inq_type</a></li>
<li><a href="#index-nc_005finq_005ftypeid-168"><code>nc_inq_typeid</code></a>: <a href="#nc_005finq_005ftypeid">nc_inq_typeid</a></li>
<li><a href="#index-nc_005finq_005ftypeids-167"><code>nc_inq_typeids</code></a>: <a href="#nc_005finq_005ftypeids">nc_inq_typeids</a></li>
<li><a href="#index-nc_005finq_005funlimdim-109"><code>nc_inq_unlimdim</code></a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-nc_005finq_005funlimdims-163"><code>nc_inq_unlimdims</code></a>: <a href="#nc_005finq_005funlimdims">nc_inq_unlimdims</a></li>
<li><a href="#index-nc_005finq_005fuser_005ftype-170"><code>nc_inq_user_type</code></a>: <a href="#nc_005finq_005fuser_005ftype">nc_inq_user_type</a></li>
<li><a href="#index-nc_005finq_005fvar-249"><code>nc_inq_var</code></a>: <a href="#nc_005finq_005fvar">nc_inq_var</a></li>
<li><a href="#index-nc_005finq_005fvar_002c-example-254">nc_inq_var, example</a>: <a href="#nc_005finq_005fvar">nc_inq_var</a></li>
<li><a href="#index-nc_005finq_005fvar_002c-typical-use-21"><code>nc_inq_var, typical use</code></a>: <a href="#Reading-Unknown">Reading Unknown</a></li>
<li><a href="#index-nc_005finq_005fvar_005fchunking-218"><code>nc_inq_var_chunking</code></a>: <a href="#nc_005finq_005fvar_005fchunking">nc_inq_var_chunking</a></li>
<li><a href="#index-nc_005finq_005fvar_005fdeflate-231"><code>nc_inq_var_deflate</code></a>: <a href="#nc_005finq_005fvar_005fdeflate">nc_inq_var_deflate</a></li>
<li><a href="#index-nc_005finq_005fvar_005fendian-244"><code>nc_inq_var_endian</code></a>: <a href="#nc_005finq_005fvar_005fendian">nc_inq_var_endian</a></li>
<li><a href="#index-nc_005finq_005fvar_005ffill-226"><code>nc_inq_var_fill</code></a>: <a href="#nc_005finq_005fvar_005ffill">nc_inq_var_fill</a></li>
<li><a href="#index-nc_005finq_005fvar_005ffletcher32-238"><code>nc_inq_var_fletcher32</code></a>: <a href="#nc_005finq_005fvar_005ffletcher32">nc_inq_var_fletcher32</a></li>
<li><a href="#index-nc_005finq_005fvar_005fszip-232"><code>nc_inq_var_szip</code></a>: <a href="#nc_005finq_005fvar_005fszip">nc_inq_var_szip</a></li>
<li><a href="#index-nc_005finq_005fvarid-245"><code>nc_inq_varid</code></a>: <a href="#nc_005finq_005fvarid">nc_inq_varid</a></li>
<li><a href="#index-nc_005finq_005fvarid_002c-example-246">nc_inq_varid, example</a>: <a href="#nc_005finq_005fvarid">nc_inq_varid</a></li>
<li><a href="#index-nc_005finq_005fvarid_002c-typical-use-15"><code>nc_inq_varid, typical use</code></a>: <a href="#Reading-Known">Reading Known</a></li>
<li><a href="#index-nc_005finq_005fvarids-141"><code>nc_inq_varids</code></a>: <a href="#nc_005finq_005fvarids">nc_inq_varids</a></li>
<li><a href="#index-nc_005finq_005fvarname-250"><code>nc_inq_varname</code></a>: <a href="#nc_005finq_005fvar">nc_inq_var</a></li>
<li><a href="#index-nc_005finq_005fvarnatts-253"><code>nc_inq_varnatts</code></a>: <a href="#nc_005finq_005fvar">nc_inq_var</a></li>
<li><a href="#index-nc_005finq_005fvarndims-252"><code>nc_inq_varndims</code></a>: <a href="#nc_005finq_005fvar">nc_inq_var</a></li>
<li><a href="#index-nc_005finq_005fvartype-251"><code>nc_inq_vartype</code></a>: <a href="#nc_005finq_005fvar">nc_inq_var</a></li>
<li><a href="#index-nc_005finsert_005farray_005fcompound-174"><code>nc_insert_array_compound</code></a>: <a href="#nc_005finsert_005farray_005fcompound">nc_insert_array_compound</a></li>
<li><a href="#index-nc_005finsert_005fcompound-173"><code>nc_insert_compound</code></a>: <a href="#nc_005finsert_005fcompound">nc_insert_compound</a></li>
<li><a href="#index-nc_005finsert_005fenum-201"><code>nc_insert_enum</code></a>: <a href="#nc_005finsert_005fenum">nc_insert_enum</a></li>
<li><a href="#index-NC_005fMPIIO-76"><code>NC_MPIIO</code></a>: <a href="#nc_005fcreate_005fpar">nc_create_par</a></li>
<li><a href="#index-NC_005fMPIPOSIX-77"><code>NC_MPIPOSIX</code></a>: <a href="#nc_005fcreate_005fpar">nc_create_par</a></li>
<li><a href="#index-NC_005fNETCDF4-92"><code>NC_NETCDF4</code></a>: <a href="#nc_005fopen_005fpar">nc_open_par</a></li>
<li><a href="#index-NC_005fNOCLOBBER-74"><code>NC_NOCLOBBER</code></a>: <a href="#nc_005fcreate_005fpar">nc_create_par</a></li>
<li><a href="#index-NC_005fNOCLOBBER-67"><code>NC_NOCLOBBER</code></a>: <a href="#nc_005f_005fcreate">nc__create</a></li>
<li><a href="#index-NC_005fNOCLOBBER-59"><code>NC_NOCLOBBER</code></a>: <a href="#nc_005fcreate">nc_create</a></li>
<li><a href="#index-NC_005fNOWRITE-90"><code>NC_NOWRITE</code></a>: <a href="#nc_005fopen_005fpar">nc_open_par</a></li>
<li><a href="#index-NC_005fNOWRITE-86"><code>NC_NOWRITE</code></a>: <a href="#nc_005f_005fopen">nc__open</a></li>
<li><a href="#index-NC_005fNOWRITE-80"><code>NC_NOWRITE</code></a>: <a href="#nc_005fopen">nc_open</a></li>
<li><a href="#index-nc_005fopen-78"><code>nc_open</code></a>: <a href="#nc_005fopen">nc_open</a></li>
<li><a href="#index-nc_005fopen_002c-example-79">nc_open, example</a>: <a href="#nc_005fopen">nc_open</a></li>
<li><a href="#index-nc_005fopen_005fpar-89"><code>nc_open_par</code></a>: <a href="#nc_005fopen_005fpar">nc_open_par</a></li>
<li><a href="#index-nc_005fput_005fatt_002c-typical-use-28"><code>nc_put_att, typical use</code></a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-nc_005fput_005fatt_002c-typical-use-4"><code>nc_put_att, typical use</code></a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-nc_005fput_005fatt_005f-type-471"><code>nc_put_att_ type</code></a>: <a href="#nc_005fput_005fatt_005f-type">nc_put_att_ type</a></li>
<li><a href="#index-nc_005fput_005fatt_005f-type_002c-example-472">nc_put_att_ type, example</a>: <a href="#nc_005fput_005fatt_005f-type">nc_put_att_ type</a></li>
<li><a href="#index-nc_005fput_005fatt_005fubyte-507"><code>nc_put_att_ubyte</code></a>: <a href="#nc_005fatt_005fubyte">nc_att_ubyte</a></li>
<li><a href="#index-nc_005fput_005fvar-291"><code>nc_put_var</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_002c-typical-use-6"><code>nc_put_var, typical use</code></a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-nc_005fput_005fvar1-272"><code>nc_put_var1</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005f-type-256"><code>nc_put_var1_ type</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005f-type_002c-example-257">nc_put_var1_ type, example</a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005fdouble-266"><code>nc_put_var1_double</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005ffloat-265"><code>nc_put_var1_float</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005fint-263"><code>nc_put_var1_int</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005flong-264"><code>nc_put_var1_long</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005flonglong-269"><code>nc_put_var1_longlong</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005fschar-261"><code>nc_put_var1_schar</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005fshort-262"><code>nc_put_var1_short</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005fstring-271"><code>nc_put_var1_string</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005ftext-259"><code>nc_put_var1_text</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005fubyte-459"><code>nc_put_var1_ubyte</code></a>: <a href="#nc_005fvar_005fubyte">nc_var_ubyte</a></li>
<li><a href="#index-nc_005fput_005fvar1_005fuchar-260"><code>nc_put_var1_uchar</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005fuint-268"><code>nc_put_var1_uint</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005fulonglong-270"><code>nc_put_var1_ulonglong</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar1_005fushort-267"><code>nc_put_var1_ushort</code></a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005f-type-273"><code>nc_put_var_ type</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005f-type_002c-example-274">nc_put_var_ type, example</a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005fdouble-285"><code>nc_put_var_double</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005ffloat-284"><code>nc_put_var_float</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005fint-282"><code>nc_put_var_int</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005flong-283"><code>nc_put_var_long</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005flonglong-288"><code>nc_put_var_longlong</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005fschar-280"><code>nc_put_var_schar</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005fshort-281"><code>nc_put_var_short</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005fstring-290"><code>nc_put_var_string</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005ftext-278"><code>nc_put_var_text</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005fubyte-460"><code>nc_put_var_ubyte</code></a>: <a href="#nc_005fvar_005fubyte">nc_var_ubyte</a></li>
<li><a href="#index-nc_005fput_005fvar_005fuchar-279"><code>nc_put_var_uchar</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005fuint-287"><code>nc_put_var_uint</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005fulonglong-289"><code>nc_put_var_ulonglong</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvar_005fushort-286"><code>nc_put_var_ushort</code></a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-nc_005fput_005fvara-310"><code>nc_put_vara</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005f-type-292"><code>nc_put_vara_ type</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005f-type_002c-example-293">nc_put_vara_ type, example</a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005fdouble-304"><code>nc_put_vara_double</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005ffloat-303"><code>nc_put_vara_float</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005fint-301"><code>nc_put_vara_int</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005flong-302"><code>nc_put_vara_long</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005flonglong-307"><code>nc_put_vara_longlong</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005fschar-299"><code>nc_put_vara_schar</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005fshort-300"><code>nc_put_vara_short</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005fstring-309"><code>nc_put_vara_string</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005ftext-297"><code>nc_put_vara_text</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005fubyte-461"><code>nc_put_vara_ubyte</code></a>: <a href="#nc_005fvar_005fubyte">nc_var_ubyte</a></li>
<li><a href="#index-nc_005fput_005fvara_005fuchar-298"><code>nc_put_vara_uchar</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005fuint-306"><code>nc_put_vara_uint</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005fulonglong-308"><code>nc_put_vara_ulonglong</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvara_005fushort-305"><code>nc_put_vara_ushort</code></a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm-347"><code>nc_put_varm</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005f-type-329"><code>nc_put_varm_ type</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005f-type_002c-example-330">nc_put_varm_ type, example</a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005fdouble-341"><code>nc_put_varm_double</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005ffloat-340"><code>nc_put_varm_float</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005fint-338"><code>nc_put_varm_int</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005flong-339"><code>nc_put_varm_long</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005flonglong-344"><code>nc_put_varm_longlong</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005fschar-336"><code>nc_put_varm_schar</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005fshort-337"><code>nc_put_varm_short</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005fstring-346"><code>nc_put_varm_string</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005ftext-334"><code>nc_put_varm_text</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005fubyte-463"><code>nc_put_varm_ubyte</code></a>: <a href="#nc_005fvar_005fubyte">nc_var_ubyte</a></li>
<li><a href="#index-nc_005fput_005fvarm_005fuchar-335"><code>nc_put_varm_uchar</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005fuint-343"><code>nc_put_varm_uint</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005fulonglong-345"><code>nc_put_varm_ulonglong</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvarm_005fushort-342"><code>nc_put_varm_ushort</code></a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-nc_005fput_005fvars-328"><code>nc_put_vars</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005f-type-311"><code>nc_put_vars_ type</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005f-type_002c-example-312">nc_put_vars_ type, example</a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005fdouble-322"><code>nc_put_vars_double</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005ffloat-321"><code>nc_put_vars_float</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005fint-319"><code>nc_put_vars_int</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005flong-320"><code>nc_put_vars_long</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005flonglong-325"><code>nc_put_vars_longlong</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005fschar-317"><code>nc_put_vars_schar</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005fshort-318"><code>nc_put_vars_short</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005fstring-327"><code>nc_put_vars_string</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005ftext-315"><code>nc_put_vars_text</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005fubyte-462"><code>nc_put_vars_ubyte</code></a>: <a href="#nc_005fvar_005fubyte">nc_var_ubyte</a></li>
<li><a href="#index-nc_005fput_005fvars_005fuchar-316"><code>nc_put_vars_uchar</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005fuint-324"><code>nc_put_vars_uint</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005fulonglong-326"><code>nc_put_vars_ulonglong</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fput_005fvars_005fushort-323"><code>nc_put_vars_ushort</code></a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-nc_005fredef-93"><code>nc_redef</code></a>: <a href="#nc_005fredef">nc_redef</a></li>
<li><a href="#index-nc_005fredef_002c-example-94">nc_redef, example</a>: <a href="#nc_005fredef">nc_redef</a></li>
<li><a href="#index-nc_005fredef_002c-typical-use-26"><code>nc_redef, typical use</code></a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-nc_005frename_005fatt-499"><code>nc_rename_att</code></a>: <a href="#nc_005frename_005fatt">nc_rename_att</a></li>
<li><a href="#index-nc_005frename_005fatt_002c-example-500">nc_rename_att, example</a>: <a href="#nc_005frename_005fatt">nc_rename_att</a></li>
<li><a href="#index-nc_005frename_005fdim-161"><code>nc_rename_dim</code></a>: <a href="#nc_005frename_005fdim">nc_rename_dim</a></li>
<li><a href="#index-nc_005frename_005fdim_002c-example-162">nc_rename_dim, example</a>: <a href="#nc_005frename_005fdim">nc_rename_dim</a></li>
<li><a href="#index-nc_005frename_005fvar-451"><code>nc_rename_var</code></a>: <a href="#nc_005frename_005fvar">nc_rename_var</a></li>
<li><a href="#index-nc_005frename_005fvar_002c-example-452">nc_rename_var, example</a>: <a href="#nc_005frename_005fvar">nc_rename_var</a></li>
<li><a href="#index-nc_005fset_005fchunk_005fcache-134"><code>nc_set_chunk_cache</code></a>: <a href="#nc_005fset_005fchunk_005fcache">nc_set_chunk_cache</a></li>
<li><a href="#index-nc_005fset_005fdefault_005fformat-131"><code>nc_set_default_format</code></a>: <a href="#nc_005fset_005fdefault_005fformat">nc_set_default_format</a></li>
<li><a href="#index-nc_005fset_005fdefault_005fformat_002c-example-132">nc_set_default_format, example</a>: <a href="#nc_005fset_005fdefault_005fformat">nc_set_default_format</a></li>
<li><a href="#index-nc_005fset_005ffill-128"><code>nc_set_fill</code></a>: <a href="#nc_005fset_005ffill">nc_set_fill</a></li>
<li><a href="#index-nc_005fset_005ffill_002c-example-129">nc_set_fill, example</a>: <a href="#nc_005fset_005ffill">nc_set_fill</a></li>
<li><a href="#index-nc_005fset_005fvar_005fchunk_005fcache-219"><code>nc_set_var_chunk_cache</code></a>: <a href="#nc_005fset_005fvar_005fchunk_005fcache">nc_set_var_chunk_cache</a></li>
<li><a href="#index-NC_005fSHARE-69"><code>NC_SHARE</code></a>: <a href="#nc_005f_005fcreate">nc__create</a></li>
<li><a href="#index-NC_005fSHARE-61"><code>NC_SHARE</code></a>: <a href="#nc_005fcreate">nc_create</a></li>
<li><a href="#index-NC_005fSHARE-38">NC_SHARE</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-NC_005fSHARE_002c-and-buffering-13"><code>NC_SHARE, and buffering</code></a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-NC_005fSHARE_002c-in-nc_005f_005fopen-88"><code>NC_SHARE, in nc__open</code></a>: <a href="#nc_005f_005fopen">nc__open</a></li>
<li><a href="#index-NC_005fSHARE_002c-in-nc_005fopen-82"><code>NC_SHARE, in nc_open</code></a>: <a href="#nc_005fopen">nc_open</a></li>
<li><a href="#index-nc_005fstrerror-48"><code>nc_strerror</code></a>: <a href="#nc_005fstrerror">nc_strerror</a></li>
<li><a href="#index-nc_005fstrerror_002c-example-51">nc_strerror, example</a>: <a href="#nc_005fstrerror">nc_strerror</a></li>
<li><a href="#index-nc_005fstrerror_002c-introduction-39"><code>nc_strerror, introduction</code></a>: <a href="#Errors">Errors</a></li>
<li><a href="#index-NC_005fSTRING_002c-freeing-448">NC_STRING, freeing</a>: <a href="#nc_005ffree_005fstring">nc_free_string</a></li>
<li><a href="#index-NC_005fSTRING_002c-using-446">NC_STRING, using</a>: <a href="#Arrays-of-Strings">Arrays of Strings</a></li>
<li><a href="#index-nc_005fsync-122"><code>nc_sync</code></a>: <a href="#nc_005fsync">nc_sync</a></li>
<li><a href="#index-nc_005fsync_002c-example-123">nc_sync, example</a>: <a href="#nc_005fsync">nc_sync</a></li>
<li><a href="#index-nc_005fvar_005fpar_005faccess-457"><code>nc_var_par_access</code></a>: <a href="#nc_005fvar_005fpar_005faccess">nc_var_par_access</a></li>
<li><a href="#index-nc_005fvar_005fpar_005faccess_002c-example-458">nc_var_par_access, example</a>: <a href="#nc_005fvar_005fpar_005faccess">nc_var_par_access</a></li>
<li><a href="#index-NC_005fWRITE-91"><code>NC_WRITE</code></a>: <a href="#nc_005fopen_005fpar">nc_open_par</a></li>
<li><a href="#index-NC_005fWRITE-87"><code>NC_WRITE</code></a>: <a href="#nc_005f_005fopen">nc__open</a></li>
<li><a href="#index-NC_005fWRITE-81"><code>NC_WRITE</code></a>: <a href="#nc_005fopen">nc_open</a></li>
<li><a href="#index-ncid-484"><code>ncid</code></a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-netCDF-2-transition-guide-515">netCDF 2 transition guide</a>: <a href="#NetCDF-2-C-Transition-Guide">NetCDF 2 C Transition Guide</a></li>
<li><a href="#index-netCDF-library-version-54">netCDF library version</a>: <a href="#nc_005finq_005flibvers">nc_inq_libvers</a></li>
<li><a href="#index-netcdf_002d3-error-codes-518">netcdf-3 error codes</a>: <a href="#NetCDF_002d3-Error-Codes">NetCDF-3 Error Codes</a></li>
<li><a href="#index-netcdf_002d4-error-codes-520">netcdf-4 error codes</a>: <a href="#NetCDF_002d4-Error-Codes">NetCDF-4 Error Codes</a></li>
<li><a href="#index-opaque-type-196">opaque type</a>: <a href="#Opaque-Type">Opaque Type</a></li>
<li><a href="#index-parallel-access-46">parallel access</a>: <a href="#parallel-access">parallel access</a></li>
<li><a href="#index-parallel-example-47">parallel example</a>: <a href="#parallel-access">parallel access</a></li>
<li><a href="#index-path-117">path</a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-reading-attributes-494">reading attributes</a>: <a href="#nc_005fget_005fatt_005f-type">nc_get_att_ type</a></li>
<li><a href="#index-reading-entire-variable-368">reading entire variable</a>: <a href="#nc_005fget_005fvar_005f-type">nc_get_var_ type</a></li>
<li><a href="#index-reading-netCDF-dataset-with-known-names-18">reading netCDF dataset with known names</a>: <a href="#Reading-Known">Reading Known</a></li>
<li><a href="#index-reading-netCDF-dataset-with-unknown-names-25">reading netCDF dataset with unknown names</a>: <a href="#Reading-Unknown">Reading Unknown</a></li>
<li><a href="#index-reading-single-value-350">reading single value</a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-renaming-attributes-502">renaming attributes</a>: <a href="#nc_005frename_005fatt">nc_rename_att</a></li>
<li><a href="#index-renaming-variable-453">renaming variable</a>: <a href="#nc_005frename_005fvar">nc_rename_var</a></li>
<li><a href="#index-single-value_002c-reading-351">single value, reading</a>: <a href="#nc_005fget_005fvar1_005f-type">nc_get_var1_ type</a></li>
<li><a href="#index-string-arrays-439">string arrays</a>: <a href="#Strings">Strings</a></li>
<li><a href="#index-strings-in-classic-model-440">strings in classic model</a>: <a href="#Classic-Strings">Classic Strings</a></li>
<li><a href="#index-subsampled-array_002c-writing-314">subsampled array, writing</a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-templates_002c-code-11">templates, code</a>: <a href="#Use-of-the-NetCDF-Library">Use of the NetCDF Library</a></li>
<li><a href="#index-transition-guide_002c-netCDF-2-516">transition guide, netCDF 2</a>: <a href="#NetCDF-2-C-Transition-Guide">NetCDF 2 C Transition Guide</a></li>
<li><a href="#index-URL-120">URL</a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-user-defined-types-165">user defined types</a>: <a href="#User-Defined-Data-Types">User Defined Data Types</a></li>
<li><a href="#index-user-defined-types_002c-overview-166">user defined types, overview</a>: <a href="#User-Defined-Types">User Defined Types</a></li>
<li><a href="#index-variable-length-array-type_002c-overview-164">variable length array type, overview</a>: <a href="#User-Defined-Data-Types">User Defined Data Types</a></li>
<li><a href="#index-variable-length-arrays-186">variable length arrays</a>: <a href="#Variable-Length-Array">Variable Length Array</a></li>
<li><a href="#index-variable_002c-copying-456">variable, copying</a>: <a href="#nc_005fcopy_005fvar">nc_copy_var</a></li>
<li><a href="#index-variable_002c-renaming-454">variable, renaming</a>: <a href="#nc_005frename_005fvar">nc_rename_var</a></li>
<li><a href="#index-variable_002c-writing-entire-277">variable, writing entire</a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-variables_002c-adding-30">variables, adding</a>: <a href="#Adding">Adding</a></li>
<li><a href="#index-variables_002c-checksum-237">variables, checksum</a>: <a href="#nc_005fdef_005fvar_005ffletcher32">nc_def_var_fletcher32</a></li>
<li><a href="#index-variables_002c-chunking-216">variables, chunking</a>: <a href="#nc_005fdef_005fvar_005fchunking">nc_def_var_chunking</a></li>
<li><a href="#index-variables_002c-contiguous-217">variables, contiguous</a>: <a href="#nc_005fdef_005fvar_005fchunking">nc_def_var_chunking</a></li>
<li><a href="#index-variables_002c-creating-212">variables, creating</a>: <a href="#nc_005fdef_005fvar">nc_def_var</a></li>
<li><a href="#index-variables_002c-endian-243">variables, endian</a>: <a href="#nc_005fdef_005fvar_005fendian">nc_def_var_endian</a></li>
<li><a href="#index-variables_002c-fill-225">variables, fill</a>: <a href="#nc_005fdef_005fvar_005ffill">nc_def_var_fill</a></li>
<li><a href="#index-variables_002c-fletcher32-236">variables, fletcher32</a>: <a href="#nc_005fdef_005fvar_005ffletcher32">nc_def_var_fletcher32</a></li>
<li><a href="#index-variables_002c-getting-name-255">variables, getting name</a>: <a href="#nc_005finq_005fvar">nc_inq_var</a></li>
<li><a href="#index-variables_002c-inquiring-about-247">variables, inquiring about</a>: <a href="#nc_005finq_005fvarid">nc_inq_varid</a></li>
<li><a href="#index-variables_002c-number-of-113">variables, number of</a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-variables_002c-setting-deflate-229">variables, setting deflate</a>: <a href="#nc_005fdef_005fvar_005fdeflate">nc_def_var_deflate</a></li>
<li><a href="#index-varid-485"><code>varid</code></a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-version-of-netCDF_002c-discovering-53">version of netCDF, discovering</a>: <a href="#nc_005finq_005flibvers">nc_inq_libvers</a></li>
<li><a href="#index-version_002c-format-116">version, format</a>: <a href="#nc_005finq-Family">nc_inq Family</a></li>
<li><a href="#index-VLEN-187">VLEN</a>: <a href="#Variable-Length-Array">Variable Length Array</a></li>
<li><a href="#index-VLEN_002c-defining-195">VLEN, defining</a>: <a href="#nc_005ffree_005fvlens">nc_free_vlens</a></li>
<li><a href="#index-VLEN_002c-defining-193">VLEN, defining</a>: <a href="#nc_005ffree_005fvlen">nc_free_vlen</a></li>
<li><a href="#index-VLEN_002c-defining-191">VLEN, defining</a>: <a href="#nc_005finq_005fvlen">nc_inq_vlen</a></li>
<li><a href="#index-VLEN_002c-defining-189">VLEN, defining</a>: <a href="#nc_005fdef_005fvlen">nc_def_vlen</a></li>
<li><a href="#index-write-errors-41">write errors</a>: <a href="#Errors">Errors</a></li>
<li><a href="#index-write-fill-mode_002c-setting-130">write fill mode, setting</a>: <a href="#nc_005fset_005ffill">nc_set_fill</a></li>
<li><a href="#index-writing-array-section-294">writing array section</a>: <a href="#nc_005fput_005fvara_005f-type">nc_put_vara_ type</a></li>
<li><a href="#index-writing-attributes-475">writing attributes</a>: <a href="#nc_005fput_005fatt_005f-type">nc_put_att_ type</a></li>
<li><a href="#index-writing-character_002dstring-data-444">writing character-string data</a>: <a href="#Classic-Strings">Classic Strings</a></li>
<li><a href="#index-writing-entire-variable-275">writing entire variable</a>: <a href="#nc_005fput_005fvar_005f-type">nc_put_var_ type</a></li>
<li><a href="#index-writing-mapped-array-332">writing mapped array</a>: <a href="#nc_005fput_005fvarm_005f-type">nc_put_varm_ type</a></li>
<li><a href="#index-writing-mapped-array-section-422">writing mapped array section</a>: <a href="#nc_005fget_005fvarm_005f-type">nc_get_varm_ type</a></li>
<li><a href="#index-writing-single-value-258">writing single value</a>: <a href="#nc_005fput_005fvar1_005f-type">nc_put_var1_ type</a></li>
<li><a href="#index-writing-subsampled-array-313">writing subsampled array</a>: <a href="#nc_005fput_005fvars_005f-type">nc_put_vars_ type</a></li>
<li><a href="#index-XDR-library-514">XDR library</a>: <a href="#NetCDF-2-C-Transition-Guide">NetCDF 2 C Transition Guide</a></li>
<li><a href="#index-xtypep-487"><code>xtypep</code></a>: <a href="#nc_005finq_005fatt-Family">nc_inq_att Family</a></li>
<li><a href="#index-zero-byte-443">zero byte</a>: <a href="#Classic-Strings">Classic Strings</a></li>
<li><a href="#index-zero-length-edge-512">zero length edge</a>: <a href="#NetCDF-2-C-Transition-Guide">NetCDF 2 C Transition Guide</a></li>
<li><a href="#index-zero-valued-count-vector-513">zero valued count vector</a>: <a href="#NetCDF-2-C-Transition-Guide">NetCDF 2 C Transition Guide</a></li>
</ul></body></html>
|