core
/
eccodes
mirror of https://github.com/ecmwf/eccodes.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Help: Fix broken URLs

This commit is contained in:
Shahram Najm 2022-03-09 16:29:09 +00:00
parent 510f423bb6
commit 254a7f10a6
12 changed files with 93 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
html/classeccodes.html
View File

@ -615,7 +615,7 @@ Public Member Functions</h2></td></tr>
<p>Load in memory a BUFR message from a file. </p> <p>Load in memory a BUFR message from a file. </p>
<p>The message can be accessed through its bufrid and it will be available<br/> <p>The message can be accessed through its bufrid and it will be available<br/>
until <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7">codes_release</a> is called.<br/> until <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7">codes_release</a> is called.<br/>
<b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/bufr_get_keys" target="_blank">bufr_get_keys.f90</a></p> <b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/bufr_get_keys" target="_blank">bufr_get_keys.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">ifile</td><td>id of the file opened with <a class="el" href="classeccodes.html#a28594e26f2f4b92b9c60e943dd8e1be3">codes_open_file</a> </td></tr> <tr><td class="paramname">ifile</td><td>id of the file opened with <a class="el" href="classeccodes.html#a28594e26f2f4b92b9c60e943dd8e1be3">codes_open_file</a> </td></tr>
@ -751,7 +751,7 @@ Public Member Functions</h2></td></tr>
message in memory (<em>msgid_dest</em>) exactly identical to the original one.<br/> message in memory (<em>msgid_dest</em>) exactly identical to the original one.<br/>
In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_clone" target="_blank">grib_clone.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_clone" target="_blank">grib_clone.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid_src</td><td>message to be cloned </td></tr> <tr><td class="paramname">msgid_src</td><td>message to be cloned </td></tr>
@ -789,7 +789,7 @@ Public Member Functions</h2></td></tr>
<p>Close a file. </p> <p>Close a file. </p>
<p>If the <em>fileid</em> does not refer to an opened file an error code is returned in status.<br/> <p>If the <em>fileid</em> does not refer to an opened file an error code is returned in status.<br/>
<b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a></p> <b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a></p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
@ -979,7 +979,7 @@ Public Member Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Counts the messages in a file. </p> <p>Counts the messages in a file. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/count_messages" target="_blank">count_messages.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/count_messages" target="_blank">count_messages.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">ifile</td><td>id of the file opened with <a class="el" href="classeccodes.html#a28594e26f2f4b92b9c60e943dd8e1be3">codes_open_file</a> </td></tr> <tr><td class="paramname">ifile</td><td>id of the file opened with <a class="el" href="classeccodes.html#a28594e26f2f4b92b9c60e943dd8e1be3">codes_open_file</a> </td></tr>
@ -2644,7 +2644,7 @@ Public Member Functions</h2></td></tr>
<p>Load in memory a GRIB message from a file. </p> <p>Load in memory a GRIB message from a file. </p>
<p>The message can be accessed through its gribid and it will be available<br/> <p>The message can be accessed through its gribid and it will be available<br/>
until <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7">codes_release</a> is called.<br/> until <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7">codes_release</a> is called.<br/>
<b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a></p> <b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">ifile</td><td>id of the file opened with <a class="el" href="classeccodes.html#a28594e26f2f4b92b9c60e943dd8e1be3">codes_open_file</a> </td></tr> <tr><td class="paramname">ifile</td><td>id of the file opened with <a class="el" href="classeccodes.html#a28594e26f2f4b92b9c60e943dd8e1be3">codes_open_file</a> </td></tr>
@ -2690,7 +2690,7 @@ Public Member Functions</h2></td></tr>
<p>To know where the samples directory is run the codes_info tool.<br/> <p>To know where the samples directory is run the codes_info tool.<br/>
In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_samples" target="_blank">grib_samples.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_samples" target="_blank">grib_samples.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">gribid</td><td>id of the message loaded in memory </td></tr> <tr><td class="paramname">gribid</td><td>id of the message loaded in memory </td></tr>
@ -2787,7 +2787,7 @@ Public Member Functions</h2></td></tr>
<p>Add a file to an index. </p> <p>Add a file to an index. </p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of the index I want to add a file to </td></tr> <tr><td class="paramname">indexid</td><td>id of the index I want to add a file to </td></tr>
@ -2839,7 +2839,7 @@ Public Member Functions</h2></td></tr>
<p>The file is indexed with the keys in argument.</p> <p>The file is indexed with the keys in argument.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of the newly created index </td></tr> <tr><td class="paramname">indexid</td><td>id of the newly created index </td></tr>
@ -2892,7 +2892,7 @@ Public Member Functions</h2></td></tr>
<p>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.</p> <p>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.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -2945,7 +2945,7 @@ Public Member Functions</h2></td></tr>
<p>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.</p> <p>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.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -2998,7 +2998,7 @@ Public Member Functions</h2></td></tr>
<p>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.</p> <p>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.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -3051,7 +3051,7 @@ Public Member Functions</h2></td></tr>
<p>The key must belong to the index.</p> <p>The key must belong to the index.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -3104,7 +3104,7 @@ Public Member Functions</h2></td></tr>
<p>The key must belong to the index.</p> <p>The key must belong to the index.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -3157,7 +3157,7 @@ Public Member Functions</h2></td></tr>
<p>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.</p> <p>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.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -3203,7 +3203,7 @@ Public Member Functions</h2></td></tr>
<p>Load an index file previously created with <a class="el" href="classeccodes.html#afd0c12a42f60fe16eabc8b0fca41ff05">codes_index_write</a>. </p> <p>Load an index file previously created with <a class="el" href="classeccodes.html#afd0c12a42f60fe16eabc8b0fca41ff05">codes_index_write</a>. </p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of loaded index </td></tr> <tr><td class="paramname">indexid</td><td>id of loaded index </td></tr>
@ -3292,7 +3292,7 @@ Public Member Functions</h2></td></tr>
<p>The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p> <p>The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -3345,7 +3345,7 @@ Public Member Functions</h2></td></tr>
<p>The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p> <p>The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -3398,7 +3398,7 @@ Public Member Functions</h2></td></tr>
<p>The value is a real. The key must have been created with real type or have real as native type if the type was not explicitly defined in the index creation.</p> <p>The value is a real. The key must have been created with real type or have real as native type if the type was not explicitly defined in the index creation.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -3451,7 +3451,7 @@ Public Member Functions</h2></td></tr>
<p>The value is a integer. 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.</p> <p>The value is a integer. 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.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -3498,7 +3498,7 @@ Public Member Functions</h2></td></tr>
<p>Index files can be read with <a class="el" href="classeccodes.html#a16dfcaea7b7c6c77794914d0570f5bc9">codes_index_read</a>.</p> <p>Index files can be read with <a class="el" href="classeccodes.html#a16dfcaea7b7c6c77794914d0570f5bc9">codes_index_read</a>.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of the index to save to file </td></tr> <tr><td class="paramname">indexid</td><td>id of the index to save to file </td></tr>
@ -3857,7 +3857,7 @@ Public Member Functions</h2></td></tr>
<p>Load in memory a message from a file. </p> <p>Load in memory a message from a file. </p>
<p>The message can be accessed through its message ID and it will be available<br/> <p>The message can be accessed through its message ID and it will be available<br/>
until <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7">codes_release</a> is called.<br/> until <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7">codes_release</a> is called.<br/>
<b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a></p> <b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">ifile</td><td>id of the file opened with <a class="el" href="classeccodes.html#a28594e26f2f4b92b9c60e943dd8e1be3">codes_open_file</a> </td></tr> <tr><td class="paramname">ifile</td><td>id of the file opened with <a class="el" href="classeccodes.html#a28594e26f2f4b92b9c60e943dd8e1be3">codes_open_file</a> </td></tr>
@ -3904,7 +3904,7 @@ Public Member Functions</h2></td></tr>
<p>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.</p> <p>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.</p>
<p>The message can be accessed through its msgid and it will be available<br/> <p>The message can be accessed through its msgid and it will be available<br/>
until <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7">codes_release</a> is called.<br/> until <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7">codes_release</a> is called.<br/>
<b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. </td></tr>
@ -3952,7 +3952,7 @@ Public Member Functions</h2></td></tr>
message is kept in the new message structure.</p> message is kept in the new message structure.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_copy_message" target="_blank">grib_copy_message.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_copy_message" target="_blank">grib_copy_message.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr> <tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
@ -4000,7 +4000,7 @@ Public Member Functions</h2></td></tr>
message is kept in the new message structure.</p> message is kept in the new message structure.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_copy_message" target="_blank">grib_copy_message.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_copy_message" target="_blank">grib_copy_message.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr> <tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
@ -4051,7 +4051,7 @@ Public Member Functions</h2></td></tr>
<p>Open a file according to a mode. </p> <p>Open a file according to a mode. </p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">ifile</td><td>id of the opened file to be used in all the file functions. </td></tr> <tr><td class="paramname">ifile</td><td>id of the opened file to be used in all the file functions. </td></tr>
@ -4907,7 +4907,7 @@ Public Member Functions</h2></td></tr>
<p>Free the memory for the message referred as msgid. </p> <p>Free the memory for the message referred as msgid. </p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr> <tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
@ -5253,7 +5253,7 @@ Public Member Functions</h2></td></tr>
the data values. To set missing data values see the bitmap examples.<br/> the data values. To set missing data values see the bitmap examples.<br/>
In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_set_missing" target="_blank">grib_set_missing.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_set_missing" target="_blank">grib_set_missing.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">id</td><td>ID of the message loaded in memory </td></tr> <tr><td class="paramname">id</td><td>ID of the message loaded in memory </td></tr>

