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

Documentation of C API

This commit is contained in:
Shahram Najm 2017-08-21 16:38:12 +01:00
parent 3886eb8169
commit 7bc1d59863
6 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
html/eccodes_8h.html
View File

@ -375,10 +375,10 @@ Functions</h2></td></tr>
<tr class="memitem:ga079df0c709e381812ae13af08c354032"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga079df0c709e381812ae13af08c354032">codes_handle_new_from_message_copy</a> (<a class="el" href="structcodes__context.html">codes_context</a> *c, const void *data, size_t data_len)</td></tr>
<tr class="memdesc:ga079df0c709e381812ae13af08c354032"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a handle from a user message. <a href="group__codes__handle.html#ga079df0c709e381812ae13af08c354032">More...</a><br/></td></tr>
<tr class="separator:ga079df0c709e381812ae13af08c354032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3b281a237e311c6b8fa4bd7096d7e025"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga3b281a237e311c6b8fa4bd7096d7e025">codes_grib_handle_new_from_samples</a> (<a class="el" href="structcodes__context.html">codes_context</a> *c, const char *res_name)</td></tr>
<tr class="memitem:ga3b281a237e311c6b8fa4bd7096d7e025"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga3b281a237e311c6b8fa4bd7096d7e025">codes_grib_handle_new_from_samples</a> (<a class="el" href="structcodes__context.html">codes_context</a> *c, const char *sample_name)</td></tr>
<tr class="memdesc:ga3b281a237e311c6b8fa4bd7096d7e025"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a handle from a GRIB message contained in a samples directory. <a href="group__codes__handle.html#ga3b281a237e311c6b8fa4bd7096d7e025">More...</a><br/></td></tr>
<tr class="separator:ga3b281a237e311c6b8fa4bd7096d7e025"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga56d0f831e520ec7bc4a0ca334c63f557"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga56d0f831e520ec7bc4a0ca334c63f557">codes_bufr_handle_new_from_samples</a> (<a class="el" href="structcodes__context.html">codes_context</a> *c, const char *res_name)</td></tr>
<tr class="memitem:ga56d0f831e520ec7bc4a0ca334c63f557"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga56d0f831e520ec7bc4a0ca334c63f557">codes_bufr_handle_new_from_samples</a> (<a class="el" href="structcodes__context.html">codes_context</a> *c, const char *sample_name)</td></tr>
<tr class="memdesc:ga56d0f831e520ec7bc4a0ca334c63f557"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a handle from a BUFR message contained in a samples directory. <a href="group__codes__handle.html#ga56d0f831e520ec7bc4a0ca334c63f557">More...</a><br/></td></tr>
<tr class="separator:ga56d0f831e520ec7bc4a0ca334c63f557"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7b226527aa98d90f2bdb470105732878"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga7b226527aa98d90f2bdb470105732878">codes_handle_clone</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h)</td></tr>

12
html/group__codes__handle.html
View File

@ -115,10 +115,10 @@ Functions</h2></td></tr>
<tr class="memitem:ga079df0c709e381812ae13af08c354032"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga079df0c709e381812ae13af08c354032">codes_handle_new_from_message_copy</a> (<a class="el" href="structcodes__context.html">codes_context</a> *c, const void *data, size_t data_len)</td></tr>
<tr class="memdesc:ga079df0c709e381812ae13af08c354032"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a handle from a user message. <a href="#ga079df0c709e381812ae13af08c354032">More...</a><br/></td></tr>
<tr class="separator:ga079df0c709e381812ae13af08c354032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3b281a237e311c6b8fa4bd7096d7e025"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga3b281a237e311c6b8fa4bd7096d7e025">codes_grib_handle_new_from_samples</a> (<a class="el" href="structcodes__context.html">codes_context</a> *c, const char *res_name)</td></tr>
<tr class="memitem:ga3b281a237e311c6b8fa4bd7096d7e025"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga3b281a237e311c6b8fa4bd7096d7e025">codes_grib_handle_new_from_samples</a> (<a class="el" href="structcodes__context.html">codes_context</a> *c, const char *sample_name)</td></tr>
<tr class="memdesc:ga3b281a237e311c6b8fa4bd7096d7e025"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a handle from a GRIB message contained in a samples directory. <a href="#ga3b281a237e311c6b8fa4bd7096d7e025">More...</a><br/></td></tr>
<tr class="separator:ga3b281a237e311c6b8fa4bd7096d7e025"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga56d0f831e520ec7bc4a0ca334c63f557"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga56d0f831e520ec7bc4a0ca334c63f557">codes_bufr_handle_new_from_samples</a> (<a class="el" href="structcodes__context.html">codes_context</a> *c, const char *res_name)</td></tr>
<tr class="memitem:ga56d0f831e520ec7bc4a0ca334c63f557"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga56d0f831e520ec7bc4a0ca334c63f557">codes_bufr_handle_new_from_samples</a> (<a class="el" href="structcodes__context.html">codes_context</a> *c, const char *sample_name)</td></tr>
<tr class="memdesc:ga56d0f831e520ec7bc4a0ca334c63f557"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a handle from a BUFR message contained in a samples directory. <a href="#ga56d0f831e520ec7bc4a0ca334c63f557">More...</a><br/></td></tr>
<tr class="separator:ga56d0f831e520ec7bc4a0ca334c63f557"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7b226527aa98d90f2bdb470105732878"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structcodes__handle.html">codes_handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codes__handle.html#ga7b226527aa98d90f2bdb470105732878">codes_handle_clone</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h)</td></tr>
@ -201,7 +201,7 @@ Functions</h2></td></tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>res_name</em>&#160;</td>
<td class="paramname"><em>sample_name</em>&#160;</td>
</tr>
<tr>
<td></td>
@ -216,7 +216,7 @@ Functions</h2></td></tr>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>: the context from which the handle will be created (NULL for default context) </td></tr>
<tr><td class="paramname">res_name</td><td>: the resource name </td></tr>
<tr><td class="paramname">sample_name</td><td>: the name of the sample file (without the .tmpl extension) </td></tr>
</table>
</dd>
</dl>
@ -376,7 +376,7 @@ Functions</h2></td></tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>res_name</em>&#160;</td>
<td class="paramname"><em>sample_name</em>&#160;</td>
</tr>
<tr>
<td></td>
@ -391,7 +391,7 @@ Functions</h2></td></tr>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>: the context from which the handle will be created (NULL for default context) </td></tr>
<tr><td class="paramname">res_name</td><td>: the resource name </td></tr>
<tr><td class="paramname">sample_name</td><td>: the name of the sample file (without the .tmpl extension) </td></tr>
</table>
</dd>
</dl>

