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
|
/*
CDI C header file
This is the only file that must be included to use the CDI library from C.
*/
#ifndef CDI_H_
#define CDI_H_
// clang-format off
#include <stdio.h>
#include <stdint.h> // int64_t
#include <stdbool.h>
#include <sys/types.h>
#ifndef CDI_SIZE_TYPE
#define CDI_SIZE_TYPE int
#endif
typedef CDI_SIZE_TYPE SizeType;
//FINT_ON <--- don't change or remove this line!!!
// Start of fortran interface for the following routines (make_fint.c)
#ifdef __cplusplus
extern "C" {
#endif
#define CDI_MAX_NAME 256 // Max length of a name
#define CDI_UNDEFID -1
#define CDI_GLOBAL -1 // Global var ID for vlist and Z-axis
#define CDI_XAXIS 1 // X-axis ID for grid
#define CDI_YAXIS 2 // Y-axis ID for grid
// Byte order
#define CDI_BIGENDIAN 0 // Byte order BIGENDIAN
#define CDI_LITTLEENDIAN 1 // Byte order LITTLEENDIAN
#define CDI_PDPENDIAN 2
#define CDI_REAL 1 // Real numbers
#define CDI_COMP 2 // Complex numbers
#define CDI_BOTH 3 // Both numbers
// Error identifier
#define CDI_NOERR 0 // No Error
#define CDI_EEOF -1 // The end of file was encountered
#define CDI_ETMOF -9 // Too many open files
#define CDI_ESYSTEM -10 // Operating system error
#define CDI_EINVAL -20 // Invalid argument
#define CDI_EISDIR -21 // Is a directory
#define CDI_EISEMPTY -22 // Is empty
#define CDI_EUFTYPE -23 // Unsupported file type
#define CDI_ELIBNAVAIL -24 // xxx library not available
#define CDI_EUFSTRUCT -25 // Unsupported file structure
#define CDI_EUNC4 -26 // Unsupported NetCDF4 structure
#define CDI_EDIMSIZE -27 // Invalid dimension size
#define CDI_EQENF -50 // Query entries not found
#define CDI_EQNAVAIL -51 // Query not available for file type
#define CDI_ELIMIT -99 // Internal limits exceeded
// File types
#define CDI_FILETYPE_GRB 1 // File type GRIB
#define CDI_FILETYPE_GRB2 2 // File type GRIB version 2
#define CDI_FILETYPE_NC 3 // File type NetCDF
#define CDI_FILETYPE_NC2 4 // File type NetCDF version 2 (64-bit offset)
#define CDI_FILETYPE_NC4 5 // File type NetCDF version 4
#define CDI_FILETYPE_NC4C 6 // File type NetCDF version 4 (classic)
#define CDI_FILETYPE_NC5 7 // File type NetCDF version 5 (64-bit data)
#define CDI_FILETYPE_SRV 8 // File type SERVICE
#define CDI_FILETYPE_EXT 9 // File type EXTRA
#define CDI_FILETYPE_IEG 10 // File type IEG
#define CDI_FILETYPE_NCZARR 11 // File type NetCDF NCZarr Data Model
// Compatibility defines for release 1.8.3 (obsolete defines)
#define FILETYPE_GRB 1 // File type GRIB
#define FILETYPE_GRB2 2 // File type GRIB version 2
#define FILETYPE_NC 3 // File type NetCDF
#define FILETYPE_NC2 4 // File type NetCDF version 2 (64-bit offset)
#define FILETYPE_NC4 5 // File type NetCDF version 4
// Protocols (in filename/URI)
#define CDI_PROTOCOL_OTHER 0 // Any other protocol (might be supported by NetCDF library)
#define CDI_PROTOCOL_FILE 1
#define CDI_PROTOCOL_FDB 2
#define CDI_PROTOCOL_ACROSS 3
// Compress types
#define CDI_COMPRESS_NONE 0
#define CDI_COMPRESS_SZIP 1
#define CDI_COMPRESS_AEC 2
#define CDI_COMPRESS_ZIP 3
#define CDI_COMPRESS_JPEG 4
#define CDI_COMPRESS_FILTER 5
// external data types
// Compatibility defines for release 1.8.3 (obsolete defines)
#define DATATYPE_PACK16 16
#define DATATYPE_PACK24 24
#define DATATYPE_FLT32 132
#define DATATYPE_FLT64 164
#define DATATYPE_INT32 232
#define DATATYPE_INT 251
#define CDI_DATATYPE_PACK 0
#define CDI_DATATYPE_PACK1 1
#define CDI_DATATYPE_PACK2 2
#define CDI_DATATYPE_PACK3 3
#define CDI_DATATYPE_PACK4 4
#define CDI_DATATYPE_PACK5 5
#define CDI_DATATYPE_PACK6 6
#define CDI_DATATYPE_PACK7 7
#define CDI_DATATYPE_PACK8 8
#define CDI_DATATYPE_PACK9 9
#define CDI_DATATYPE_PACK10 10
#define CDI_DATATYPE_PACK11 11
#define CDI_DATATYPE_PACK12 12
#define CDI_DATATYPE_PACK13 13
#define CDI_DATATYPE_PACK14 14
#define CDI_DATATYPE_PACK15 15
#define CDI_DATATYPE_PACK16 16
#define CDI_DATATYPE_PACK17 17
#define CDI_DATATYPE_PACK18 18
#define CDI_DATATYPE_PACK19 19
#define CDI_DATATYPE_PACK20 20
#define CDI_DATATYPE_PACK21 21
#define CDI_DATATYPE_PACK22 22
#define CDI_DATATYPE_PACK23 23
#define CDI_DATATYPE_PACK24 24
#define CDI_DATATYPE_PACK25 25
#define CDI_DATATYPE_PACK26 26
#define CDI_DATATYPE_PACK27 27
#define CDI_DATATYPE_PACK28 28
#define CDI_DATATYPE_PACK29 29
#define CDI_DATATYPE_PACK30 30
#define CDI_DATATYPE_PACK31 31
#define CDI_DATATYPE_PACK32 32
#define CDI_DATATYPE_CPX32 64
#define CDI_DATATYPE_CPX64 128
#define CDI_DATATYPE_FLT32 132
#define CDI_DATATYPE_FLT64 164
#define CDI_DATATYPE_INT8 208
#define CDI_DATATYPE_INT16 216
#define CDI_DATATYPE_INT32 232
#define CDI_DATATYPE_UINT8 308
#define CDI_DATATYPE_UINT16 316
#define CDI_DATATYPE_UINT32 332
// internal data types
#define CDI_DATATYPE_INT 251
#define CDI_DATATYPE_FLT 252
#define CDI_DATATYPE_TXT 253
#define CDI_DATATYPE_CPX 254
#define CDI_DATATYPE_UCHAR 255
#define CDI_DATATYPE_LONG 256
#define CDI_DATATYPE_UINT 257
// Chunk types
#define CDI_CHUNK_AUTO 1 // use default chunk size
#define CDI_CHUNK_GRID 2
#define CDI_CHUNK_LINES 3
// GRID types
#define GRID_GENERIC 1 // Generic grid
#define GRID_GAUSSIAN 2 // Regular Gaussian lon/lat grid
#define GRID_GAUSSIAN_REDUCED 3 // Reduced Gaussian lon/lat grid
#define GRID_LONLAT 4 // Regular longitude/latitude grid
#define GRID_SPECTRAL 5 // Spherical harmonic coefficients (spectral gaussian)
#define GRID_FOURIER 6 // Fourier coefficients (spectral gaussian)
#define GRID_GME 7 // Icosahedral-hexagonal GME grid
#define GRID_TRAJECTORY 8 // Trajectory
#define GRID_UNSTRUCTURED 9 // General unstructured grid
#define GRID_CURVILINEAR 10 // Curvilinear grid
#define GRID_HEALPIX 11 // HealPIX grid
#define GRID_PROJECTION 12 // Projected coordinates
#define GRID_CHARXY 13 // One horizontal character dimension
#define CDI_PROJ_RLL 21 // Rotated Latitude Longitude
#define CDI_PROJ_LCC 22 // Lambert Conformal Conic
#define CDI_PROJ_LAEA 23 // Lambert Azimuthal Equal Area
#define CDI_PROJ_SINU 24 // Sinusoidal
#define CDI_PROJ_STERE 25 // Polar stereographic
#define CDI_PROJ_HEALPIX 26 // Healpix
// ZAXIS types
#define ZAXIS_SURFACE 0 // Surface level
#define ZAXIS_GENERIC 1 // Generic level
#define ZAXIS_HYBRID 2 // Hybrid level
#define ZAXIS_HYBRID_HALF 3 // Hybrid half level
#define ZAXIS_PRESSURE 4 // Isobaric pressure level in Pascal
#define ZAXIS_HEIGHT 5 // Height above ground
#define ZAXIS_DEPTH_BELOW_SEA 6 // Depth below sea level in meters
#define ZAXIS_DEPTH_BELOW_LAND 7 // Depth below land surface in centimeters
#define ZAXIS_ISENTROPIC 8 // Isentropic
#define ZAXIS_TRAJECTORY 9 // Trajectory
#define ZAXIS_ALTITUDE 10 // Altitude above mean sea level in meters
#define ZAXIS_SIGMA 11 // Sigma level
#define ZAXIS_MEANSEA 12 // Mean sea level
#define ZAXIS_TOA 13 // Norminal top of atmosphere
#define ZAXIS_SEA_BOTTOM 14 // Sea bottom
#define ZAXIS_ATMOSPHERE 15 // Entire atmosphere
#define ZAXIS_CLOUD_BASE 16 // Cloud base level
#define ZAXIS_CLOUD_TOP 17 // Level of cloud tops
#define ZAXIS_ISOTHERM_ZERO 18 // Level of 0o C isotherm
#define ZAXIS_SNOW 19 // Snow level
#define ZAXIS_LAKE_BOTTOM 20 // Lake or River Bottom
#define ZAXIS_SEDIMENT_BOTTOM 21 // Bottom Of Sediment Layer
#define ZAXIS_SEDIMENT_BOTTOM_TA 22 // Bottom Of Thermally Active Sediment Layer
#define ZAXIS_SEDIMENT_BOTTOM_TW 23 // Bottom Of Sediment Layer Penetrated By Thermal Wave
#define ZAXIS_MIX_LAYER 24 // Mixing Layer
#define ZAXIS_REFERENCE 25 // zaxis reference number
#define ZAXIS_CHAR 26 // Area types
#define ZAXIS_TROPOPAUSE 27 // Tropopause
// SUBTYPE types
enum {
SUBTYPE_TILES = 0 // Tiles variable
};
#define MAX_KV_PAIRS_MATCH 10
/* Data structure defining a key-value search, possibly with multiple
key-value pairs in combination.
Currently, only multiple pairs combined by AND are supported.
*/
typedef struct {
int nAND; // no. of key-value pairs that have to match
int key_value_pairs[2][MAX_KV_PAIRS_MATCH]; // key-value pairs
} subtype_query_t;
// TIME types
#define TIME_CONSTANT 0 // Time constant
#define TIME_VARYING 1 // Time varying
#define TIME_VARIABLE 1 // obsolete, use TIME_VARYING
// TSTEP types
#define TSTEP_CONSTANT 0 // obsolete, use TIME_CONSTANT
#define TSTEP_INSTANT 1 // Instant
#define TSTEP_AVG 2 // Average
#define TSTEP_ACCUM 3 // Accumulation
#define TSTEP_MAX 4 // Maximum
#define TSTEP_MIN 5 // Minimum
#define TSTEP_DIFF 6 // Difference
#define TSTEP_RMS 7 // Root mean square
#define TSTEP_SD 8 // Standard deviation
#define TSTEP_COV 9 // Covariance
#define TSTEP_RATIO 10 // Ratio
#define TSTEP_SUM 11 // Summation
#define TSTEP_RANGE 12
#define TSTEP_INSTANT2 13
#define TSTEP_INSTANT3 14
// TAXIS types
#define TAXIS_ABSOLUTE 1
#define TAXIS_RELATIVE 2
#define TAXIS_FORECAST 3
// TUNIT types
#define TUNIT_SECOND 1
#define TUNIT_MINUTE 2
#define TUNIT_QUARTER 3
#define TUNIT_30MINUTES 4
#define TUNIT_HOUR 5
#define TUNIT_3HOURS 6
#define TUNIT_6HOURS 7
#define TUNIT_12HOURS 8
#define TUNIT_DAY 9
#define TUNIT_MONTH 10
#define TUNIT_YEAR 11
// CALENDAR types
#define CALENDAR_STANDARD 0 // don't change this value (used also in cgribexlib)!
#define CALENDAR_GREGORIAN 1
#define CALENDAR_PROLEPTIC 2
#define CALENDAR_360DAYS 3
#define CALENDAR_365DAYS 4
#define CALENDAR_366DAYS 5
#define CALENDAR_NONE 6
#define CDI_HAS_CGRIBEX 1
#define CDI_NC_HAS_FILTER 2
#define CDI_NC_HAS_DAP 3
#define CDI_NC_HAS_S3 4
#define CDI_NC_HAS_HDF5 5
// number of unsigned char needed to store UUID
#define CDI_UUID_SIZE 16
// Structs that are used to return data to the user
typedef struct CdiParam { int discipline; int category; int number; } CdiParam;
// Opaque types
typedef struct CdiIterator CdiIterator;
typedef struct CdiGribIterator CdiGribIterator;
// CDI control routines
void cdiReset(void);
const char *cdiStringError(int cdiErrno);
void cdiDebug(int debug);
const char *cdiLibraryVersion(void);
void cdiPrintVersion(void);
int cdiHaveFiletype(int fileType);
int cdiGetConfig(int confType);
void cdiDefMissval(double missval);
double cdiInqMissval(void);
void cdiDefGlobal(const char *string, int val);
int namespaceNew(void);
void namespaceSetActive(int namespaceID);
int namespaceGetActive(void);
void namespaceDelete(int namespaceID);
// CDI converter routines
// parameter
void cdiParamToString(int param, char *paramstr, int maxlen);
void cdiDecodeParam(int param, int *pnum, int *pcat, int *pdis);
int cdiEncodeParam(int pnum, int pcat, int pdis);
// date format: YYYYMMDD
// time format: hhmmss
void cdiDecodeDate(int date, int *year, int *month, int *day);
int cdiEncodeDate(int year, int month, int day);
void cdiDecodeTime(int time, int *hour, int *minute, int *second);
int cdiEncodeTime(int hour, int minute, int second);
// STREAM control routines
int cdiGetFiletype(const char *uri, int *byteorder);
int cdiGetProtocol(const char *uri, const char **filename);
int streamOpenReadNCMem(int ncid);
int streamOpenWriteNCMem(int ncid);
void streamCloseNCMem(int ncid);
// streamOpenRead: Open a dataset for reading
int streamOpenRead(const char *path);
// streamOpenWrite: Create a new dataset
int streamOpenWrite(const char *path, int filetype);
int streamOpenAppend(const char *path);
// streamClose: Close an open dataset
void streamClose(int streamID);
// streamSync: Synchronize an Open Dataset to Disk
void streamSync(int streamID);
void streamDefMaxSteps(int streamID, int maxSteps);
void streamDefNumWorker(int streamID, int numWorker);
int streamInqNumSteps(int streamID);
// streamDefVlist: Define the Vlist for a stream
void streamDefVlist(int streamID, int vlistID);
// streamInqVlist: Get the Vlist of a stream
int streamInqVlist(int streamID);
// streamInqFiletype: Get the filetype
int streamInqFiletype(int streamID);
// streamDefByteorder: Define the byteorder
void streamDefByteorder(int streamID, int byteorder);
// streamInqByteorder: Get the byteorder
int streamInqByteorder(int streamID);
void streamDefShuffle(int streamID, int shuffle);
void streamDefFilter(int streamID, const char *filterSpec);
// streamDefCompType: Define compression type
void streamDefCompType(int streamID, int comptype);
// streamInqCompType: Get compression type
int streamInqCompType(int streamID);
// streamDefCompLevel: Define compression level
void streamDefCompLevel(int streamID, int complevel);
// streamInqCompLevel: Get compression level
int streamInqCompLevel(int streamID);
// streamDefTimestep: Define time step
int streamDefTimestep(int streamID, int tsID);
// streamInqTimestep: Get time step
int streamInqTimestep(int streamID, int tsID);
// PIO: query currently set timestep id
int streamInqCurTimestepID(int streamID);
const char *streamFilename(int streamID);
const char *streamFilesuffix(int filetype);
SizeType streamNvals(int streamID);
int streamInqNvars(int streamID);
// STREAM var I/O routines (random access)
// streamWriteVar: Write a variable
void streamWriteVar(int streamID, int varID, const double data[], SizeType numMissVals);
void streamWriteVarF(int streamID, int varID, const float data[], SizeType numMissVals);
// streamReadVar: Read a variable
void streamReadVar(int streamID, int varID, double data[], SizeType *numMissVals);
void streamReadVarF(int streamID, int varID, float data[], SizeType *numMissVals);
void streamReadVarPart(int streamID, int varID, int varType, int start, SizeType size, void *data, SizeType *numMissVals, int memtype);
// streamWriteVarSlice: Write a horizontal slice of a variable
void streamWriteVarSlice(int streamID, int varID, int levelID, const double data[], SizeType numMissVals);
void streamWriteVarSliceF(int streamID, int varID, int levelID, const float data[], SizeType numMissVals);
void streamReadVarSlicePart(int streamID, int varID, int levelID, int varType, int start, SizeType size, void *data, SizeType *numMissVals, int memtype);
// streamReadVarSlice: Read a horizontal slice of a variable
void streamReadVarSlice(int streamID, int varID, int levelID, double data[], SizeType *numMissVals);
void streamReadVarSliceF(int streamID, int varID, int levelID, float data[], SizeType *numMissVals);
void streamWriteVarChunk(int streamID, int varID, const int rect[][2], const double data[], SizeType numMissVals);
void streamWriteVarChunkF(int streamID, int varID, const int rect[][2], const float data[], SizeType numMissVals);
// STREAM field I/O routines (sequential access)
void streamDefField(int streamID, int varID, int levelID);
void streamInqField(int streamID, int *varID, int *levelID);
void streamWriteField(int streamID, const double data[], SizeType numMissVals);
void streamWriteFieldF(int streamID, const float data[], SizeType numMissVals);
void streamReadField(int streamID, double data[], SizeType *numMissVals);
void streamReadFieldF(int streamID, float data[], SizeType *numMissVals);
void streamCopyField(int streamIDdest, int streamIDsrc);
void * stream_get_pointer(int streamID);
void * stream_get_vlist_pointer(int streamID);
void pstreamInqField(void *streamPtr, int *varID, int *levelID);
void streamInqGRIBinfo(int streamID, int *intnum, float *fltnum, off_t *bignum);
// File driven I/O (may yield better performance than using the streamXXX functions)
// Creation & Destruction
CdiIterator *cdiIterator_new(const char *path); // Requires a subsequent call to cdiIteratorNextField() to point the iterator at the first field.
CdiIterator *cdiIterator_clone(CdiIterator *me);
char *cdiIterator_serialize(CdiIterator *me); // Returns a malloc'ed string.
CdiIterator *cdiIterator_deserialize(const char *description); // description is a string that was returned by cdiIteratorSerialize(). Returns a copy of the original iterator.
void cdiIterator_print(CdiIterator *me, FILE *stream);
void cdiIterator_delete(CdiIterator *me);
// Advancing an iterator
int cdiIterator_nextField(CdiIterator *me); // Points the iterator at the next field, returns CDI_EEOF if there are no more fields in the file.
// Introspecting metadata
// All outXXX arguments to these functions may be NULL.
char *cdiIterator_inqStartTime(CdiIterator *me); // Returns the (start) time as an ISO-8601 coded string. The caller is responsible to Free() the returned string.
char *cdiIterator_inqEndTime(CdiIterator *me); // Returns the end time of an integration period as an ISO-8601 coded string, or NULL if there is no end time. The caller is responsible to Free() the returned string.
char *cdiIterator_inqRTime(CdiIterator *me); // Returns the reference date as an ISO-8601 coded string. The caller is responsible to Free() the returned string.
char *cdiIterator_inqVTime(CdiIterator *me); // Returns the validity date as an ISO-8601 coded string. The caller is responsible to Free() the returned string.
int cdiIterator_inqLevelType(CdiIterator *me, int levelSelector, char **outName_optional, char **outLongName_optional, char **outStdName_optional, char **outUnit_optional); // callers are responsible to Free() strings that they request
int cdiIterator_inqLevel(CdiIterator *me, int levelSelector, double *outValue1_optional, double *outValue2_optional); // outValue2 is only written to if the level is a hybrid level
int cdiIterator_inqLevelUuid(CdiIterator *me, int *outVgridNumber_optional, int *outLevelCount_optional, unsigned char outUuid_optional[CDI_UUID_SIZE]); // outUuid must point to a buffer of 16 bytes, returns an error code if no generalized zaxis is used.
int cdiIterator_inqTile(CdiIterator *me, int *outTileIndex, int *outTileAttribute); // Returns CDI_EINVAL if there is no tile information connected to the current field, *outTileIndex and *outTileAttribute will be set to -1 in this case.
int cdiIterator_inqTileCount(CdiIterator *me, int *outTileCount, int *outTileAttributeCount); // outTileAttributeCount is the count for the tile associated with the current field, a total attribute count cannot be inquired. Returns CDI_EINVAL if there is no tile information connected to the current field, *outTileCount and *outTileAttributeCount will be set to 0 in this case.
CdiParam cdiIterator_inqParam(CdiIterator *me);
void cdiIterator_inqParamParts(CdiIterator *me, int *outDiscipline, int *outCategory, int *outNumber); // Some FORTRAN compilers produce wrong code for the cdiIterator_inqParam()-wrapper, rendering it unusable from FORTRAN. This function is the workaround.
int cdiIterator_inqDatatype(CdiIterator *me);
int cdiIterator_inqFiletype(CdiIterator *me);
int cdiIterator_inqTsteptype(CdiIterator *me);
char *cdiIterator_inqVariableName(CdiIterator *me); // The caller is responsible to Free() the returned buffer.
int cdiIterator_inqGridId(CdiIterator *me); // The returned id is only valid until the next call to cdiIteratorNextField().
// Reading data
void cdiIterator_readField(CdiIterator *me, double data[], SizeType *numMissVals_optional);
void cdiIterator_readFieldF(CdiIterator *me, float data[], SizeType *numMissVals_optional);
// TODO[NH]: Add functions to read partial fields.
// Direct access to grib fields
CdiGribIterator *cdiGribIterator_clone(CdiIterator *me); // Returns NULL if the associated file is not a GRIB file.
void cdiGribIterator_delete(CdiGribIterator *me);
// Callthroughs to GRIB-API
int cdiGribIterator_getLong(CdiGribIterator *me, const char *key, long *value); // Same semantics as grib_get_long().
int cdiGribIterator_getDouble(CdiGribIterator *me, const char *key, double *value); // Same semantics as grib_get_double().
int cdiGribIterator_getLength(CdiGribIterator *me, const char *key, size_t *value); // Same semantics as grib_get_length().
int cdiGribIterator_getString(CdiGribIterator *me, const char *key, char *value, size_t *length); // Same semantics as grib_get_string().
int cdiGribIterator_getSize(CdiGribIterator *me, const char *key, size_t *value); // Same semantics as grib_get_size().
int cdiGribIterator_getLongArray(CdiGribIterator *me, const char *key, long *value, size_t *array_size); // Same semantics as grib_get_long_array().
int cdiGribIterator_getDoubleArray(CdiGribIterator *me, const char *key, double *value, size_t *array_size); // Same semantics as grib_get_double_array().
// Convenience functions for accessing GRIB-API keys
int cdiGribIterator_inqEdition(CdiGribIterator *me);
long cdiGribIterator_inqLongValue(CdiGribIterator *me, const char *key); // Aborts on failure to fetch the given key.
long cdiGribIterator_inqLongDefaultValue(CdiGribIterator *me, const char *key, long defaultValue); // Returns the default value if the given key is not present.
double cdiGribIterator_inqDoubleValue(CdiGribIterator *me, const char *key); // Aborts on failure to fetch the given key.
double cdiGribIterator_inqDoubleDefaultValue(CdiGribIterator *me, const char *key, double defaultValue); // Returns the default value if the given key is not present.
char *cdiGribIterator_inqStringValue(CdiGribIterator *me, const char *key); // Returns a malloc'ed string.
// VLIST routines
// vlistCreate: Create a variable list
int vlistCreate(void);
// vlistDestroy: Destroy a variable list
void vlistDestroy(int vlistID);
// vlistDuplicate: Duplicate a variable list
int vlistDuplicate(int vlistID);
// vlistCopyFlag: Copy some entries of a variable list
void vlistCopyFlag(int vlistID2, int vlistID1);
void vlistClearFlag(int vlistID);
// vlistCat: Concatenate two variable lists
void vlistCat(int vlistID2, int vlistID1);
// vlistMerge: Merge two variable lists
void vlistMerge(int vlistID2, int vlistID1);
void vlistPrint(int vlistID);
// vlistNumber: Number type in a variable list
int vlistNumber(int vlistID);
// vlistNvars: Number of variables in a variable list
int vlistNvars(int vlistID);
// vlistNumGrids: Number of grids in a variable list
int vlistNumGrids(int vlistID);
// vlistNumZaxis: Number of zaxis in a variable list
int vlistNumZaxis(int vlistID);
// vlistNsubtypes: Number of subtypes in a variable list
int vlistNsubtypes(int vlistID);
void vlistDefNtsteps(int vlistID, int nts);
int vlistNtsteps(int vlistID);
SizeType vlistGridsizeMax(int vlistID);
int vlistGrid(int vlistID, int index);
int vlistGridIndex(int vlistID, int gridID);
void vlistChangeGridIndex(int vlistID, int index, int gridID);
void vlistChangeGrid(int vlistID, int gridID1, int gridID2);
int vlistZaxis(int vlistID, int index);
int vlistZaxisIndex(int vlistID, int zaxisID);
void vlistChangeZaxisIndex(int vlistID, int index, int zaxisID);
void vlistChangeZaxis(int vlistID, int zaxisID1, int zaxisID2);
int vlistNumFields(int vlistID);
int vlistSubtype(int vlistID, int index);
int vlistSubtypeIndex(int vlistID, int subtypeID);
// vlistDefTaxis: Define the time axis of a variable list
void vlistDefTaxis(int vlistID, int taxisID);
// vlistInqTaxis: Get the time axis of a variable list
int vlistInqTaxis(int vlistID);
void vlistDefTable(int vlistID, int tableID);
int vlistInqTable(int vlistID);
void vlistDefInstitut(int vlistID, int instID);
int vlistInqInstitut(int vlistID);
void vlistDefModel(int vlistID, int modelID);
int vlistInqModel(int vlistID);
// VLIST VAR routines
// vlistDefVarTiles: Create a new tile-based variable
int vlistDefVarTiles(int vlistID, int gridID, int zaxisID, int timetype, int tilesetID);
// vlistDefVar: Create a new variable
int vlistDefVar(int vlistID, int gridID, int zaxisID, int timetype);
void vlistChangeVarGrid(int vlistID, int varID, int gridID);
void vlistChangeVarZaxis(int vlistID, int varID, int zaxisID);
void vlistInqVar(int vlistID, int varID, int *gridID, int *zaxisID, int *timetype);
int vlistInqVarGrid(int vlistID, int varID);
int vlistInqVarZaxis(int vlistID, int varID);
// used in MPIOM
int vlistInqVarID(int vlistID, int code);
void vlistDefVarTimetype(int vlistID, int varID, int timetype);
int vlistInqVarTimetype(int vlistID, int varID);
void vlistDefVarTsteptype(int vlistID, int varID, int tsteptype);
// vlistInqVarTsteptype: Get the timestep type of a Variable
int vlistInqVarTsteptype(int vlistID, int varID);
void vlistDefVarCompType(int vlistID, int varID, int comptype);
int vlistInqVarCompType(int vlistID, int varID);
void vlistDefVarCompLevel(int vlistID, int varID, int complevel);
int vlistInqVarCompLevel(int vlistID, int varID);
// vlistDefVarParam: Define the parameter number of a Variable
void vlistDefVarParam(int vlistID, int varID, int param);
// vlistInqVarParam: Get the parameter number of a Variable
int vlistInqVarParam(int vlistID, int varID);
// vlistDefVarCode: Define the code number of a Variable
void vlistDefVarCode(int vlistID, int varID, int code);
// vlistInqVarCode: Get the code number of a Variable
int vlistInqVarCode(int vlistID, int varID);
// vlistDefVarDatatype: Define the data type of a Variable
void vlistDefVarDatatype(int vlistID, int varID, int datatype);
// vlistInqVarDatatype: Get the data type of a Variable
int vlistInqVarDatatype(int vlistID, int varID);
void vlistDefVarXYZ(int vlistID, int varID, int xyz);
int vlistInqVarXYZ(int vlistID, int varID);
void vlistDefVarNSB(int vlistID, int varID, int nsb);
int vlistInqVarNSB(int vlistID, int varID);
int vlistInqVarNumber(int vlistID, int varID);
void vlistDefVarInstitut(int vlistID, int varID, int instID);
int vlistInqVarInstitut(int vlistID, int varID);
void vlistDefVarModel(int vlistID, int varID, int modelID);
int vlistInqVarModel(int vlistID, int varID);
void vlistDefVarTable(int vlistID, int varID, int tableID);
int vlistInqVarTable(int vlistID, int varID);
// vlistDefVarName: Define the name of a Variable
void vlistDefVarName(int vlistID, int varID, const char *name);
// vlistInqVarName: Get the name of a Variable
void vlistInqVarName(int vlistID, int varID, char *name);
// vlistCopyVarName: Safe and convenient version of vlistInqVarName
char *vlistCopyVarName(int vlistId, int varId);
// vlistDefVarStdname: Define the standard name of a Variable
void vlistDefVarStdname(int vlistID, int varID, const char *stdname);
// vlistInqVarStdname: Get the standard name of a Variable
void vlistInqVarStdname(int vlistID, int varID, char *stdname);
// vlistDefVarLongname: Define the long name of a Variable
void vlistDefVarLongname(int vlistID, int varID, const char *longname);
// vlistInqVarLongname: Get the long name of a Variable
void vlistInqVarLongname(int vlistID, int varID, char *longname);
// vlistDefVarUnits: Define the units of a Variable
void vlistDefVarUnits(int vlistID, int varID, const char *units);
// vlistInqVarUnits: Get the units of a Variable
void vlistInqVarUnits(int vlistID, int varID, char *units);
// vlistDefVarMissval: Define the missing value of a Variable
void vlistDefVarMissval(int vlistID, int varID, double missval);
// vlistInqVarMissval: Get the missing value of a Variable
double vlistInqVarMissval(int vlistID, int varID);
SizeType vlistInqVarSize(int vlistID, int varID);
void vlistDefIndex(int vlistID, int varID, int levID, int index);
int vlistInqIndex(int vlistID, int varID, int levID);
void vlistDefFlag(int vlistID, int varID, int levID, int flag);
int vlistInqFlag(int vlistID, int varID, int levID);
int vlistFindVar(int vlistID, int fvarID);
int vlistFindLevel(int vlistID, int fvarID, int flevelID);
int vlistMergedVar(int vlistID, int varID);
int vlistMergedLevel(int vlistID, int varID, int levelID);
int pvlistInqFlag(void *vlistPtr, int varID, int levelID);
// cdiClearAdditionalKeys: Clear the list of additional GRIB keys
void cdiClearAdditionalKeys(void);
// cdiDefAdditionalKey: Register an additional GRIB key which is read when file is opened
void cdiDefAdditionalKey(const char *string);
// vlistDefVarIntKey: Set an arbitrary keyword/integer value pair for GRIB API
void vlistDefVarIntKey(int vlistID, int varID, const char *name, int value);
// vlistDefVarDblKey: Set an arbitrary keyword/double value pair for GRIB API
void vlistDefVarDblKey(int vlistID, int varID, const char *name, double value);
// vlistHasVarKey: returns 1 if meta-data key was read, 0 otherwise
int vlistHasVarKey(int vlistID, int varID, const char *name);
// vlistInqVarDblKey: raw access to GRIB meta-data
double vlistInqVarDblKey(int vlistID, int varID, const char *name);
// vlistInqVarIntKey: raw access to GRIB meta-data
int vlistInqVarIntKey(int vlistID, int varID, const char *name);
// CDI attributes
// cdiInqNatts: Get number of attributes assigned to this variable
int cdiInqNatts(int cdiID, int varID, int *nattsp);
// cdiInqAtt: Get information about an attribute
int cdiInqAtt(int cdiID, int varID, int attrnum, char *name, int *typep, int *lenp);
int cdiInqAttLen(int cdiID, int varID, const char *name);
int cdiInqAttType(int cdiID, int varID, const char *name);
int cdiDelAtt(int cdiID, int varID, const char *name);
int cdiCopyAtts(int cdiID1, int varID1, int cdiID2, int varID2);
// cdiDefAttInt: Define an integer attribute
int cdiDefAttInt(int cdiID, int varID, const char *name, int type, int len, const int ip[]);
// cdiDefAttFlt: Define a floating point attribute
int cdiDefAttFlt(int cdiID, int varID, const char *name, int type, int len, const double dp[]);
// cdiDefAttTxt: Define a text attribute
int cdiDefAttTxt(int cdiID, int varID, const char *name, int len, const char *tp_cbuf);
// cdiInqAttInt: Get the value(s) of an integer attribute
int cdiInqAttInt(int cdiID, int varID, const char *name, int mlen, int ip[]);
// cdiInqAttFlt: Get the value(s) of a floating point attribute
int cdiInqAttFlt(int cdiID, int varID, const char *name, int mlen, double dp[]);
// cdiInqAttTxt: Get the value(s) of a text attribute
int cdiInqAttTxt(int cdiID, int varID, const char *name, int mlen, char *tp_cbuf);
// GRID routines
void gridName(int gridtype, char *gridname);
const char *gridNamePtr(int gridtype);
void gridCompress(int gridID);
void gridDefMaskGME(int gridID, const int mask[]);
int gridInqMaskGME(int gridID, int mask[]);
void gridDefMask(int gridID, const int mask[]);
int gridInqMask(int gridID, int mask[]);
// gridCreate: Create a horizontal Grid
int gridCreate(int gridtype, SizeType size);
// gridDestroy: Destroy a horizontal Grid
void gridDestroy(int gridID);
// gridDuplicate: Duplicate a Grid
int gridDuplicate(int gridID);
// gridDefProj: Define the projection ID of a Grid
void gridDefProj(int gridID, int projID);
// gridInqProj: Get the projection ID of a Grid
int gridInqProj(int gridID);
// gridInqProjType: Get the projection type
int gridInqProjType(int gridID);
// gridInqType: Get the type of a Grid
int gridInqType(int gridID);
// gridInqSize: Get the size of a Grid
SizeType gridInqSize(int gridID);
// gridDefXsize: Define the size of a X-axis
void gridDefXsize(int gridID, SizeType xsize);
// gridInqXsize: Get the size of a X-axis
SizeType gridInqXsize(int gridID);
// gridDefYsize: Define the size of a Y-axis
void gridDefYsize(int gridID, SizeType ysize);
// gridInqYsize: Get the size of a Y-axis
SizeType gridInqYsize(int gridID);
void gridDefIndices(int gridID, const int64_t *indices);
SizeType gridInqIndices(int gridID, int64_t *indices);
// gridDefNP: Define the number of parallels between a pole and the equator
void gridDefNP(int gridID, int np);
// gridInqNP: Get the number of parallels between a pole and the equator
int gridInqNP(int gridID);
// gridDefXvals: Define the values of a X-axis
void gridDefXvals(int gridID, const double xvals[]);
// gridInqXvals: Get all values of a X-axis
SizeType gridInqXvals(int gridID, double xvals[]);
SizeType gridInqXvalsPart(int gridID, int start, SizeType size, double xvals[]);
const double *gridInqXvalsPtr(int gridID);
// gridInqXIsc: Find out whether X-coordinate is of type CHAR
int gridInqXIsc(int gridID);
// gridInqXCvals: Get strings from X-axis in case grid is of type GRID_CHARXY
SizeType gridInqXCvals(int gridID, char *xcvals[]);
// gridDefYvals: Define the values of a Y-axis
void gridDefYvals(int gridID, const double yvals[]);
// gridInqYvals: Get all values of a Y-axis
SizeType gridInqYvals(int gridID, double yvals[]);
SizeType gridInqYvalsPart(int gridID, int start, SizeType size, double yvals[]);
const double *gridInqYvalsPtr(int gridID);
// gridInqYIsc: Find out whether Y-coordinate is of type CHAR
int gridInqYIsc(int gridID);
// gridInqYCvals: Get strings from Y-axis in case grid is of type GRID_CHARXY
SizeType gridInqYCvals(int gridID, char *ycvals[]);
// CDI var keys
// String keys
#define CDI_KEY_NAME 942 // Variable name
#define CDI_KEY_LONGNAME 943 // Long name of the variable
#define CDI_KEY_STDNAME 944 // CF Standard name of the variable
#define CDI_KEY_UNITS 945 // Units of the variable
#define CDI_KEY_DATATYPE 946 // Data type
#define CDI_KEY_REFERENCEURI 947 // Reference URI to grid file
// Integer keys
#define CDI_KEY_NUMBEROFGRIDUSED 961 // GRIB2 numberOfGridUsed
#define CDI_KEY_NUMBEROFGRIDINREFERENCE 962 // GRIB2 numberOfGridInReference
#define CDI_KEY_NUMBEROFVGRIDUSED 963 // GRIB2 numberOfVGridUsed
#define CDI_KEY_NLEV 964 // GRIB2 nlev
#define CDI_KEY_CHUNKTYPE 965 // ChunkType: CDI_CHUNK_AUTO/CDI_CHUNK_GRID/CDI_CHUNK_LINES
#define CDI_KEY_CHUNKSIZE 966 // ChunkSize
#define CDI_KEY_CHUNKSIZE_DIMT 967 // ChunkSize time dimension
#define CDI_KEY_CHUNKSIZE_DIMZ 968 // ChunkSize zaxis dimension
#define CDI_KEY_CHUNKSIZE_DIMY 969 // ChunkSize yaxis dimension
#define CDI_KEY_CHUNKSIZE_DIMX 970 // ChunkSize xaxis dimension
// Floating point keys
#define CDI_KEY_MISSVAL 701 // Missing value
#define CDI_KEY_ADDOFFSET 702 // Add offset
#define CDI_KEY_SCALEFACTOR 703 // Scale factor
#define CDI_KEY_FILTERSPEC_IN 720 // NetCDF4 filter specification read in
#define CDI_KEY_FILTERSPEC 721 // NetCDF4 filter specification
// Byte array keys
#define CDI_KEY_UUID 960 // UUID for grid/Z-axis reference [size: CDI_UUID_SIZE]
#define CDI_KEY_DIMNAME 941 // Dimension name
#define CDI_KEY_PSNAME 950 // Z-axis surface pressure name
#define CDI_KEY_P0NAME 951 // Z-axis reference pressure name
#define CDI_KEY_P0VALUE 952 // Z-axis reference pressure in Pa
#define CDI_KEY_TABLESVERSION 801 // GRIB2 tablesVersion
#define CDI_KEY_LOCALTABLESVERSION 802 // GRIB2 localTablesVersion
#define CDI_KEY_TYPEOFGENERATINGPROCESS 803 // GRIB2 typeOfGeneratingProcess
#define CDI_KEY_PRODUCTDEFINITIONTEMPLATE 804 // GRIB2 productDefinitionTemplate
#define CDI_KEY_TYPEOFPROCESSEDDATA 805 // GRIB2 typeOfProcessedData
#define CDI_KEY_SHAPEOFTHEEARTH 806 // GRIB2 shapeOfTheEarth
#define CDI_KEY_BACKGROUNDPROCESS 807 // GRIB2 backgroundProcess
#define CDI_KEY_TYPEOFENSEMBLEFORECAST 808 // GRIB2 typeOfEnsembleForecast
#define CDI_KEY_NUMBEROFFORECASTSINENSEMBLE 809 // GRIB2 numberOfForecastsInEnsemble
#define CDI_KEY_PERTURBATIONNUMBER 810 // GRIB2 perturbationNumber
#define CDI_KEY_CENTRE 811 // GRIB2 centre
#define CDI_KEY_SUBCENTRE 812 // GRIB2 subCentre
#define CDI_KEY_MPIMTYPE 813 // GRIB2 mpimType
#define CDI_KEY_MPIMCLASS 814 // GRIB2 mpimClass
#define CDI_KEY_MPIMUSER 815 // GRIB2 mpimUser
#define CDI_KEY_REVSTATUS 816 // GRIB2 revStatus
#define CDI_KEY_REVNUMBER 817 // GRIB2 revNumber
#define CDI_KEY_GRIB2LOCALSECTIONNUMBER 818 // GRIB2 grib2LocalSectionNumber
#define CDI_KEY_SECTION2PADDINGLENGTH 819 // GRIB2 length of section2Padding
#define CDI_KEY_SECTION2PADDING 820 // GRIB2 section2Padding
#define CDI_KEY_CONSTITUENTTYPE 821 // GRIB2 constituentType
#define CDI_KEY_TYPEOFTIMEINCREMENT 822 // GRIB2 typeOfTimeIncrement
#define CDI_KEY_TYPEOFFIRSTFIXEDSURFACE 823 // GRIB2 typeOfFirstFixedSurface
#define CDI_KEY_TYPEOFSECONDFIXEDSURFACE 824 // GRIB2 typeOfSecondFixedSurface
#define CDI_KEY_UVRELATIVETOGRID 825 // GRIB uvRelativeToGrid
#define CDI_KEY_SCANNINGMODE 826 // GRIB scanningMode
#define CDI_KEY_VDIMNAME 920 // Vertex dimension name
#define CDI_KEY_GRIDMAP_VARTYPE 921 // Grid mapping var datatype
#define CDI_KEY_GRIDMAP_VARNAME 922 // Grid mapping var name
#define CDI_KEY_GRIDMAP_NAME 923 // Grid mapping name
// cdiDefKeyInt: Define an integer value from a key
int cdiDefKeyInt(int cdiID, int varID, int key, int value);
// cdiInqKeyInt: Get an integer value from a key
int cdiInqKeyInt(int cdiID, int varID, int key, int *value);
// cdiDefKeyFloat: Define a float value from a key
int cdiDefKeyFloat(int cdiID, int varID, int key, double value);
// cdiInqKeyFloat Get a float value from a key
int cdiInqKeyFloat(int cdiID, int varID, int key, double *value);
// cdiDefKeyBytes: Define a byte array from a key
int cdiDefKeyBytes(int cdiID, int varID, int key, const unsigned char bytes[], int length);
// cdiInqKeyBytes: Get a byte array from a key
int cdiInqKeyBytes(int cdiID, int varID, int key, unsigned char bytes[], int *length);
// cdiDefKeyString: Define a string from a key
int cdiDefKeyString(int cdiID, int varID, int key, const char *string);
// cdiInqKeyString: Get a string from a key
int cdiInqKeyString(int cdiID, int varID, int key, char *string, int *length);
// cdiInqKeyLen: Get the length of the string representation of the key
int cdiInqKeyLen(int cdiID, int varID, int key, int *length);
int cdiCopyKeys(int cdiID1, int varID1, int cdiID2, int varID2);
int cdiCopyKey(int cdiID1, int varID1, int key, int cdiID2);
int cdiDeleteKey(int cdiID, int varID, int key);
// GRID routines
// gridDefXname: Define the name of a X-axis
void gridDefXname(int gridID, const char *xname);
// gridInqXname: Get the name of a X-axis
void gridInqXname(int gridID, char *xname);
// gridDefXlongname: Define the longname of a X-axis
void gridDefXlongname(int gridID, const char *xlongname);
// gridInqXlongname: Get the longname of a X-axis
void gridInqXlongname(int gridID, char *xlongname);
// gridDefXunits: Define the units of a X-axis
void gridDefXunits(int gridID, const char *xunits);
// gridInqXunits: Get the units of a X-axis
void gridInqXunits(int gridID, char *xunits);
// gridDefYname: Define the name of a Y-axis
void gridDefYname(int gridID, const char *yname);
// gridInqYname: Get the name of a Y-axis
void gridInqYname(int gridID, char *yname);
// gridDefYlongname: Define the longname of a Y-axis
void gridDefYlongname(int gridID, const char *ylongname);
// gridInqYlongname: Get the longname of a Y-axis
void gridInqYlongname(int gridID, char *ylongname);
// gridDefYunits: Define the units of a Y-axis
void gridDefYunits(int gridID, const char *yunits);
// gridInqYunits: Get the units of a Y-axis
void gridInqYunits(int gridID, char *yunits);
void gridDefDatatype(int gridID, int datatype);
int gridInqDatatype(int gridID);
// gridInqXval: Get one value of a X-axis
double gridInqXval(int gridID, SizeType index);
// gridInqYval: Get one value of a Y-axis
double gridInqYval(int gridID, SizeType index);
double gridInqXinc(int gridID);
double gridInqYinc(int gridID);
int gridIsCircular(int gridID);
int gridInqTrunc(int gridID);
void gridDefTrunc(int gridID, int trunc);
// Reference of an unstructured grid
// gridDefNumber: Define the reference number for an unstructured grid
void gridDefNumber(int gridID, int number);
// gridInqNumber: Get the reference number to an unstructured grid
int gridInqNumber(int gridID);
// gridDefPosition: Define the position of grid in the reference file
void gridDefPosition(int gridID, int position);
// gridInqPosition: Get the position of grid in the reference file
int gridInqPosition(int gridID);
// gridDefReference: Define the reference URI for an unstructured grid
void gridDefReference(int gridID, const char *reference);
// gridInqReference: Get the reference URI to an unstructured grid
int gridInqReference(int gridID, char *reference);
// gridDefUUID: Define the UUID of an unstructured grid
void gridDefUUID(int gridID, const unsigned char uuid[CDI_UUID_SIZE]);
// gridInqUUID: Get the UUID of an unstructured grid
void gridInqUUID(int gridID, unsigned char uuid[CDI_UUID_SIZE]);
// Rotated Lon/Lat grid
void gridDefParamRLL(int gridID, double xpole, double ypole, double angle);
void gridInqParamRLL(int gridID, double *xpole, double *ypole, double *angle);
// Hexagonal GME grid
void gridDefParamGME(int gridID, int nd, int ni, int ni2, int ni3);
void gridInqParamGME(int gridID, int *nd, int *ni, int *ni2, int *ni3);
void gridDefArea(int gridID, const double area[]);
void gridInqArea(int gridID, double area[]);
int gridHasArea(int gridID);
// gridDefNvertex: Define the number of vertex of a Gridbox
void gridDefNvertex(int gridID, int nvertex);
// gridInqNvertex: Get the number of vertex of a Gridbox
int gridInqNvertex(int gridID);
// gridDefXbounds: Define the bounds of a X-axis
void gridDefXbounds(int gridID, const double xbounds[]);
// gridInqXbounds: Get the bounds of a X-axis
SizeType gridInqXbounds(int gridID, double xbounds[]);
SizeType gridInqXboundsPart(int gridID, int start, SizeType size, double xbounds[]);
const double *gridInqXboundsPtr(int gridID);
// gridDefYbounds: Define the bounds of a Y-axis
void gridDefYbounds(int gridID, const double ybounds[]);
// gridInqYbounds: Get the bounds of a Y-axis
SizeType gridInqYbounds(int gridID, double ybounds[]);
SizeType gridInqYboundsPart(int gridID, int start, SizeType size, double ybounds[]);
const double *gridInqYboundsPtr(int gridID);
void gridDefReducedPoints(int gridID, int reducedPointsSize, const int reducedPoints[]);
void gridInqReducedPoints(int gridID, int reducedPoints[]);
void gridChangeType(int gridID, int gridtype);
void gridDefComplexPacking(int gridID, int lpack);
int gridInqComplexPacking(int gridID);
// ZAXIS routines
void zaxisName(int zaxistype, char *zaxisname);
const char *zaxisNamePtr(int leveltype);
// zaxisCreate: Create a vertical Z-axis
int zaxisCreate(int zaxistype, int size);
// zaxisDestroy: Destroy a vertical Z-axis
void zaxisDestroy(int zaxisID);
// zaxisInqType: Get the type of a Z-axis
int zaxisInqType(int zaxisID);
// zaxisInqSize: Get the size of a Z-axis
int zaxisInqSize(int zaxisID);
// zaxisDuplicate: Duplicate a Z-axis
int zaxisDuplicate(int zaxisID);
// zaxisDefLevels: Define the levels of a Z-axis
void zaxisDefLevels(int zaxisID, const double levels[]);
// zaxisDefCvals: Define area types of a Z-axis
void zaxisDefCvals(int zaxisID, const char *cvals[], int clength);
// zaxisInqLevels: Get all levels of a Z-axis
int zaxisInqLevels(int zaxisID, double levels[]);
// zaxisInqCLen: Get maximal string length of character Z-axis
int zaxisInqCLen(int zaxisID);
// zaxisInqCVals: Get all string values of a character Z-axis
int zaxisInqCVals(int zaxisID, char ***clevels);
// zaxisDefLevel: Define one level of a Z-axis
void zaxisDefLevel(int zaxisID, int levelID, double levels);
// zaxisInqLevel: Get one level of a Z-axis
double zaxisInqLevel(int zaxisID, int levelID);
// zaxisDefNlevRef: Define the number of half levels of a generalized Z-axis
void zaxisDefNlevRef(int gridID, int nhlev);
// zaxisInqNlevRef: Get the number of half levels of a generalized Z-axis
int zaxisInqNlevRef(int gridID);
// zaxisDefNumber: Define the reference number for a generalized Z-axis
void zaxisDefNumber(int gridID, int number);
// zaxisInqNumber: Get the reference number to a generalized Z-axis
int zaxisInqNumber(int gridID);
// zaxisDefUUID: Define the UUID of a generalized Z-axis
void zaxisDefUUID(int zaxisID, const unsigned char uuid[CDI_UUID_SIZE]);
// zaxisInqUUID: Get the UUID of a generalized Z-axis
void zaxisInqUUID(int zaxisID, unsigned char uuid[CDI_UUID_SIZE]);
// zaxisDefName: Define the name of a Z-axis
void zaxisDefName(int zaxisID, const char *name_optional);
// zaxisInqName: Get the name of a Z-axis
void zaxisInqName(int zaxisID, char *name);
// zaxisDefLongname: Define the longname of a Z-axis
void zaxisDefLongname(int zaxisID, const char *longname_optional);
// zaxisInqLongname: Get the longname of a Z-axis
void zaxisInqLongname(int zaxisID, char *longname);
// zaxisDefUnits: Define the units of a Z-axis
void zaxisDefUnits(int zaxisID, const char *units_optional);
// zaxisInqUnits: Get the units of a Z-axis
void zaxisInqUnits(int zaxisID, char *units);
// zaxisInqStdname: Get the standard name of a Z-axis
void zaxisInqStdname(int zaxisID, char *stdname);
void zaxisDefDatatype(int zaxisID, int datatype);
int zaxisInqDatatype(int zaxisID);
void zaxisDefPositive(int zaxisID, int positive);
int zaxisInqPositive(int zaxisID);
void zaxisDefScalar(int zaxisID);
int zaxisInqScalar(int zaxisID);
void zaxisDefVct(int zaxisID, int size, const double vct[]);
void zaxisInqVct(int zaxisID, double vct[]);
int zaxisInqVctSize(int zaxisID);
const double *zaxisInqVctPtr(int zaxisID);
void zaxisDefLbounds(int zaxisID, const double lbounds[]);
int zaxisInqLbounds(int zaxisID, double lbounds_optional[]);
double zaxisInqLbound(int zaxisID, int index);
void zaxisDefUbounds(int zaxisID, const double ubounds[]);
int zaxisInqUbounds(int zaxisID, double ubounds_optional[]);
double zaxisInqUbound(int zaxisID, int index);
void zaxisDefWeights(int zaxisID, const double weights[]);
int zaxisInqWeights(int zaxisID, double weights_optional[]);
void zaxisChangeType(int zaxisID, int zaxistype);
// TAXIS routines
// taxisCreate: Create a Time axis
int taxisCreate(int taxistype);
// taxisDestroy: Destroy a Time axis
void taxisDestroy(int taxisID);
int taxisDuplicate(int taxisID);
void taxisCopyTimestep(int taxisIDdes, int taxisIDsrc);
void taxisDefType(int taxisID, int taxistype);
int taxisInqType(int taxisID);
// taxisDefVdate: Define the verification date
void taxisDefVdate(int taxisID, int date);
// taxisDefVtime: Define the verification time
void taxisDefVtime(int taxisID, int time);
// taxisInqVdate: Get the verification date
int taxisInqVdate(int taxisID);
// taxisInqVtime: Get the verification time
int taxisInqVtime(int taxisID);
// taxisDefRdate: Define the reference date
void taxisDefRdate(int taxisID, int date);
// taxisDefRtime: Define the reference time
void taxisDefRtime(int taxisID, int time);
// taxisInqRdate: Get the reference date
int taxisInqRdate(int taxisID);
// taxisInqRtime: Get the reference time
int taxisInqRtime(int taxisID);
int taxisHasBounds(int taxisID);
void taxisWithBounds(int taxisID);
void taxisDeleteBounds(int taxisID);
void taxisDefVdateBounds(int taxisID, int vdate_lb, int vdate_ub);
void taxisDefVtimeBounds(int taxisID, int vtime_lb, int vtime_ub);
void taxisInqVdateBounds(int taxisID, int *vdate_lb, int *vdate_ub);
void taxisInqVtimeBounds(int taxisID, int *vtime_lb, int *vtime_ub);
// taxisDefCalendar: Define the calendar
void taxisDefCalendar(int taxisID, int calendar);
// taxisInqCalendar: Get the calendar
int taxisInqCalendar(int taxisID);
void taxisDefTunit(int taxisID, int tunit);
int taxisInqTunit(int taxisID);
void taxisDefForecastTunit(int taxisID, int tunit);
int taxisInqForecastTunit(int taxisID);
void taxisDefForecastPeriod(int taxisID, double fc_period);
double taxisInqForecastPeriod(int taxisID);
void taxisDefNumavg(int taxisID, int numavg);
int taxisInqNumavg(int taxisID);
const char *taxisNamePtr(int taxisID);
const char *tunitNamePtr(int tunitID);
// Institut routines
int institutDef(int center, int subcenter, const char *name, const char *longname);
int institutInq(int center, int subcenter, const char *name, const char *longname);
int institutInqNumber(void);
int institutInqCenter(int instID);
int institutInqSubcenter(int instID);
const char *institutInqNamePtr(int instID);
const char *institutInqLongnamePtr(int instID);
// Model routines
int modelDef(int instID, int modelgribID, const char *name);
int modelInq(int instID, int modelgribID, const char *name);
int modelInqInstitut(int modelID) ;
int modelInqGribID(int modelID);
const char *modelInqNamePtr(int modelID);
// Table routines
// tableFWriteC: write table of parameters to FILE* in C language format
void tableFWriteC(FILE *ptfp, int tableID);
// tableWrite: write table of parameters to file in tabular format
void tableWrite(const char *filename, int tableID);
// tableRead: read table of parameters from file in tabular format
int tableRead(const char *tablefile);
int tableDef(int modelID, int tablenum, const char *tablename);
const char *tableInqNamePtr(int tableID);
int tableInq(int modelID, int tablenum, const char *tablename);
int tableInqNumber(void);
int tableInqNum(int tableID);
int tableInqModel(int tableID);
void tableInqEntry(int tableID, int id, int ltype, char *name, char *longname, char *units);
// Subtype routines
// subtypeCreate: Create a variable subtype
int subtypeCreate(int subtype);
// Gives a textual summary of the variable subtype
void subtypePrint(int subtypeID);
// Compares two subtype data structures
int subtypeCompare(int subtypeID1, int subtypeID2);
// subtypeInqSize: Get the size of a subtype (e.g. no. of tiles)
int subtypeInqSize(int subtypeID);
// subtypeInqActiveIndex: Get the currently active index of a subtype (e.g. current tile index)
int subtypeInqActiveIndex(int subtypeID);
// subtypeDefActiveIndex: Set the currently active index of a subtype (e.g. current tile index)
void subtypeDefActiveIndex(int subtypeID, int index);
// Generate a "query object" out of a key-value pair
subtype_query_t keyValuePair(const char *key, int value);
// Generate an AND-combined "query object" out of two previous query objects
subtype_query_t matchAND(subtype_query_t q1, subtype_query_t q2);
// subtypeInqSubEntry: Returns subtype entry ID for a given criterion
int subtypeInqSubEntry(int subtypeID, subtype_query_t criterion);
// subtypeInqTile: Specialized version of subtypeInqSubEntry looking for tile/attribute pair
int subtypeInqTile(int subtypeID, int tileindex, int attribute);
// subtypeInqAttribute: Inquire the value of a subtype attribute. Returns CDI_EINVAL if the attribute does not exist.
int subtypeInqAttribute(int subtypeID, int index, const char *key, int *outValue);
// vlistInqVarSubtype: Return subtype ID for a given variable
int vlistInqVarSubtype(int vlistID, int varID);
void gribapiLibraryVersion(int *major_version, int *minor_version, int *revision_version);
// Compatibility functions for release 1.8.3 (obsolete functions)
void zaxisDefLtype(int zaxisID, int ltype);
int vlistInqVarTypeOfGeneratingProcess(int vlistID, int varID);
void vlistDefVarTypeOfGeneratingProcess(int vlistID, int varID, int typeOfGeneratingProcess);
void vlistDefVarProductDefinitionTemplate(int vlistID, int varID, int productDefinitionTemplate);
// Compatibility functions for ParaView vtkCDIReader (obsolete functions)
int vlistNgrids(int vlistID); // calls vlistNumGrids()
int vlistNzaxis(int vlistID); // calls vlistNumZaxis()
#ifdef __cplusplus
}
#endif
// End of fortran interface
//FINT_OFF <--- don't change or remove this line!!!
#ifdef __cplusplus
extern "C" {
#endif
// CDI query interface
typedef struct
{
int numEntries;
// Names
int numNames;
bool *namesFound;
char **names;
// Grid cell indices
int numCellidx;
bool *cellidxFound;
size_t *cellidx;
// Level indices
int numLevidx;
bool *levidxFound;
int *levidx;
// Time step indices
int numStepidx;
bool *stepidxFound;
int *stepidx;
} CdiQuery;
CdiQuery *cdiQueryCreate(void);
CdiQuery *cdiQueryClone(const CdiQuery *query);
void cdiQueryDelete(CdiQuery *query);
void cdiQuerySetNames(CdiQuery *query, int numNames, char **names);
void cdiQuerySetCellidx(CdiQuery *query, int numCellidx, size_t *cellidx);
void cdiQuerySetLevidx(CdiQuery *query, int numLevidx, int *levidx);
void cdiQuerySetStepidx(CdiQuery *query, int numStepidx, int *stepidx);
size_t cdiQueryGetCellidx(const CdiQuery *query, int index);
int cdiQueryName(CdiQuery *query, const char *name);
int cdiQueryCellidx(CdiQuery *query, size_t cellidx);
int cdiQueryLevidx(CdiQuery *query, int levidx);
int cdiQueryStepidx(CdiQuery *query, int stepidx);
int cdiQueryNumNames(const CdiQuery *query);
int cdiQueryNumCellidx(const CdiQuery *query);
int cdiQueryNumStepidx(const CdiQuery *query);
int cdiQueryNumEntries(const CdiQuery *query);
int cdiQueryNumEntriesFound(const CdiQuery *query);
void cdiQueryPrint(const CdiQuery *query);
void cdiQueryPrintEntriesNotFound(const CdiQuery *query);
// streamOpenReadQuery: Open a dataset for reading and apply query
int streamOpenReadQuery(const char *path, CdiQuery *query);
// CDI interface for paraview vtkCDIReader.cxx
#include "cdi_datetime.h"
// taxisDefRdatetime: Define the reference date/time
void taxisDefRdatetime(int taxisID, CdiDateTime rDateTime);
// taxisInqRdatetime: Get the reference date/time
CdiDateTime taxisInqRdatetime(int taxisID);
// taxisDefFdatetime: Define the forecast reference date/time
void taxisDefFdatetime(int taxisID, CdiDateTime fDateTime);
// taxisInqFdatetime: Get the forecast reference date/time
CdiDateTime taxisInqFdatetime(int taxisID);
// taxisDefVdatetime: Define the verification date/time
void taxisDefVdatetime(int taxisID, CdiDateTime vDateTime);
// taxisInqVdatetime: Get the verification date/time
CdiDateTime taxisInqVdatetime(int taxisID);
void taxisDefVdatetimeBounds(int taxisID, CdiDateTime vDateTime_lb, CdiDateTime vDateTime_ub);
void taxisInqVdatetimeBounds(int taxisID, CdiDateTime *vDateTime_lb, CdiDateTime *vDateTime_ub);
// date format: YYYYMMDD
// time format: hhmmss
int64_t date_to_julday(int calendar, int64_t date); // Used in paraview vtkCDIReader.cxx
int64_t julday_to_date(int calendar, int64_t julday);
int time_to_sec(int time); // Used in paraview vtkCDIReader.cxx
int sec_to_time(int secofday);
// CDI projection parameter interface
struct CDI_GridProjParams
{
double mv; // Missing value
double lon_0; // The East longitude of the meridian which is parallel to the Y-axis
double lat_0; // Latitude of the projection origin
double lat_1; // First latitude from the pole at which the secant cone cuts the sphere
double lat_2; // Second latitude at which the secant cone cuts the sphere
// lat_ts = lat_1;
double a; // Semi-major axis or earth radius in metres (optional)
double b; // Semi-minor axis in metres (optional)
double rf; // Inverse flattening (1/f) (optional)
double xval_0; // Longitude of the first grid point in degree (optional)
double yval_0; // Latitude of the first grid point in degree (optional)
double x_0; // False easting (optional)
double y_0; // False northing (optional)
double x_SP; // Longitude of southern pole
double y_SP; // Latitude of southern pole
int nside; // HEALPix number of points along a side (number of data points should be = 12 * nside * nside)
int order; // HEALPix ordering convention (0:ring; 1:nested)
};
void gridProjParamsInit(struct CDI_GridProjParams *gridProjParams);
// Lambert Conformal Conic grid
void gridDefParamsLCC(int gridID, struct CDI_GridProjParams gridProjParams);
int gridInqParamsLCC(int gridID, struct CDI_GridProjParams *gridProjParams);
// Polar stereographic grid
void gridDefParamsSTERE(int gridID, struct CDI_GridProjParams gridProjParams);
int gridInqParamsSTERE(int gridID, struct CDI_GridProjParams *gridProjParams);
// HEALPix grid
void gridDefParamsHEALPIX(int gridID, struct CDI_GridProjParams gridProjParams);
int gridInqParamsHEALPIX(int gridID, struct CDI_GridProjParams *gridProjParams);
#define HAVE_CDI_PROJ_FUNCS 1
extern int (*proj_lonlat_to_lcc_func)(struct CDI_GridProjParams gpp, size_t, double*, double*);
extern int (*proj_lcc_to_lonlat_func)(struct CDI_GridProjParams gpp, double, double, size_t, double*, double*);
extern int (*proj_lonlat_to_stere_func)(struct CDI_GridProjParams gpp, size_t, double*, double*);
extern int (*proj_stere_to_lonlat_func)(struct CDI_GridProjParams gpp, double, double, size_t, double*, double*);
// Used in CDO remap_scrip_io.cc
void cdf_def_var_filter(int ncid, int ncvarID, const char *filterSpec);
#ifdef __cplusplus
}
#endif
// clang-format on
#endif /* CDI_H_ */
/*
* Local Variables:
* c-file-style: "Java"
* c-basic-offset: 2
* indent-tabs-mode: nil
* show-trailing-whitespace: t
* require-trailing-newline: t
* End:
*/
|