8
html/index.html
View File

@ -86,17 +86,17 @@ Overview</h1>
<li>WMO FM-94 BUFR edition 3 and edition 4 (<a href="http://www.wmo.int/pages/prog/www/WMOCodes/Guides/BUFRCREX/Layer1-2-English.pdf">See WMO document</a>)</li> <li>WMO FM-94 BUFR edition 3 and edition 4 (<a href="http://www.wmo.int/pages/prog/www/WMOCodes/Guides/BUFRCREX/Layer1-2-English.pdf">See WMO document</a>)</li>
<li>WMO GTS <a href="http://www.wmo.int/pages/prog/www/WIS/Publications/WMO_386/WMO_386_Vol_I_en.pdf">abbreviated header</a> (only decoding in this release).</li> <li>WMO GTS <a href="http://www.wmo.int/pages/prog/www/WIS/Publications/WMO_386/WMO_386_Vol_I_en.pdf">abbreviated header</a> (only decoding in this release).</li>
</ul> </ul>
<p>A useful set of <a href="https://software.ecmwf.int/wiki/display/ECC/Command+line+tools">command line tools</a> provide quick access to the messages. C, Fortran 90 and Python interfaces provide access to the main ecCodes functionality.</p> <p>A useful set of <a href="https://confluence.ecmwf.int/display/ECC/Command+line+tools">command line tools</a> provide quick access to the messages. C, Fortran 90 and Python interfaces provide access to the main ecCodes functionality.</p>
<p>ecCodes is an evolution of GRIB-API. It is designed to provide the user with a simple set of functions to access data from several formats with a key/value approach.</p> <p>ecCodes is an evolution of GRIB-API. It is designed to provide the user with a simple set of functions to access data from several formats with a key/value approach.</p>
<p>For GRIB encoding and decoding, the GRIB-API functionality is provided fully in ecCodes with the same user interface and behaviour. Interfaces for C, Fortran 90 and Python are all maintained as in GRIB-API. However, the GRIB-API Fortran 77 interface is no longer available.</p> <p>For GRIB encoding and decoding, the GRIB-API functionality is provided fully in ecCodes with the same user interface and behaviour. Interfaces for C, Fortran 90 and Python are all maintained as in GRIB-API. However, the GRIB-API Fortran 77 interface is no longer available.</p>
<p>In addition, a new set of functions with the prefix "codes_" is provided to operate on all the supported message formats. These functions have the same interface and behaviour as the "grib_" functions.</p> <p>In addition, a new set of functions with the prefix "codes_" is provided to operate on all the supported message formats. These functions have the same interface and behaviour as the "grib_" functions.</p>
<p>A selection of GRIB-API tools has been included in ecCodes (<a href="https://software.ecmwf.int/wiki/display/ECC/GRIB+tools">ecCodes GRIB tools</a>), while new tools are available for the BUFR (<a href="https://software.ecmwf.int/wiki/display/ECC/BUFR+tools">ecCodes BUFR tools</a>) and GTS formats. The new tools have been developed to be as similar as possible to the existing GRIB-API tools maintaining, where possible, the same options and behaviour. A significant difference compared with GRIB-API tools is that bufr_dump produces output in <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> format which can be used in many web based applications.</p> <p>A selection of GRIB-API tools has been included in ecCodes (<a href="https://confluence.ecmwf.int/display/ECC/GRIB+tools">ecCodes GRIB tools</a>), while new tools are available for the BUFR (<a href="https://confluence.ecmwf.int/display/ECC/BUFR+tools">ecCodes BUFR tools</a>) and GTS formats. The new tools have been developed to be as similar as possible to the existing GRIB-API tools maintaining, where possible, the same options and behaviour. A significant difference compared with GRIB-API tools is that bufr_dump produces output in <a href="https://en.wikipedia.org/wiki/JSON">JSON</a> format which can be used in many web based applications.</p>
<p>Migration from GRIB-API to ecCodes is expected to be transparent for current GRIB-API users. The GRIB-API library is fully available in the ecCodes library. Users are encouraged to test their GRIB-API applications by linking with the ecCodes library and to provide feedback of any problems encountered. For further details see <a href="https://software.ecmwf.int/wiki/display/ECC/GRIB-API+migration">here</a>.</p> <p>Migration from GRIB-API to ecCodes is expected to be transparent for current GRIB-API users. The GRIB-API library is fully available in the ecCodes library. Users are encouraged to test their GRIB-API applications by linking with the ecCodes library and to provide feedback of any problems encountered. For further details see <a href="https://confluence.ecmwf.int/display/ECC/GRIB-API+migration">here</a>.</p>
<dl class="section warning"><dt>Warning</dt><dd>Name clashes prevent a simultaneous use of the GRIB-API and ecCodes libraries. For this reason, and to simplify the software maintenance, it is planned to replace GRIB-API by ecCodes.<br/> <dl class="section warning"><dt>Warning</dt><dd>Name clashes prevent a simultaneous use of the GRIB-API and ecCodes libraries. For this reason, and to simplify the software maintenance, it is planned to replace GRIB-API by ecCodes.<br/>
The functions with the "grib_" prefix will, however, be maintained in ecCodes.</dd></dl> The functions with the "grib_" prefix will, however, be maintained in ecCodes.</dd></dl>
<h6></h6> <h6></h6>
<p>Reference manuals are also provided for the C library (organized in <a class="el" href="modules.html">C interface</a>), for the <a class="el" href="classeccodes.html">Fortran 90 interface</a> and for the <a class="el" href="namespaceec_codes.html">Python interface</a>.</p> <p>Reference manuals are also provided for the C library (organized in <a class="el" href="modules.html">C interface</a>), for the <a class="el" href="classeccodes.html">Fortran 90 interface</a> and for the <a class="el" href="namespaceec_codes.html">Python interface</a>.</p>
<p><a href="https://software.ecmwf.int/wiki/display/ECC/ecCodes+installation">Installation instructions</a> are also provided. </p> <p><a href="https://confluence.ecmwf.int/display/ECC/ecCodes+installation">Installation instructions</a> are also provided. </p>
</div></div><!-- contents --> </div></div><!-- contents -->
<!-- start footer part --> <!-- start footer part -->
<hr class="footer"/><address class="footer"><small> <hr class="footer"/><address class="footer"><small>

