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

Documentation: remove references to grib_api

This commit is contained in:
Shahram Najm 2017-02-22 11:12:10 +00:00
parent 16e6846465
commit dfe21aac7f
7 changed files with 63 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
fortran/eccodes_f90_int.f90
View File

@ -61,10 +61,10 @@
codes_index_select_string, &
codes_index_select_real8
end interface codes_index_select
!> Get the value for a key from a grib message.
!> Get the value for a key from a message.
!>
!> Given a \em gribid and \em key as input a \em value for the \em key is returned.
!> Given a \em msgid and \em key as input a \em value for the \em key is returned.
!> In some cases the \em value can be an array rather than a scalar.
!> As examples of array keys we have "values","pl", "pv" respectively the data values,
!> the list of number of points for each latitude in a reduced grid and the list of
@ -76,7 +76,7 @@
!> Analogous conversions are always provided when possible.
!> Illegal conversions are real to integer and character to any other type.
!>
!> The \em gribid references to a grib message loaded in memory.
!> The \em msgid references to a message loaded in memory.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
@ -86,11 +86,10 @@
!>
!> @see codes_new_from_file, codes_release, codes_set
!>
!>
!> @param[in] gribid id of the grib loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8),character
!> @param[out] status CODES_SUCCESS if OK, integer value on error
!> @param[in] msgid id of the message loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8),character
!> @param[out] status CODES_SUCCESS if OK, integer value on error
interface codes_get
module procedure codes_get_int, &
codes_get_real4, &
@ -111,7 +110,7 @@
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param msgid id of the message loaded in memory
!> @param key name of the key
!> @param size size of the array key
!> @param status CODES_SUCCESS if OK, integer value on error
@ -119,15 +118,15 @@
module procedure codes_get_size_int
end interface codes_get_size
!> Set the value for a key in a grib message.
!> Set the value for a key in a message.
!>
!> The given \em value is set for the \em key in the \em gribid message.
!> The given \em value is set for the \em key in the \em msgid message.
!> In some cases the \em value can be an array rather than a scalar.
!> As examples of array keys we have "values","pl", "pv" respectively the data values,
!> the list of number of points for each latitude in a reduced grid and the list of
!> vertical levels. In these cases the \em value array must be allocated by the caller
!> and their required dimension can be obtained with \ref codes_get_size. \n
!> The gribid references to a grib message loaded in memory.
!> The msgid references to a message loaded in memory.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
@ -137,10 +136,10 @@
!>
!> @see codes_new_from_file, codes_release, codes_get
!>
!> @param[in] gribid id of the grib loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8)
!> @param[out] status CODES_SUCCESS if OK, integer value on error
!> @param[in] msgid id of the message loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8)
!> @param[out] status CODES_SUCCESS if OK, integer value on error
interface codes_set
module procedure codes_set_int, &
codes_set_real4, &

5
fortran/eccodes_f90_int_size_t.f90
View File

@ -12,7 +12,6 @@
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be read
!> @param nbytes number of bytes to be read
@ -28,7 +27,6 @@
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be read
!> @param nbytes number of bytes to be read
@ -46,7 +44,6 @@
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be written
!> @param nbytes number of bytes to be written
@ -64,7 +61,7 @@
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param msgid id of the message loaded in memory
!> @param nbytes size in bytes of the message
!> @param status CODES_SUCCESS if OK, integer value on error
interface codes_get_message_size

34
fortran/eccodes_f90_long_int.f90
View File

@ -29,7 +29,6 @@
!> Get the number of distinct values of the key in argument contained in the index. The key must belong to the index.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
@ -65,11 +64,11 @@
codes_index_select_real8
end interface codes_index_select
!> Get the value for a key from a grib message.
!> Get the value for a key from a message.
!>
!> Given a \em gribid and \em key as input a \em value for the \em key is returned.
!> Given a \em msgid and \em key as input a \em value for the \em key is returned.
!> In some cases the \em value can be an array rather than a scalar.
!> As examples of array keys we have "values","pl", "pv" respectively the data values,
!> As examples of array keys we have "values", "pl", "pv" respectively the data values,
!> the list of number of points for each latitude in a reduced grid and the list of
!> vertical levels. In these cases the \em value array must be allocated by the caller
!> and their required dimension can be obtained with \ref codes_get_size. \n
@ -79,7 +78,7 @@
!> Analogous conversions are always provided when possible.
!> Illegal conversions are real to integer and character to any other type.
!>
!> The \em gribid references to a grib message loaded in memory.
!> The \em msgid references to a message loaded in memory.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
@ -89,11 +88,10 @@
!>
!> @see codes_new_from_file, codes_release, codes_set
!>
!>
!> @param[in] gribid id of the grib loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8),character
!> @param[out] status CODES_SUCCESS if OK, integer value on error
!> @param[in] msgid id of the message loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8),character
!> @param[out] status CODES_SUCCESS if OK, integer value on error
interface codes_get
module procedure codes_get_int, &
codes_get_long, &
@ -114,7 +112,7 @@
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param msgid id of the message loaded in memory
!> @param key name of the key
!> @param size size of the array key
!> @param status CODES_SUCCESS if OK, integer value on error
@ -123,15 +121,15 @@
codes_get_size_long
end interface codes_get_size
!> Set the value for a key in a grib message.
!> Set the value for a key in a message.
!>
!> The given \em value is set for the \em key in the \em gribid message.
!> The given \em value is set for the \em key in the \em msgid message.
!> In some cases the \em value can be an array rather than a scalar.
!> As examples of array keys we have "values","pl", "pv" respectively the data values,
!> the list of number of points for each latitude in a reduced grid and the list of
!> vertical levels. In these cases the \em value array must be allocated by the caller
!> and their required dimension can be obtained with \ref codes_get_size. \n
!> The gribid references to a grib message loaded in memory.
!> The msgid references to a message loaded in memory.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
@ -141,10 +139,10 @@
!>
!> @see codes_new_from_file, codes_release, codes_get
!>
!> @param[in] gribid id of the grib loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8)
!> @param[out] status CODES_SUCCESS if OK, integer value on error
!> @param[in] msgid id of the message loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8)
!> @param[out] status CODES_SUCCESS if OK, integer value on error
interface codes_set
module procedure codes_set_int, &
codes_set_long, &

