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
|
FORTRAN 77 BINDINGS FOR GETDATA
===============================
This README describes the Fortran 77 bindings for the GetData library. These
bindings consist of a Fortran compatibility library, 'libfgetdata' (written in
C) and a Fortran 77 source file, 'getdata.f' which defines useful Fortran
parameters and declares the external subroutines.
These bindings are designed to comply to the Fortran 77 standards. As a result,
identifiers are limited to six characters. The compatibility library will
take care of converting Fortran CHARACTER stings to C strings. However, as a
result, when strings are passed to the compatibility library as arguments, the
length of the string must also be passed.
Because Fortran 77 handles neither pointers nor abstract data types, DIRFILE
pointers are not used to refer to dirfile instances. Instead, an integer
dirfile unit number is used. Space is available in the compatibility library
for only 1023 dirfile units. If an application attempts to open more than 1023
dirfiles simultaneously, the compatibility library will emit an error message
on standard error and return an invalid dirfile unit number. Passing an invalid
dirfile unit number to a subroutines which requires one as input (other than
GDCLOS, which will simply ignore it) will result in the call failing with error
code GD_EBD (= GD_E_BAD_DIRFILE, see below).
Including getdata.f (which will be installed in the same directory as getdata.h)
will define several convenient parameters including the DIRFILE flags, the data
type specifiers, and error codes. See below for a complete list. If your
Fortran 77 compiler supports the MIL STD 1753 (DoD Extension) INCLUDE statement
(which any remotely modern compiler should), you can include this file in your
Fortran program to define these constants.
All integer type parameters passed to the compatibility library are of type
INTEGER (i.e. the native size of the platform). As a result, largefile support
is not be available in the Fortran 77 bindings.
All character string arguments require also an integer indicating the size of
the character buffer. In cases where the bindings return a string value, the
value will not be returned if the string length supplied is too short. In
these cases, the character string will be left untouched, but the integer
indicating the string length will be updated to indicate the required string
length. The exception to this is GDESTR, which simply truncates the string
it outputs, as the C API does.
Available Subroutines
=====================
* GDENCS(support, encoding)
Output:
INTEGER support
Input:
INTEGER encoding
This wraps gd_encoding_support(3). When passed one of the GDE_xx encoding
parameters, this subroutine will return GD_RW if the library can read from
and write to that encoding, GD_RO if it can only read from the encoding,
or -1 if neither reading or writing is supported.
Subroutines interacting with the database
-----------------------------------------
* GDOPEN(dirfile_unit, dirfilename, dirfilename_len, flags)
Output:
INTEGER dirfile_unit
Input:
INTEGER dirfilename_len, flags
CHARACTER*<dirfilename_len> dirfilename
This wraps gd_open(3), with the same input arguments (dirfilename_len should
contain the string length of dirfilename). It returns the dirfile unit number
in dirfile_unit. The flags should be a bitwise "or"d list of flag parameters
(see below). If no more dirfile unit numbers are available, it returns -1,
otherwise, this behaves analogously to gd_open() itself: it returns a valid
dirfile unit even in case of error.
* GDCOPN(dirfile_unit, dirfilename, dirfilename_len, flags, sehandler)
Output:
INTEGER dirfile_unit
Input:
INTEGER dirfilename_len, flags
CHARACTER*<dirfilename_len> dirfilename
EXTERNAL sehandler
This wraps gd_cbopen(3), and behaves identically to GDOPEN, except for
requiring the name of the callback subroutine as sehandler. The callback
subroutine should accept the following arguments:
SUBROUTINE CALBCK(act, dirfile_unit, suberror, line)
INTEGER act, dirfile_unit, suberror
CHARACTER*(GD_MLL) line
where GD_MLL is a integer parameter, defined in getdata.f, equal to the value
of the C macro GD_MAX_LINE_LENGTH. The callback subroutine may modify line,
and should set act to one of the syntax handler action parameters (see below).
If the callback subroutine fails to set act, the default action (GDSX_A =
GD_SYNTAX_ABORT) will be assumed. The possible values of suberror are also
listed below. If GDCOPN is passed zero as sehandler, no callback is set.
The callback subroutine is wrapped by the Fortran 77 library to properly
interface with GetData. Other than GDCOPN, the only other subroutines which
potentially could cause the callback subroutine to be called are GDINCL and
GDINCA. Use GDCLBK to change the callback function before calling GDINCL or
GDINCA, if required.
* GDCLBK(dirfile_unit, callback)
Input:
INTEGER dirfile_unit
EXTERNAL callback
This wraps gd_parser_callback(3), setting the registered parser callback to
the subroutine given. The signature of this subroutine is given above under
GDCOPN. Unlike the C interface, this function cannot be used to remove a
registered callback; use GDNOCB for that.
* GDNOCB(dirfile_unit)
Input:
INTEGER dirfile_unit
This calls gd_parser_callback(3) to deregister a previous parser callback
associated with the specified dirfile. If it had none, this procedure does
nothing.
* GDINVD(dirfile_unit)
Output:
INTEGER dirfile_unit
This wraps gd_invalid_dirfile(3), and returns the unit number of a
newly-created, invalid dirfile. If no dirfile unit numbers were available,
it returns -1.
* GDCLOS(dirfile_unit)
Input:
INTEGER dirfile_unit
This wraps gd_close(3). The argument is the dirfile unit to close. In
addition to closing the dirfile itself, this will also disassociate the
supplied dirfile unit number, which may be subsequently returned by a
subsequent call to GDOPEN.
* GDDSCD(dirfile_unit)
Input:
INTEGER dirfile_unit
This wraps gd_discard(3), but otherwise behaves identically to GDCLOS.
* GDFLSH(dirfile_unit, field_code, field_code_len)
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This wraps gd_flush(3). If field_code_len is zero, the entire dirfile will be
flushed, and field_code will be ignored. Otherwise the field named by
field_code will be flushed.
* GDSYNC(dirfile_unit, field_code, field_code_len)
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This wraps gd_sync(3). If field_code_len is zero, the entire dirfile will be
synced, and field_code will be ignored. Otherwise the field named by
field_code will be synced.
* GDRCLO(dirfile_unit, field_code, field_code_len)
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This wraps gd_raw_close(3). If field_code_len is zero, the entire dirfile
will be closed, and field_code will be ignored. Otherwise the field named by
field_code will be closed.
* GDMFLS(dirfile_unit)
Input:
INTEGER dirfile_unit
This subroutine wraps gd_metaflush(3), and will cause metadata changes to be
written to disk.
* GDDSYN(desync, dirfile_unit, flags)
Output:
INTEGER desync
Input:
INTEGER dirfile_unit, flags
This wraps gd_desync(3), and sets desync to a non-zero value if the loaded
dirfile has become desynchronised from the metadata on disk and will,
optionally, reload the dirfile.
* GDFLAG(flags, dirfile_unit, set, reset)
Output:
INTEGER flags
Input:
INTEGER dirfile_unit, set, reset
This wraps gd_flags(3). The value of the flags after modification are
returned in flags.
* GDTOKE(token, token_len, dirfile_unit, string, string_len)
Output:
CHARACTER*<token_len> token
Input/Output:
INTEGER token_len
Input:
INTEGER dirfile_unit, string_len
CHARACTER*<string_len> string
This wraps gd_strtok(3). If string_len <= 0, the next token of the previously
supplied string is returned in token (ie. NULL is passed to gd_strtok(3)),
otherwise, the first token from string is returned, and the string is cached
by GetData. If the output token is longer than the supplied token_len, the
actual length of the token is returned in token_len and token is unmodified.
* GDVBPX(dirfile_unit, prefix, prefix_len
Input:
INTEGER dirfile_unit, prefix_len
CHARACTER*<prefix_len> prefix
This wraps gd_verbose_prefix(3). To remove a prefix, set prefix_len to
zero, in which case prefix itself is ignored.
Subroutines interacting with data
---------------------------------
* GDGETD(n_read, dirfile_unit, field_code, field_code_len, first_frame,
first_sample, num_frames, num_samples, return_type, data_out)
Output:
INTEGER n_read
<datatype> data_out(n)
Input:
INTEGER dirfile_unit, field_code_len, first_frame, first_sample
INTEGER num_frames, num_samples, return_type
CHARACTER*<field_code_len> field_code
This wraps getdata(3), with the same input arguments (field_code_len should
contain the string length of the field_code). The number of samples actually
read is returned in n_read. The return_type parameter should be one of the
parameters defined in getdata.f (see below). data_out must be of sufficient
length and of appropriate data type width for the data returned.
* GDGTCA(dirfile_unit, field_code, field_code_len, return_type, data_out)
Output:
<datatype> data_out(array_len)
Input:
INTEGER dirfile_unit, field_code_len, return_type
CHARACTER*<field_code_len> field_code
This wraps gd_get_carray(3), with the same input arguments (field_code_len
should contain the string length of the field_code). The return_type
parameter should be one of the parameters defined in getdata.f. data_out must
be of appropriate data type width and length for the data returned.
* GDGCAS(dirfile_unit, field_code, field_code_len, start, n, return_type,
data_out)
Output:
<datatype> data_out(array_len)
Input:
INTEGER dirfile_unit, field_code_len, return_type, start, n
CHARACTER*<field_code_len> field_code
This wraps gd_get_carray_slice(3), with the same input arguments
(field_code_len should contain the string length of the field_code). The
return_type parameter should be one of the parameters defined in getdata.f.
data_out must be of appropriate data type width and length for the data
returned.
* GDGTCO(dirfile_unit, field_code, field_code_len, return_type, data_out)
Output:
<datatype> data_out
Input:
INTEGER dirfile_unit, field_code_len, return_type
CHARACTER*<field_code_len> field_code
This wraps gd_get_constant(3), with the same input arguments (field_code_len
should contain the string length of the field_code). The return_type
parameter should be one of the parameters defined in getdata.f. data_out must
be of appropriate data type width for the data returned.
* GDGTST(size, dirfile_unit, field_code, field_code_len, len, data_out)
Output:
INTEGER size
CHARACTER*<len> data_out
Input:
INTEGER dirfile_unit, field_code_len, len
CHARACTER*<field_code_len> field_code
This wraps gd_get_string(3), with the same input arguments (field_code_len
should contain the string length of the field_code). The number of characters
actually read is returned in size. At most len characters will be returned.
* GDPUTD(n_wrote, dirfile_unit, field_code, field_code_len, first_frame,
first_sample, num_frames, num_samples, data_type, data_in)
Output:
INTEGER n_wrote
Input:
INTEGER dirfile_unit, field_code_len, first_frame, first_sample
INTEGER num_frames, num_samples, data_type
CHARACTER*<field_code_len> field_code
<datatype> data_out(n)
This wraps gd_putdata(3), with the same input arguments (field_code_len should
contain the string length of the field_code). The number of samples actually
written is returned in n_wrote. The data_type parameter should be one of the
parameters defined in getdata.f. data_in must be of sufficient length and
of appropriate data type width for the data input.
* GDPTCA(dirfile_unit, field_code, field_code_len, data_type, data_in)
Input:
INTEGER dirfile_unit, field_code_len, data_type
CHARACTER*<field_code_len> field_code
<datatype> data_in(array_len)
This wraps gd_put_carray(3), with the same input arguments (field_code_len
should contain the string length of the field_code). The data_type parameter
should be one of the parameters defined in getdata.f.
* GDPCAS(dirfile_unit, field_code, field_code_len, start, n, data_type, data_in)
Input:
INTEGER dirfile_unit, field_code_len, data_type
CHARACTER*<field_code_len> field_code
<datatype> data_in(n)
This wraps gd_put_carray_slice(3), with the same input arguments
(field_code_len should contain the string length of the field_code). The
data_type parameter should be one of the parameters defined in getdata.f.
* GDPTCO(dirfile_unit, field_code, field_code_len, data_type, data_in)
Input:
INTEGER dirfile_unit, field_code_len, data_type
CHARACTER*<field_code_len> field_code
<datatype> data_in
This wraps gd_put_constant(3), with the same input arguments (field_code_len
should contain the string length of the field_code). The data_type parameter
should be one of the parameters defined in getdata.f.
* GDPTST(dirfile_unit, field_code, field_code_len, len, data_out)
Input:
INTEGER dirfile_unit, field_code_len, len
CHARACTER*<field_code_len> field_code
CHARACTER*<len> data_in
This wraps gd_put_string(3), with the same input arguments (field_code_len
should contain the string length of the field_code, and len should contain the
string length of data_in).
* GDVLDT(invalid, dirfile_unit, field_code, field_code_len)
Output:
INTEGER invalid
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_validate(3), and returns non-zero if there is a
problem with the specified field.
* GDFNUM(framenum, dirfile_unit, field_code, field_code_len, value)
Output:
REAL*8 invalid
Input:
INTEGER dirfile_unit, field_code_len
REAL*8 value
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_framenum(3), and performs a reverse look-up on a
field.
* GDFNSS(framenum, dirfile_unit, field_code, field_code_len, value, field_start,
field_end)
Output:
REAL*8 invalid
Input:
INTEGER dirfile_unit, field_code_len, field_start, field_end
REAL*8 value
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_framenum_subset(3), and performs a reverse
look-up on a field.
* GDSEEK(pos, dirfile_unit, field_code, field_code_len, frame_num, sample_num,
flags)
Output:
INTEGER pos
Input:
INTEGER dirfile_unit, field_code_len, frame_num, sample_num, flags
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_seek(3), and repositions the field pointer of the
specified field. It returns the new value of the field pointer. The
'flags' argument should be one of GDSK_S, GDSK_C, or GDSK_E, optionally
bitwise or'd with GDSK_E.
* GDTELL(pos, dirfile_unit, field_code)
Output:
INTEGER pos
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_tell(3), and returns the current value of the field
pointer for the specified field.
* GDMXLB(dirfile_unit, lookback)
Input:
INTEGER dirfile_unit, lookback
This wraps gd_mplex_lookback(3).
Subroutines interacting with global metadata
--------------------------------------------
* GDNMAT(nentries, dirfile_unit, regex, regex_len, fragment, type, flags)
Output:
INTEGER nentries
Input:
INTEGER dirfile_unit, regex_len, type, flags
CHARACTER*<regex_len> regex
This wraps gd_match_entries(3). It returns the number of entries in the
dirfile satisfying the supplied criteria. If regex_len is zero, regex itself
is ignored. To access the matched field names themselves, use GDMATN (see
below).
* GDNENT(nentries dirfile_unit, parent, parent_len, type, flags)
Output:
INTEGER nentries
Input:
INTEGER dirfile_unit, parent_len, type, flags
CHARACTER*<parent_len> parent
This wraps gd_nentries(3). It returns the number of entries in the dirfile
satisfying the supplied criteria. If parent_len is zero, parent itself is
ignored, and top-level entries are considered. Otherwise, meta-entries
under parent are considered.
* GDNFLD(nfields, dirfile_unit)
* GDNFDT(nfields, dirfile_unit, type)
* GDNVEC(nvectors, dirfile_unit)
* GDNMFD(nfields, dirfile, parent, parent_l)
* GDNMFT(nfields, dirfile, parent, parent_l, type)
* GDNMVE(nvectors, dirfile, parent, parent_l)
These procedures wrap, respectively, gd_nfields(3), gd_nfields_by_type(3),
gd_nvectors(3), gd_nmfields(3), gd_nmfields_by_type(3), and gd_nmvectors(3),
and are all special cases of GDNENT.
* GDNALS(nfields, dirfile_unit, field_code, field_code_len)
Output:
INTEGER nframes
Input:
INTEGER dirfile_unit
CHARACTER*<field_code_len> field_code
This wraps gd_naliases(3). It returns the number of aliases of field_code
(including field_code itself).
* GDMATX(entry_max, dirfile_unit, regex, regex_len, fragment, type, flags)
Output:
INTEGER entry_max
Input:
INTEGER dirfile_unit, regex_len, fragment, type, flags
CHARACTER*<regex_len> regex
This subroutine, which has no direct analogue in the C API, returns in
entry_max the length (in characters) of the longest entry name in the
dirfile in which satisfies the given criteria. If regex_len is zero,
regex itself is ignored. See gd_match_entries(3).
* GDENTX(entry_max, dirfile_unit, parent, parent_len, type, flags)
Output:
INTEGER entry_max
Input:
INTEGER dirfile_unit, parent_len, type, flags
CHARACTER*<parent_len> parent
This subroutine, which has no direct analogue in the C API, returns in
entry_max the length (in characters) of the longest entry name in the
dirfile in which satisfies the given criteria. If parent_len is zero,
parent itself is ignored, and top-level entries are considered.
Otherwise, meta-entries under parent are considered.
* GDFDNX(field_max, dirfile_unit)
* GDMFNX(field_max, dirfile_unit, parent, parent_len)
These subroutines are special cases of GDENTX, with type and flags both
equal to zero, and, in the case of GDFDNX, parent_len also zero.
* GDMATN(name, name_len, dirfile_unit, regex, regex_len, fragment, type,
flags, entry_num)
Output:
CHARACTER*<name_len> name
Input/Output:
INTEGER name_len
Input:
INTEGER dirfile_unit, regex_len, fragment, type, flags, entry_num
CHARACTER*<regex_len> regex
This subroutine is the replacement for gd_match_entries(3). It returns in
name a Fortran 77 string containing the entry name of the entry indexed by
entry_num (which is should be a number between 1 and the output of GDNMAT).
If the name of the field is longer than name_len, it will return the actual
length of the field in name_len and not modify the name argument. If
entry_num is out of range, name_len will be set to zero, and name will not be
modified.
* GDENTN(name, name_len, dirfile_unit, parent, parent_len, type, flags,
entry_num)
Output:
CHARACTER*<name_len> name
Input/Output:
INTEGER name_len
Input:
INTEGER dirfile_unit, parent_len, type, flags, entry_num
CHARACTER*<parent_len> parent
This subroutine is the replacement for gd_entry_list(3). It returns in
name a Fortran 77 string containing the entry name of the entry indexed by
entry_num (which is should be a number between 1 and the output of GDNENT).
If the name of the field is longer than name_len, it will return the actual
length of the field in name_len and not modify the name argument. If
entry_num is out of range, name_len will be set to zero, and name will not be
modified.
* GDFLDN(name, name_len, dirfile_unit, field_num)
* GDFDNT(name, name_len, dirfile_unit, type, field_num)
* GDVECN(name, name_len, dirfile_unit, field_num)
* GDMFDN(name, name_len, dirfile_unit, parent, parent_len, field_num)
* GDMFDT(name, name_len, dirfile_unit, parent, parent_len, type, field_num)
* GDMVEN(name, name_len, dirfile_unit, parent, parent_len, field_num)
These subroutines are replacements for, respectively, gd_field_list(3),
gd_field_list_by_type(3), gd_vector_list(3), gd_mfield_list(3),
gd_mfield_list_by_type(3), and gd_mvector_list(3), and are all special cases
of GDENTN.
* GDALSS(name, name_len, dirfile_unit, field_code, field_code_len, field_num)
Output:
CHARACTER*<name_len> name
Input/Output:
INTEGER name_len
Input:
INTEGER dirfile_unit, field_num, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine is the replacement for gd_aliases(3) and behaves in
the same manner as GDFLDN.
* GDSTRX(string_max, dirfile_unit)
Output:
INTEGER string_max
Input:
INTEGER dirfile_unit
This subroutine, which has no direct analogue in the C API, returns the length
of the longest STRING field defined in the dirfile. It takes the dirfile unit
number as input and returns the length (in characters) of the longest STRING
in the dirfile in string_max.
* GDMSTX(string_max, dirfile_unit, parent, parent_len)
Output:
INTEGER string_max
Input:
INTEGER dirfile_unit, parent_len
CHARACTER*<parent_len> parent
This subroutine, which has no direct analogue in the C API, returns the length
of the longest STRING defined in the dirfile for META fields of the supplied
parent field. It returns the length (in characters) of the longest STRING
META field for the supplied parent in string_max.
* GDCONS(value, dirfile_unit, return_type, field_num)
Output:
CHARACTER*<name_len> name
<datatype> value
Input:
INTEGER dirfile_unit, field_num
This subroutine is the replacement for gd_constants(3) and behaves in the same
manner as GDFLDN.
* GDMCOS(value, dirfile_unit, parent, parent_len, return_type, field_num)
Output:
CHARACTER*<name_len> name
<datatype> value
Input:
INTEGER dirfile_unit, field_num, parent_len
CHARACTER*<parent_len> parent
This subroutine is the replacement for gd_mconstants(3) and behaves in the
same manner as GDFLDN.
* GDSTRS(value, value_len, dirfile_unit, field_num)
Output:
CHARACTER*<value_len> value
Input/Output:
INTEGER value_len
Input:
INTEGER dirfile_unit, field_num
This subroutine is the replacement for gd_strings(3) and behaves in the same
manner as GDSTRS.
* GDMSTS(value, value_len, dirfile_unit, parent, parent_len, field_num)
Output:
CHARACTER*<value_len> value
Input/Output:
INTEGER value_len
Input:
INTEGER dirfile_unit, field_num, parent_len
CHARACTER*<parent_len> parent
This subroutine is the replacement for gd_mstrings(3) and behaves in the same
manner as GDFLDN.
* GDNFRM(nframes, dirfile_unit)
Output:
INTEGER nframes
Input:
INTEGER dirfile_unit
This wraps gd_nframes(3). It takes the dirfile unit number as input and
returns the number of frames in the dirfile in nframes.
* GDALSX(alias_max, dirfile_unit, field_code, field_code_len)
Output:
INTEGER alias_max
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine, which has no direct analogue in the C API, returns the
length of the longest alias defined in the dirfile for field_code.
* GDECNT(error_count, dirfile_unit)
Output:
INTEGER error_count
Input:
INTEGER dirfile_unit
This subroutine wraps gd_error_count(3). It takes the dirfile unit number as
input and returns the number of errors encountered by GetData since the last
call to this subroutine (or since the dirfile was first opened) in
error_count.
* GDEROR(error, dirfile_unit)
Output:
INTEGER error
Input:
INTEGER dirfile_unit
This subroutine wraps gd_error(3). It takes the dirfile unit number as input
and returns the error value arising from the last library call in error. The
value of error will equal one of the error codes defined in getdata.f.
* GDESTR(dirfile_unit, buffer, buffer_len)
Output:
CHARACTER*<buffer_len> buffer
Input:
INTEGER dirfile_unit, buffer_len
This subroutine takes a dirfile unit as input and will write the error
string returned by gd_error_string(3) in buffer, which is of length
buffer_len.
* GDNFRG(nformats, dirfile_unit)
Output:
INTEGER nformats
Input:
INTEGER dirfile_unit
This subroutine returns the number of format file fragments in the specified
dirfile.
* GDNAME(name, name_len, dirfile_unit)
Output:
CHARACTER*<name_len> name
Input/Output:
INTEGER name_len
Input:
INTEGER dirfile_unit
This wraps gd_dirfilename(3). The name of the dirfile will be returned in
name. If the name of the dirfile is longer than name_len, it will return the
actual length of the name in name_len and not modify the name argument.
* GDREFE(name, name_len, dirfile_unit, field_code, field_code_len)
Output:
CHARACTER*<name_len> name
Input/Output:
INTEGER name_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This wraps gd_reference(3). The reference field will be set to field_code,
unless field_code_len is zero, in which case the reference field will not be
changed, and field_code will be ignored. The name of the reference field will
be returned in name. If the name of the reference field is longer than
name_len it will return the actual length of the field in name_len and not
modify the name argument.
* GDSTDV(version, dirfile_unit)
Input/Output:
INTEGER version
Input:
INTEGER dirfile_unit
This wraps gd_dirfile_standards(3). It attempts to set the current Standards
Version of the loaded dirfile to the value specified by version (which may
equal the parameter GDSV_C indicating no change). It then returns the
current Version in version, or -1 on error.
Subroutines interacting with fragment metadata
----------------------------------------------
* GDFRGN(filename, filename_len, dirfile_unit, ind)
Output:
CHARACTER*<infield_len> infield
Input/Output:
INTEGER infield_len
Input:
INTEGER ind
This subroutine returns the name of the format file fragment indexed by ind.
If the name of the file is longer than filename_len, it will return the
actual length of the filename in filename_len and not modify the filename
argument.
* GDINCL(dirfile_unit, file, file_len, fragment_index, flags)
Input:
INTEGER dirfile_unit, field_code_len, fragment_index, flags
CHARACTER*<file_len> file
This subroutine wraps gd_include(3), and allows the inclusion of another
format file fragment into the current dirfile. This may call the registered
callback subroutine, if any. See the caveat in the description of GDCOPN
above.
* GDINCA(dirfile_unit, file, file_len, fragment_index, prefix, prefix_len,
suffix, suffix_len, flags)
Input:
INTEGER dirfile_unit, field_code_len, fragment_index, prefix_len,
INTEGER suffix_len, flags
CHARACTER*<file_len> file
CHARACTER*<prefix_len> prefix
CHARACTER*<suffix_len> suffix
This subroutine wraps gd_include_affix(3), and allows the inclusion of another
format file fragment into the current dirfile with the specified field code
prefix and suffix. This may call the registered callback subroutine, if any.
See the caveat in the description of GDCOPN above.
* GDUINC(dirfile_unit, fragment, del)
Input:
INTEGER dirfile_unit, fragment, del
This subroutine wraps gd_uninclude(3). It removes the specified fragment
from the dirfile. If del is non-zero, the fragment file will be deleted.
* GDGENC(encoding, dirfile_unit, fragment_index)
Output:
INTEGER encoding
Input:
INTEGER dirfile_unit, fragment_index
This subroutine wraps gd_encoding(3). It returns the current encoding
scheme of the specified fragment, which will be one of the symbols listed
below.
* GDAENC(dirfile_unit, encoding, fragment, recode)
Input:
INTEGER dirfile_unit, encoding, fragment, recode
This subroutine wraps gd_alter_encoding(3). It sets the encoding scheme of
the specified fragment to the value of the encoding parameter, which should
be one of the encoding flags listed below. If recode is non-zero, binary
files associated with this fragment will be modified to compensate for the
change.
* GDGEND(endianness, dirfile_unit, fragment_index)
Output:
INTEGER endianness
Input:
INTEGER dirfile_unit, fragment_index
This subroutine wraps gd_endianness(3). It returns the current byte sex
of the specified fragment, which will be one of the symbols listed below.
* GDAEND(dirfile_unit, endianness, fragment, recode)
Input:
INTEGER dirfile_unit, endianness, fragment, recode
This subroutine wraps gd_alter_endianness(3). It sets the byte sex of the
specified fragment to the value of the endianness parameter, which should be
zero or a combination of GD_BE and GD_LE as described on the
gd_alter_endianness manual page. If recode is non-zero, binary files
associated with this fragment will be modified to compensate for the change.
* GDGFOF(frame_offset, dirfile_unit, fragment_index)
Output:
INTEGER frame_offset
Input:
INTEGER dirfile_unit, fragment_index
This subroutine wraps gd_frameoffset(3). It returns the current frame
offset of the specified fragment.
* GDAFOF(dirfile_unit, frame_offset, fragment, recode)
Input:
INTEGER dirfile_unit, frame_offset, fragment, recode
This subroutine wraps gd_alter_frameoffset(3). It sets the frame offset of
the specified fragment to the value of the frame_offset parameter. If recode
is non-zero, binary files associated with this fragment will be modified to
compensate for the change.
* GDGPRT(protection_level, dirfile_unit, fragment_index)
Output:
INTEGER protection_level
Input:
INTEGER dirfile_unit, fragment_index
This subroutine wraps gd_protection(3). It returns the current protection
level of the specified fragment, which will be one of the symbols listed
below.
* GDAPRT(dirfile_unit, protection_level, fragment)
Input:
INTEGER dirfile_unit, protection_level, fragment
This subroutine wraps gd_protect(3). It sets the protection level of the
specified fragment to the value of the protection_level parameter, which
should one of the protection level listed below.
* GDPFRG(parent, dirfile_unit, fragment)
Output:
INTEGER parent
Input:
INTEGER dirfile_unit, fragment
This subroutine wraps gd_parent_fragment(3). It returns the parent
fragment of the specified fragment, or -1 on error.
* GDFRAF(prefix, prefix_len, suffix, suffix_len, dirfile_unit, fragment_index)
Output:
CHARACTER*<prefix_len> prefix
CHARACTER*<suffix_len> suffix
Input/Output:
INTEGER prefix_len, suffix_len
Input:
INTEGER dirfile_unit, fragment_index
This subroutine wraps gd_fragment_affixes(3), returning the field code
prefix and suffix for the specified fragment. On error, it sets prefix_len
to zero. In this case the value of the other output parameters in
unspecified.
* GDAAFX(dirfile_unit, fragment, prefix, prefix_len, suffix, suffix_len
Input:
INTEGER dirfile_unit, fragment
CHARACTER*<prefix_len> prefix
CHARACTER*<suffix_len> suffix
This subroutine wraps gd_alter_affix(3). It sets the field code prefix and
suffix of the specified fragment to the value of the prefix and suffix
parameters.
Subroutines interacting with field metadata
-------------------------------------------
* GDGERW(spf, data_type, fragment_index, dirfile_unit, field_code,
field_code_len)
Output:
INTEGER spf, data_type, fragment_index
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a RAW field. It returns the
samples-per-frame, native data type, and the format file index in spf and
data_type. The data_type will be one of the data type parameters listed
below. If field_code is not found, or the field specified is not of RAW type,
spf will be set to zero. In this case the value of the other output
parameters is unspecified.
* GDGECL(nfields, infield1, infield1_len, m1, b1, infield2, infield2_len, m2,
b2, infield3, infield3_len, m3, b3, fragment_index, dirfile_unit, field_code,
field_code_len)
Output:
INTEGER nfields, fragment_index
CHARACTER*<infield1_len> infield1
CHARACTER*<infield2_len> infield2
CHARACTER*<infield3_len> infield3
COMPLEX*16 m1, b1, m2, b2, m3, b3
Input/Output:
INTEGER infield1_len, infield2_len, infield3_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a LINCOM field. Although three
sets of arguments are required, only nfields of them will be updated. If
field_code is not found, or the field specified is not of LINCOM type, nfields
will be set to zero. In this case the value of the remaining data is
unspecified.
* GDGELC(nfields, infield1, infield1_len, m1, b1, infield2, infield2_len, m2,
b2, infield3, infield3_len, m3, b3, fragment_index, dirfile_unit, field_code,
field_code_len)
Output:
INTEGER nfields, fragment_index
CHARACTER*<infield1_len> infield1
CHARACTER*<infield2_len> infield2
CHARACTER*<infield3_len> infield3
REAL*8 m1, b1, m2, b2, m3, b3
Input/Output:
INTEGER infield1_len, infield2_len, infield3_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This is equivalent to GDGELC above, but returns only the real part of the
scale factors and offset terms.
* GDGELT(infield, infield_len, table, table_len, fragment_index, dirfile_unit,
field_code, field_code_len)
Output:
CHARACTER*<infield_len> infield
CHARACTER*<table_len> table
INTEGER fragment_index
Input/Output:
INTEGER infield_len, table_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a LINTERP field. If field_code
is not found, or the field specified is not of LINTERP type, infield_len will
be set to zero. In this case the value of the remaining data is unspecified.
* GDGEBT(infield, infield_len, bitnum, numbits, fragment_index, dirfile_unit,
field_code, field_code_len)
Output:
CHARACTER*<infield_len> infield
INTEGER bitnum, numbits, fragment_index
Input/Output:
INTEGER infield_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a BIT field. If field_code
is not found, or the field specified is not of BIT type, infield_len will
be set to zero. In this case the value of the remaining data is unspecified.
* GDGESB(infield, infield_len, bitnum, numbits, fragment_index, dirfile_unit,
field_code, field_code_len)
Output:
CHARACTER*<infield_len> infield
INTEGER bitnum, numbits, fragment_index
Input/Output:
INTEGER infield_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a SBIT field. If field_code
is not found, or the field specified is not of SBIT type, infield_len will
be set to zero. In this case the value of the remaining data is unspecified.
* GDGECR(infield, infield_len, dividend, fragment_index, dirfile_unit,
field_code, field_code_len)
Output:
CHARACTER*<infield_len> infield
COMPLEX*16 dividend
INTEGER fragment_index
Input/Output:
INTEGER infield_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a RECIP field. If field_code
is not found, or the field specified is not of RECIP type, infield_len will
be set to zero. In this case the value of the remaining data is unspecified.
* GDGERC(infield, infield_len, dividend, fragment_index, dirfile_unit,
field_code, field_code_len)
Output:
CHARACTER*<infield_len> infield
REAL*8 dividend
INTEGER fragment_index
Input/Output:
INTEGER infield_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a RECIP field. If field_code
is not found, or the field specified is not of RECIP type, infield_len will
be set to zero. In this case the value of the remaining data is unspecified.
* GDGEDV(infield1, infield1_len, infield2, infield2_len, fragment_index,
dirfile_unit, field_code, field_code_len)
Output:
CHARACTER*<infield1_len> infield1
CHARACTER*<infield2_len> infield2
INTEGER fragment_index
Input/Output:
INTEGER infield1_len, infield2_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a DIVIDE field. If field_code
is not found, or the field specified is not of DIVIDE type, infield1_len
will be set to zero. In this case the value of the remaining data is
unspecified.
* GDGEMT(infield1, infield1_len, infield2, infield2_len, fragment_index,
dirfile_unit, field_code, field_code_len)
Output:
CHARACTER*<infield1_len> infield1
CHARACTER*<infield2_len> infield2
INTEGER fragment_index
Input/Output:
INTEGER infield1_len, infield2_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a MULTIPLY field. If field_code
is not found, or the field specified is not of MULTIPLY type, infield1_len
will be set to zero. In this case the value of the remaining data is
unspecified.
* GDGEPH(infield, infield_len, shift, fragment_index, dirfile_unit, field_code,
field_code_len)
Output:
CHARACTER*<infield_len> infield
INTEGER shift, fragment_index
Input/Output:
INTEGER infield_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a PHASE field. If field_code
is not found, or the field specified is not of PHASE type, infield_len will
be set to zero. In this case the value of the remaining data is unspecified.
* GDGEPN(poly_ord, infield, infield_len, a0, a1, a2, a3, a4, a5, fragment_index,
dirfile_unit, field_code, field_code_len)
Output:
INTEGER poly_ord, fragment_index
CHARACTER*<infield_len> infield
REAL*8 a0, a1, a2, a3, a4, a5
Input/Output:
INTEGER infield1_len, infield2_len, infield3_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This is equivalent to GDGECP above, but returns only the real part of the
coefficients.
* GDGECP(poly_ord, infield, infield_len, a0, a1, a2, a3, a4, a5, fragment_index,
dirfile_unit, field_code, field_code_len)
Output:
INTEGER poly_ord, fragment_index
CHARACTER*<infield_len> infield
COMPLEX*16 a0, a1, a2, a3, a4, a5
Input/Output:
INTEGER infield1_len, infield2_len, infield3_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a POLYNOM field. Although six
coefficients must be provided, only poly_ord + 1 of them will be updated. If
field_code is not found, or the field specified is not of POLYNOM type,
nfields will be set to zero. In this case the value of the remaining data is
unspecified.
* GDGEWD(infield, infield_len, checkfield, checkfield_len, windop, ithreshold,
rthreshold, fragment_index, dirfile_unit, field_code, field_code_len)
Output:
INTEGER windop, ithreshold, fragment_index
CHARACTER*<infield_len> infield
CHARACTER*<checkfield_len> checkfield
Input/Output:
INTEGER infield_len, checkfield_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a WINDOW field. Only one of
ithreshold and rthreshold is ever updated. If the returned windop is one of
GDW_EQ, GDW_NE, GDW_ST, or GDW_CL, ithreshold will be updated, otherwise,
rthreshold will be updated. If field_code is not found, or the field
specified is not of POLYNOM type, infield_len will be set to zero. In this
case the value of the remaining data is unspecified.
* GDGEMX(infield, infield_len, countfield, countfield_len, countval, period,
fragment_index, dirfile_unit, field_code, field_code_len)
Output:
INTEGER countval, period, fragment_index
CHARACTER*<infield_len> infield
CHARACTER*<countfield_len> countfield
Input/Output:
INTEGER infield_len, countfield_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a MPLEX field. If field_code
is not found, or the field specified is not of MPLEX type, infield_len will
be set to zero. In this case the value of the remaining data is unspecified.
* GDGECA(const_type, array_len, fragment_index, dirfile_unit, field_code,
field_code_len)
Output:
INTEGER const_type, array_len, fragment_index
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a CARRAY field. If field_code
is not found, or the field specified is not of CARRAY type, const_type will
be set to zero. In this case the value of the remaining data is unspecified.
* GDGECO(const_type, fragment_index, dirfile_unit, field_code, field_code_len)
Output:
INTEGER const_type, fragment_index
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns metadata describing a CONST field. If field_code
is not found, or the field specified is not of CONST type, const_type will
be set to zero. In this case the value of the remaining data is unspecified.
* GDARLN(array_len, dirfile_unit, field_code, field_code_len)
Output:
INTEGER array_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This wraps gd_array_len(3). The field_code_len parameter should contain the
string length of field_code. The length of the field will be returned in
array_len.
* GDGSPF(spf, dirfile_unit, field_code, field_code_len)
Output:
INTEGER spf
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This wraps gd_spf(3). The field_code_len parameter should contain the
string length of field_code. The number of samples per frame in field_code
will be returned in spf.
* GDENTY(entry_type, dirfile_unit, field_code, field_code_len)
Output:
INTEGER type
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_entry_type(3), and returns the field type of the
specified field_code in entry_type. The entry_type will be one of the entry
type parameters listed below.
* GDFRGI(fragment_index, dirfile_unit, field_code, field_code_len)
Output:
INTEGER fragment_index
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_fragment_index(3), and returns the format file
fragment index for the supplied field. If the field does not exist, or an
error occurred, -1 is returned.
* GDATRG(targ, targ_len, dirfile_unit, field_code, field_code_len)
Output:
CHARACTER*<targ_len> targ
Input/Output:
INTEGER targ_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_alias_target(3), and returns the target of the
alias specified by format_file.
* GDHIDN(result, dirfile_unit, field_code, field_code_len)
Output:
INTEGER result
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_hidden(3). It sets result to one if the specified
field is hidden, or zero if it is not. On error, it sets result to -1.
* GDHIDE(dirfile_unit, field_code, field_code_len)
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_hide(3). It hides the specified field.
* GDUHID(dirfile_unit, field_code, field_code_len)
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_unhide(3). It unhides the specified field.
* GDGBOF(bof, dirfile_unit, field_code, field_code_len)
Output:
INTEGER bof
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_bof(3), and returns the location of the beginning-
of-field marker for the specified field.
* GDGEOF(eof, dirfile, field_code, field_code_len)
Output:
INTEGER eof
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_eof(3), and returns the location of the end-of-field
marker for the specified field.
* GDLSRW(dirfile_unit, field_code, field_code_len, data_type, spf, spf_scalar,
spf_scalar_len, spf_scalar_index, recode)
Input:
INTEGER dirfile_unit, field_code_len, data_type, spf, spf_scalar_len
INTEGER spf_scalar_index, recode
CHARACTER*<field_code_len> field_code
CHARACTER*<spf_scalar_len> spf_scalar
This subroutine modifies the RAW field specified according to the supplied
parameters. Passing -1 as one of the spf_scalar_len will delete an existing
scalar field code, if one is present. Passing 0 for this parameter indicates
no change to the corresponding parameter field code. If recode is non-zero,
the binary file associated with this field will be modified to account for the
changes.
* GDALRW(dirfile_unit, field_code, field_code_len, data_type, spf, recode)
Input:
INTEGER dirfile_unit, field_code_len, data_type, spf, recode
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_alter_raw(3), and modifies the specified field
metadata. If recode is non-zero, the binary file associated with this field
will be modified to account for the changes.
* GDLSCL(dirfile_unit, field_code, field_code_len, nfields, in_field1,
in_field1_len, m1, m1_scalar, m1_scalar_len, m1_scalar_index, b1, b1_scalar,
b1_scalar_len, b1_scalar_index, in_field2, in_field2_len, m2, m2_scalar,
m2_scalar_len, m2_scalar_index, b2, b2_scalar, b2_scalar_len, b2_scalar_index,
in_field3, in_field3_len, m3, m3_scalar, m3_scalar_len, m3_scalar_index, b3,
b3_scalar, b3_scalar_len, b3_scalar_index)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field1_len, m1_scalar_len
INTEGER m1_scalar_index, b1_scalar_len, b1_scalar_index, in_field2_len
INTEGER m2_scalar_len, m2_scalar_index, b2_scalar_len, b2_scalar_index
INTEGER in_field3_len, m3_scalar_len, m3_scalar_index, b3_scalar_len
INTEGER b3_scalar_index
COMPLEX*16 m1, b1, m2, b2, m3, b3
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<in_field2_len> in_field2
CHARACTER*<in_field3_len> in_field3
This subroutine modifies the LINCOM field specified according to the supplied
parameters. Passing -1 as one of the .._scalar_len parameters will delete
an existing scalar field code, if one is present. Passing 0 for these
parameters indicates no change to the corresponding parameter field code.
* GDALCL(dirfile_unit, field_code, field_code_len, nfields, in_field1,
in_field1_len, m1, b1, in_field2, in_field2_len, m2, b2, in_field3,
in_field3_len, m3, b3)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field1_len, in_field2_len
INTEGER in_field3_len
COMPLEX*16 m1, b1, m2, b2, m3, b3
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<in_field2_len> in_field2
CHARACTER*<in_field3_len> in_field3
This subroutine wraps gd_alter_lincom(3), and modifies the specified field
metadata.
* GDLSLC(dirfile_unit, field_code, field_code_len, nfields, in_field1,
in_field1_len, m1, m1_scalar, m1_scalar_len, m1_scalar_index, b1, b1_scalar,
b1_scalar_len, b1_scalar_index, in_field2, in_field2_len, m2, m2_scalar,
m2_scalar_len, m2_scalar_index, b2, b2_scalar, b2_scalar_len, b2_scalar_index,
in_field3, in_field3_len, m3, m3_scalar, m3_scalar_len, m3_scalar_index, b3,
b3_scalar, b3_scalar_len, b3_scalar_index)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field1_len, m1_scalar_len
INTEGER m1_scalar_index, b1_scalar_len, b1_scalar_index, in_field2_len
INTEGER m2_scalar_len, m2_scalar_index, b2_scalar_len, b2_scalar_index
INTEGER in_field3_len, m3_scalar_len, m3_scalar_index, b3_scalar_len
INTEGER b3_scalar_index
REAL*8 m1, b1, m2, b2, m3, b3
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<in_field2_len> in_field2
CHARACTER*<in_field3_len> in_field3
This is equivalent to GDLSCL above, but takes purely real parameters.
* GDALLC(dirfile_unit, field_code, field_code_len, nfields, in_field1,
in_field1_len, m1, b1, in_field2, in_field2_len, m2, b2, in_field3,
in_field3_len, m3, b3)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field1_len, in_field2_len
INTEGER in_field3_len
REAL*8 m1, b1, m2, b2, m3, b3
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<in_field2_len> in_field2
CHARACTER*<in_field3_len> in_field3
This is equivalent to GDALCL above, but takes purely real parameters.
* GDALLT(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
table, table_len, move)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, table_len, move
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<table_len> table
This subroutine wraps gd_alter_linterp(3), and modifies the specified field
metadata. If move is non-zero, the look-up table will be moved to the path
specified by table.
* GDLSBT(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
bitnum, bitnum_scalar, bitnum_scalar_len, bitnum_scalar_index,
numbits, numbits_scalar, numbits_scalar_len, numbits_scalar_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, bitnum
INTEGER bitnum_scalar_len, bitnum_scalar_index, numbits, numbits_scalar_len
INTEGER numbits_scalar_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<bitnum_scalar_len> bitnum_scalar_len
CHARACTER*<numbits_scalar> numbits_scalar_len
This subroutine modifies the BIT field specified according to the supplied
parameters. Passing -1 as bitnum_scalar_len or numbits_scalar_len will delete
an existing scalar field code, if one is present. Passing 0 for these
parameters indicates no change to the corresponding parameter field code.
* GDALBT(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
bitnum, numbits)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, bitnum, numbits
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
This subroutine wraps gd_alter_bit(3), and modifies the specified field
metadata.
* GDALDV(dirfile_unit, field_code, field_code_len, in_field1, in_field1_len,
in_field2, in_field2_len)
Input:
INTEGER dirfile_unit, field_code_len, in_field1_len, in_field2_len
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<in_field2_len> in_field2
This subroutine wraps gd_alter_divide(3), and modifies the specified field
metadata.
* GDALMT(dirfile_unit, field_code, field_code_len, in_field1, in_field1_len,
in_field2, in_field2_len)
Input:
INTEGER dirfile_unit, field_code_len, in_field1_len, in_field2_len
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<in_field2_len> in_field2
This subroutine wraps gd_alter_multiply(3), and modifies the specified field
metadata.
* GDLSPH(dirfile_unit, field_code, field_code_len, in_field1, in_field1_len,
shift, shift_scalar, shift_scalar_len, shift_scalar_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field1_len, shift, fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
This subroutine modifies the PHASE field specified according to the supplied
parameters. Passing -1 as shift_scalar_len will delete an existing scalar
field code, if one is present. Passing 0 for this parameter indicates no
change to the corresponding parameter field code.
* GDALPH(dirfile_unit, field_code, field_code_len, in_field1, in_field1_len,
shift)
Input:
INTEGER dirfile_unit, field_code_len, in_field1_len, shift, fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
This subroutine wraps gd_alter_phase(3), and modifies the specified field
metadata.
* GDLSCP(dirfile_unit, field_code, field_code_len, poly_ord, in_field,
in_field_len, a0, a0_scalar, a0_scalar_len, a0_scalar_index, a1, a1_scalar,
a1_scalar_len, a1_scalar_index, a2, a2_scalar, a2_scalar_len, a2_scalar_index,
a3, a3_scalar, a3_scalar_len, a3_scalar_index, a4, a4_scalar, a4_scalar_len,
a4_scalar_index, a5, a5_scalar, a5_scalar_len, a5_scalar_index)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field_len, a0_scalar_len
INTEGER a0_scalar_index, a1_scalar_len, a1_scalar_index, a2_scalar_len
INTEGER a2_scalar_index, a3_scalar_len, a3_scalar_index, a4_scalar_len
INTEGER a4_scalar_index, a5_scalar_len, a5_scalar_index
COMPLEX*16 a0, a1, a2, a3, a4, a5
CHARACTER*<field_code_len> field_code
CHARACTER*<a0_scalar_len> a0_scalar
CHARACTER*<a1_scalar_len> a1_scalar
CHARACTER*<a2_scalar_len> a2_scalar
CHARACTER*<a3_scalar_len> a3_scalar
CHARACTER*<a4_scalar_len> a4_scalar
CHARACTER*<a5_scalar_len> a5_scalar
This subroutine modifies the POLYNOM field specified according to the supplied
parameters. Passing -1 as one of the .._scalar_len parameters will delete
an existing scalar field code, if one is present. Passing 0 for these
parameters indicates no change to the corresponding parameter field code.
* GDALCP(dirfile_unit, field_code, field_code_len, poly_ord, in_field,
in_field_len, a0, a1, a2, a3, a4, a5)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field_len
COMPLEX*16 a0, a1, a2, a3, a4, a5
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
This subroutine wraps gd_alter_polynom(3), and modifies the specified field
metadata.
* GDLSPN(dirfile_unit, field_code, field_code_len, poly_ord, in_field,
in_field_len, a0, a0_scalar, a0_scalar_len, a0_scalar_index, a1, a1_scalar,
a1_scalar_len, a1_scalar_index, a2, a2_scalar, a2_scalar_len, a2_scalar_index,
a3, a3_scalar, a3_scalar_len, a3_scalar_index, a4, a4_scalar, a4_scalar_len,
a4_scalar_index, a5, a5_scalar, a5_scalar_len, a5_scalar_index)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field_len, a0_scalar_len
INTEGER a0_scalar_index, a1_scalar_len, a1_scalar_index, a2_scalar_len
INTEGER a2_scalar_index, a3_scalar_len, a3_scalar_index, a4_scalar_len
INTEGER a4_scalar_index, a5_scalar_len, a5_scalar_index
REAL*8 a0, a1, a2, a3, a4, a5
CHARACTER*<field_code_len> field_code
CHARACTER*<a0_scalar_len> a0_scalar
CHARACTER*<a1_scalar_len> a1_scalar
CHARACTER*<a2_scalar_len> a2_scalar
CHARACTER*<a3_scalar_len> a3_scalar
CHARACTER*<a4_scalar_len> a4_scalar
CHARACTER*<a5_scalar_len> a5_scalar
This is equivalent to GDLSCP, but with purely real parameters.
* GDALPN(dirfile_unit, field_code, field_code_len, poly_ord, in_field,
in_field_len, a0, a1, a2, a3, a4, a5)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field_len
REAL*8 a0, a1, a2, a3, a4, a5
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
This subroutine is equivalent to GDALCP above, but takes purely real
parameters.
* GDLSSB(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
bitnum, bitnum_scalar, bitnum_scalar_len, bitnum_scalar_index,
numbits, numbits_scalar, numbits_scalar_len, numbits_scalar_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, bitnum
INTEGER bitnum_scalar_len, bitnum_scalar_index, numbits, numbits_scalar_len
INTEGER numbits_scalar_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<bitnum_scalar_len> bitnum_scalar_len
CHARACTER*<numbits_scalar> numbits_scalar_len
This subroutine modifies the SBIT field specified according to the supplied
parameters. Passing -1 as bitnum_scalar_len or numbits_scalar_len will delete
an existing scalar field code, if one is present. Passing 0 for these
parameters indicates no change to the corresponding parameter field code.
* GDALSB(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
bitnum, numbits)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, bitnum, numbits
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
This subroutine wraps gd_alter_sbit(3), and modifies the specified field
metadata.
* GDLSCR(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
dividend, dividend_scalar, dividend_scalar_len, dividend_scalar_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, dividend_scalar_len,
INTEGER dividend_scalar_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<dividend_scalar_len> dividend_scalar
COMPLEX*16 dividend
This subroutine modifies the RECIP field specified according to the supplied
parameters. Passing -1 as dividend_scalar_len parameters will delete
an existing scalar field code, if one is present. Passing 0 for this
parameter indicates no change to the corresponding parameter field code.
* GDALCR(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
dividend)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
COMPLEX*16 dividend
This subroutine wraps gd_alter_crecip(3), and modifies the specified field
metadata.
* GDLSRC(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
dividend, dividend_scalar, dividend_scalar_len, dividend_scalar_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, dividend_scalar_len,
INTEGER dividend_scalar_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<dividend_scalar_len> dividend_scalar
REAL*16 dividend
This is equivalent to GDLSCR, but with purely real parameters.
* GDALRC(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
dividend)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
REAL*8 dividend
This subroutine wraps gd_alter_recip(3), and modifies the specified field
metadata.
* GDLSWD(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
check_field, check_field_len, windop, threshold, threshold_scalar,
threshold_scalar_len, threshold_scalar_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, check_field_len, windop
INTEGER threshold_scalar_len, threshold_scalar_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<check_field_len> check_field
CHARACTER*<threshold_scalar_len> threshold_scalar
INTEGER threshold
or
REAL*8 threshold
This subroutine modifies the WINDOW field specified according to the supplied
parameters. Passing -1 as threshold_scalar_len will delete an existing scalar
field code, if one is present. Passing 0 for this parameter indicates no
change to the corresponding parameter field code. If windop is one of
GDW_EQ, GDW_NE, GDW_ST, or GDW_CL, threshold should be of type integer,
otherwise it should be double precision.
* GDALWD(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
check_field, check_field_len, windop, threshold)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, check_field_len, windop
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<check_field_len> check_field
INTEGER threshold
or
REAL*8 threshold
This subroutine wraps gd_alter_windop(3), and modifies the specified field
metadata. If windop is one of GDW_EQ, GDW_NE, GDW_ST, or GDW_CL, threshold
should be of type integer, otherwise it should be double precision.
* GDLSMX(dirfile_unit, field_code, field_code_len, infield, infield_len,
countfield, countfield_len, countval, countval_scalar, countval_scalar_len,
countval_scalar_index, period, period_scalar_len, period_scalar_index)
Input:
INTEGER dirfile_unit, field_code_len, infield_len, countfile_len, countval
INTEGER countval_scalar_len, countval_scalar_index, period,
INTEGER period_scalar_len, period_scalar_index
CHARACTER*<field_code_len> field_code
CHARACTER*<infield_len> infield
CHARACTER*<countfield_len> countfield
This subroutine modifies the MPLEX field specified according to the supplied
parameters. Passing -1 as one of the .._scalar_len parameters will delete
an existing scalar field code, if one is present. Passing 0 for these
parameters indicates no change to the corresponding parameter field code.
* GDALMX(dirfile_unit, field_code, field_code_len, infield, infield_len,
countfield, countfield_len, countval, period)
Input:
INTEGER dirfile_unit, field_code_len, infield_len, countfile_len, countval
INTEGER period
CHARACTER*<field_code_len> field_code
CHARACTER*<infield_len> infield
CHARACTER*<countfield_len> countfield
This subroutine wraps gd_alter_mplex(3), and modifies the specified field
metadata.
* GDALCA(dirfile_unit, field_code, field_code_len, const_type, array_len)
Input:
INTEGER dirfile_unit, field_code_len, const_type, array_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_alter_carray(3), and modifies the specified field
metadata.
* GDALCO(dirfile_unit, field_code, field_code_len, const_type)
Input:
INTEGER dirfile_unit, field_code_len, const_type
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_alter_const(3), and modifies the specified field
metadata.
* GDALSP(dirfile_unit, spec, spec_len, move)
Input:
INTEGER dirfile_unit, move, spec_len
CHARACTER*<spec_len> spec
This subroutine wraps gd_alter_spec(3), and modifies the specified field
metadata. If move is non-zero, and the field is a RAW field, the binary
file will be modified. If move is non-zero, and the field is a LINTERP,
the look-up table will be moved. Otherwise, move is ignored.
* GDMLSP(dirfile_unit, spec, spec_len, parent, parent_len, move)
Input:
INTEGER dirfile_unit, spec_len, parent_len, move
CHARACTER*<spec_len> spec
CHARACTER*<parent_len> parent
This subroutine wraps gd_malter_spec(3), and behaves similarly to GDALSP, but
also requires the name of the metafield's parent. The spec should contain
only the name of the metafield, and not the metafield's full field code.
* GDRWFN(name, name_len, dirfile_unit, field_code, field_code_len)
Output:
CHARACTER*<name_len> name
Input/Output:
INTEGER name_len
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_raw_filename(3). It returns in name the name of
the binary file associated with the raw field indicated by field_code. On
error, it sets name_len to zero.
* GDMOVE(dirfile_unit, field_code, field_code_len, new_fragment, flags)
Input:
INTEGER dirfile_unit, field_code_len, new_fragment, flags
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_move(3), and moves the specified field or alias to
indicated fragment. The flags parameter should be zero or more of the GDR_xx
parameters, bitwise or'd together.
* GDRENM(dirfile_unit, field_code, field_code_len, new_name, new_name_len,
flags)
Input:
INTEGER dirfile_unit, field_code_len, new_name_len, flags
CHARACTER*<field_code_len> field_code
CHARACTER*<new_name_len> new_name
This subroutine wraps gd_rename(3), and changes the name of a field. The
flags parameter should be zero or more of the GDR_xx parameters, bitwise or'd
together.
* GDNTYP(ntype, dirfile_unit, field_code, field_code_len)
Output:
INTEGER ntype
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_native_type(3), and returns the native type of
the specified field. The return value will be one of the data type symbols
listed below.
* GDENFL(flags, dirfile_unit, field_code, field_code_len)
Output:
INTEGER flags
Input:
INTEGER dirfile_unit, field_code_len
CHARACTER*<field_code_len> field_code
This subroutine returns the flags member of the specified field.
* GDGSCA(scalar, scalar_len, scalar_index, dirfile_unit, field_code,
field_code_len, index)
Output:
CHARACTER*<scalar_len> scalar
INTEGER scalar_index
Input/Output:
INTEGER scalar_len
Input:
INTEGER dirfile_unit, field_code_len, index
CHARACTER*<field_code_len> field_code
This subroutine returns the element indexed by index of the scalar array of
the gd_entry_t object associated with the specified field code. If index is
too large for the specified field, behaviour is undefined. The array is
indexed starting from one.
* GDGACA(dirfile_unit, field_code, field_code_len, index, scalar, scalar_len,
scalar_index, recode)
Input:
INTEGER dirfile_unit, field_code_len, scalar_len, index, recode
INTEGER scalar_index
CHARACTER*<field_code_len> field_code
CHARACTER*<scalar_len> scalar
This subroutine modifies the element indexed by index of the scalar array
member of the gd_entry_t object associated with the specified field code. If
index is too large for the specified field, nothing happens. The array is
indexed starting from one. If scalar indicates a CONST field, scalar_index
is ignored.
Subroutines which add or delete fields and aliases
--------------------------------------------------
* GDDELE(dirfile_unit, field_code, field_code_len, flags)
Input:
INTEGER dirfile_unit, field_code_len, flags
CHARACTER*<field_code_len> field_code
This subroutine wraps gd_delete(3). It deletes the indicated field or alias.
The flags parameter should be either zero, or one or more of the delete flags
listed below bitwise or'd together.
* GDADAL(dirfile_unit, field_code, field_code_len, targ, targ_len,
fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, targ_len, fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<targ_len> targ
This subroutine wraps gd_add_alias(3). It adds an alias named field_code
pointing to targ in the fragment indexed by fragment_index.
* GDASRW(dirfile_unit, field_code, field_code_len, data_type, spf,
spf_scalar, spf_scalar_len, spf_scalar_index, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, data_type, spf, spf_scalar_len
INTEGER spf_scalar_index, fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<spf_scalar_len> spf_scalar
This subroutine adds a RAW field with the supplied parameters to the
specified fragment of the dirfile. If spf_scalar_len is zero, spf_scalar and
spf_scalar_index are ignored, and the literal value spf is used for the
parameter. If spf_scalar_len is non-zero, the literal spf is ignored and the
field code specified by spf_scalar and spf_scalar_index is used for the
parameter.
* GDADRW(dirfile_unit, field_code, field_code_len, data_type, spf,
fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, data_type, spf, fragment_index
CHARACTER*<field_code_len> field_code
This is equivalent to GDASRW with spf_scalar_len set to zero (i.e. with a
literal parameter only).
* GDASCL(dirfile_unit, field_code, field_code_len, nfields, in_field1,
in_field1_len, m1, m1_scalar, m1_scalar_len, m1_scalar_index, b1, b1_scalar,
b1_scalar_len, b1_scalar_index, in_field2, in_field2_len, m2, m2_scalar,
m2_scalar_len, m2_scalar_index, b2, b2_scalar, b2_scalar_len, b2_scalar_index,
in_field3, in_field3_len, m3, m3_scalar, m3_scalar_len, m3_scalar_index, b3,
b3_scalar, b3_scalar_len, b3_scalar_index, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field1_len, m1_scalar_len
INTEGER m1_scalar_index, b1_scalar_len, b1_scalar_index, in_field2_len
INTEGER m2_scalar_len, m2_scalar_index, b2_scalar_len, b2_scalar_index
INTEGER in_field3_len, m3_scalar_len, m3_scalar_index, b3_scalar_len
INGEGER b3_scalar_index, fragment_index
COMPLEX*16 m1, b1, m2, b2, m3, b3
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<m1_scalar_len> m1_scalar
CHARACTER*<b1_scalar_len> b1_scalar
CHARACTER*<in_field2_len> in_field2
CHARACTER*<m2_scalar_len> m2_scalar
CHARACTER*<b2_scalar_len> b2_scalar
CHARACTER*<in_field3_len> in_field3
CHARACTER*<m3_scalar_len> m3_scalar
CHARACTER*<b3_scalar_len> b3_scalar
This subroutine adds a LINCOM field with the supplied parameters to the
specified format file fragment of the dirfile. All three sets of input
parameters are required to be passed to the call, but only the first
nfields sets will be examined. If a .._scalar_len parameter is zero, the
corresponding .._scalar and .._scalar_index parameters are ignored, and the
literal parameter (m1, b1, &c.) is used for that parameter. If the
.._scalar_len parameter is non-zero, the literal parameter is ignored, and the
scalar is set to the field code specified by the corresponding .._scalar and
.._scalar_index parameters.
* GDADCL(dirfile_unit, field_code, field_code_len, nfields, in_field1,
in_field1_len, m1, b1, in_field2, in_field2_len, m2, b2, in_field3,
in_field3_len, m3, b3, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field1_len, in_field2_len
INTEGER in_field3_len, fragment_index
COMPLEX*16 m1, b1, m2, b2, m3, b3
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<in_field2_len> in_field2
CHARACTER*<in_field3_len> in_field3
This is equivalent to GDASCL with all the .._scalar_len parameters set to
zero. (i.e. using literal scalars only.)
* GDASLC(dirfile_unit, field_code, field_code_len, nfields, in_field1,
in_field1_len, m1, m1_scalar, m1_scalar_len, m1_scalar_index, b1, b1_scalar,
b1_scalar_len, b1_scalar_index, in_field2, in_field2_len, m2, m2_scalar,
m2_scalar_len, m2_scalar_index, b2, b2_scalar, b2_scalar_len, b2_scalar_index,
in_field3, in_field3_len, m3, m3_scalar, m3_scalar_len, m3_scalar_index, b3,
b3_scalar, b3_scalar_len, b3_scalar_index, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field1_len, m1_scalar_len
INTEGER m1_scalar_index, b1_scalar_len, b1_scalar_index, in_field2_len
INTEGER m2_scalar_len, m2_scalar_index, b2_scalar_len, b2_scalar_index
INTEGER in_field3_len, m3_scalar_len, m3_scalar_index, b3_scalar_len
INGEGER b3_scalar_index, fragment_index
REAL*8 m1, b1, m2, b2, m3, b3
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<m1_scalar_len> m1_scalar
CHARACTER*<b1_scalar_len> b1_scalar
CHARACTER*<in_field2_len> in_field2
CHARACTER*<m2_scalar_len> m2_scalar
CHARACTER*<b2_scalar_len> b2_scalar
CHARACTER*<in_field3_len> in_field3
CHARACTER*<m3_scalar_len> m3_scalar
CHARACTER*<b3_scalar_len> b3_scalar
This is equivalent to GDASCL above, but takes purely real parameters.
* GDADLC(dirfile_unit, field_code, field_code_len, nfields, in_field1,
in_field1_len, m1, b1, in_field2, in_field2_len, m2, b2, in_field3,
in_field3_len, m3, b3, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, nfields, in_field1_len, in_field2_len
INTEGER in_field3_len, fragment_index
REAL*8 m1, b1, m2, b2, m3, b3
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<in_field2_len> in_field2
CHARACTER*<in_field3_len> in_field3
This is equivalent to GDADCL above, but takes purely real parameters.
* GDADLT(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
table, table_len, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, table_len
INTEGER fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<table_len> table
This subroutine adds a LINTERP field with the supplied parameters to the
specified format file fragment of the dirfile.
* GDASBT(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
bitnum, bitnum_scalar, bitnum_scalar_len, bitnum_scalar_index,
numbits, numbits_scalar, numbits_scalar_len, numbits_scalar_index,
fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, fragment_index
INTEGER bitnum, bitnum_scalar_len, bitnum_scalar_index
INTEGER numbits, numbits_scalar_len, numbits_scalar_index
CHARACTER*<field_code_len> field_code
CHARACTER*<bitnum_scalar_len> bitnum_scalar
CHARACTER*<numbits_scalar_len> numbits_scalar
CHARACTER*<in_field_len> in_field
This subroutine adds a BIT field with the supplied parameters to the
specified format file fragment of the dirfile. If bitnum_scalar_len is zero,
the bitnum_scalar and bitnum_scalar_index values are ignored and the literal
value of bitnum is used. If bitnum_scalar_len is non-zero, the value of
bitnum is ignored and bitnum_scalar and bitnum_scalar_index is used to form
a scalar field code for bitnum. Similarly with numbits. See also GDADBT.
* GDADBT(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
bitnum, numbits, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, bitnum, numbits
INTEGER fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
This function is equivalent to calling GDASBT (above) with bitnum_scalar_len
and numbits_scalar_len set to zero (i.e. with literal parameters only).
* GDASSB(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
bitnum, bitnum_scalar, bitnum_scalar_len, bitnum_scalar_index,
numbits, numbits_scalar, numbits_scalar_len, numbits_scalar_index,
fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, fragment_index
INTEGER bitnum, bitnum_scalar_len, bitnum_scalar_index
INTEGER numbits, numbits_scalar_len, numbits_scalar_index
CHARACTER*<field_code_len> field_code
CHARACTER*<bitnum_scalar_len> bitnum_scalar
CHARACTER*<numbits_scalar_len> numbits_scalar
CHARACTER*<in_field_len> in_field
This subroutine adds a SBIT field with the supplied parameters to the
specified format file fragment of the dirfile. If bitnum_scalar_len is zero,
the bitnum_scalar and bitnum_scalar_index values are ignored and the literal
value of bitnum is used. If bitnum_scalar_len is non-zero, the value of
bitnum is ignored and bitnum_scalar and bitnum_scalar_index is used to form
a scalar field code for bitnum. Similarly with numbits. See also GDADBT.
* GDADSB(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
bitnum, numbits, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, bitnum, numbits
INTEGER fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
This function is equivalent to calling GDASSB (above) with bitnum_scalar_len
and numbits_scalar_len set to zero (i.e. with literal parameters only).
* GDASCR(dirfile_unit, field_code, field_code_len, in_field1, in_field1_len,
divident, divident_scalar, divident_scalar_len, divident_scalar_index,
fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field1_len
INTEGER dividend_scalar_len, dividend_scalar_index, fragment_index
COMPLEX*16 dividend
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<dividend_scalar_len> dividend_scalar.
This subroutine adds a PHASE field with the supplied parameters to the
specified fragment of the dirfile. If dividend_scalar_len is zero,
dividend_scalar and dividend_scalar_index are ignored, and the literal value
dividend is used for the parameter. If dividend_scalar_len is non-zero, the
literal dividend is ignored and the field code specified by dividend_scalar
and dividend_scalar_index is used for the parameter.
* GDADCR(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
dividend, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len
INTEGER fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
COMPLEX*16 dividend
This is equivalent to GDASCR with dividend_scalar_len set to zero (i.e. with a
literal parameter only).
* GDASRC(dirfile_unit, field_code, field_code_len, in_field1, in_field1_len,
divident, divident_scalar, divident_scalar_len, divident_scalar_index,
fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field1_len
INTEGER dividend_scalar_len, dividend_scalar_index, fragment_index
REAL*8 dividend
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<dividend_scalar_len> dividend_scalar.
This is equivalent to GDASCR, but with a purely real dividend.
* GDADRC(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
dividend, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len
INTEGER fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
REAL*8 dividend
This is equivalent to GDASRC with dividend_scalar_len set to zero (i.e. with a
literal parameter only).
* GDADMT(dirfile_unit, field_code, field_code_len, in_field1, in_field1_len,
in_field2, in_field2_len, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field1_len, in_field2_len
INTEGER fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<in_field2_len> in_field2
This subroutine adds a MULTIPLY field with the supplied parameters to the
specified format file fragment of the dirfile.
* GDADDV(dirfile_unit, field_code, field_code_len, in_field1, in_field1_len,
in_field2, in_field2_len, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field1_len, in_field2_len
INTEGER fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field1_len> in_field1
CHARACTER*<in_field2_len> in_field2
This subroutine adds a DIVIDE field with the supplied parameters to the
specified format file fragment of the dirfile.
* GDASCP(dirfile_unit, field_code, field_code_len, poly_ord, in_field,
in_field_len, a0, a0_scalar, a0_scalar_len, a0_scalar_index, a1, a1_scalar,
a1_scalar_len, a1_scalar_index, a2, a2_scalar, a2_scalar_len, a2_scalar_index,
a3, a3_scalar, a3_scalar_len, a3_scalar_index, a4, a4_scalar, a4_scalar_len,
a4_scalar_index, a5, a5_scalar, a5_scalar_len, a5_scalar_index,
fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, poly_ord, in_field_len
INTEGER a0_scalar_len, a0_scalar_index, a1_scalar_len, a1_scalar_index
INTEGER a2_scalar_len, a2_scalar_index, a3_scalar_len, a3_scalar_index
INTEGER a4_scalar_len, a4_scalar_index, a5_scalar_len, a5_scalar_index
INTEGER fragment_index
COMPLEX*16 a0, a1, a2, a3, a4, a5
CHARACTER*<field_code_len> field_code
CHARACTER*<a0_scalar_len> a0_scalar_len
CHARACTER*<a1_scalar_len> a1_scalar_len
CHARACTER*<a2_scalar_len> a2_scalar_len
CHARACTER*<a3_scalar_len> a3_scalar_len
CHARACTER*<a4_scalar_len> a4_scalar_len
CHARACTER*<a5_scalar_len> a5_scalar_len
CHARACTER*<in_field_len> in_field
This subroutine adds a POLYNOM field with the supplied parameters to the
specified format file fragment of the dirfile. All six coefficients are
required to be passed to the call, but only the first poly_ord + 1 will be
examined. If a .._scalar_len parameter is zero, the corresponding .._scalar
and .._scalar_index parameters are ignored, and the literal parameter (a0, a1,
&c.) is used for that parameter. If the .._scalar_len parameter is non-zero,
the literal parameter is ignored, and the scalar is set to the field code
specified by the corresponding .._scalar and .._scalar_index parameters.
* GDADCP(dirfile_unit, field_code, field_code_len, poly_ord, in_field,
in_field_len, a0, a1, a2, a3, a4, a5, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, poly_ord, in_field_len
INTEGER fragment_index
COMPLEX*16 a0, a1, a2, a3, a4, a5
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
This is equivalent to GDASCP with all the .._scalar_len parameters set to
zero. (i.e. using literal scalars only.)
* GDASPN(dirfile_unit, field_code, field_code_len, poly_ord, in_field,
in_field_len, a0, a0_scalar, a0_scalar_len, a0_scalar_index, a1, a1_scalar,
a1_scalar_len, a1_scalar_index, a2, a2_scalar, a2_scalar_len, a2_scalar_index,
a3, a3_scalar, a3_scalar_len, a3_scalar_index, a4, a4_scalar, a4_scalar_len,
a4_scalar_index, a5, a5_scalar, a5_scalar_len, a5_scalar_index,
fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, poly_ord, in_field_len
INTEGER a0_scalar_len, a0_scalar_index, a1_scalar_len, a1_scalar_index
INTEGER a2_scalar_len, a2_scalar_index, a3_scalar_len, a3_scalar_index
INTEGER a4_scalar_len, a4_scalar_index, a5_scalar_len, a5_scalar_index
INTEGER fragment_index
REAL*8 a0, a1, a2, a3, a4, a5
CHARACTER*<field_code_len> field_code
CHARACTER*<a0_scalar_len> a0_scalar_len
CHARACTER*<a1_scalar_len> a1_scalar_len
CHARACTER*<a2_scalar_len> a2_scalar_len
CHARACTER*<a3_scalar_len> a3_scalar_len
CHARACTER*<a4_scalar_len> a4_scalar_len
CHARACTER*<a5_scalar_len> a5_scalar_len
CHARACTER*<in_field_len> in_field
This subroutine is equivalent GDASCP, but takes purely real parameters.
* GDADPN(dirfile_unit, field_code, field_code_len, poly_ord, in_field,
in_field_len, a0, a1, a2, a3, a4, a5, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, poly_ord, in_field_len
INTEGER fragment_index
REAL*8 a0, a1, a2, a3, a4, a5
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
This subroutine is equivalent GDADCP, but takes purely real parameters.
* GDASPH(dirfile_unit, field_code, field_code_len, in_field1, in_field1_len,
shift, shift_scalar, shift_scalar_len, shift_scalar_index, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field1_len, shift
INTEGER shift_scalar_len, shift_scalar_index, fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<shift_scalar_len> shift_scalar.
This subroutine adds a PHASE field with the supplied parameters to the
specified fragment of the dirfile. If shift_scalar_len is zero, shift_scalar
and shift_scalar_index are ignored, and the literal value shift is used for
the parameter. If shift_scalar_len is non-zero, the literal shift is ignored
and the field code specified by shift_scalar and shift_scalar_index is used
for the parameter.
* GDADPH(dirfile_unit, field_code, field_code_len, in_field1, in_field1_len,
shift, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field1_len, shift, fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
This is equivalent to GDASPH above with shift_scalar_len set to zer (i.e. with
a literal parameter only).
* GDASWD(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
check_field, check_field_len, windop, threshold, threshold_scalar,
threshold_scalar_len, threshold_scalar_index, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, check_field_len
INTEGER threshold_scalar_len, threshold_scalar_index, windop
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<check_field_len> check_field
INTEGER threshold
or
REAL*8 threshold
This subroutine adds a WINDOW field with the supplied parameters to the
specified fragment of the dirfile. If threshold_scalar_len is zero,
threshold_scalar and threshold_scalar_index are ignored, and the literal value
threshold is used for the parameter. In this case, if windop is one of
GDW_EQ, GDW_NE, GDW_ST, or GDW_CL, threshold should be an integer; otherwise,
threshold should be a real. If threshold_scalar_len is non-zero, the literal
threshold is ignored and the field code specified by threshold_scalar and
threshold_scalar_index is used for the parameter.
* GDADWD(dirfile_unit, field_code, field_code_len, in_field, in_field_len,
check_field, check_field_len, windop, threshold, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, in_field_len, check_field_len, windop
INTEGER fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<in_field_len> in_field
CHARACTER*<check_field_len> check_field
INTEGER threshold
or
REAL*8 threshold
This is equivalent to GDASWD with threshold_scalar_len set to zero (i.e. with
a literal parameter only).
* GDASMX(dirfile_unit, field_code, field_code_len, infield, infield_len,
countfield, countfield_len, countval, countval_scalar, countval_scalar_len,
countval_scalar_index, period, period_scalar, period_scalar_len,
period_scalar_index, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, infield_len, countfile_len, countval
INTEGER countval_scalar_len, countval_scalar_index, period
INTEGER period_scalar_len, period_scalar_index, fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<infield_len> infield
CHARACTER*<countfield_len> countfield
CHARACTER*<countval_scalar_len> countval_scalar
CHARACTER*<period_scalar_len> period_scalar
This subroutine adds a MPLEX field with the supplied parameters to the
specified fragment of the dirfile. If countval_scalar_len is zero,
countval_scalar and countval_scalar_index are ignored and the literal value
countval is used for the parameter. If countval_scalar_len is non-zero, the
literal countval is ignored, and the field code specified by countval_scalar
and countval_scalar_index are used for the parameter. Similarly with period.
* GDADMX(dirfile_unit, field_code, field_code_len, infield, infield_len,
countfield, countfield_len, countval, period, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, infield_len, countfile_len, countval
INTEGER period, fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<infield_len> infield
CHARACTER*<countfield_len> countfield
This subroutine is equivalent to GDASMX above with countval_scalar_len and
period_scalar_len set to zero (i.e. with literal parameters only).
* GDADCA(dirfile_unit, field_code, field_code_len, const_type, array_len,
data_type, data, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, const_type, data_type, fragment_index
INTEGER array_len
CHARACTER*<field_code_len> field_code
<data_type> data(array_len)
This subroutine adds a CARRAY field with the supplied parameters to the
specified format file fragment of the dirfile. const_type is the data type
of the field when stored in the dirfile. data_type is the data type of the
supplied data. These need not be the same.
* GDADCO(dirfile_unit, field_code, field_code_len, const_type, data_type,
value, fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, const_type, data_type, fragment_index
CHARACTER*<field_code_len> field_code
<data_type> value
This subroutine adds a CONST field with the supplied parameters to the
specified format file fragment of the dirfile. const_type is the data type
of the field when stored in the dirfile. data_type is the data type of the
supplied value. These need not be the same.
* GDADST(dirfile_unit, field_code, field_code_len, value, value_len,
fragment_index)
Input:
INTEGER dirfile_unit, field_code_len, value_len, fragment_index
CHARACTER*<field_code_len> field_code
CHARACTER*<value_len> value
This subroutine adds a STRING field with the supplied parameters to the
specified format file fragment of the dirfile
* GDADSP(dirfile_unit, spec, spec_len, fragment_index)
Input:
INTEGER dirfile_unit, fragment_index, spec_len
CHARACTER*<spec_len> spec
This subroutine wraps gd_add_spec(3), and allows adding a field to a dirfile
given a field specification line.
* GDMDSP(dirfile_unit, spec, spec_len, parent, parent_len)
Input:
INTEGER dirfile_unit, spec_len, parent_len
CHARACTER*<spec_len> spec
CHARACTER*<parent_len> parent
This subroutine wraps gd_madd_spec(3), and allows adding a metafield to a
dirfile given a field specification line.
* GDMDAL(dirfile_unit, parent, parent_len, field_code, field_code_len, targ,
targ_len)
* GDMDBT(dirfile_unit, parent, parent_len, field_code, field_code_len, in_field,
in_field_len, bitnum, numbits)
* GDMDCL(dirfile_unit, parent, parent_len, field_code, field_code_len, nfields,
in_field1, in_field1_len, m1, b1, in_field2, in_field2_len, m2, b2, in_field3,
in_field3_len, m3, b3)
* GDFACO(dirfile_unit, parent, parent_len, field_code, field_code_len,
const_type, data_type, value)
* GDMDCP(dirfile_unit, parent, parent_len, field_code, field_code_len, poly_ord,
int_field, in_field_len, a0, a1, a2, a3, a4, a5)
* GDMDCR(dirfile_unit, parent, parent_len, field_code, field_code_len, in_field,
in_field_len, dividend)
* GDMDDV(dirfile_unit, parent, parent_len, field_code, field_code_len,
in_field1, in_field1_len, in_field2, in_field2_len)
* GDMDLC(dirfile_unit, parent, parent_len, field_code, field_code_len, nfields,
in_field1, in_field1_len, m1, b1, in_field2, in_field2_len, m2, b2, in_field3,
in_field3_len, m3, b3)
* GDMDLT(dirfile_unit, parent, parent_len, field_code, field_code_len, in_field,
in_field_len, table, table_len)
* GDMDMT(dirfile_unit, parent, parent_len, field_code, field_code_len,
in_field1, in_field1_len, in_field2, in_field2_len)
* GDMDPH(dirfile_unit, parent, parent_len, field_code, field_code_len,
in_field, in_field_len, shift)
* GDMDPN(dirfile_unit, parent, parent_len, field_code, field_code_len, poly_ord,
int_field, in_field_len, a0, a1, a2, a3, a4, a5)
* GDMDRC(dirfile_unit, parent, parent_len, field_code, field_code_len, in_field,
in_field_len, dividend)
* GDMDSB(dirfile_unit, parent, parent_len, field_code, field_code_len, in_field,
in_field_len, bitnum, numbits)
* GDMDWD(dirfile_unit, parent, field_code, field_code_len, in_field,
in_field_len, check_field, check_field_len, windop, threshold)
* GDMDMX(dirfile_unit, parent, field_code, field_code_len, in_field,
in_field_len, count_field, count_field_len, count_val, period)
* GDMDCA(dirfile_unit, parent, parent_len, field_code, field_code_len,
const_type, array_len, data_type, data)
* GDMDCO(dirfile_unit, parent, parent_len, field_code, field_code_len,
const_type, data_type, value)
* GDMDST(dirfile_unit, parent, parent_len, field_code, field_code_len, value,
value_len)
These functions are the corresponding META field functions for the GDADxx
functions above. They add META fields to the parent field indicated.
Defined Parameters
==================
The following parameters, listed here with their C library analogues, are
defined in getdata.f which may be included in any Fortran program using the
Fortran 77 bindings.
Error codes (returned by GDEROR):
F77 symbol C symbol Notes
---------- ------------------- ---------------------------------------
GD_EOK GD_E_OK This is guaranteed to be equal to zero.
GD_EAC GD_E_ACCMODE
GD_EAL GD_E_ALLOC
GD_EAR GD_E_ARGUMENT
GD_EBC GD_E_BAD_CODE
GD_EBD GD_E_BAD_DIRFILE
GD_EBE GD_E_BAD_ENTRY
GD_EBF GD_E_BAD_FIELD_TYPE
GD_EBI GD_E_BAD_INDEX
GD_EBO GD_E_BOUNDS
GD_EBP GD_E_BAD_PROTECTION Deprecated; kept as an alias for GD_EAR.
GD_EBR GD_E_BAD_REFERENCE
GD_EBS GD_E_BAD_SCALAR
GD_EBT GD_E_BAD_TYPE
GD_ECB GD_E_CALLBACK
GD_ECR GD_E_CREAT
GD_EDL GD_E_DELETE
GD_EDM GD_E_DIMENSION
GD_EDO GD_E_DOMAIN
GD_EDU GD_E_DUPLICATE
GD_EEN GD_E_BAD_ENDIANNESS Deprecated; kept as an alias for GD_EAR.
GD_EEX GD_E_EXISTS
GD_EFL GD_E_FLUSH
GD_EFO GD_E_FORMAT
GD_EIE GD_E_INTERNAL_ERROR
GD_EOF GD_E_OPEN_FRAGMENT
GD_EOI GD_E_OPEN_INCLUDE Deprecated; kept as an alias for GD_EOF.
GD_EOL GD_E_OPEN_LINFILE
GD_EOP GD_E_OPEN
GD_EPT GD_E_PROTECTED
GD_ERA GD_E_RANGE
GD_ERL GD_E_RECURSE_LEVEL
GD_ERP GD_E_BAD_REPR
GD_ERW GD_E_RAW_IO
GD_ETL GD_E_LINE_TOO_LONG
GD_ETR GD_E_TRUNC
GD_EUE GD_E_UNKNOWN_ENCODING
GD_EVR GD_E_BAD_VERSION Deprecated; kept as an alias for GD_EAR.
GD_UCL GD_E_UNCLEAN_DB
GD_UNS GD_E_UNSUPPORTED
Dirfile flags (required by GDOPEN, GDCOPN, GDINCL, GDINCA, and GDFLAG):
F77 symbol C symbol Notes
---------- ----------------- --------------------------------------
GD_RO GD_RDONLY The flags argument passed to GDOPEN
GD_RW GD_RDWR must contain at least GD_RO or GD_RW
GD_AE GD_ARM_ENDIAN
GD_BE GD_BIG_ENDIAN
GD_CR GD_CREAT
GD_EX GD_EXCL
GD_FC GD_FORCE_ENCODING
GD_FE GD_FORCE_ENDIAN
GD_ID GD_IGNORE_DUPS
GD_IR GD_IGNORE_REFS
GD_LE GD_LITTLE_ENDIAN
GD_NA GD_NOT_ARM_ENDIAN
GD_PE GD_PEDANTIC
GD_PM GD_PERMISSIVE
GD_PP GD_PRETTY_PRINT
GD_TR GD_TRUNC
GD_TS GD_TRUNCSUB
GD_VB GD_VERBOSE
Encoding types:
F77 symbol C symbol Notes
---------- ----------------- --------------------------------------
GDE_AU GD_AUTO_ENCODED
GDE_BZ GD_BZIP2_ENCODED
GDE_GZ GD_GZIP_ENCODED
GDE_LZ GD_LZMA_ENCODED
GDE_SL GD_SLIM_ENCODED
GDE_SI GD_SIE_ENCODED
GDE_TX GD_TEXT_ENCODED
GDE_UN GD_UNENCODED
GDE_ZS GD_ZZSLIM_ENCODED
GDE_ZZ GD_ZZIP_ENCODED
Entry types (required by GDFLDT):
F77 symbol C symbol Notes
---------- ----------------- --------------------------------------
GD_NOE GD_NO_ENTRY Indicating an invalid field type
GD_RWE GD_RAW_ENTRY
GD_LCE GD_LINCOM_ENTRY
GD_LTE GD_LINTERP_ENTRY
GD_BTE GD_BIT_ENTRY
GD_MTE GD_MULTIPLY_ENTRY
GD_PHE GD_PHASE_ENTRY
GD_IXE GD_INDEX_ENTRY
GD_PNE GD_POLYNOM_ENTRY
GD_SBE GD_SBIT_ENTRY
GD_DVE GD_DIVIDE_ENTRY
GD_RCE GD_RECIP_ENTRY
GD_WDE GD_WINDOW_ENTRY
GD_MXE GD_MPLEX_ENTRY
GD_COE GD_CONST_ENTRY
GD_CAE GD_CARRAY_ENTRY
GD_STE GD_STRING_ENTRY
Data types. Note, Fortran does not support unsigned data types, but GDGERW may
still return an unsigned type, so all types are defined here. The unsigned data
type specifiers will be accepted by the other subroutines, but the data returned
may not be properly interpretable by Fortran 77.
F77 symbol C symbol Notes
---------- ----------------- --------------------------------------
GD_NUL GD_NULL Not suitable to be passed to GDPUTD
GD_U8 GD_UINT8
GD_I8 GD_INT8
GD_U16 GD_UINT16
GD_I16 GD_INT16
GD_U32 GD_UINT32
GD_I32 GD_INT32
GD_U64 GD_UINT64
GD_I64 GD_INT64
GD_F32 GD_FLOAT32
GD_F64 GD_FLOAT64
GD_C64 GD_COMPLEX64
GDC128 GD_COMPLEX128
Delete flags (required by GDDELE):
F77 symbol C symbol
---------- -----------------
GDD_MT GD_DEL_META
GDD_DT GD_DEL_DATA
GDD_DR GD_DEL_DEREF
GDD_FO GD_DEL_FORCE
Rename flags (requred by GDRENM):
F77 symbol C symbol
---------- -----------------
GDR_DT GD_REN_DATA
GDR_UP GD_REN_UPDB
Protection levels (returned by GDGPRT and required by GDAPRT):
F77 symbol C symbol Notes
---------- ----------------- --------------------------------------
GDPR_N GD_PROTECT_NONE
GDPR_F GD_PROTECT_FORMAT
GDPR_D GD_PROTECT_DATA
GDPR_A GD_PROTECT_ALL This is the bitwise or of GDPR_D and GDPR_A
Syntax error handler actions (returned by the registered callback function, see
GDCOPN)
F77 symbol C symbol
---------- -------------------
GDSX_A GD_PROTECT_ABORT
GDSX_S GD_PROTECT_RESCAN
GDSX_I GD_PROTECT_IGNORE
GDSX_C GD_PROTECT_CONTINUE
Syntax suberrors (provided to the registered callback function, see GDCOPN):
F77 symbol C symbol
---------- ---------------------
GDF_AL GD_E_FORMAT_ALIAS
GDF_BN GD_E_FORMAT_BITNUM
GDF_CH GD_E_FORMAT_CHARACTER
GDF_DU GD_E_FORMAT_DUPLICATE
GDF_EN GD_E_FORMAT_ENDIAN
GDF_LI GD_E_FORMAT_BAD_LINE
GDF_LO GD_E_FORMAT_LOCATION
GDF_LT GD_E_FORMAT_LITERAL
GDF_MM GD_E_FORMAT_META_META
GDF_MR GD_E_FORMAT_METARAW
GDF_MV GD_E_FORMAT_MPLEXVAL
GDF_NA GD_E_FORMAT_BAD_NAME
GDF_NB GD_E_FORMAT_NUMBITS
GDF_NF GD_E_FORMAT_N_FIELDS
GDF_NT GD_E_FORMAT_N_TOK
GDF_PA GD_E_FORMAT_NO_PARENT
GDF_PR GD_E_FORMAT_PROTECT
GDF_RN GD_E_FORMAT_RES_NAME
GDF_SF GD_E_FORMAT_BAD_SPF
GDF_SZ GD_E_FORMAT_BITSIZE
GDF_TY GD_E_FORMAT_BAD_TYPE
GDF_UM GD_E_FORMAT_UNTERM
GDF_WO GD_E_FORMAT_WINDOP
Special version symbols:
F77 symbol C symbol
---------- ---------------------
GDSV_C GD_VERSION_CURRENT
GDSV_L GD_VERSION_LATEST
GDSV_E GD_VERSION_EARLIEST
Seek flags:
F77 symbol C symbol
---------- ---------------------
GDSK_C GD_SEEK_CUR
GDSK_E GD_SEEK_END
GDSK_P GD_SEEK_PAD
GDSK_S GD_SEEK_SET
WINDOW entry operations:
F77 symbol C symbol
---------- ---------------------
GDW_CL GD_WINDOP_CLR
GDW_EQ GD_WINDOP_EQ
GDW_GE GD_WINDOP_GE
GDW_GT GD_WINDOP_GT
GDW_LE GD_WINDOP_LE
GDW_LT GD_WINDOP_LT
GDW_NE GD_WINDOP_NE
GDW_ST GD_WINDOP_SET
GDW_UN GD_WINDOP_UNK
Desync flags:
F77 symbol C symbol
---------- ---------------------
GDDS_P GD_DESYNC_PATHCHECK
GDDS_O GD_DESYNC_REOPEN
MPLEX lookback parameters:
F77 symbol C symbol
---------- ---------------------
GDLB_A GD_LOOKBACK_ALL
GDLB_D GD_DEFAULT_LOOKBACK
Miscellaneous parameters:
F77 symbol C symbol
---------- -------------------------
GD_ALL GD_ALL_FRAGMENTS
GD_DSV GD_DIRFILE_STANDARDS_VERSION
GD_HER GD_HERE
GD_MLL GD_MAX_LINE_LENGTH
|