/usr/include/eccodes.h is in libeccodes-dev 2.6.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 | /*
* Copyright 2005-2017 ECMWF.
*
* This software is licensed under the terms of the Apache Licence Version 2.0
* which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
*
* In applying this licence, ECMWF does not waive the privileges and immunities granted to it by
* virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.
*/
/*! \file eccodes.h
\brief The ecCodes C header file
This is the only file that must be included to use the ecCodes library
from C.
*/
#ifndef eccodes_H
#define eccodes_H
#ifdef __cplusplus
extern "C" {
#endif
#include "grib_api.h"
#define CODES_VERSION ECCODES_VERSION
/* sections */
#define CODES_SECTION_PRODUCT GRIB_SECTION_PRODUCT
#define CODES_SECTION_GRID GRIB_SECTION_GRID
#define CODES_SECTION_LOCAL GRIB_SECTION_LOCAL
#define CODES_SECTION_DATA GRIB_SECTION_DATA
#define CODES_SECTION_BITMAP GRIB_SECTION_BITMAP
/* LOG MODES
Log mode for information for processing information
*/
#define CODES_LOG_INFO GRIB_LOG_INFO
#define CODES_LOG_WARNING GRIB_LOG_WARNING
#define CODES_LOG_ERROR GRIB_LOG_ERROR
#define CODES_LOG_FATAL GRIB_LOG_FATAL
#define CODES_LOG_DEBUG GRIB_LOG_DEBUG
/* Types */
#define CODES_TYPE_UNDEFINED GRIB_TYPE_UNDEFINED
#define CODES_TYPE_LONG GRIB_TYPE_LONG
#define CODES_TYPE_DOUBLE GRIB_TYPE_DOUBLE
#define CODES_TYPE_STRING GRIB_TYPE_STRING
#define CODES_TYPE_BYTES GRIB_TYPE_BYTES
#define CODES_TYPE_SECTION GRIB_TYPE_SECTION
#define CODES_TYPE_LABEL GRIB_TYPE_LABEL
#define CODES_TYPE_MISSING GRIB_TYPE_MISSING
/* Missing values */
#define CODES_MISSING_LONG GRIB_MISSING_LONG
#define CODES_MISSING_DOUBLE GRIB_MISSING_DOUBLE
/*set spec flags*/
#define CODES_UTIL_SET_SPEC_FLAGS_ONLY_PACKING GRIB_UTIL_SET_SPEC_FLAGS_ONLY_PACKING
/* Dump option flags*/
#define CODES_DUMP_FLAG_READ_ONLY GRIB_DUMP_FLAG_READ_ONLY
#define CODES_DUMP_FLAG_DUMP_OK GRIB_DUMP_FLAG_DUMP_OK
#define CODES_DUMP_FLAG_VALUES GRIB_DUMP_FLAG_VALUES
#define CODES_DUMP_FLAG_CODED GRIB_DUMP_FLAG_CODED
#define CODES_DUMP_FLAG_OCTECT GRIB_DUMP_FLAG_OCTECT
#define CODES_DUMP_FLAG_ALIASES GRIB_DUMP_FLAG_ALIASES
#define CODES_DUMP_FLAG_TYPE GRIB_DUMP_FLAG_TYPE
#define CODES_DUMP_FLAG_HEXADECIMAL GRIB_DUMP_FLAG_HEXADECIMAL
#define CODES_DUMP_FLAG_NO_DATA GRIB_DUMP_FLAG_NO_DATA
#define CODES_DUMP_FLAG_ALL_DATA GRIB_DUMP_FLAG_ALL_DATA
#define CODES_DUMP_FLAG_ALL_ATTRIBUTES GRIB_DUMP_FLAG_ALL_ATTRIBUTES
/* codes_nearest flags */
#define CODES_NEAREST_SAME_GRID GRIB_NEAREST_SAME_GRID
#define CODES_NEAREST_SAME_DATA GRIB_NEAREST_SAME_DATA
#define CODES_NEAREST_SAME_POINT GRIB_NEAREST_SAME_POINT
/*! Iteration is carried out on all the keys available in the message
\ingroup keys_iterator
\see codes_keys_iterator_new
*/
#define CODES_KEYS_ITERATOR_ALL_KEYS GRIB_KEYS_ITERATOR_ALL_KEYS
/*! read only keys are skipped by keys iterator.
\ingroup keys_iterator
\see codes_keys_iterator_new
*/
#define CODES_KEYS_ITERATOR_SKIP_READ_ONLY GRIB_KEYS_ITERATOR_SKIP_READ_ONLY
/*! optional keys are skipped by keys iterator.
\ingroup keys_iterator
\see codes_keys_iterator_new */
#define CODES_KEYS_ITERATOR_SKIP_OPTIONAL GRIB_KEYS_ITERATOR_SKIP_OPTIONAL
/*! edition specific keys are skipped by keys iterator.
\ingroup keys_iterator
\see codes_keys_iterator_new */
#define CODES_KEYS_ITERATOR_SKIP_EDITION_SPECIFIC GRIB_KEYS_ITERATOR_SKIP_EDITION_SPECIFIC
/*! coded keys are skipped by keys iterator.
\ingroup keys_iterator
\see codes_keys_iterator_new */
#define CODES_KEYS_ITERATOR_SKIP_CODED GRIB_KEYS_ITERATOR_SKIP_CODED
/*! computed keys are skipped by keys iterator.
\ingroup keys_iterator
\see codes_keys_iterator_new */
#define CODES_KEYS_ITERATOR_SKIP_COMPUTED GRIB_KEYS_ITERATOR_SKIP_COMPUTED
/*! duplicates of a key are skipped by keys iterator.
\ingroup keys_iterator
\see codes_keys_iterator_new */
#define CODES_KEYS_ITERATOR_SKIP_DUPLICATES GRIB_KEYS_ITERATOR_SKIP_DUPLICATES
/*! function keys are skipped by keys iterator.
\ingroup keys_iterator
\see codes_keys_iterator_new */
#define CODES_KEYS_ITERATOR_SKIP_FUNCTION GRIB_KEYS_ITERATOR_SKIP_FUNCTION
/*! only keys present in the dump
\ingroup keys_iterator
\see codes_keys_iterator_new */
#define CODES_KEYS_ITERATOR_DUMP_ONLY GRIB_KEYS_ITERATOR_DUMP_ONLY
typedef struct grib_values codes_values;
typedef struct grib_key_value_list codes_key_value_list;
/*! Codes handle, structure giving access to parsed values by keys
\ingroup codes_handle
\struct codes_handle
*/
typedef struct grib_handle codes_handle;
/*! GRIB multi field handle, structure used to build multi fields messages.
\ingroup codes_handle
\struct codes_multi_handle
*/
typedef struct grib_multi_handle codes_multi_handle;
/*! Codes context, structure containing the memory methods, the parsers and the formats.
\ingroup codes_context
\struct codes_context
*/
typedef struct grib_context codes_context;
/*! Codes iterator, structure supporting a geographic iteration of values in a GRIB message.
\ingroup iterators
\struct codes_iterator
*/
typedef struct grib_iterator codes_iterator;
/*! Codes nearest, structure used to find the nearest points of a latitude longitude point in a GRIB message.
\ingroup iterators
\struct codes_nearest
*/
typedef struct grib_nearest codes_nearest;
typedef struct grib_box codes_box;
typedef struct grib_points codes_points;
/*! Codes keys iterator. Iterator over keys.
\ingroup keys_iterator
\struct codes_keys_iterator
*/
typedef struct grib_keys_iterator codes_keys_iterator;
typedef struct bufr_keys_iterator codes_bufr_keys_iterator;
typedef struct grib_fieldset codes_fieldset;
typedef struct grib_order_by codes_order_by;
typedef struct grib_where codes_where;
typedef struct grib_sarray codes_sarray;
typedef struct grib_oarray codes_oarray;
typedef struct grib_darray codes_darray;
typedef struct grib_iarray codes_iarray;
typedef struct grib_vdarray codes_vdarray;
typedef struct grib_vsarray codes_vsarray;
typedef struct grib_viarray codes_viarray;
typedef struct grib_string_list codes_string_list;
typedef struct grib_util_packing_spec codes_util_packing_spec;
typedef struct grib_util_grid_spec codes_util_grid_spec;
codes_fieldset *codes_fieldset_new_from_files(codes_context *c, char *filenames[], int nfiles, char **keys, int nkeys, const char *where_string, const char *order_by_string, int *err);
void codes_fieldset_delete(codes_fieldset* set);
void codes_fieldset_rewind(codes_fieldset* set);
int codes_fieldset_apply_order_by(codes_fieldset* set,const char* order_by_string);
codes_handle* codes_fieldset_next_handle(codes_fieldset* set,int* err);
int codes_fieldset_count(codes_fieldset *set);
int codes_values_check(codes_handle* h, codes_values* values, int count);
/*! \defgroup codes_index The indexing feature
The codes_index is the structure giving indexed access to messages in a file.
*/
/*! @{*/
/*! index structure to access messages in a file.
* \ingroup codes_index
* \struct codes_index
*/
typedef struct grib_index codes_index;
/**
* Create a new index form a file. The file is indexed with the keys in argument.
*
* @param c : context (NULL for default context)
* @param filename : name of the file of messages to be indexed
* @param keys : comma separated list of keys for the index.
* The type of the key can be explicitly declared appending :l for long,
* (or alternatively :i)
* :d for double, :s for string to the key name. If the type is not
* declared explicitly, the native type is assumed.
* @param err : 0 if OK, integer value on error
* @return the newly created index
*/
codes_index* codes_index_new_from_file(codes_context* c, char* filename,const char* keys,int *err);
/**
* Create a new index based on a set of keys.
*
* @param c : context (NULL for default context)
* @param keys : comma separated list of keys for the index.
* The type of the key can be explicitly declared appending :l for long,
* (or alternatively :i)
* :d for double, :s for string to the key name. If the type is not
* declared explicitly, the native type is assumed.
* @param err : 0 if OK, integer value on error
* @return the newly created index
*/
codes_index* codes_index_new(codes_context* c, const char* keys,int *err);
/**
* Indexes the file given in argument in the index given in argument.
*
* @param index : index
* @param filename : name of the file of messages to be indexed
* @return 0 if OK, integer value on error
*/
int codes_index_add_file(grib_index *index, const char *filename);
int codes_index_write(codes_index *index, const char *filename);
codes_index* codes_index_read(codes_context* c,const char* filename,int *err);
/**
* Get the number of distinct values of the key in argument contained in the index. The key must belong to the index.
*
* @param index : an index created from a file.
* The index must have been created with the key in argument.
* @param key : key for which the number of values is computed
* @param size : number of distinct values of the key in the index
* @return 0 if OK, integer value on error
*/
int codes_index_get_size(codes_index* index,const char* key,size_t* size);
/**
* Get the distinct values of the key in argument contained in the index. The key must belong to the index. This function is used when the type of the key was explicitly defined as long or when the native type of the key is long.
*
* @param index : an index created from a file.
* The index must have been created with the key in argument.
* @param key : key for which the values are returned
* @param values : array of values. The array must be allocated before entering this function and its size must be enough to contain all the values.
* @param size : size of the values array
* @return 0 if OK, integer value on error
*/
int codes_index_get_long(codes_index* index,const char* key,long* values,size_t *size);
/**
* Get the distinct values of the key in argument contained in the index. The key must belong to the index. This function is used when the type of the key was explicitly defined as double or when the native type of the key is double.
*
* @param index : an index created from a file.
* The index must have been created with the key in argument.
* @param key : key for which the values are returned
* @param values : array of values. The array must be allocated before entering this function and its size must be enough to contain all the values.
* @param size : size of the values array
* @return 0 if OK, integer value on error
*/
int codes_index_get_double(codes_index* index,const char* key, double* values,size_t *size);
/**
* Get the distinct values of the key in argument contained in the index. The key must belong to the index. This function is used when the type of the key was explicitly defined as string or when the native type of the key is string.
*
* @param index : an index created from a file.
* The index must have been created with the key in argument.
* @param key : key for which the values are returned
* @param values : array of values. The array must be allocated before entering this function and its size must be enough to contain all the values.
* @param size : size of the values array
* @return 0 if OK, integer value on error
*/
int codes_index_get_string(codes_index* index,const char* key,char** values,size_t *size);
/**
* Select the message subset with key==value. The value is a long. The key must have been created with long type or have long as native type if the type was not explicitly defined in the index creation.
*
* @param index : an index created from a file.
* The index must have been created with the key in argument.
* @param key : key to be selected
* @param value : value of the key to select
* @return 0 if OK, integer value on error
*/
int codes_index_select_long(codes_index* index,const char* key,long value);
/**
* Select the message subset with key==value. The value is a double. The key must have been created with double type or have double as native type if the type was not explicitly defined in the index creation.
*
* @param index : an index created from a file.
* The index must have been created with the key in argument.
* @param key : key to be selected
* @param value : value of the key to select
* @return 0 if OK, integer value on error
*/
int codes_index_select_double(codes_index* index,const char* key,double value);
/**
* Select the message subset with key==value. The value is a string. The key must have been created with string type or have string as native type if the type was not explicitly defined in the index creation.
*
* @param index : an index created from a file.
* The index must have been created with the key in argument.
* @param key : key to be selected
* @param value : value of the key to select
* @return 0 if OK, integer value on error
*/
int codes_index_select_string(codes_index* index,const char* key,char* value);
/**
* Create a new handle from an index after having selected the key values.
* All the keys belonging to the index must be selected before calling this function. Successive calls to this function will return all the handles compatible with the constraints defined selecting the values of the index keys.
* When no more handles are available from the index a NULL pointer is returned and the err variable is set to CODES_END_OF_INDEX.
*
* @param index : an index created from a file.
* @param err : 0 if OK, integer value on error. CODES_END_OF_INDEX when no more handles are contained in the index.
* @return grib handle.
*/
codes_handle* codes_handle_new_from_index(codes_index* index,int *err);
/**
* Delete the index.
*
* @param index : index to be deleted.
*/
void codes_index_delete(codes_index* index);
/*! @} */
/*! \defgroup codes_handle The message handle
The codes_handle is the structure giving access to parsed message values by keys.
*/
/*! @{*/
/**
* Counts the messages contained in a file resource.
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param f : the file resource
* @param n : the number of messages in the file
* @return 0 if OK, integer value on error
*/
int codes_count_in_file(codes_context* c, FILE* f,int* n);
/**
* Counts the messages contained in a file.
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param filename : the path to the file
* @param n : the number of messages in the file
* @return 0 if OK, integer value on error
*/
int codes_count_in_filename(codes_context* c, const char* filename, int* n);
/**
* Create a handle from a file resource.
* The file is read until a message is found. The message is then copied.
* Remember always to delete the handle when it is not needed anymore to avoid
* memory leaks.
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param f : the file resource
* @param product : the kind of product e.g. PRODUCT_GRIB, PRODUCT_BUFR
* @param error : error code set if the returned handle is NULL and the end of file is not reached
* @return the new handle, NULL if the resource is invalid or a problem is encountered
*/
grib_handle* codes_handle_new_from_file(grib_context* c, FILE* f, ProductKind product, int* error);
/**
* Create a GRIB handle from a file resource.
* The file is read until a GRIB message is found. The message is then copied.
* Remember always to delete the handle when it is not needed anymore to avoid
* memory leaks.
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param f : the file resource
* @param error : error code set if the returned handle is NULL and the end of file is not reached
* @return the new handle, NULL if the resource is invalid or a problem is encountered
*/
grib_handle* codes_grib_handle_new_from_file(grib_context* c, FILE* f, int* error);
/**
* Create a BUFR handle from a file resource.
* The file is read until a BUFR message is found. The message is then copied.
* Remember always to delete the handle when it is not needed anymore to avoid
* memory leaks.
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param f : the file resource
* @param error : error code set if the returned handle is NULL and the end of file is not reached
* @return the new handle, NULL if the resource is invalid or a problem is encountered
*/
grib_handle* codes_bufr_handle_new_from_file(grib_context* c, FILE* f, int* error);
/**
* Write a coded message to a file.
*
* @param h : codes_handle to be written
* @param file : name of the output file
* @param mode : mode
* @return 0 if OK, integer value on error
*/
int codes_write_message(codes_handle* h,const char* file,const char* mode);
codes_handle* codes_grib_util_sections_copy(codes_handle* hfrom,codes_handle* hto,int what,int *err);
codes_string_list* codes_grib_util_get_param_id(const char* mars_param);
codes_string_list* codes_grib_util_get_mars_param(const char* param_id);
/**
* Create a handle from a user message in memory. The message will not be freed at the end.
* The message will be copied as soon as a modification is needed.
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param data : the actual message
* @param data_len : the length of the message in number of bytes
* @return the new handle, NULL if the message is invalid or a problem is encountered
*/
codes_handle* codes_handle_new_from_message(codes_context* c, const void* data, size_t data_len);
/**
* Create a handle from a user message in memory. The message will not be freed at the end.
* The message will be copied as soon as a modification is needed.
* This function works also with multi field messages.
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param data : the actual message
* @param data_len : the length of the message in number of bytes
* @param error : error code
* @return the new handle, NULL if the message is invalid or a problem is encountered
*/
codes_handle* codes_grib_handle_new_from_multi_message(codes_context* c,void** data,
size_t *data_len,int* error);
/**
* Create a handle from a user message. The message is copied and will be freed with the handle
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param data : the actual message
* @param data_len : the length of the message in number of bytes
* @return the new handle, NULL if the message is invalid or a problem is encountered
*/
codes_handle* codes_handle_new_from_message_copy(codes_context* c, const void* data, size_t data_len);
/**
* Create a handle from a GRIB message contained in the samples directory.
* The message is copied at the creation of the handle
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param sample_name : the name of the sample file (without the .tmpl extension)
* @return the new handle, NULL if the resource is invalid or a problem is encountered
*/
codes_handle* codes_grib_handle_new_from_samples (codes_context* c, const char* sample_name);
/**
* Create a handle from a BUFR message contained in a samples directory.
* The message is copied at the creation of the handle
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param sample_name : the name of the sample file (without the .tmpl extension)
* @return the new handle, NULL if the resource is invalid or a problem is encountered
*/
codes_handle* codes_bufr_handle_new_from_samples (codes_context* c, const char* sample_name);
/**
* Clone an existing handle using the context of the original handle,
* The message is copied and reparsed
*
* @param h : The handle to be cloned
* @return the new handle, NULL if the message is invalid or a problem is encountered
*/
codes_handle* codes_handle_clone(codes_handle* h) ;
/**
* Frees a handle, also frees the message if it is not a user message
* @see codes_handle_new_from_message
* @param h : The handle to be deleted
* @return 0 if OK, integer value on error
*/
int codes_handle_delete(codes_handle* h);
/**
* Create an empty multi-field GRIB handle.
* Remember always to delete the multi-handle when it is not needed any more to avoid
* memory leaks.
*
* @param c : the context from which the handle will be created (NULL for default context)
*/
codes_multi_handle* codes_grib_multi_handle_new(codes_context* c);
/**
* Append the sections starting with start_section of the message pointed by h at
* the end of the multi-field GRIB handle mh.
* Remember always to delete the multi-handle when it is not needed any more to avoid
* memory leaks.
*
* @param h : The handle from which the sections are copied.
* @param start_section : section number. Starting from this section all the sections to the end of the message will be copied.
* @param mh : The multi-field handle on which the sections are appended.
* @return 0 if OK, integer value on error
*/
int codes_grib_multi_handle_append(codes_handle* h,int start_section,codes_multi_handle* mh);
/**
* Delete multi-field GRIB handle.
*
* @param mh : The multi-field handle to be deleted.
* @return 0 if OK, integer value on error
*/
int codes_grib_multi_handle_delete(codes_multi_handle* mh);
/**
* Write a multi-field GRIB handle in a file.
* Remember always to delete the multi-handle when it is not needed any more to avoid
* memory leaks.
*
* @param mh : The multi-field GRIB handle to be written.
* @param f : File on which the file handle is written.
* @return 0 if OK, integer value on error
*/
int codes_grib_multi_handle_write(codes_multi_handle* mh,FILE* f);
/*! @} */
/*! \defgroup handling_coded_messages Handling coded messages */
/*! @{ */
/**
* getting the message attached to a handle
*
* @param h : the handle to which the buffer should be gathered
* @param message : the pointer to be set to the handle's data
* @param message_length : On exit, the message size in number of bytes
* @return 0 if OK, integer value on error
*/
int codes_get_message(codes_handle* h ,const void** message, size_t *message_length );
/**
* getting a copy of the message attached to a handle
*
* @param h : the handle to which the buffer should be returned
* @param message : the pointer to the data buffer to be filled
* @param message_length : On entry, the size in number of bytes of the allocated empty message.
* On exit, the actual message length in number of bytes
* @return 0 if OK, integer value on error
*/
int codes_get_message_copy(codes_handle* h, void* message,size_t *message_length );
/*! @} */
/*! \defgroup iterators Iterating on latitude/longitude/values */
/*! @{ */
/*!
* \brief Create a new iterator from a GRIB handle, using current geometry and values.
*
* \param h : the handle from which the iterator will be created
* \param flags : flags for future use.
* \param error : error code
* \return the new iterator, NULL if no iterator can be created
*/
codes_iterator* codes_grib_iterator_new(codes_handle* h, unsigned long flags, int* error);
/**
* Get latitude/longitude and data values.
* The Latitudes, longitudes and values arrays must be properly allocated by the caller.
* Their required dimension can be obtained by getting the value of the integer key "numberOfPoints".
*
* @param h : handle from which geography and data values are taken
* @param lats : returned array of latitudes
* @param lons : returned array of longitudes
* @param values : returned array of data values
* @return 0 if OK, integer value on error
*/
int codes_grib_get_data(codes_handle *h, double *lats, double *lons, double *values);
/**
* Get the next value from an iterator.
*
* @param i : the iterator
* @param lat : on output latitude in degree
* @param lon : on output longitude in degree
* @param value : on output value of the point
* @return positive value if successful, 0 if no more data are available
*/
int codes_grib_iterator_next(codes_iterator *i, double* lat,double* lon,double* value);
/**
* Get the previous value from an iterator.
*
* @param i : the iterator
* @param lat : on output latitude in degree
* @param lon : on output longitude in degree
* @param value : on output value of the point*
* @return positive value if successful, 0 if no more data are available
*/
int codes_grib_iterator_previous(codes_iterator *i, double* lat,double* lon,double* value);
/**
* Test procedure for values in an iterator.
*
* @param i : the iterator
* @return boolean, 1 if the iterator still nave next values, 0 otherwise
*/
int codes_grib_iterator_has_next(codes_iterator *i);
/**
* Test procedure for values in an iterator.
*
* @param i : the iterator
* @return 0 if OK, integer value on error
*/
int codes_grib_iterator_reset(codes_iterator *i);
/**
* Frees an iterator from memory
*
* @param i : the iterator
* @return 0 if OK, integer value on error
*/
int codes_grib_iterator_delete(codes_iterator *i);
/*!
* \brief Create a new nearest from a handle, using current geometry .
*
* \param h : the handle from which the iterator will be created
* \param error : error code
* \return the new nearest, NULL if no nearest can be created
*/
codes_nearest* codes_grib_nearest_new(codes_handle* h, int* error);
/**
* Find the 4 nearest points of a latitude longitude point.
* The flags are provided to speed up the process of searching. If you are
* sure that the point you are asking for is not changing from a call
* to another you can use CODES_NEAREST_SAME_POINT. The same is valid for
* the grid. Flags can be used together doing a bitwise OR.
* The distances are given in kilometres.
*
* @param nearest : nearest structure
* @param h : handle from which geography and data values are taken
* @param inlat : latitude of the point to search for
* @param inlon : longitude of the point to search for
* @param flags : CODES_NEAREST_SAME_POINT, CODES_NEAREST_SAME_GRID
* @param outlats : returned array of latitudes of the nearest points
* @param outlons : returned array of longitudes of the nearest points
* @param values : returned array of data values of the nearest points
* @param distances : returned array of distances from the nearest points
* @param indexes : returned array of indexes of the nearest points
* @param len : size of the arrays
* @return 0 if OK, integer value on error
*/
int codes_grib_nearest_find(codes_nearest *nearest,codes_handle* h,double inlat,double inlon,
unsigned long flags,double* outlats,double* outlons,
double* values,double* distances,int* indexes,size_t *len);
/**
* Frees an nearest from memory
*
* @param nearest : the nearest
* @return 0 if OK, integer value on error
*/
int codes_grib_nearest_delete(codes_nearest *nearest);
/**
* Find the nearest point of a set of points whose latitudes and longitudes
* are given in the inlats, inlons arrays respectively.
* If the flag is_lsm is 1 the nearest land point is returned and the
* grib passed as handle (h) is considered a land sea mask.
* The land nearest point is the nearest point with land sea mask value>=0.5.
* If no nearest land points are found the nearest value is returned.
* If the flag is_lsm is 0 the nearest point is returned.
* values, distances, indexes (in the "values" array) for the nearest points (ilons,ilats)
* are returned.
* The distances are given in kilometres.
*
* @param h : handle from which geography and data values are taken
* @param is_lsm : lsm flag (1-> nearest land, 0-> nearest)
* @param inlats : latitudes of the points to search for
* @param inlons : longitudes of the points to search for
* @param npoints : number of points (size of the inlats,inlons,outlats,outlons,values,distances,indexes arrays)
* @param outlats : returned array of latitudes of the nearest points
* @param outlons : returned array of longitudes of the nearest points
* @param values : returned array of data values of the nearest points
* @param distances : returned array of distances from the nearest points
* @param indexes : returned array of indexes of the nearest points
* @return 0 if OK, integer value on error
*/
int codes_grib_nearest_find_multiple(codes_handle* h,int is_lsm,
double* inlats,double* inlons,long npoints,
double* outlats,double* outlons,
double* values,double* distances, int* indexes);
/* @} */
/*! \defgroup get_set Accessing header and data values */
/*! @{ */
/**
* Get the number offset of a key, in a message if several keys of the same name
* are present, the offset of the last one is returned
*
* @param h : the handle to get the offset from
* @param key : the key to be searched
* @param offset : the address of a size_t where the offset will be set
* @return 0 if OK, integer value on error
*/
int codes_get_offset(codes_handle* h, const char* key, size_t* offset);
/**
* Get the number of coded value from a key, if several keys of the same name are present, the total sum is returned
*
* @param h : the handle to get the offset from
* @param key : the key to be searched
* @param size : the address of a size_t where the size will be set
* @return 0 if OK, integer value on error
*/
int codes_get_size(codes_handle* h, const char* key,size_t *size);
/**
* Get the length of the string representation of the key, if several keys of the same name are present, the maximum length is returned
*
* @param h : the handle to get the offset from
* @param key : the key to be searched
* @param length : the address of a size_t where the length will be set
* @return 0 if OK, integer value on error
*/
int codes_get_length(codes_handle* h, const char* key,size_t *length);
/**
* Get a long value from a key, if several keys of the same name are present, the last one is returned
* @see codes_set_long
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param value : the address of a long where the data will be retrieved
* @return 0 if OK, integer value on error
*/
int codes_get_long(codes_handle* h, const char* key, long* value );
/**
* Get a double value from a key, if several keys of the same name are present, the last one is returned
* @see codes_set_double
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param value : the address of a double where the data will be retrieved
* @return 0 if OK, integer value on error
*/
int codes_get_double(codes_handle* h, const char* key, double* value );
/**
* Get as double the i-th element of the "key" array
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param i : zero-based index
* @param value : the address of a double where the data will be retrieved
* @return 0 if OK, integer value on error
*/
int codes_get_double_element(codes_handle* h, const char* key, int i, double* value);
/**
* Get as double array the elements of the "key" array whose indexes are listed in the input array i
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param i : zero-based array of indexes
* @param size : size of the i and value arrays
* @param value : the double array for the data values
* @return 0 if OK, integer value on error
*/
int codes_get_double_elements(codes_handle* h, const char* key, int* i, long size, double* value);
/**
* Get a string value from a key, if several keys of the same name are present, the last one is returned
* @see codes_set_string
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param mesg : the address of a string where the data will be retrieved
* @param length : the address of a size_t that contains allocated length of the string on input, and that contains the actual length of the string on output
* @return 0 if OK, integer value on error
*/
int codes_get_string(codes_handle* h, const char* key, char* mesg, size_t *length );
/**
* Get string array values from a key. If several keys of the same name are present, the last one is returned
* @see codes_set_string_array
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param vals : the address of a string array where the data will be retrieved
* @param length : the address of a size_t that contains allocated length of the array on input, and that contains the actual length of the array on output
* @return 0 if OK, integer value on error
*/
int codes_get_string_array(codes_handle* h, const char* key, char** vals, size_t *length);
/**
* Get raw bytes values from a key. If several keys of the same name are present, the last one is returned
* @see codes_set_bytes
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param bytes : the address of a byte array where the data will be retrieved
* @param length : the address of a size_t that contains allocated length of the byte array on input, and that contains the actual length of the byte array on output
* @return 0 if OK, integer value on error
*/
int codes_get_bytes(codes_handle* h, const char* key, unsigned char* bytes, size_t *length);
/**
* Get double array values from a key. If several keys of the same name are present, the last one is returned
* @see codes_set_double_array
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param vals : the address of a double array where the data will be retrieved
* @param length : the address of a size_t that contains allocated length of the double array on input, and that contains the actual length of the double array on output
* @return 0 if OK, integer value on error
*/
int codes_get_double_array(codes_handle* h, const char* key, double* vals, size_t *length);
/**
* Get long array values from a key. If several keys of the same name are present, the last one is returned
* @see codes_set_long_array
*
* @param h : the handle to get the data from
* @param key : the key to be searched
* @param vals : the address of a long array where the data will be retrieved
* @param length : the address of a size_t that contains allocated length of the long array on input, and that contains the actual length of the long array on output
* @return 0 if OK, integer value on error
*/
int codes_get_long_array(codes_handle* h, const char* key, long* vals, size_t *length);
/* setting data */
/**
* Copy the keys belonging to a given namespace from a source handle to a destination handle
*
*
* @param dest : destination handle
* @param name : namespace
* @param src : source handle
* @return 0 if OK, integer value on error
*/
int codes_copy_namespace(codes_handle* dest, const char* name, codes_handle* src);
/**
* Set a long value from a key. If several keys of the same name are present, the last one is set
* @see codes_get_long
*
* @param h : the handle to set the data to
* @param key : the key to be searched
* @param val : a long where the data will be read
* @return 0 if OK, integer value on error
*/
int codes_set_long(codes_handle* h, const char* key, long val);
/**
* Set a double value from a key. If several keys of the same name are present, the last one is set
* @see codes_get_double
*
* @param h : the handle to set the data to
* @param key : the key to be searched
* @param val : a double where the data will be read
* @return 0 if OK, integer value on error
*/
int codes_set_double(codes_handle* h, const char* key, double val);
/**
* Set a string value from a key. If several keys of the same name are present, the last one is set
* @see codes_get_string
*
* @param h : the handle to set the data to
* @param key : the key to be searched
* @param mesg : the address of a string where the data will be read
* @param length : the address of a size_t that contains the length of the string on input, and that contains the actual packed length of the string on output
* @return 0 if OK, integer value on error
*/
int codes_set_string(codes_handle* h, const char* key , const char* mesg, size_t *length);
/**
* Set a bytes array from a key. If several keys of the same name are present, the last one is set
* @see codes_get_bytes
*
* @param h : the handle to set the data to
* @param key : the key to be searched
* @param bytes : the address of a byte array where the data will be read
* @param length : the address of a size_t that contains the length of the byte array on input, and that contains the actual packed length of the byte array on output
* @return 0 if OK, integer value on error
*/
int codes_set_bytes(codes_handle* h, const char* key, const unsigned char* bytes, size_t *length);
/**
* Set a double array from a key. If several keys of the same name are present, the last one is set
* @see codes_get_double_array
*
* @param h : the handle to set the data to
* @param key : the key to be searched
* @param vals : the address of a double array where the data will be read
* @param length : a size_t that contains the length of the byte array on input
* @return 0 if OK, integer value on error
*/
int codes_set_double_array(codes_handle* h, const char* key, const double* vals, size_t length);
/**
* Same as codes_set_double_array but allows setting of READ-ONLY keys like codedValues.
* Use with great caution!!
*/
int codes_set_force_double_array(codes_handle* h, const char* key, const double* vals, size_t length);
/**
* Set a long array from a key. If several keys of the same name are present, the last one is set
* @see codes_get_long_array
*
* @param h : the handle to set the data to
* @param key : the key to be searched
* @param vals : the address of a long array where the data will be read
* @param length : a size_t that contains the length of the long array on input
* @return 0 if OK, integer value on error
*/
int codes_set_long_array(codes_handle* h, const char* key, const long* vals, size_t length);
/**
* Set a string array from a key. If several keys of the same name are present, the last one is set
* @see codes_get_long_array
*
* @param h : the handle to set the data to
* @param key : the key to be searched
* @param vals : the address of a string array where the data will be read
* @param length : a size_t that contains the length of the array on input
* @return 0 if OK, integer value on error
*/
int codes_set_string_array(codes_handle *h, const char *key, const char **vals, size_t length);
/*! @} */
/**
* Print all keys, with the context print procedure and dump mode to a resource
*
* @param h : the handle to be printed
* @param out : output file handle
* @param mode : Examples of available dump modes: debug wmo
* @param option_flags : all the CODES_DUMP_FLAG_x flags can be used
* @param arg : used to provide a format to output data (experimental)
*/
void codes_dump_content(codes_handle* h,FILE* out,const char* mode, unsigned long option_flags,void* arg);
/**
* Print all keys from the parsed definition files available in a context
*
* @param f : the File used to print the keys on
* @param c : the context that contains the cached definition files to be printed
*/
void codes_dump_action_tree(codes_context* c, FILE* f) ;
/*! \defgroup context The context object
The context is a long life configuration object of eccodes.
It is used to define special allocation and free routines or
to set special eccodes behaviours and variables.
*/
/*! @{ */
/* TODO: function pointers
grib_malloc_proc
grib_realloc_proc
grib_log_proc
grib_print_proc
grib_data_read_proc
grib_data_write_proc
grib_data_tell_proc
grib_data_seek_proc
grib_data_eof_proc
*/
/**
* Get the static default context
*
* @return the default context, NULL it the context is not available
*/
codes_context* codes_context_get_default(void);
/**
* Frees the cached definition files of the context
*
* @param c : the context to be deleted
*/
void codes_context_delete(codes_context* c);
/**
* Set the GTS header mode on.
* The GTS headers will be preserved.
*
* @param c : the context
*/
void codes_gts_header_on(codes_context* c) ;
/**
* Set the GTS header mode off.
* The GTS headers will be deleted.
*
* @param c : the context
*/
void codes_gts_header_off(codes_context* c);
/**
* Set the GRIBEX mode on.
* GRIB files will be compatible with GRIBEX.
*
* @param c : the context
*/
void codes_gribex_mode_on(codes_context* c);
/**
* Get the GRIBEX mode.
*
* @param c : the context
*/
int codes_get_gribex_mode(codes_context* c);
/**
* Set the GRIBEX mode off.
* GRIB files won't be always compatible with GRIBEX.
*
* @param c : the context
*/
void codes_gribex_mode_off(codes_context* c);
/**
* Sets the search path for definition files.
*
* @param c : the context to be modified
* @param path : the search path for definition files
*/
void codes_context_set_definitions_path(grib_context* c, const char* path);
/**
* Sets the search path for sample files.
*
* @param c : the context to be modified
* @param path : the search path for sample files
*/
void codes_context_set_samples_path(grib_context* c, const char* path);
/**
* Turn on support for multiple fields in single GRIB messages
*
* @param c : the context to be modified
*/
void codes_grib_multi_support_on(codes_context* c);
/**
* Turn off support for multiple fields in single GRIB messages
*
* @param c : the context to be modified
*/
void codes_grib_multi_support_off(codes_context* c);
/**
* Reset file handle in multiple GRIB field support mode
*
* @param c : the context to be modified
* @param f : the file pointer
*/
void codes_grib_multi_support_reset_file(codes_context* c, FILE* f);
char* codes_samples_path(const codes_context *c);
char* codes_definition_path(const codes_context *c);
/*! @} */
/**
* Get the API version
*
* @return API version
*/
long codes_get_api_version(void);
/**
* Get the Git version control SHA1 identifier
*
* @return character string with SHA1 identifier
*/
const char* codes_get_git_sha1(void);
/**
* Get the package name
*
* @return character string with package name
*/
const char* codes_get_package_name(void);
/**
* Prints the API version
*
*/
void codes_print_api_version(FILE* out);
/*! \defgroup keys_iterator Iterating on keys names
The keys iterator is designed to get the key names defined in a message.
Key names on which the iteration is carried out can be filtered through their
attributes or by the namespace they belong to.
*/
/*! @{ */
/*! Create a new iterator from a valid and initialised handle.
* @param h : the handle whose keys you want to iterate
* @param filter_flags : flags to filter out some of the keys through their attributes
* @param name_space : if not null the iteration is carried out only on
* keys belonging to the namespace passed. (NULL for all the keys)
* @return keys iterator ready to iterate through keys according to filter_flags
* and namespace
*/
codes_keys_iterator* codes_keys_iterator_new(codes_handle* h,unsigned long filter_flags, const char* name_space);
/* codes_bufr_copy_data copies all the values in the data section that are present in the same position in the data tree
* and with the same number of values to the output handle. Should not exit with error if the output handle has a different
* structure as the aim is to copy what is possible to be copied.
* This will allow the user to add something to a message by creating a new message with additions or changes to the
* unexpandedDescriptors and copying what is possible to copy from the original message. */
char **codes_bufr_copy_data_return_copied_keys(grib_handle *hin, grib_handle *hout, size_t *nkeys, int *err);
int codes_bufr_copy_data(grib_handle* hin, grib_handle* hout);
/*! Step to the next item from the keys iterator.
* @param kiter : valid codes_keys_iterator
* @return 1 if next iterator exists, 0 if no more elements to iterate on
*/
int codes_keys_iterator_next(codes_keys_iterator *kiter);
/*! get the key name from the keys iterator
* @param kiter : valid codes_keys_iterator
* @return key name
*/
const char* codes_keys_iterator_get_name(codes_keys_iterator *kiter);
/*! Delete the keys iterator.
* @param kiter : valid codes_keys_iterator
* @return 0 if OK, integer value on error
*/
int codes_keys_iterator_delete( codes_keys_iterator* kiter);
/*! Rewind the keys iterator.
* @param kiter : valid codes_keys_iterator
* @return 0 if OK, integer value on error
*/
int codes_keys_iterator_rewind(codes_keys_iterator* kiter);
int codes_keys_iterator_set_flags(codes_keys_iterator *kiter,unsigned long flags);
int codes_keys_iterator_get_long(codes_keys_iterator *kiter, long *v, size_t *len);
int codes_keys_iterator_get_double(codes_keys_iterator *kiter, double *v, size_t *len);
int codes_keys_iterator_get_string(codes_keys_iterator *kiter, char *v, size_t *len);
int codes_keys_iterator_get_bytes(codes_keys_iterator *kiter, unsigned char *v, size_t *len);
/* @} */
void codes_update_sections_lengths(codes_handle* h);
/**
* Convert an error code into a string
* @param code : the error code
* @return the error message
*/
const char* codes_get_error_message(int code);
const char* codes_get_type_name(int type);
int codes_get_native_type(codes_handle* h, const char* name,int* type);
void codes_check(const char* call,const char* file,int line,int e,const char* msg);
#define CODES_CHECK(a,msg) GRIB_CHECK(a,msg)
#define CODES_CHECK_NOLINE(a,msg) GRIB_CHECK_NOLINE(a,msg)
int codes_set_values(codes_handle* h, codes_values* codes_values, size_t arg_count);
codes_handle* codes_handle_new_from_partial_message_copy(codes_context* c, const void* data, size_t size);
codes_handle* codes_handle_new_from_partial_message(codes_context* c, const void* data, size_t buflen);
int codes_is_missing(codes_handle* h, const char* key, int* err);
int codes_is_defined(codes_handle* h, const char* key);
int codes_set_missing(codes_handle* h, const char* key);
/* The truncation is the Gaussian number (or order) */
int codes_get_gaussian_latitudes(long truncation,double* latitudes);
int codes_julian_to_datetime(double jd, long *year, long *month, long *day, long *hour, long *minute, long *second);
int codes_datetime_to_julian(long year, long month, long day, long hour, long minute, long second, double *jd);
long codes_julian_to_date(long jdate);
long codes_date_to_julian(long ddate);
void codes_get_reduced_row(long pl,double lon_first,double lon_last,long* npoints,long* ilon_first, long* ilon_last );
/* read products */
int codes_get_message_offset(codes_handle* h,off_t* offset);
int codes_get_message_size(codes_handle* h,size_t* size);
codes_box* codes_box_new(codes_handle* h,int* error);
codes_points* codes_box_get_points(codes_box *box,double north, double west,double south,double east, int *err);
int codes_points_get_values(codes_handle* h, codes_points* points, double* val);
/* --------------------------------------- */
#define CODES_UTIL_GRID_SPEC_REGULAR_LL GRIB_UTIL_GRID_SPEC_REGULAR_LL
#define CODES_UTIL_GRID_SPEC_ROTATED_LL GRIB_UTIL_GRID_SPEC_ROTATED_LL
#define CODES_UTIL_GRID_SPEC_REGULAR_GG GRIB_UTIL_GRID_SPEC_REGULAR_GG
#define CODES_UTIL_GRID_SPEC_ROTATED_GG GRIB_UTIL_GRID_SPEC_ROTATED_GG
#define CODES_UTIL_GRID_SPEC_REDUCED_GG GRIB_UTIL_GRID_SPEC_REDUCED_GG
#define CODES_UTIL_GRID_SPEC_SH GRIB_UTIL_GRID_SPEC_SH
#define CODES_UTIL_GRID_SPEC_REDUCED_LL GRIB_UTIL_GRID_SPEC_REDUCED_LL
#define CODES_UTIL_GRID_SPEC_POLAR_STEREOGRAPHIC GRIB_UTIL_GRID_SPEC_POLAR_STEREOGRAPHIC
#define CODES_UTIL_PACKING_TYPE_SPECTRAL_COMPLEX GRIB_UTIL_PACKING_TYPE_SPECTRAL_COMPLEX
#define CODES_UTIL_PACKING_TYPE_SPECTRAL_SIMPLE GRIB_UTIL_PACKING_TYPE_SPECTRAL_SIMPLE
#define CODES_UTIL_PACKING_TYPE_JPEG GRIB_UTIL_PACKING_TYPE_JPEG
#define CODES_UTIL_PACKING_TYPE_GRID_COMPLEX GRIB_UTIL_PACKING_TYPE_GRID_COMPLEX
#define CODES_UTIL_PACKING_TYPE_GRID_SIMPLE GRIB_UTIL_PACKING_TYPE_GRID_SIMPLE
#define CODES_UTIL_PACKING_TYPE_GRID_SIMPLE_MATRIX GRIB_UTIL_PACKING_TYPE_GRID_SIMPLE_MATRIX
#define CODES_UTIL_PACKING_TYPE_GRID_SECOND_ORDER GRIB_UTIL_PACKING_TYPE_GRID_SECOND_ORDER
#define CODES_UTIL_PACKING_SAME_AS_INPUT GRIB_UTIL_PACKING_SAME_AS_INPUT
#define CODES_UTIL_PACKING_USE_PROVIDED GRIB_UTIL_PACKING_USE_PROVIDED
#define CODES_UTIL_ACCURACY_SAME_BITS_PER_VALUES_AS_INPUT GRIB_UTIL_ACCURACY_SAME_BITS_PER_VALUES_AS_INPUT
#define CODES_UTIL_ACCURACY_USE_PROVIDED_BITS_PER_VALUES GRIB_UTIL_ACCURACY_USE_PROVIDED_BITS_PER_VALUES
#define CODES_UTIL_ACCURACY_SAME_DECIMAL_SCALE_FACTOR_AS_INPUT GRIB_UTIL_ACCURACY_SAME_DECIMAL_SCALE_FACTOR_AS_INPUT
#define CODES_UTIL_ACCURACY_USE_PROVIDED_DECIMAL_SCALE_FACTOR GRIB_UTIL_ACCURACY_USE_PROVIDED_DECIMAL_SCALE_FACTOR
codes_handle *codes_grib_util_set_spec(codes_handle *h,
const codes_util_grid_spec *grid_spec,
const codes_util_packing_spec *packing_spec, /* NULL for defaults (same as input) */
int flags,
const double *data_values,
size_t data_values_count,
int *err);
/* --------------------------------------- */
#ifdef __cplusplus
}
#endif
#endif
/* This part is automatically generated by ./errors.pl, do not edit */
#ifndef eccodes_errors_H
#define eccodes_errors_H
/*! \defgroup errors Error codes
Error codes returned by the eccodes functions.
*/
/*! @{*/
/** No error */
#define CODES_SUCCESS GRIB_SUCCESS
/** End of resource reached */
#define CODES_END_OF_FILE GRIB_END_OF_FILE
/** Internal error */
#define CODES_INTERNAL_ERROR GRIB_INTERNAL_ERROR
/** Passed buffer is too small */
#define CODES_BUFFER_TOO_SMALL GRIB_BUFFER_TOO_SMALL
/** Function not yet implemented */
#define CODES_NOT_IMPLEMENTED GRIB_NOT_IMPLEMENTED
/** Missing 7777 at end of message */
#define CODES_7777_NOT_FOUND GRIB_7777_NOT_FOUND
/** Passed array is too small */
#define CODES_ARRAY_TOO_SMALL GRIB_ARRAY_TOO_SMALL
/** File not found */
#define CODES_FILE_NOT_FOUND GRIB_FILE_NOT_FOUND
/** Code not found in code table */
#define CODES_CODE_NOT_FOUND_IN_TABLE GRIB_CODE_NOT_FOUND_IN_TABLE
/** Array size mismatch */
#define CODES_WRONG_ARRAY_SIZE GRIB_WRONG_ARRAY_SIZE
/** Key/value not found */
#define CODES_NOT_FOUND GRIB_NOT_FOUND
/** Input output problem */
#define CODES_IO_PROBLEM GRIB_IO_PROBLEM
/** Message invalid */
#define CODES_INVALID_MESSAGE GRIB_INVALID_MESSAGE
/** Decoding invalid */
#define CODES_DECODING_ERROR GRIB_DECODING_ERROR
/** Encoding invalid */
#define CODES_ENCODING_ERROR GRIB_ENCODING_ERROR
/** Code cannot unpack because of string too small */
#define CODES_NO_MORE_IN_SET GRIB_NO_MORE_IN_SET
/** Problem with calculation of geographic attributes */
#define CODES_GEOCALCULUS_PROBLEM GRIB_GEOCALCULUS_PROBLEM
/** Memory allocation error */
#define CODES_OUT_OF_MEMORY GRIB_OUT_OF_MEMORY
/** Value is read only */
#define CODES_READ_ONLY GRIB_READ_ONLY
/** Invalid argument */
#define CODES_INVALID_ARGUMENT GRIB_INVALID_ARGUMENT
/** Null handle */
#define CODES_NULL_HANDLE GRIB_NULL_HANDLE
/** Invalid section number */
#define CODES_INVALID_SECTION_NUMBER GRIB_INVALID_SECTION_NUMBER
/** Value cannot be missing */
#define CODES_VALUE_CANNOT_BE_MISSING GRIB_VALUE_CANNOT_BE_MISSING
/** Wrong message length */
#define CODES_WRONG_LENGTH GRIB_WRONG_LENGTH
/** Invalid key type */
#define CODES_INVALID_TYPE GRIB_INVALID_TYPE
/** Unable to set step */
#define CODES_WRONG_STEP GRIB_WRONG_STEP
/** Wrong units for step (step must be integer) */
#define CODES_WRONG_STEP_UNIT GRIB_WRONG_STEP_UNIT
/** Invalid file id */
#define CODES_INVALID_FILE GRIB_INVALID_FILE
/** Invalid grib id */
#define CODES_INVALID_GRIB GRIB_INVALID_GRIB
/** Invalid index id */
#define CODES_INVALID_INDEX GRIB_INVALID_INDEX
/** Invalid iterator id */
#define CODES_INVALID_ITERATOR GRIB_INVALID_ITERATOR
/** Invalid keys iterator id */
#define CODES_INVALID_KEYS_ITERATOR GRIB_INVALID_KEYS_ITERATOR
/** Invalid nearest id */
#define CODES_INVALID_NEAREST GRIB_INVALID_NEAREST
/** Invalid order by */
#define CODES_INVALID_ORDERBY GRIB_INVALID_ORDERBY
/** Missing a key from the fieldset */
#define CODES_MISSING_KEY GRIB_MISSING_KEY
/** The point is out of the grid area */
#define CODES_OUT_OF_AREA GRIB_OUT_OF_AREA
/** Concept no match */
#define CODES_CONCEPT_NO_MATCH GRIB_CONCEPT_NO_MATCH
/** Hash array no match */
#define CODES_HASH_ARRAY_NO_MATCH GRIB_HASH_ARRAY_NO_MATCH
/** Definitions files not found */
#define CODES_NO_DEFINITIONS GRIB_NO_DEFINITIONS
/** Wrong type while packing */
#define CODES_WRONG_TYPE GRIB_WRONG_TYPE
/** End of resource */
#define CODES_END GRIB_END
/** Unable to code a field without values */
#define CODES_NO_VALUES GRIB_NO_VALUES
/** Grid description is wrong or inconsistent */
#define CODES_WRONG_GRID GRIB_WRONG_GRID
/** End of index reached */
#define CODES_END_OF_INDEX GRIB_END_OF_INDEX
/** Null index */
#define CODES_NULL_INDEX GRIB_NULL_INDEX
/** End of resource reached when reading message */
#define CODES_PREMATURE_END_OF_FILE GRIB_PREMATURE_END_OF_FILE
/** An internal array is too small */
#define CODES_INTERNAL_ARRAY_TOO_SMALL GRIB_INTERNAL_ARRAY_TOO_SMALL
/** Message is too large for the current architecture */
#define CODES_MESSAGE_TOO_LARGE GRIB_MESSAGE_TOO_LARGE
/** Constant field */
#define CODES_CONSTANT_FIELD GRIB_CONSTANT_FIELD
/** Switch unable to find a matching case */
#define CODES_SWITCH_NO_MATCH GRIB_SWITCH_NO_MATCH
/** Underflow */
#define CODES_UNDERFLOW GRIB_UNDERFLOW
/** Message malformed */
#define CODES_MESSAGE_MALFORMED GRIB_MESSAGE_MALFORMED
/** Index is corrupted */
#define CODES_CORRUPTED_INDEX GRIB_CORRUPTED_INDEX
/** Invalid number of bits per value */
#define CODES_INVALID_BPV GRIB_INVALID_BPV
/** Edition of two messages is different */
#define CODES_DIFFERENT_EDITION GRIB_DIFFERENT_EDITION
/** Value is different */
#define CODES_VALUE_DIFFERENT GRIB_VALUE_DIFFERENT
/** Invalid key value */
#define CODES_INVALID_KEY_VALUE GRIB_INVALID_KEY_VALUE
/** String is smaller than requested */
#define CODES_STRING_TOO_SMALL GRIB_STRING_TOO_SMALL
/** Wrong type conversion */
#define CODES_WRONG_CONVERSION GRIB_WRONG_CONVERSION
/** Missing BUFR table entry for descriptor */
#define CODES_MISSING_BUFR_ENTRY GRIB_MISSING_BUFR_ENTRY
/** Null pointer */
#define CODES_NULL_POINTER GRIB_NULL_POINTER
/** Attribute is already present, cannot add */
#define CODES_ATTRIBUTE_CLASH GRIB_ATTRIBUTE_CLASH
/** Too many attributes. Increase MAX_ACCESSOR_ATTRIBUTES */
#define CODES_TOO_MANY_ATTRIBUTES GRIB_TOO_MANY_ATTRIBUTES
/** Attribute not found. */
#define CODES_ATTRIBUTE_NOT_FOUND GRIB_ATTRIBUTE_NOT_FOUND
/** Edition not supported. */
#define CODES_UNSUPPORTED_EDITION GRIB_UNSUPPORTED_EDITION
/** Value out of coding range */
#define CODES_OUT_OF_RANGE GRIB_OUT_OF_RANGE
/** Size of bitmap is incorrect */
#define CODES_WRONG_BITMAP_SIZE GRIB_WRONG_BITMAP_SIZE
/*! @}*/
#endif
|