5
fortran/eccodes_f90_long_size_t.f90
View File

@ -12,7 +12,6 @@
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be read
!> @param nbytes number of bytes to be read
@ -30,7 +29,6 @@
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be read
!> @param nbytes number of bytes to be read
@ -52,7 +50,6 @@
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
!>
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param buffer buffer to be written
!> @param nbytes number of bytes to be written
@ -74,7 +71,7 @@
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param msgid id of the message loaded in memory
!> @param nbytes size in bytes of the message
!> @param status CODES_SUCCESS if OK, integer value on error
interface codes_get_message_size

12
fortran/eccodes_f90_tail.f90
View File

@ -71,7 +71,6 @@ end subroutine codes_index_add_file
!> Get the number of distinct values of the key in argument contained in the index. The key must belong to the index.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
@ -368,7 +367,6 @@ end subroutine codes_index_release
!> Open a file according to a mode.
!>
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref codes_get_error_string.
@ -377,7 +375,7 @@ end subroutine codes_index_release
!>
!> @param ifile id of the opened file to be used in all the file functions.
!> @param filename name of the file to be open
!> @param mode open mode can be 'r' (read only) or 'w' (write only)
!> @param mode open mode can be 'r' (read) or 'w' (write)
!> @param status CODES_SUCCESS if OK, integer value on error
subroutine codes_open_file ( ifile, filename, mode, status )
integer(kind=kindOfInt),intent(out) :: ifile
@ -963,7 +961,7 @@ end subroutine codes_new_from_file
!>
!> @param ifile id of the file opened with @ref codes_open_file
!> @param msgid id of the message loaded in memory
!> @param status CODES_SUCCESS if OK, GRIB_END_OF_FILE at the end of file, or error code
!> @param status CODES_SUCCESS if OK, CODES_END_OF_FILE at the end of file, or error code
subroutine codes_any_new_from_file ( ifile, msgid , status)
integer(kind=kindOfInt),intent(in) :: ifile
integer(kind=kindOfInt),intent(out) :: msgid
@ -981,7 +979,7 @@ end subroutine codes_any_new_from_file
!>
!> @param ifile id of the file opened with @ref codes_open_file
!> @param gribid id of the GRIB loaded in memory
!> @param status CODES_SUCCESS if OK, GRIB_END_OF_FILE at the end of file, or error code
!> @param status CODES_SUCCESS if OK, CODES_END_OF_FILE at the end of file, or error code
subroutine codes_grib_new_from_file ( ifile, gribid , status)
integer(kind=kindOfInt),intent(in) :: ifile
integer(kind=kindOfInt),intent(out) :: gribid
@ -999,7 +997,7 @@ end subroutine codes_grib_new_from_file
!>
!> @param ifile id of the file opened with @ref codes_open_file
!> @param bufrid id of the BUFR loaded in memory
!> @param status CODES_SUCCESS if OK, GRIB_END_OF_FILE at the end of file, or error code
!> @param status CODES_SUCCESS if OK, CODES_END_OF_FILE at the end of file, or error code
subroutine codes_bufr_new_from_file ( ifile, bufrid , status)
integer(kind=kindOfInt),intent(in) :: ifile
integer(kind=kindOfInt),intent(out) :: bufrid
@ -1405,7 +1403,7 @@ end subroutine codes_bufr_keys_iterator_get_name
!> gathered with @ref grib_get_error_string.
!>
!> @param iterid keys iterator id created with @ref codes_bufr_keys_iterator_new
!> @param status GRIB_SUCCESS if OK, integer value on error
!> @param status CODES_SUCCESS if OK, integer value on error
subroutine codes_bufr_keys_iterator_rewind( iterid, status )
integer(kind=kindOfInt), intent(in) :: iterid
integer(kind=kindOfInt),optional, intent(out) :: status