2
html/interfaceeccodes_1_1codes__get.html
View File

@ -131,7 +131,7 @@ Public Member Functions</h2></td></tr>
<p>The <em>gribid</em> references to a grib message loaded in memory.</p> <p>The <em>gribid</em> references to a grib message loaded in memory.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a>, <a href="https://software.ecmwf.int/wiki/display/ECC/grib_print_data" target="_blank">grib_print_data.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.f90</a>, <a href="https://confluence.ecmwf.int/display/ECC/grib_print_data" target="_blank">grib_print_data.f90</a></p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classeccodes.html#a5533c6fb8bd7d8f622c89484b7bbdfb6" title="Load in memory a message from a file. ">codes_new_from_file</a>, <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7" title="Free the memory for the message referred as msgid. ">codes_release</a>, <a class="el" href="interfaceeccodes_1_1codes__set.html" title="Set the value for a key in a grib message. ">codes_set</a></dd></dl> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classeccodes.html#a5533c6fb8bd7d8f622c89484b7bbdfb6" title="Load in memory a message from a file. ">codes_new_from_file</a>, <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7" title="Free the memory for the message referred as msgid. ">codes_release</a>, <a class="el" href="interfaceeccodes_1_1codes__set.html" title="Set the value for a key in a grib message. ">codes_set</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">

2
html/interfaceeccodes_1_1codes__get__element.html
View File

@ -114,7 +114,7 @@ Public Member Functions</h2></td></tr>
<p>Given an ID and key name as input a value corresponding to the given index is returned. The index is zero based i.e. the first element has zero index, the second element index one and so on. If the parameter index is an array all the values correspondig to the indexes list is returned. The ID references to a message loaded in memory.</p> <p>Given an ID and key name as input a value corresponding to the given index is returned. The index is zero based i.e. the first element has zero index, the second element index one and so on. If the parameter index is an array all the values correspondig to the indexes list is returned. The ID references to a message loaded in memory.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_nearest" target="_blank">grib_nearest.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_nearest" target="_blank">grib_nearest.f90</a></p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classeccodes.html#a5533c6fb8bd7d8f622c89484b7bbdfb6" title="Load in memory a message from a file. ">codes_new_from_file</a>, <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7" title="Free the memory for the message referred as msgid. ">codes_release</a>, <a class="el" href="interfaceeccodes_1_1codes__get.html" title="Get the value for a key from a grib message. ">codes_get</a></dd></dl> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classeccodes.html#a5533c6fb8bd7d8f622c89484b7bbdfb6" title="Load in memory a message from a file. ">codes_new_from_file</a>, <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7" title="Free the memory for the message referred as msgid. ">codes_release</a>, <a class="el" href="interfaceeccodes_1_1codes__get.html" title="Get the value for a key from a grib message. ">codes_get</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">

