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
|
5 User Defined Data Types {#f90-user-defined-data-types}
=========================
5.1 User Defined Types Introduction {#f90-user-defined-types-introduction}
=========================
[TOC]
NetCDF-4 has added support for four different user defined data types.
`compound type`
: Like a C struct, a compound type is a collection of types, including
other user defined types, in one package.
`variable length array type`
: The variable length array may be used to store ragged arrays.
`opaque type`
: This type has only a size per element, and no other
type information.
`enum type`
: Like an enumeration in C, this type lets you assign text values to
integer values, and store the integer values.
Users may construct user defined type with the various NF90\_DEF\_\*
functions described in this section. They may learn about user defined
types by using the NF90\_INQ\_ functions defined in this section.
Once types are constructed, define variables of the new type with
NF90\_DEF\_VAR (see section [Create a Variable: `NF90_DEF_VAR`](#NF90_005fDEF_005fVAR)). Write to them with
NF90\_PUT\_VAR (see section [Writing Data Values: `NF90_PUT_VAR`](#NF90_005fPUT_005fVAR)). Read data of user-defined type
with NF90\_GET\_VAR (see section [Reading Data Values: `NF90_GET_VAR`](#NF90_005fGET_005fVAR)).
Create attributes of the new type with NF90\_PUT\_ATT (see section
[Create an Attribute: NF90\_PUT\_ATT](#NF90_005fPUT_005fATT)). Read
attributes of the new type with NF90\_GET\_ATT (see section [Get
Attribute’s Values: NF90\_GET\_ATT](#NF90_005fGET_005fATT)).
5.2 Learn the IDs of All Types in Group: NF90_INQ_TYPEIDS {#f90-learn-the-ids-of-all-types-in-group-nf90_inq_typeids}
=========================
Learn the number of types defined in a group, and their IDs.
## Usage
~~~~.fortran
function nf90_inq_typeids(ncid, ntypes, typeids)
integer, intent(in) :: ncid
integer, intent(out) :: ntypes
integer, intent(out) :: typeids
integer :: nf90_inq_typeids
~~~~
`NCID`
: The group id.
`NTYPES`
: A pointer to int which will get the number of types defined in
the group. If NULL, ignored.
`TYPEIDS`
: A pointer to an int array which will get the typeids. If
NULL, ignored.
## Errors
`NF90_NOERR`
: No error.
`NF90_BADID`
: Bad ncid.
## Example
5.3 Find a Typeid from Group and Name: nf90_inq_typeid {#f90-find-a-typeid-from-group-and-name-nf90_inq_typeid}
=========================
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.
## Usage
~~~~.fortran
int nf90_inq_typeid(int ncid, char *name, nf90_type *typeidp);
~~~~
`ncid`
: The group id.
`name`
: The name of a type.
`typeidp`
: The typeid, if found.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADID`
: Bad ncid.
`NF90_EBADTYPE`
: Can’t find type.
## Example
5.4 Learn About a User Defined Type: NF90_INQ_TYPE {#f90-learn-about-a-user-defined-type-nf90_inq_type}
=========================
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.
For even more information about a user defined type [Learn About a User
Defined Type: NF90\_INQ\_USER\_TYPE](#NF90_005fINQ_005fUSER_005fTYPE).
## Usage
~~~~.fortran
function nf90_inq_type(ncid, xtype, name, size)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
character (len = *), intent(out) :: name
integer, intent(out) :: size
integer :: nf90_inq_type
~~~~
`NCID`
: The ncid for the group containing the type (ignored for
atomic types).
`XTYPE`
: The typeid for this type, as returned by NF90\_DEF\_COMPOUND,
NF90\_DEF\_OPAQUE, NF90\_DEF\_ENUM, NF90\_DEF\_VLEN, or
NF90\_INQ\_VAR, or as found in netcdf.inc in the list of atomic
types (NF90\_CHAR, NF90\_INT, etc.).
`NAME`
: The name of the user defined type will be copied here. It will be
NF90\_MAX\_NAME bytes or less. For atomic types, the type name from
CDL will be given.
`SIZEP`
: The (in-memory) size of the type (in bytes) will be copied here.
VLEN type size is the size of one element of the VLEN. String size
is returned as the size of one char.
## Return Codes
`NF90_NOERR`
: No error.
`NF90_EBADTYPEID`
: Bad typeid.
`NF90_ENOTNC4`
: Seeking a user-defined type in a netCDF-3 file.
`NF90_ESTRICTNC3`
: Seeking a user-defined type in a netCDF-4 file for which classic
model has been turned on.
`NF90_EBADGRPID`
: Bad group ID in ncid.
`NF90_EBADID`
: Type ID not found.
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
## Example
5.5 Learn About a User Defined Type: NF90_INQ_USER_TYPE {#f90-learn-about-a-user-defined-type-nf90_inq_user_type}
=========================
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.
## Usage
~~~~.fortran
function nf90_inq_user_type(ncid, xtype, name, size, base_typeid, nfields, class)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
character (len = *), intent(out) :: name
integer, intent(out) :: size
integer, intent(out) :: base_typeid
integer, intent(out) :: nfields
integer, intent(out) :: class
integer :: nf90_inq_user_type
~~~~
`NCID`
: The ncid for the group containing the user defined type.
`XTYPE`
: The typeid for this type, as returned by NF90\_DEF\_COMPOUND,
NF90\_DEF\_OPAQUE, NF90\_DEF\_ENUM, NF90\_DEF\_VLEN,
or NF90\_INQ\_VAR.
`NAME`
: The name of the user defined type will be copied here. It will be
NF90\_MAX\_NAME bytes or less.
`SIZE`
: The (in-memory) size of the user defined type will be copied here.
`BASE_NF90_TYPE`
: The base typeid will be copied here for vlen and enum types.
`NFIELDS`
: The number of fields will be copied here for enum and
compound types.
`CLASS`
: The class of the user defined type, NF90\_VLEN, NF90\_OPAQUE,
NF90\_ENUM, or NF90\_COMPOUND, will be copied here.
## Errors
`NF90_NOERR`
: No error.
`NF90_EBADTYPEID`
: Bad typeid.
`NF90_EBADFIELDID`
: Bad fieldid.
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
## Example
## 5.5.1 Set a Variable Length Array with NF90_PUT_VLEN_ELEMENT {#f90-set-a-variable-length-array-with-nf90_put_vlen_element}
Use this to set the element of the (potentially) n-dimensional array of
VLEN. That is, this sets the data in one variable length array.
### Usage
~~~~.fortran
INTEGER FUNCTION NF90_PUT_VLEN_ELEMENT(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) VLEN_ELEMENT, INTEGER LEN, DATA)
~~~~
`NCID`
: The ncid of the file that contains the VLEN type.
`XTYPE`
: The type of the VLEN.
`VLEN_ELEMENT`
: The VLEN element to be set.
`LEN`
: The number of entries in this array.
`DATA`
: The data to be stored. Must match the base type of this VLEN.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADTYPE`
: Can’t find the typeid.
`NF90_EBADID`
: ncid invalid.
`NF90_EBADGRPID`
: Group ID part of ncid was invalid.
### Example
This example is from nf90\_test/ftst\_vars4.F.
~~~~.fortran
C Set up the vlen with this helper function, since F90 can't deal
C with pointers.
retval = nf90_put_vlen_element(ncid, vlen_typeid, vlen,
& vlen_len, data1)
if (retval .ne. nf90_noerr) call handle_err(retval)
~~~~
## 5.5.2 Set a Variable Length Array with NF90_GET_VLEN_ELEMENT {#f90-set-a-variable-length-array-with-nf90_get_vlen_element}
Use this to set the element of the (potentially) n-dimensional array of
VLEN. That is, this sets the data in one variable length array.
### Usage
~~~~.fortran
INTEGER FUNCTION NF90_GET_VLEN_ELEMENT(INTEGER NCID, INTEGER XTYPE,
CHARACTER*(*) VLEN_ELEMENT, INTEGER LEN, DATA)
~~~~
`NCID`
: The ncid of the file that contains the VLEN type.
`XTYPE`
: The type of the VLEN.
`VLEN_ELEMENT`
: The VLEN element to be set.
`LEN`
: This will be set to the number of entries in this array.
`DATA`
: The data will be copied here. Sufficient storage must be available
or bad things will happen to you.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADTYPE`
: Can’t find the typeid.
`NF90_EBADID`
: ncid invalid.
`NF90_EBADGRPID`
: Group ID part of ncid was invalid.
### Example
5.6 Compound Types Introduction {#f90-compound-types-introduction}
=========================
NetCDF-4 added support for compound types, which allow users to
construct a new type - a combination of other types, like a C struct.
Compound types are not supported in classic or 64-bit offset format
files.
To write data in a compound type, first use nf90\_def\_compound to
create the type, multiple calls to nf90\_insert\_compound to add to the
compound type, and then write data with the appropriate nf90\_put\_var1,
nf90\_put\_vara, nf90\_put\_vars, or nf90\_put\_varm call.
To read data written in a compound type, you must know its structure.
Use the NF90\_INQ\_COMPOUND functions to learn about the compound type.
In Fortran a character buffer must be used for the compound data. The
user must read the data from within that buffer in the same way that the
C compiler which compiled netCDF would store the structure.
The use of compound types introduces challenges and portability issues
for Fortran users.
## 5.6.1 Creating a Compound Type: NF90_DEF_COMPOUND {#f90-creating-a-compound-type-nf90_def_compound}
Create a compound type. Provide an ncid, a name, and a total size (in
bytes) of one element of the completed compound type.
After calling this function, fill out the type with repeated calls to
NF90\_INSERT\_COMPOUND (see section [Inserting a Field into a Compound
Type: NF90\_INSERT\_COMPOUND](#NF90_005fINSERT_005fCOMPOUND)). Call
NF90\_INSERT\_COMPOUND once for each field you wish to insert into the
compound type.
Note that there does not seem to be a fully portable way to read such
types into structures in Fortran 90 (and there are no structures in
Fortran 77). Dozens of top-notch programmers are swarming over this
problem in a sub-basement of Unidata’s giant underground bunker in
Wyoming.
Fortran users may use character buffers to read and write compound
types. User are invited to try classic Fortran features such as the
equivilence and the common block statment.
### Usage
~~~~.fortran
function nf90_def_compound(ncid, size, name, typeid)
integer, intent(in) :: ncid
integer, intent(in) :: size
character (len = *), intent(in) :: name
integer, intent(out) :: typeid
integer :: nf90_def_compound
~~~~
`NCID`
: The groupid where this compound type will be created.
`SIZE`
: The size, in bytes, of the compound type.
`NAME`
: The name of the new compound type.
`TYPEIDP`
: The typeid of the new type will be placed here.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADID`
: Bad group id.
`NF90_ENAMEINUSE`
: That name is in use. Compound type names must be unique in the
data file.
`NF90_EMAXNAME`
: Name exceeds max length NF90\_MAX\_NAME.
`NF90_EBADNAME`
: Name contains illegal characters.
`NF90_ENOTNC4`
: 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 NF90\_NETCDF4. (see section
[NF90\_OPEN](#NF90_005fOPEN)).
`NF90_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see section
[NF90\_OPEN](#NF90_005fOPEN)).
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
`NF90_EPERM`
: Attempt to write to a read-only file.
`NF90_ENOTINDEFINE`
: Not in define mode.
### Example
## 5.6.2 Inserting a Field into a Compound Type: NF90_INSERT_COMPOUND {#f90-inserting-a-field-into-a-compound-type-nf90_insert_compound}
Insert a named field into a compound type.
### Usage
~~~~.fortran
function nf90_insert_compound(ncid, xtype, name, offset, field_typeid)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
character (len = *), intent(in) :: name
integer, intent(in) :: offset
integer, intent(in) :: field_typeid
integer :: nf90_insert_compound
~~~~
`TYPEID`
: The typeid for this compound type, as returned by
NF90\_DEF\_COMPOUND, or NF90\_INQ\_VAR.
`NAME`
: The name of the new field.
`OFFSET`
: Offset in byte from the beginning of the compound type for
this field.
`FIELD_TYPEID`
: The type of the field to be inserted.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADID`
: Bad group id.
`NF90_ENAMEINUSE`
: That name is in use. Field names must be unique within a
compound type.
`NF90_EMAXNAME`
: Name exceed max length NF90\_MAX\_NAME.
`NF90_EBADNAME`
: Name contains illegal characters.
`NF90_ENOTNC4`
: 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 NF90\_NETCDF4. (see section
[NF90\_OPEN](#NF90_005fOPEN)).
`NF90_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see section
[NF90\_OPEN](#NF90_005fOPEN)).
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
`NF90_ENOTINDEFINE`
: Not in define mode.
### Example
## 5.6.3 Inserting an Array Field into a Compound Type: NF90_INSERT_ARRAY_COMPOUND {#f90-inserting-an-array-field-into-a-compound-type-nf90_insert_array_compound}
Insert a named array field into a compound type.
### Usage
~~~~.fortran
function nf90_insert_array_compound(ncid, xtype, name, offset, field_typeid, &
ndims, dim_sizes)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
character (len = *), intent(in) :: name
integer, intent(in) :: offset
integer, intent(in) :: field_typeid
integer, intent(in) :: ndims
integer, intent(in) :: dim_sizes
integer :: nf90_insert_array_compound
~~~~
`NCID`
: The ID of the file that contains the array type and the
compound type.
`XTYPE`
: The typeid for this compound type, as returned by
nf90\_def\_compound, or nf90\_inq\_var.
`NAME`
: The name of the new field.
`OFFSET`
: Offset in byte from the beginning of the compound type for
this field.
`FIELD_TYPEID`
: The base type of the array to be inserted.
`NDIMS`
: The number of dimensions for the array to be inserted.
`DIM_SIZES`
: An array containing the sizes of each dimension.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADID`
: Bad group id.
`NF90_ENAMEINUSE`
: That name is in use. Field names must be unique within a
compound type.
`NF90_EMAXNAME`
: Name exceed max length NF90\_MAX\_NAME.
`NF90_EBADNAME`
: Name contains illegal characters.
`NF90_ENOTNC4`
: 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 NF90\_NETCDF4. (see section
[NF90\_OPEN](#NF90_005fOPEN)).
`NF90_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see section
[NF90\_OPEN](#NF90_005fOPEN)).
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
`NF90_ENOTINDEFINE`
: Not in define mode.
`NF90_ETYPEDEFINED`
: 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.
### Example
## 5.6.4 Learn About a Compound Type: NF90_INQ_COMPOUND {#f90-learn-about-a-compound-type-nf90_inq_compound}
Get the number of fields, length in bytes, and name of a compound type.
In addtion to the NF90\_INQ\_COMPOUND function, three additional
functions are provided which get only the name, size, and number of
fields.
### Usage
~~~~.fortran
function nf90_inq_compound(ncid, xtype, name, size, nfields)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
character (len = *), intent(out) :: name
integer, intent(out) :: size
integer, intent(out) :: nfields
integer :: nf90_inq_compound
function nf90_inq_compound_name(ncid, xtype, name)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
character (len = *), intent(out) :: name
integer :: nf90_inq_compound_name
function nf90_inq_compound_size(ncid, xtype, size)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
integer, intent(out) :: size
integer :: nf90_inq_compound_size
function nf90_inq_compound_nfields(ncid, xtype, nfields)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
integer, intent(out) :: nfields
integer :: nf90_inq_compound_nfields
~~~~
`NCID`
: The ID of any group in the file that contains the compound type.
`XTYPE`
: The typeid for this compound type, as returned by
NF90\_DEF\_COMPOUND, or NF90\_INQ\_VAR.
`NAME`
: Character array which will get the name of the compound type. It
will have a maximum length of NF90\_MAX\_NAME.
`SIZEP`
: The size of the compound type in bytes will be put here.
`NFIELDSP`
: The number of fields in the compound type will be placed here.
### Return Codes
`NF90_NOERR`
: No error.
`NF90_EBADID`
: Couldn’t find this ncid.
`NF90_ENOTNC4`
: Not a netCDF-4/HDF5 file.
`NF90_ESTRICTNC3`
: A netCDF-4/HDF5 file, but with CLASSIC\_MODEL. No user defined types
are allowed in the classic model.
`NF90_EBADTYPE`
: This type not a compound type.
`NF90_EBADTYPEID`
: Bad type id.
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
### Example
## 5.6.5 Learn About a Field of a Compound Type: NF90_INQ_COMPOUND_FIELD {#f90-learn-about-a-field-of-a-compound-type-nf90_inq_compound_field}
Get information about one of the fields of a compound type.
### Usage
~~~~.fortran
function nf90_inq_compound_field(ncid, xtype, fieldid, name, offset, &
field_typeid, ndims, dim_sizes)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
integer, intent(in) :: fieldid
character (len = *), intent(out) :: name
integer, intent(out) :: offset
integer, intent(out) :: field_typeid
integer, intent(out) :: ndims
integer, intent(out) :: dim_sizes
integer :: nf90_inq_compound_field
function nf90_inq_compound_fieldname(ncid, xtype, fieldid, name)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
integer, intent(in) :: fieldid
character (len = *), intent(out) :: name
integer :: nf90_inq_compound_fieldname
function nf90_inq_compound_fieldindex(ncid, xtype, name, fieldid)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
character (len = *), intent(in) :: name
integer, intent(out) :: fieldid
integer :: nf90_inq_compound_fieldindex
function nf90_inq_compound_fieldoffset(ncid, xtype, fieldid, offset)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
integer, intent(in) :: fieldid
integer, intent(out) :: offset
integer :: nf90_inq_compound_fieldoffset
function nf90_inq_compound_fieldtype(ncid, xtype, fieldid, field_typeid)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
integer, intent(in) :: fieldid
integer, intent(out) :: field_typeid
integer :: nf90_inq_compound_fieldtype
function nf90_inq_compound_fieldndims(ncid, xtype, fieldid, ndims)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
integer, intent(in) :: fieldid
integer, intent(out) :: ndims
integer :: nf90_inq_compound_fieldndims
function nf90_inq_cmp_fielddim_sizes(ncid, xtype, fieldid, dim_sizes)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
integer, intent(in) :: fieldid
integer, intent(out) :: dim_sizes
integer :: nf90_inq_cmp_fielddim_sizes
~~~~
`NCID`
: The groupid where this compound type exists.
`XTYPE`
: The typeid for this compound type, as returned by
NF90\_DEF\_COMPOUND, or NF90\_INQ\_VAR.
`FIELDID`
: A one-based index number specifying a field in the compound type.
`NAME`
: A character array which will get the name of the field. The name
will be NF90\_MAX\_NAME characters, at most.
`OFFSETP`
: An integer which will get the offset of the field.
`FIELD_TYPEID`
: An integer which will get the typeid of the field.
`NDIMSP`
: An integer which will get the number of dimensions of the field.
`DIM_SIZESP`
: An integer array which will get the dimension sizes of the field.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADTYPEID`
: Bad type id.
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
### Example
5.7 Variable Length Array Introduction {#f90-variable-length-array-introduction}
=========================
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 NF90\_CLASSIC\_MODEL flag.
A variable length array is represented in C as a structure from HDF5,
the nf90\_vlen\_t structure. It contains a len member, which contains
the length of that array, and a pointer to the array.
So an array of VLEN in C is an array of nc\_vlen\_t structures. The only
way to handle this in Fortran is with a character buffer sized correctly
for the platform.
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.
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.
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.
Compression is permitted but may not be effective for VLEN data, because
the compression is applied to the nc\_vlen\_t structures, rather than
the actual data.
## 5.7.1 Define a Variable Length Array (VLEN): NF90_DEF_VLEN {#f90-define-a-variable-length-array-vlen-nf90_def_vlen}
Use this function to define a variable length array type.
### Usage
~~~~.fortran
function nf90_def_vlen(ncid, name, base_typeid, xtypeid)
integer, intent(in) :: ncid
character (len = *), intent(in) :: name
integer, intent(in) :: base_typeid
integer, intent(out) :: xtypeid
integer :: nf90_def_vlen
~~~~
`NCID`
: The ncid of the file to create the VLEN type in.
`NAME`
: A name for the VLEN type.
`BASE_TYPEID`
: The typeid of the base type of the VLEN. For example, for a VLEN of
shorts, the base type is NF90\_SHORT. This can be a user
defined type.
`XTYPEP`
: The typeid of the new VLEN type will be set here.
### Errors
`NF90_NOERR`
: No error.
`NF90_EMAXNAME`
: NF90\_MAX\_NAME exceeded.
`NF90_ENAMEINUSE`
: Name is already in use.
`NF90_EBADNAME`
: Attribute or variable name contains illegal characters.
`NF90_EBADID`
: ncid invalid.
`NF90_EBADGRPID`
: Group ID part of ncid was invalid.
`NF90_EINVAL`
: Size is invalid.
`NF90_ENOMEM`
: Out of memory.
### Example
## 5.7.2 Learning about a Variable Length Array (VLEN) Type: NF90_INQ_VLEN {#f90-learning-about-a-variable-length-array-vlen-type-nf90_inq_vlen}
Use this type to learn about a vlen.
### Usage
~~~~.fortran
function nf90_inq_vlen(ncid, xtype, name, datum_size, base_nc_type)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
character (len = *), intent(out) :: name
integer, intent(out) :: datum_size
integer, intent(out) :: base_nc_type
integer :: nf90_inq_vlen
~~~~
`NCID`
: The ncid of the file that contains the VLEN type.
`XTYPE`
: The type of the VLEN to inquire about.
`NAME`
: The name of the VLEN type. The name will be NF90\_MAX\_NAME
characters or less.
`DATUM_SIZEP`
: A pointer to a size\_t, this will get the size of one element of
this vlen.
`BASE_NF90_TYPEP`
: An integer that will get the type of the VLEN base type. (In other
words, what type is this a VLEN of?)
#### Errors
`NF90_NOERR`
: No error.
`NF90_EBADTYPE`
: Can’t find the typeid.
`NF90_EBADID`
: ncid invalid.
`NF90_EBADGRPID`
: Group ID part of ncid was invalid.
### Example
## 5.7.3 Releasing Memory for a Variable Length Array (VLEN) Type: NF90_FREE_VLEN {#f90-releasing-memory-for-a-variable-length-array-vlen-type-nf90_free_vlen}
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.
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.
### Usage
~~~~.fortran
function nf90_free_vlen(vl)
character (len = *), intent(in) :: vlen
integer :: nf90_free_vlen
end function nf90_free_vlen
~~~~
`VL`
: The variable length array structure which is to be freed.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADTYPE`
: Can’t find the typeid.
### Example
5.8 Opaque Type Introduction {#f90-opaque-type-introduction}
=========================
NetCDF-4 added support for the opaque type. This is not supported in
classic or 64-bit offset files.
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.
To use an opaque type, first define it with [Creating Opaque Types:
NF90\_DEF\_OPAQUE](#NF90_005fDEF_005fOPAQUE). If encountering an enum
type in a new data file, use [Learn About an Opaque Type:
NF90\_INQ\_OPAQUE](#NF90_005fINQ_005fOPAQUE) to learn its name and size.
## 5.8.1 Creating Opaque Types: NF90_DEF_OPAQUE {#f90-creating-opaque-types-nf90_def_opaque}
Create an opaque type. Provide a size and a name.
### Usage
~~~~.fortran
function nf90_def_opaque(ncid, size, name, xtype)
integer, intent(in) :: ncid
integer, intent(in) :: size
character (len = *), intent(in) :: name
integer, intent(out) :: xtype
integer :: nf90_def_opaque
~~~~
`NCID`
: The groupid where the type will be created. The type may be used
anywhere in the file, no matter what group it is in.
`NAME`
: The name for this type. Must be shorter than NF90\_MAX\_NAME.
`SIZE`
: The size of each opaque object.
`TYPEIDP`
: Pointer where the new typeid for this type is returned. Use this
typeid when defining variables of this type with [Create a Variable:
`NF90_DEF_VAR`](#NF90_005fDEF_005fVAR).
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADTYPEID`
: Bad typeid.
`NF90_EBADFIELDID`
: Bad fieldid.
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
### Example
## 5.8.2 Learn About an Opaque Type: NF90_INQ_OPAQUE {#f90-learn-about-an-opaque-type-nf90_inq_opaque}
Given a typeid, get the information about an opaque type.
### Usage
~~~~.fortran
function nf90_inq_opaque(ncid, xtype, name, size)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
character (len = *), intent(out) :: name
integer, intent(out) :: size
integer :: nf90_inq_opaque
~~~~
`NCID`
: The ncid for the group containing the opaque type.
`XTYPE`
: The typeid for this opaque type, as returned by NF90\_DEF\_COMPOUND,
or NF90\_INQ\_VAR.
`NAME`
: The name of the opaque type will be copied here. It will be
NF90\_MAX\_NAME bytes or less.
`SIZEP`
: The size of the opaque type will be copied here.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADTYPEID`
: Bad typeid.
`NF90_EBADFIELDID`
: Bad fieldid.
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
### Example
5.9 Enum Type Introduction {#f90-enum-type-introduction}
=========================
NetCDF-4 added support for the enum type. This is not supported in
classic or 64-bit offset files.
## 5.9.1 Creating a Enum Type: NF90_DEF_ENUM {#f90-creating-a-enum-type-nf90_def_enum}
Create an enum type. Provide an ncid, a name, and a base integer type.
After calling this function, fill out the type with repeated calls to
NF90\_INSERT\_ENUM (see section [Inserting a Field into a Enum Type:
NF90\_INSERT\_ENUM](#NF90_005fINSERT_005fENUM)). Call NF90\_INSERT\_ENUM
once for each value you wish to make part of the enumeration.
### Usage
~~~~.fortran
function nf90_def_enum(ncid, base_typeid, name, typeid)
integer, intent(in) :: ncid
integer, intent(in) :: base_typeid
character (len = *), intent(in) :: name
integer, intent(out) :: typeid
integer :: nf90_def_enum
~~~~
`NCID`
: The groupid where this compound type will be created.
`BASE_TYPEID`
: The base integer type for this enum. Must be one of: NF90\_BYTE,
NF90\_UBYTE, NF90\_SHORT, NF90\_USHORT, NF90\_INT, NF90\_UINT,
NF90\_INT64, NF90\_UINT64.
`NAME`
: The name of the new enum type.
`TYPEIDP`
: The typeid of the new type will be placed here.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADID`
: Bad group id.
`NF90_ENAMEINUSE`
: That name is in use. Compound type names must be unique in the
data file.
`NF90_EMAXNAME`
: Name exceeds max length NF90\_MAX\_NAME.
`NF90_EBADNAME`
: Name contains illegal characters.
`NF90_ENOTNC4`
: 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 NF90\_NETCDF4. (see section
[NF90\_OPEN](#NF90_005fOPEN)).
`NF90_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see section
[NF90\_OPEN](#NF90_005fOPEN)).
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
`NF90_EPERM`
: Attempt to write to a read-only file.
`NF90_ENOTINDEFINE`
: Not in define mode.
### Example
## 5.9.2 Inserting a Field into a Enum Type: NF90_INSERT_ENUM {#f90-inserting-a-field-into-a-enum-type-nf90_insert_enum}
Insert a named member into a enum type.
### Usage
~~~~.fortran
function nf90_insert_enum(ncid, xtype, name, value)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
character (len = *), intent(in) :: name
integer, intent(in) :: value
integer :: nf90_insert_enum
~~~~
`NCID`
: The ncid of the group which contains the type.
`TYPEID`
: The typeid for this enum type, as returned by nf90\_def\_enum,
or nf90\_inq\_var.
`IDENTIFIER`
: The identifier of the new member.
`VALUE`
: The value that is to be associated with this member.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADID`
: Bad group id.
`NF90_ENAMEINUSE`
: That name is in use. Field names must be unique within a enum type.
`NF90_EMAXNAME`
: Name exceed max length NF90\_MAX\_NAME.
`NF90_EBADNAME`
: Name contains illegal characters.
`NF90_ENOTNC4`
: 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 NF90\_NETCDF4. (see section
[NF90\_OPEN](#NF90_005fOPEN)).
`NF90_ESTRICTNC3`
: This file was created with the strict netcdf-3 flag, therefore
netcdf-4 operations are not allowed. (see section
[NF90\_OPEN](#NF90_005fOPEN)).
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
`NF90_ENOTINDEFINE`
: Not in define mode.
### Example
## 5.9.3 Learn About a Enum Type: NF90_INQ_ENUM {#f90-learn-about-a-enum-type-nf90_inq_enum}
Get information about a user-defined enumeration type.
### Usage
~~~~.fortran
function nf90_inq_enum(ncid, xtype, name, base_nc_type, base_size, num_members)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
character (len = *), intent(out) :: name
integer, intent(out) :: base_nc_type
integer, intent(out) :: base_size
integer, intent(out) :: num_members
integer :: nf90_inq_enum
~~~~
`NCID`
: The group ID of the group which holds the enum type.
`XTYPE`
: The typeid for this enum type, as returned by NF90\_DEF\_ENUM,
or NF90\_INQ\_VAR.
`NAME`
: Character array which will get the name. It will have a maximum
length of NF90\_MAX\_NAME.
`BASE_NF90_TYPE`
: An integer which will get the base integer type of this enum.
`BASE_SIZE`
: An integer which will get the size (in bytes) of the base integer
type of this enum.
`NUM_MEMBERS`
: An integer which will get the number of members defined for this
enumeration type.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADTYPEID`
: Bad type id.
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
### Example
## 5.9.4 Learn the Name of a Enum Type: nf90_inq_enum_member {#f90-learn-the-name-of-a-enum-type-nf90_inq_enum_member}
Get information about a member of an enum type.
### Usage
~~~~.fortran
function nf90_inq_enum_member(ncid, xtype, idx, name, value)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
integer, intent(in) :: idx
character (len = *), intent(out) :: name
integer, intent(in) :: value
integer :: nf90_inq_enum_member
~~~~
`NCID`
: The groupid where this enum type exists.
`XTYPE`
: The typeid for this enum type.
`IDX`
: The one-based index number for the member of interest.
`NAME`
: A character array which will get the name of the member. It will
have a maximum length of NF90\_MAX\_NAME.
`VALUE`
: An integer that will get the value associated with this member.
### Errors
`NF90_NOERR`
: No error.
`NF90_EBADTYPEID`
: Bad type id.
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
### Example
## 5.9.5 Learn the Name of a Enum Type: NF90_INQ_ENUM_IDENT {#f90-learn-the-name-of-a-enum-type-nf90_inq_enum_ident}
Get the name which is associated with an enum member value.
This is similar to NF90\_INQ\_ENUM\_MEMBER, but instead of using the
index of the member, you use the value of the member.
### Usage
~~~~.fortran
function nf90_inq_enum_ident(ncid, xtype, value, idx)
integer, intent(in) :: ncid
integer, intent(in) :: xtype
integer, intent(in) :: value
integer, intent(out) :: idx
integer :: nf90_inq_enum_ident
~~~~
`NCID`
: The groupid where this enum type exists.
`XTYPE`
: The typeid for this enum type.
`VALUE`
: The value for which an identifier is sought.
`IDENTIFIER`
: A character array that will get the identifier. It will have a
maximum length of NF90\_MAX\_NAME.
### Return Code
`NF90_NOERR`
: No error.
`NF90_EBADTYPEID`
: Bad type id, or not an enum type.
`NF90_EHDFERR`
: An error was reported by the HDF5 layer.
`NF90_EINVAL`
: The value was not found in the enum.
### Example
|