40
fortran/grib_f90_int.f90
View File

@ -61,10 +61,10 @@
grib_index_select_string, &
grib_index_select_real8
end interface grib_index_select
!> Get the value for a key from a grib message.
!> Get the value for a key from a message.
!>
!> Given a \em gribid and \em key as input a \em value for the \em key is returned.
!> Given a \em msgid and \em key as input a \em value for the \em key is returned.
!> In some cases the \em value can be an array rather than a scalar.
!> As examples of array keys we have "values","pl", "pv" respectively the data values,
!> the list of number of points for each latitude in a reduced grid and the list of
@ -72,11 +72,11 @@
!> and their required dimension can be obtained with \ref grib_get_size. \n
!> The \em value can be integer(4), real(4), real(8), character.
!> Although each key has its own native type, a key of type integer
!> can be retrieved (with \ref grib_get) as real(4), real(8) or character.
!> can be retrieved (with \ref codes_get) as real(4), real(8) or character.
!> Analogous conversions are always provided when possible.
!> Illegal conversions are real to integer and character to any other type.
!>
!> The \em gribid references to a grib message loaded in memory.
!> The \em msgid references to a message loaded in memory.
!>
!> In case of error, if the status parameter (optional) is not given, the program will
!> exit with an error message.\n Otherwise the error message can be
@ -87,10 +87,10 @@
!> @see grib_new_from_file, grib_release, grib_set
!>
!>
!> @param[in] gribid id of the grib loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8),character
!> @param[out] status GRIB_SUCCESS if OK, integer value on error
!> @param[in] msgid id of the loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8),character
!> @param[out] status GRIB_SUCCESS if OK, integer value on error
interface grib_get
module procedure grib_get_int, &
grib_get_real4, &
@ -101,7 +101,7 @@
grib_get_real4_array, &
grib_get_real8_array
end interface grib_get
!> Get the size of an array key.
!>
@ -111,17 +111,17 @@
!> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string.
!>
!> @param gribid id of the grib loaded in memory
!> @param key name of the key
!> @param size size of the array key
!> @param status GRIB_SUCCESS if OK, integer value on error
!> @param msgid id of the message loaded in memory
!> @param key name of the key
!> @param size size of the array key
!> @param status GRIB_SUCCESS if OK, integer value on error
interface grib_get_size
module procedure grib_get_size_int
end interface grib_get_size
!> Set the value for a key in a grib message.
!> Set the value for a key in a message.
!>
!> The given \em value is set for the \em key in the \em gribid message.
!> The given \em value is set for the \em key in the \em msgid message.
!> In some cases the \em value can be an array rather than a scalar.
!> As examples of array keys we have "values","pl", "pv" respectively the data values,
!> the list of number of points for each latitude in a reduced grid and the list of
@ -137,10 +137,10 @@
!>
!> @see grib_new_from_file, grib_release, grib_get
!>
!> @param[in] gribid id of the grib loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8)
!> @param[out] status GRIB_SUCCESS if OK, integer value on error
!> @param[in] msgid id of the message loaded in memory
!> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8)
!> @param[out] status GRIB_SUCCESS if OK, integer value on error
interface grib_set
module procedure grib_set_int, &
grib_set_real4, &

8
html/classeccodes.html
View File

@ -530,7 +530,7 @@ Public Member Functions</h2></td></tr>
<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">msgid</td><td>id of the message loaded in memory </td></tr>
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, GRIB_END_OF_FILE at the end of file, or error code </td></tr>
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, CODES_END_OF_FILE at the end of file, or error code </td></tr>
</table>
</dd>
</dl>
@ -620,7 +620,7 @@ Public Member Functions</h2></td></tr>
<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">bufrid</td><td>id of the BUFR loaded in memory </td></tr>
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, GRIB_END_OF_FILE at the end of file, or error code </td></tr>
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, CODES_END_OF_FILE at the end of file, or error code </td></tr>
</table>
</dd>
</dl>
@ -846,7 +846,7 @@ Public Member Functions</h2></td></tr>
<tr><td class="paramname">msgid_src</td><td>source message </td></tr>
<tr><td class="paramname">msgid_dest</td><td>destination message </td></tr>
<tr><td class="paramname">key</td><td>key whose value is to be copied </td></tr>
<tr><td class="paramname">status</td><td>GRIB_SUCCESS if OK, integer value on error </td></tr>
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
</table>
</dd>
</dl>
@ -2649,7 +2649,7 @@ Public Member Functions</h2></td></tr>
<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">gribid</td><td>id of the GRIB loaded in memory </td></tr>
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, GRIB_END_OF_FILE at the end of file, or error code </td></tr>
<tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, CODES_END_OF_FILE at the end of file, or error code </td></tr>
</table>
</dd>
</dl>