2
html/interfaceeccodes_1_1codes__grib__find__nearest.html
View File

@ -119,7 +119,7 @@ Public Member Functions</h2></td></tr>
<p>If a single latitude/longitude point is provided and outlat,outlon,value,distance,index are defined as arrays with four elements the lat/lon coordinates and values, distances and indexes of the four nearest points are returned.</p> <p>If a single latitude/longitude point is provided and outlat,outlon,value,distance,index are defined as arrays with four elements the lat/lon coordinates and values, distances and indexes of the four nearest points are returned.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_nearest" target="_blank">grib_nearest.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_nearest" target="_blank">grib_nearest.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr>

2
html/interfaceeccodes_1_1codes__grib__get__data.html
View File

@ -108,7 +108,7 @@ Public Member Functions</h2></td></tr>
<p>Latitudes, longitudes, data values arrays are returned. They must be properly allocated by the caller and their required dimension can be obtained with <a class="el" href="interfaceeccodes_1_1codes__get__size.html">codes_get_size</a> or by getting (with <a class="el" href="interfaceeccodes_1_1codes__get.html">codes_get</a>) the value of the integer key "numberOfPoints".</p> <p>Latitudes, longitudes, data values arrays are returned. They must be properly allocated by the caller and their required dimension can be obtained with <a class="el" href="interfaceeccodes_1_1codes__get__size.html">codes_get_size</a> or by getting (with <a class="el" href="interfaceeccodes_1_1codes__get.html">codes_get</a>) the value of the integer key "numberOfPoints".</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_data" target="_blank">grib_get_data.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_data" target="_blank">grib_get_data.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr>

10
html/interfaceeccodes_1_1codes__index__get.html
View File

@ -114,7 +114,7 @@ Public Member Functions</h2></td></tr>
<p>The key must belong to the index.</p> <p>The key must belong to the index.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -165,7 +165,7 @@ Public Member Functions</h2></td></tr>
<p>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.</p> <p>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.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -218,7 +218,7 @@ Public Member Functions</h2></td></tr>
<p>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.</p> <p>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.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -271,7 +271,7 @@ Public Member Functions</h2></td></tr>
<p>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.</p> <p>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.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -324,7 +324,7 @@ Public Member Functions</h2></td></tr>
<p>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.</p> <p>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.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>

6
html/interfaceeccodes_1_1codes__index__get__size.html
View File

@ -108,7 +108,7 @@ Public Member Functions</h2></td></tr>
<p>The key must belong to the index.</p> <p>The key must belong to the index.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -159,7 +159,7 @@ Public Member Functions</h2></td></tr>
<p>The key must belong to the index.</p> <p>The key must belong to the index.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -212,7 +212,7 @@ Public Member Functions</h2></td></tr>
<p>The key must belong to the index.</p> <p>The key must belong to the index.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>

10
html/interfaceeccodes_1_1codes__index__select.html
View File

@ -113,7 +113,7 @@ Public Member Functions</h2></td></tr>
<div class="textblock"><p>Select the message subset with key==value. </p> <div class="textblock"><p>Select the message subset with key==value. </p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -164,7 +164,7 @@ Public Member Functions</h2></td></tr>
<p>The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p> <p>The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -217,7 +217,7 @@ Public Member Functions</h2></td></tr>
<p>The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p> <p>The value is a integer. The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -270,7 +270,7 @@ Public Member Functions</h2></td></tr>
<p>The value is a real. The key must have been created with real type or have real as native type if the type was not explicitly defined in the index creation.</p> <p>The value is a real. The key must have been created with real type or have real as native type if the type was not explicitly defined in the index creation.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -323,7 +323,7 @@ Public Member Functions</h2></td></tr>
<p>The value is a integer. 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.</p> <p>The value is a integer. 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.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>

6
html/interfaceeccodes_1_1codes__new__from__message.html
View File

@ -110,7 +110,7 @@ Public Member Functions</h2></td></tr>
message is kept in the new message structure.</p> message is kept in the new message structure.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_copy_message" target="_blank">grib_copy_message.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_copy_message" target="_blank">grib_copy_message.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">id</td><td>ID of the message loaded in memory </td></tr> <tr><td class="paramname">id</td><td>ID of the message loaded in memory </td></tr>
@ -156,7 +156,7 @@ Public Member Functions</h2></td></tr>
message is kept in the new message structure.</p> message is kept in the new message structure.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_copy_message" target="_blank">grib_copy_message.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_copy_message" target="_blank">grib_copy_message.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr> <tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
@ -204,7 +204,7 @@ Public Member Functions</h2></td></tr>
message is kept in the new message structure.</p> message is kept in the new message structure.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_copy_message" target="_blank">grib_copy_message.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_copy_message" target="_blank">grib_copy_message.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr> <tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>

2
html/interfaceeccodes_1_1codes__set.html
View File

@ -133,7 +133,7 @@ Public Member Functions</h2></td></tr>
The gribid references to a grib message loaded in memory.</p> The gribid references to a grib message loaded in memory.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/> <p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p> Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_set_keys" target="_blank">grib_set_keys.f90</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_set_keys" target="_blank">grib_set_keys.f90</a></p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classeccodes.html#a5533c6fb8bd7d8f622c89484b7bbdfb6" title="Load in memory a message from a file. ">codes_new_from_file</a>, <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7" title="Free the memory for the message referred as msgid. ">codes_release</a>, <a class="el" href="interfaceeccodes_1_1codes__get.html" title="Get the value for a key from a grib message. ">codes_get</a></dd></dl> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classeccodes.html#a5533c6fb8bd7d8f622c89484b7bbdfb6" title="Load in memory a message from a file. ">codes_new_from_file</a>, <a class="el" href="classeccodes.html#a1c0ab28b0ae33f04d267d794a8bdd4b7" title="Free the memory for the message referred as msgid. ">codes_release</a>, <a class="el" href="interfaceeccodes_1_1codes__get.html" title="Get the value for a key from a grib message. ">codes_get</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">