4
src/eccodes.c
View File

@ -167,9 +167,9 @@ grib_handle* codes_handle_new_from_message_copy(grib_context* c, const void* dat
{
return grib_handle_new_from_message_copy(c,data,data_len);
}
grib_handle* codes_grib_handle_new_from_samples (grib_context* c, const char* res_name)
grib_handle* codes_grib_handle_new_from_samples(grib_context* c, const char* sample_name)
{
return grib_handle_new_from_samples(c, res_name);
return grib_handle_new_from_samples(c, sample_name);
}
grib_handle* codes_handle_clone(grib_handle* h)
{

10
src/eccodes.h
View File

@ -458,24 +458,24 @@ codes_handle* codes_handle_new_from_message_copy(codes_context* c, const void* d
/**
* Create a handle from a GRIB message contained in a samples directory.
* Create a handle from a GRIB message contained in the samples directory.
* The message is copied at the creation of the handle
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param res_name : the resource name
* @param sample_name : the name of the sample file (without the .tmpl extension)
* @return the new handle, NULL if the resource is invalid or a problem is encountered
*/
codes_handle* codes_grib_handle_new_from_samples (codes_context* c, const char* res_name) ;
codes_handle* codes_grib_handle_new_from_samples (codes_context* c, const char* sample_name);
/**
* Create a handle from a BUFR message contained in a samples directory.
* The message is copied at the creation of the handle
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param res_name : the resource name
* @param sample_name : the name of the sample file (without the .tmpl extension)
* @return the new handle, NULL if the resource is invalid or a problem is encountered
*/
codes_handle* codes_bufr_handle_new_from_samples (codes_context* c, const char* res_name) ;
codes_handle* codes_bufr_handle_new_from_samples (codes_context* c, const char* sample_name);
/**

6
src/grib_api.h
View File

@ -485,14 +485,14 @@ grib_handle* grib_handle_new_from_message_copy(grib_context* c, const void* data
/**
* Create a handle from a message contained in a samples directory.
* Create a handle from a GRIB message contained in the samples directory.
* The message is copied at the creation of the handle
*
* @param c : the context from which the handle will be created (NULL for default context)
* @param res_name : the resource name
* @param sample_name : the name of the sample file (without the .tmpl extension)
* @return the new handle, NULL if the resource is invalid or a problem is encountered
*/
grib_handle* grib_handle_new_from_samples (grib_context* c, const char* res_name) ;
grib_handle* grib_handle_new_from_samples (grib_context* c, const char* sample_name);

4
src/grib_handle.c
View File

@ -249,7 +249,7 @@ static grib_handle* grib_handle_create ( grib_handle *gl, grib_context* c, cons
return gl;
}
grib_handle* grib_handle_new_from_samples ( grib_context* c, const char* name )
grib_handle* grib_handle_new_from_samples( grib_context* c, const char* name )
{
grib_handle* g = 0;
if ( c == NULL ) c = grib_context_get_default();
@ -264,7 +264,7 @@ grib_handle* grib_handle_new_from_samples ( grib_context* c, const char* name )
printf("ECCODES DEBUG: grib_handle_new_from_samples '%s'\n", name);
}
g=grib_external_template ( c,name );
g = grib_external_template( c,name );
if ( !g )
grib_context_log ( c,GRIB_LOG_ERROR,"Unable to load sample file %s.tmpl\n in %s",
name, c->grib_samples_path );