From 5e79ca55468217321d2c96fd8d41a88f2905b513 Mon Sep 17 00:00:00 2001 From: Shahram Najm Date: Tue, 17 Jan 2017 14:41:54 +0000 Subject: [PATCH] Documentation --- doxygen/prepare_pydocs.pl | 2 + doxygen/process_python.pl | 2 + html/annotated.html | 53 +- html/classeccodes.html | 174 ++++-- html/classes.html | 21 +- ...sshigh__level__api_1_1_test_bufr_file.html | 229 ++++++++ ...igh__level__api_1_1_test_bufr_message.html | 225 +++++++ ...sshigh__level__api_1_1_test_grib_file.html | 237 ++++++++ ...shigh__level__api_1_1_test_grib_index.html | 183 ++++++ ...igh__level__api_1_1_test_grib_message.html | 233 ++++++++ .../dir_d050070cc3e4bbd91d897ff8856046e0.html | 6 + .../dir_da7ee69c60c6cc261c862ec60d8c4bc7.html | 4 + html/eccodes_8h.html | 34 +- html/functions.html | 81 +-- html/functions_0x74.html | 156 +++++ html/functions_func.html | 81 +-- ...al_error.html => functions_func_0x74.html} | 85 ++- html/globals.html | 8 +- html/globals_defs.html | 3 + html/globals_func.html | 5 +- html/group__codes__handle.html | 12 +- html/group__errors.html | 4 +- html/group__get__set.html | 6 +- html/group__keys__iterator.html | 16 + ...terfaceeccodes_1_1codes__get__element.html | 48 +- ...eccodes_1_1codes__grib__find__nearest.html | 24 +- html/interfaceeccodes_1_1codes__set.html | 3 +- html/namespaceec_codes.html | 552 +++++++++++------- html/namespacemembers.html | 23 +- html/namespacemembers_func.html | 23 +- html/search/all_63.js | 29 +- html/search/all_67.js | 2 - html/search/all_74.js | 20 +- html/search/classes_63.js | 3 +- .../{functions_67.html => classes_74.html} | 2 +- html/search/classes_74.js | 8 + html/search/functions_63.js | 23 +- html/search/functions_67.js | 5 - html/search/functions_74.html | 26 + html/search/functions_74.js | 16 + html/search/search.js | 4 +- python/gribapi/gribapi.py | 1 + 42 files changed, 2171 insertions(+), 501 deletions(-) create mode 100644 html/classhigh__level__api_1_1_test_bufr_file.html create mode 100644 html/classhigh__level__api_1_1_test_bufr_message.html create mode 100644 html/classhigh__level__api_1_1_test_grib_file.html create mode 100644 html/classhigh__level__api_1_1_test_grib_index.html create mode 100644 html/classhigh__level__api_1_1_test_grib_message.html create mode 100644 html/functions_0x74.html rename html/{classec_codes_1_1_codes_internal_error.html => functions_func_0x74.html} (52%) rename html/search/{functions_67.html => classes_74.html} (93%) create mode 100644 html/search/classes_74.js delete mode 100644 html/search/functions_67.js create mode 100644 html/search/functions_74.html create mode 100644 html/search/functions_74.js diff --git a/doxygen/prepare_pydocs.pl b/doxygen/prepare_pydocs.pl index e55ae8ceb..5f25e573f 100755 --- a/doxygen/prepare_pydocs.pl +++ b/doxygen/prepare_pydocs.pl @@ -29,6 +29,8 @@ my @exclude = qw( grib_get_double_array grib_set_long_array grib_get_long_array + grib_get_string_array + grib_set_string_array grib_index_get_long grib_index_get_string grib_index_get_double diff --git a/doxygen/process_python.pl b/doxygen/process_python.pl index a74fd816c..c72479977 100755 --- a/doxygen/process_python.pl +++ b/doxygen/process_python.pl @@ -56,6 +56,8 @@ while (<>) { s/\bgrib_get_double_array\b/codes_get_double_array/; s/\bgrib_set_long_array\b/codes_set_long_array/; s/\bgrib_get_long_array\b/codes_get_long_array/; + s/\bgrib_set_string_array\b/codes_set_string_array/; + s/\bgrib_get_string_array\b/codes_get_string_array/; s/\bgrib_multi_new\b/codes_grib_multi_new/; s/\bgrib_multi_release\b/codes_grib_multi_release/; s/\bgrib_copy_namespace\b/codes_copy_namespace/; diff --git a/html/annotated.html b/html/annotated.html index bc69154b8..468a636fe 100644 --- a/html/annotated.html +++ b/html/annotated.html @@ -86,31 +86,36 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
Here are the data structures with brief descriptions:
[detail level 12]
- - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - - - + + + + + + + + + + + + + +
oNecCodesThis package is the Python interface to ecCodes
|\CCodesInternalErrorWrap errors coming from the C API in a Python exception object
oCcodes_context
oCcodes_handle
oCcodes_index
oCcodes_iterator
oCcodes_keys_iterator
oCcodes_multi_handle
oCcodes_nearest
\CeccodesModule eccodes
+
oNecCodesThis package is the Python interface to ecCodes
oNhigh_level_api
|oCTestGribFileTest GribFile functionality
|oCTestGribMessageTest GribMessage functionality
|oCTestGribIndexTest GribIndex functionality
|oCTestBufrFileTest BufrFile functionality
|\CTestBufrMessageTest BufrMessage functionality
oCcodes_context
oCcodes_handle
oCcodes_index
oCcodes_iterator
oCcodes_keys_iterator
oCcodes_multi_handle
oCcodes_nearest
\CeccodesModule eccodes
This is the Fortran90 interface for ecCodes
 oCcodes_getGet the value for a key from a grib message
 oCcodes_get_elementGet a value of specified index from an array key
 oCcodes_get_message_sizeGet the size of a coded message
 oCcodes_get_sizeGet the size of an array key
 oCcodes_grib_find_nearestFind the nearest point/points of a given latitude/longitude point
 oCcodes_grib_get_dataGet latitude/longitude and data values
 oCcodes_index_getGet the distinct values of the key in argument contained in the index
 oCcodes_index_get_sizeGet the number of distinct values of the key in argument contained in the index
 oCcodes_index_selectSelect the message subset with key==value
 oCcodes_new_from_messageCreate a new message in memory from an integer or character array containting the coded message
 oCcodes_read_bytesReads nbytes bytes into the buffer from a file opened with codes_open_file
 oCcodes_read_from_fileReads a message in the buffer array from the file opened with codes_open_file
 oCcodes_setSet the value for a key in a grib message
 \Ccodes_write_bytesWrite nbytes bytes from the buffer in a file opened with codes_open_file
 oCcodes_getGet the value for a key from a grib message
 oCcodes_get_elementGet a value of specified index from an array key
 oCcodes_get_message_sizeGet the size of a coded message
 oCcodes_get_sizeGet the size of an array key
 oCcodes_grib_find_nearestFind the nearest point/points of a given latitude/longitude point
 oCcodes_grib_get_dataGet latitude/longitude and data values
 oCcodes_index_getGet the distinct values of the key in argument contained in the index
 oCcodes_index_get_sizeGet the number of distinct values of the key in argument contained in the index
 oCcodes_index_selectSelect the message subset with key==value
 oCcodes_new_from_messageCreate a new message in memory from an integer or character array containting the coded message
 oCcodes_read_bytesReads nbytes bytes into the buffer from a file opened with codes_open_file
 oCcodes_read_from_fileReads a message in the buffer array from the file opened with codes_open_file
 oCcodes_setSet the value for a key in a grib message
 \Ccodes_write_bytesWrite nbytes bytes from the buffer in a file opened with codes_open_file
diff --git a/html/classeccodes.html b/html/classeccodes.html index 7a527ba46..59c029e84 100644 --- a/html/classeccodes.html +++ b/html/classeccodes.html @@ -364,6 +364,9 @@ Public Member Functions subroutine codes_get_string_array (msgid, key, value, status)  Get the string array of values for a key from a message. More...
  +subroutine codes_bufr_copy_data (msgid1, msgid2, status) + Copy data values from a BUFR message msgid1 to another message msgid2. More...
+  subroutine codes_set_string_array (msgid, key, value, status)  Set the string values for an array key in a message. More...
  @@ -382,18 +385,18 @@ Public Member Functions subroutine codes_get_real8_array (msgid, key, value, status)  Get the real(8) array of values for a key from a message. More...
  -subroutine codes_get_real4_element (msgid, key, index, value, status) - Get a real(4) value of specified index from an array key. More...
-  -subroutine codes_get_real8_element (msgid, key, index, value, status) - Get a real(8) value of specified index from an array key. More...
-  -subroutine codes_get_real4_elements (msgid, key, index, value, status) - Get the real(4) values whose indexes are stored in the array "index" from an array key. More...
-  -subroutine codes_get_real8_elements (msgid, key, index, value, status) - Get the real(8) values whose indexes are stored in the array "index" from an array key. More...
-  +subroutine codes_get_real4_element (msgid, key, kindex, value, status) + Get a real(4) value of specified index from an array key. More...
+  +subroutine codes_get_real8_element (msgid, key, kindex, value, status) + Get a real(8) value of specified index from an array key. More...
+  +subroutine codes_get_real4_elements (msgid, key, kindex, value, status) + Get the real(4) values whose indexes are stored in the array "index" from an array key. More...
+  +subroutine codes_get_real8_elements (msgid, key, kindex, value, status) + Get the real(8) values whose indexes are stored in the array "index" from an array key. More...
+  subroutine codes_set_int (msgid, key, value, status)  Set the integer value for a key in a message. More...
  @@ -445,12 +448,12 @@ Public Member Functions subroutine codes_grib_find_nearest_multiple (gribid, is_lsm, inlats, inlons, outlats, outlons, values, distances, indexes, status)  Find the nearest point of a set of points whose latitudes and longitudes are given in the inlats, inlons arrays respectively. More...
  -subroutine codes_grib_find_nearest_single (gribid, is_lsm, inlat, inlon, outlat, outlon, value, distance, index, status) - Find the nearest point of a given latitude/longitude point. More...
-  -subroutine codes_grib_find_nearest_four_single (gribid, is_lsm, inlat, inlon, outlat, outlon, value, distance, index, status) - Find the 4 nearest points of a latitude longitude point. More...
-  +subroutine codes_grib_find_nearest_single (gribid, is_lsm, inlat, inlon, outlat, outlon, value, distance, kindex, status) + Find the nearest point of a given latitude/longitude point. More...
+  +subroutine codes_grib_find_nearest_four_single (gribid, is_lsm, inlat, inlon, outlat, outlon, value, distance, kindex, status) + Find the 4 nearest points of a latitude longitude point. More...
+  subroutine codes_grib_multi_support_on (status)  Turn on the support for multiple fields in a single message. More...
  @@ -481,6 +484,9 @@ Public Member Functions subroutine codes_set_samples_path (path, status)  Set the samples path. More...
  +subroutine codes_copy_key (msgid_src, key, msgid_dest, status) + Copy the value of a key from the source message to the destination message. More...

Detailed Description

Module eccodes
@@ -529,6 +535,51 @@ Public Member Functions +

+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
subroutine codes_bufr_copy_data (integer(kind=kindofint), intent(in) msgid1,
integer(kind=kindofint), intent(in) msgid2,
integer(kind=kindofint), intent(out), optional status 
)
+
+ +

Copy data values from a BUFR message msgid1 to another message msgid2.

+

In case of error, if the status parameter (optional) is not given, the program will exit with an error message.
+ Otherwise the error message can be gathered with codes_get_error_string.
+

+
Parameters
+ + + + +
msgid1id of the message from which the data are copied
msgid2id of the message to which the data are copied
statusCODES_SUCCESS if OK, integer value on error
+
+
+
@@ -749,6 +800,57 @@ Public Member Functions + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
subroutine codes_copy_key (integer(kind=kindofint), intent(in) msgid_src,
character(len=*), intent(in) key,
integer(kind=kindofint), intent(in) msgid_dest,
integer(kind=kindofint), intent(out), optional status 
)
+
+ +

Copy the value of a key from the source message to the destination message.

+

In case of error, if the status parameter (optional) is not given, the program will exit with an error message.
+ Otherwise the error message can be gathered with codes_get_error_string.

+
Parameters
+ + + + + +
msgid_srcsource message
msgid_destdestination message
keykey whose value is to be copied
statusGRIB_SUCCESS if OK, integer value on error
+
+
+
@@ -1423,7 +1525,7 @@ Public Member Functions - +
@@ -1443,7 +1545,7 @@ Public Member Functions - + @@ -1472,7 +1574,7 @@ Public Member Functions
integer(kind=kindofint), intent(in) index, kindex,
- +
msgidid of the grib loaded in memory
keykey name
indexinteger(4) index
kindexinteger(4) index
valuereal(4) value
statusCODES_SUCCESS if OK, integer value on error
@@ -1481,7 +1583,7 @@ Public Member Functions
- +
@@ -1501,7 +1603,7 @@ Public Member Functions - + @@ -1530,7 +1632,7 @@ Public Member Functions
integer(kind=kindofint), dimension(:), intent(in) index, kindex,
- +
msgidid of the grib loaded in memory
keykey name
indexinteger(4) array indexes
kindexinteger(4) array indexes
valuereal(4) array value
statusCODES_SUCCESS if OK, integer value on error
@@ -1642,7 +1744,7 @@ Public Member Functions
- +
@@ -1662,7 +1764,7 @@ Public Member Functions - + @@ -1691,7 +1793,7 @@ Public Member Functions
integer(kind=kindofint), intent(in) index, kindex,
- +
msgidid of the grib loaded in memory
keykey name
indexinteger(4) index
kindexinteger(4) index
valuereal(8) value
statusCODES_SUCCESS if OK, integer value on error
@@ -1700,7 +1802,7 @@ Public Member Functions
- +
@@ -1720,7 +1822,7 @@ Public Member Functions - + @@ -1749,7 +1851,7 @@ Public Member Functions
integer(kind=kindofint), dimension(:), intent(in) index, kindex,
- +
msgidid of the grib loaded in memory
keykey name
indexinteger(4) array index
kindexinteger(4) array index
valuereal(8) array value
statusCODES_SUCCESS if OK, integer value on error
@@ -1965,7 +2067,7 @@ Public Member Functions
- +
@@ -2021,7 +2123,7 @@ Public Member Functions - + @@ -2049,7 +2151,7 @@ Public Member Functions - +
integer(kind = kindofint), dimension(4), intent(out) index, kindex,
outlatlatitude of the nearest point
outlonlongitude of the nearest point
distancedistance between the given point and its nearest
indexzero based index
kindexzero based index
valuevalue of the field in the nearest point
statusCODES_SUCCESS if OK, integer value on error
@@ -2151,7 +2253,7 @@ Public Member Functions
- +
@@ -2207,7 +2309,7 @@ Public Member Functions - + @@ -2235,7 +2337,7 @@ Public Member Functions - +
integer(kind = kindofint), intent(out) index, kindex,
outlatlatitude of the nearest point
outlonlongitude of the nearest point
distancedistance between the given point and its nearest
indexzero based index
kindexzero based index
valuevalue of the field in the nearest point
statusCODES_SUCCESS if OK, integer value on error
diff --git a/html/classes.html b/html/classes.html index 16a88cbcc..1d720007f 100644 --- a/html/classes.html +++ b/html/classes.html @@ -84,19 +84,22 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
xxindex
-
C | E
+
C | E | T
- - - - - + + + + + + + +
  C  
-
eccodes::codes_get_size   eccodes::codes_index_get_size   eccodes::codes_new_from_message   
  E  
-
eccodes::codes_grib_find_nearest   eccodes::codes_index_select   eccodes::codes_read_bytes   
codes_context   eccodes::codes_grib_get_data   codes_iterator   eccodes::codes_read_from_file   eccodes   
eccodes::codes_get   codes_handle   codes_keys_iterator   eccodes::codes_set   
eccodes::codes_get_element   codes_index   codes_multi_handle   eccodes::codes_write_bytes   
eccodes::codes_get_message_size   eccodes::codes_index_get   codes_nearest   CodesInternalError (ecCodes)   
eccodes::codes_grib_find_nearest   codes_iterator   eccodes::codes_set   TestBufrMessage (high_level_api)   
eccodes::codes_grib_get_data   codes_keys_iterator   eccodes::codes_write_bytes   TestGribFile (high_level_api)   
codes_context   codes_handle   codes_multi_handle   
  E  
+
TestGribIndex (high_level_api)   
eccodes::codes_get   codes_index   codes_nearest   TestGribMessage (high_level_api)   
eccodes::codes_get_element   eccodes::codes_index_get   eccodes::codes_new_from_message   eccodes   
eccodes::codes_get_message_size   eccodes::codes_index_get_size   eccodes::codes_read_bytes   
  T  
+
eccodes::codes_get_size   eccodes::codes_index_select   eccodes::codes_read_from_file   
TestBufrFile (high_level_api)   
-
C | E
+
C | E | T