82
html/namespaceec_codes.html
View File

@ -403,7 +403,7 @@ Functions</h2></td></tr>
<p>Load in memory a message from a file. </p> <p>Load in memory a message from a file. </p>
<p>The message can be accessed through its id and will be available<br/> <p>The message can be accessed through its id and will be available<br/>
until <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f">codes_release</a> is called.<br/> until <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f">codes_release</a> is called.<br/>
<b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_keys" target="_blank">grib_get_keys.py</a></p> <b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">fileobj</td><td>python file object </td></tr> <tr><td class="paramname">fileobj</td><td>python file object </td></tr>
@ -499,7 +499,7 @@ Functions</h2></td></tr>
<p>Load in memory a BUFR message from a file. </p> <p>Load in memory a BUFR message from a file. </p>
<p>The message can be accessed through its id and will be available<br/> <p>The message can be accessed through its id and will be available<br/>
until <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f">codes_release</a> is called.<br/> until <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f">codes_release</a> is called.<br/>
<b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/bufr_get_keys" target="_blank">bufr_get_keys.py</a></p> <b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/bufr_get_keys" target="_blank">bufr_get_keys.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">fileobj</td><td>python file object </td></tr> <tr><td class="paramname">fileobj</td><td>python file object </td></tr>
@ -574,7 +574,7 @@ Functions</h2></td></tr>
<p>Create a copy of a message. </p> <p>Create a copy of a message. </p>
<p>Create a copy of a given message (<em>msgid_src</em>) resulting in a new message in memory (<em>msgid_dest</em>) identical to the original one.</p> <p>Create a copy of a given message (<em>msgid_src</em>) resulting in a new message in memory (<em>msgid_dest</em>) identical to the original one.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_clone" target="_blank">grib_clone.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_clone" target="_blank">grib_clone.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid_src</td><td>id of message to be cloned </td></tr> <tr><td class="paramname">msgid_src</td><td>id of message to be cloned </td></tr>
@ -716,7 +716,7 @@ Functions</h2></td></tr>
<p>Get the value of a key in a grib message. </p> <p>Get the value of a key in a grib message. </p>
<p>The type of value returned depends on the native type of the requested key. The type of value returned can be forced by using the type argument of the function. The type argument can be int, float or str.</p> <p>The type of value returned depends on the native type of the requested key. The type of value returned can be forced by using the type argument of the function. The type argument can be int, float or str.</p>
<p>The <em>msgid</em> references a grib message loaded in memory.</p> <p>The <em>msgid</em> references a grib message loaded in memory.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_keys" target="_blank">grib_get_keys.py</a>, <a href="https://software.ecmwf.int/wiki/display/ECC/grib_print_data" target="_blank">grib_print_data.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.py</a>, <a href="https://confluence.ecmwf.int/display/ECC/grib_print_data" target="_blank">grib_print_data.py</a></p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="namespaceec_codes.html#a80246f356012448955e2e75572a8d210" title="Load in memory a grib message from a file. ">codes_grib_new_from_file</a>, <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f" title="Free the memory for the message referred as msgid. ">codes_release</a>, <a class="el" href="namespaceec_codes.html#abb5cff8e4911614c8b04032fb014ea07" title="Set the value for a scalar key in a grib message. ">codes_set</a></dd></dl> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="namespaceec_codes.html#a80246f356012448955e2e75572a8d210" title="Load in memory a grib message from a file. ">codes_grib_new_from_file</a>, <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f" title="Free the memory for the message referred as msgid. ">codes_release</a>, <a class="el" href="namespaceec_codes.html#abb5cff8e4911614c8b04032fb014ea07" title="Set the value for a scalar key in a grib message. ">codes_set</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
@ -1332,7 +1332,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Get the size of an array key. </p> <p>Get the size of an array key. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_keys" target="_blank">grib_get_keys.py</a>,count_messages.py</p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.py</a>,count_messages.py</p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr> <tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
@ -1506,7 +1506,7 @@ Functions</h2></td></tr>
<p>Retrieve the contents of the 'values' key for a GRIB message. </p> <p>Retrieve the contents of the 'values' key for a GRIB message. </p>
<p>A NumPy ndarray containing the values in the message is returned.</p> <p>A NumPy ndarray containing the values in the message is returned.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_print_data" target="_blank">grib_print_data.py</a>, <a href="https://software.ecmwf.int/wiki/display/ECC/grib_samples" target="_blank">grib_samples.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_print_data" target="_blank">grib_print_data.py</a>, <a href="https://confluence.ecmwf.int/display/ECC/grib_samples" target="_blank">grib_samples.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">gribid</td><td>id of the GRIB loaded in memory </td></tr> <tr><td class="paramname">gribid</td><td>id of the GRIB loaded in memory </td></tr>
@ -1571,7 +1571,7 @@ Functions</h2></td></tr>
<p>Find the nearest grid point or the nearest four grid points to a given latitude/longitude. </p> <p>Find the nearest grid point or the nearest four grid points to a given latitude/longitude. </p>
<p>The number of nearest points returned can be controled through the npoints function argument.</p> <p>The number of nearest points returned can be controled through the npoints function argument.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_nearest" target="_blank">grib_nearest.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_nearest" target="_blank">grib_nearest.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr> <tr><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr>
@ -1611,7 +1611,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Delete a geoiterator and free memory. </p> <p>Delete a geoiterator and free memory. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_iterator" target="_blank">grib_iterator.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_iterator" target="_blank">grib_iterator.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">iterid</td><td>geoiterator id </td></tr> <tr><td class="paramname">iterid</td><td>geoiterator id </td></tr>
@ -1655,7 +1655,7 @@ Functions</h2></td></tr>
<p>Create a new geoiterator for the given message, using its geometry and values. </p> <p>Create a new geoiterator for the given message, using its geometry and values. </p>
<p>The geoiterator can be used to go through all the geopoints in a message and retrieve the values corresponding to those geopoints.</p> <p>The geoiterator can be used to go through all the geopoints in a message and retrieve the values corresponding to those geopoints.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_iterator" target="_blank">grib_iterator.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_iterator" target="_blank">grib_iterator.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr> <tr><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr>
@ -1686,7 +1686,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Retrieve the next value from a geoiterator. </p> <p>Retrieve the next value from a geoiterator. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_iterator" target="_blank">grib_iterator.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_iterator" target="_blank">grib_iterator.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">iterid</td><td>geoiterator id </td></tr> <tr><td class="paramname">iterid</td><td>geoiterator id </td></tr>
@ -1739,7 +1739,7 @@ Functions</h2></td></tr>
<p>Append a single field grib message to a multi field grib message. </p> <p>Append a single field grib message to a multi field grib message. </p>
<p>Only the sections with section number greather or equal "startsection" are copied from the input single message to the multi field output grib.</p> <p>Only the sections with section number greather or equal "startsection" are copied from the input single message to the multi field output grib.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_multi_write" target="_blank">grib_multi_write.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_multi_write" target="_blank">grib_multi_write.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">ingribid</td><td>id of the input single grib </td></tr> <tr><td class="paramname">ingribid</td><td>id of the input single grib </td></tr>
@ -1775,7 +1775,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Create a new multi field and return its id. </p> <p>Create a new multi field and return its id. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_multi_write" target="_blank">grib_multi_write.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_multi_write" target="_blank">grib_multi_write.py</a></p>
<dl class="section return"><dt>Returns</dt><dd>id of the multi field </dd></dl> <dl class="section return"><dt>Returns</dt><dd>id of the multi field </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd> <dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception"> <table class="exception">
@ -1805,7 +1805,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Release a multi field from memory. </p> <p>Release a multi field from memory. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_multi_write" target="_blank">grib_multi_write.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_multi_write" target="_blank">grib_multi_write.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">gribid</td><td>id of the multi field we want to release the memory for </td></tr> <tr><td class="paramname">gribid</td><td>id of the multi field we want to release the memory for </td></tr>
@ -1904,7 +1904,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Write a multi field message to a file. </p> <p>Write a multi field message to a file. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_multi_write" target="_blank">grib_multi_write.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_multi_write" target="_blank">grib_multi_write.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">multigribid</td><td>id of the multi field grib loaded in memory </td></tr> <tr><td class="paramname">multigribid</td><td>id of the multi field grib loaded in memory </td></tr>
@ -1953,7 +1953,7 @@ Functions</h2></td></tr>
<p>The message can be accessed through its gribid and will be available<br/> <p>The message can be accessed through its gribid and will be available<br/>
until <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f">codes_release</a> is called.<br/> until <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f">codes_release</a> is called.<br/>
The message can be loaded headers only by using the headers_only argument. Default is to have the headers only option set to off (False). If set to on (True), data values will be skipped. This will result in a significant performance gain if one is only interested in browsing through messages to retrieve metadata. Any attempt to retrieve data values keys when in the headers only mode will result in a key not found error.</p> The message can be loaded headers only by using the headers_only argument. Default is to have the headers only option set to off (False). If set to on (True), data values will be skipped. This will result in a significant performance gain if one is only interested in browsing through messages to retrieve metadata. Any attempt to retrieve data values keys when in the headers only mode will result in a key not found error.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_keys" target="_blank">grib_get_keys.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">fileobj</td><td>python file object </td></tr> <tr><td class="paramname">fileobj</td><td>python file object </td></tr>
@ -1991,7 +1991,7 @@ Functions</h2></td></tr>
<p>Create a new valid GRIB message from a sample. </p> <p>Create a new valid GRIB message from a sample. </p>
<p>The available samples are picked up from the directory pointed to by the environment variable ECCODES_SAMPLES_PATH. To know where the samples directory is run the codes_info tool.<br/> <p>The available samples are picked up from the directory pointed to by the environment variable ECCODES_SAMPLES_PATH. To know where the samples directory is run the codes_info tool.<br/>
<b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_samples" target="_blank">grib_samples.py</a></p> <b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_samples" target="_blank">grib_samples.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">samplename</td><td>name of the sample to be used </td></tr> <tr><td class="paramname">samplename</td><td>name of the sample to be used </td></tr>
@ -2164,7 +2164,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Add a file to an index. </p> <p>Add a file to an index. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of the index to add the file to </td></tr> <tr><td class="paramname">indexid</td><td>id of the index to add the file to </td></tr>
@ -2217,7 +2217,7 @@ Functions</h2></td></tr>
<p>Get the distinct values of an index key. </p> <p>Get the distinct values of an index key. </p>
<p>The key must belong to the index.</p> <p>The key must belong to the index.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created on the given key. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created on the given key. </td></tr>
@ -2267,7 +2267,7 @@ Functions</h2></td></tr>
<p>Get the distinct values of the key in argument contained in the index. </p> <p>Get the distinct values of the key in argument contained in the index. </p>
<p>The key must belong to the index.</p> <p>The key must belong to the index.</p>
<p>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.</p> <p>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.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -2316,7 +2316,7 @@ Functions</h2></td></tr>
<p>Get the distinct values of the key in argument contained in the index. </p> <p>Get the distinct values of the key in argument contained in the index. </p>
<p>The key must belong to the index.</p> <p>The key must belong to the index.</p>
<p>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.</p> <p>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.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -2364,7 +2364,7 @@ Functions</h2></td></tr>
<p>Get the number of distinct values for the index key. </p> <p>Get the number of distinct values for the index key. </p>
<p>The key must belong to the index.</p> <p>The key must belong to the index.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created on the given key. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created on the given key. </td></tr>
@ -2413,7 +2413,7 @@ Functions</h2></td></tr>
<p>Get the distinct values of the key in argument contained in the index. </p> <p>Get the distinct values of the key in argument contained in the index. </p>
<p>The key must belong to the index.</p> <p>The key must belong to the index.</p>
<p>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.</p> <p>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.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -2460,7 +2460,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Create a new index from a file. </p> <p>Create a new index from a file. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">filename</td><td>path of the file to index on </td></tr> <tr><td class="paramname">filename</td><td>path of the file to index on </td></tr>
@ -2497,7 +2497,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Loads an index previously saved with <a class="el" href="namespaceec_codes.html#a32c66888832215b2860535729ee616f8">codes_index_write</a> to a file. </p> <p>Loads an index previously saved with <a class="el" href="namespaceec_codes.html#a32c66888832215b2860535729ee616f8">codes_index_write</a> to a file. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">filename</td><td>path of file to load the index from </td></tr> <tr><td class="paramname">filename</td><td>path of file to load the index from </td></tr>
@ -2533,7 +2533,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Delete an index. </p> <p>Delete an index. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. </td></tr>
@ -2584,7 +2584,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Select the message subset with key==value. </p> <p>Select the message subset with key==value. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -2639,7 +2639,7 @@ Functions</h2></td></tr>
<p>Select the message subset with key==value. </p> <p>Select the message subset with key==value. </p>
<p>The value is a double.</p> <p>The value is a double.</p>
<p>The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p> <p>The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -2694,7 +2694,7 @@ Functions</h2></td></tr>
<p>Select the message subset with key==value. </p> <p>Select the message subset with key==value. </p>
<p>The value is an integer.</p> <p>The value is an integer.</p>
<p>The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p> <p>The key must have been created with integer type or have integer as native type if the type was not explicitly defined in the index creation.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -2749,7 +2749,7 @@ Functions</h2></td></tr>
<p>Select the message subset with key==value. </p> <p>Select the message subset with key==value. </p>
<p>The value is an integer.</p> <p>The value is an integer.</p>
<p>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.</p> <p>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.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. The index must have been created with the key in argument. </td></tr>
@ -2797,7 +2797,7 @@ Functions</h2></td></tr>
<p>Write an index to a file for later reuse. </p> <p>Write an index to a file for later reuse. </p>
<p>An index can be loaded back from an index file with <a class="el" href="namespaceec_codes.html#a13866152bfd07b8cd418f6cf8c73d7ab">codes_index_read</a>.</p> <p>An index can be loaded back from an index file with <a class="el" href="namespaceec_codes.html#a13866152bfd07b8cd418f6cf8c73d7ab">codes_index_read</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of the index </td></tr> <tr><td class="paramname">indexid</td><td>id of the index </td></tr>
@ -2922,7 +2922,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Delete a keys iterator and free memory. </p> <p>Delete a keys iterator and free memory. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_keys_iterator" target="_blank">grib_keys_iterator.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_keys_iterator" target="_blank">grib_keys_iterator.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">iterid</td><td>keys iterator id created with <a class="el" href="namespaceec_codes.html#a199fb77e1395975be732e46f93b3e337">codes_keys_iterator_new</a> </td></tr> <tr><td class="paramname">iterid</td><td>keys iterator id created with <a class="el" href="namespaceec_codes.html#a199fb77e1395975be732e46f93b3e337">codes_keys_iterator_new</a> </td></tr>
@ -2957,7 +2957,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Get the name of a key from a keys iterator. </p> <p>Get the name of a key from a keys iterator. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_keys_iterator" target="_blank">grib_keys_iterator.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_keys_iterator" target="_blank">grib_keys_iterator.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">iterid</td><td>keys iterator id created with <a class="el" href="namespaceec_codes.html#a199fb77e1395975be732e46f93b3e337">codes_keys_iterator_new</a> </td></tr> <tr><td class="paramname">iterid</td><td>keys iterator id created with <a class="el" href="namespaceec_codes.html#a199fb77e1395975be732e46f93b3e337">codes_keys_iterator_new</a> </td></tr>
@ -3004,7 +3004,7 @@ Functions</h2></td></tr>
<p>Create a new iterator on the keys. </p> <p>Create a new iterator on the keys. </p>
<p>The keys iterator can be navigated to give all the key names which can then be used to get or set the key values with <a class="el" href="namespaceec_codes.html#a1ba4d3b6473499af0581cf52eb4cad0b">codes_get</a> or <a class="el" href="namespaceec_codes.html#abb5cff8e4911614c8b04032fb014ea07">codes_set</a>. The set of keys returned can be controlled with the input variable namespace or using the functions <a class="el" href="namespaceec_codes.html#afb6f25e55aab91e1cf273403c4151c70">codes_skip_read_only</a>, <a class="el" href="namespaceec_codes.html#a57f7a5a0f6975e1357e5aa1dc4715e0c">codes_skip_duplicates</a>, <a class="el" href="namespaceec_codes.html#a4b7140ca0dd81372721cffd1d964e4ad">codes_skip_coded</a>,<a class="el" href="namespaceec_codes.html#a587af29aac21a816f8ffd327a1fce779">codes_skip_computed</a>. If namespace is a non empty string only the keys belonging to that namespace are returned. Example namespaces are "ls" (to get the same default keys as the grib_ls) and "mars" to get the keys used by mars.</p> <p>The keys iterator can be navigated to give all the key names which can then be used to get or set the key values with <a class="el" href="namespaceec_codes.html#a1ba4d3b6473499af0581cf52eb4cad0b">codes_get</a> or <a class="el" href="namespaceec_codes.html#abb5cff8e4911614c8b04032fb014ea07">codes_set</a>. The set of keys returned can be controlled with the input variable namespace or using the functions <a class="el" href="namespaceec_codes.html#afb6f25e55aab91e1cf273403c4151c70">codes_skip_read_only</a>, <a class="el" href="namespaceec_codes.html#a57f7a5a0f6975e1357e5aa1dc4715e0c">codes_skip_duplicates</a>, <a class="el" href="namespaceec_codes.html#a4b7140ca0dd81372721cffd1d964e4ad">codes_skip_coded</a>,<a class="el" href="namespaceec_codes.html#a587af29aac21a816f8ffd327a1fce779">codes_skip_computed</a>. If namespace is a non empty string only the keys belonging to that namespace are returned. Example namespaces are "ls" (to get the same default keys as the grib_ls) and "mars" to get the keys used by mars.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_iterator" target="_blank">grib_iterator.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_iterator" target="_blank">grib_iterator.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr> <tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
@ -3041,7 +3041,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Advance to the next keys iterator value. </p> <p>Advance to the next keys iterator value. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_keys_iterator" target="_blank">grib_keys_iterator.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_keys_iterator" target="_blank">grib_keys_iterator.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">iterid</td><td>keys iterator id created with <a class="el" href="namespaceec_codes.html#a199fb77e1395975be732e46f93b3e337">codes_keys_iterator_new</a> </td></tr> <tr><td class="paramname">iterid</td><td>keys iterator id created with <a class="el" href="namespaceec_codes.html#a199fb77e1395975be732e46f93b3e337">codes_keys_iterator_new</a> </td></tr>
@ -3215,7 +3215,7 @@ Functions</h2></td></tr>
<p>Create a new handle from an index after having selected the key values. </p> <p>Create a new handle from an index after having selected the key values. </p>
<p>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.</p> <p>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.</p>
<p>The message can be accessed through its gribid and will be available until <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f">codes_release</a> is called.</p> <p>The message can be accessed through its gribid and will be available until <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f">codes_release</a> is called.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_index" target="_blank">grib_index.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_index" target="_blank">grib_index.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">indexid</td><td>id of an index created from a file. </td></tr> <tr><td class="paramname">indexid</td><td>id of an index created from a file. </td></tr>
@ -3297,7 +3297,7 @@ Functions</h2></td></tr>
<p>Create a new valid message from a sample for a given product. </p> <p>Create a new valid message from a sample for a given product. </p>
<p>The available samples are picked up from the directory pointed to by the environment variable ECCODES_SAMPLES_PATH. To know where the samples directory is run the codes_info tool.<br/> <p>The available samples are picked up from the directory pointed to by the environment variable ECCODES_SAMPLES_PATH. To know where the samples directory is run the codes_info tool.<br/>
<b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_samples" target="_blank">grib_samples.py</a></p> <b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_samples" target="_blank">grib_samples.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">samplename</td><td>name of the sample to be used </td></tr> <tr><td class="paramname">samplename</td><td>name of the sample to be used </td></tr>
@ -3360,7 +3360,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Free the memory for the message referred as msgid. </p> <p>Free the memory for the message referred as msgid. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_get_keys" target="_blank">grib_get_keys.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_get_keys" target="_blank">grib_get_keys.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr> <tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
@ -3412,7 +3412,7 @@ Functions</h2></td></tr>
<p>Set the value for a scalar key in a grib message. </p> <p>Set the value for a scalar key in a grib message. </p>
<p>The input value can be a python int, float or str.</p> <p>The input value can be a python int, float or str.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_set_keys" target="_blank">grib_set_keys.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_set_keys" target="_blank">grib_set_keys.py</a></p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="namespaceec_codes.html#a80246f356012448955e2e75572a8d210" title="Load in memory a grib message from a file. ">codes_grib_new_from_file</a>, <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f" title="Free the memory for the message referred as msgid. ">codes_release</a>, <a class="el" href="namespaceec_codes.html#a1ba4d3b6473499af0581cf52eb4cad0b" title="Get the value of a key in a grib message. ">codes_get</a></dd></dl> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="namespaceec_codes.html#a80246f356012448955e2e75572a8d210" title="Load in memory a grib message from a file. ">codes_grib_new_from_file</a>, <a class="el" href="namespaceec_codes.html#a23859e3fb8802982fe865789d61b181f" title="Free the memory for the message referred as msgid. ">codes_release</a>, <a class="el" href="namespaceec_codes.html#a1ba4d3b6473499af0581cf52eb4cad0b" title="Get the value of a key in a grib message. ">codes_get</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
@ -3803,7 +3803,7 @@ Functions</h2></td></tr>
<p>Set as missing the value for a key in a grib message. </p> <p>Set as missing the value for a key in a grib message. </p>
<p>It can be used to set a missing value in the grib header but not in the data values.</p> <p>It can be used to set a missing value in the grib header but not in the data values.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_set_missing" target="_blank">grib_set_missing.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_set_missing" target="_blank">grib_set_missing.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr> <tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>
@ -3985,7 +3985,7 @@ Functions</h2></td></tr>
<p>The input array can be a numpy.ndarray or a python sequence like tuple, list, array, ...</p> <p>The input array can be a numpy.ndarray or a python sequence like tuple, list, array, ...</p>
<p>The wrapper will internally try to convert the input to a NumPy array before extracting its data and length. This is possible as NumPy allows the construction of arrays from arbitrary python sequences.</p> <p>The wrapper will internally try to convert the input to a NumPy array before extracting its data and length. This is possible as NumPy allows the construction of arrays from arbitrary python sequences.</p>
<p>The elements of the input sequence need to be convertible to a double.</p> <p>The elements of the input sequence need to be convertible to a double.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_clone" target="_blank">grib_clone.py</a>, <a href="https://software.ecmwf.int/wiki/display/ECC/grib_samples" target="_blank">grib_samples.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_clone" target="_blank">grib_clone.py</a>, <a href="https://confluence.ecmwf.int/display/ECC/grib_samples" target="_blank">grib_samples.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr> <tr><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr>
@ -4238,7 +4238,7 @@ Functions</h2></td></tr>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Write a message to a file. </p> <p>Write a message to a file. </p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_set_keys" target="_blank">grib_set_keys.py</a></p> <p><b>Examples:</b> <a href="https://confluence.ecmwf.int/display/ECC/grib_set_keys" target="_blank">grib_set_keys.py</a></p>
<dl class="params"><dt>Parameters</dt><dd> <dl class="params"><dt>Parameters</dt><dd>
<table class="params"> <table class="params">
<tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr> <tr><td class="paramname">msgid</td><td>id of the message loaded in memory </td></tr>