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

Documentation

This commit is contained in:
Shahram Najm 2017-08-22 15:33:03 +01:00
parent 21ca0ec6a0
commit da91d2221e
2 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
fortran/grib_f90_int.f90
View File

@ -87,7 +87,7 @@
!> @see grib_new_from_file, grib_release, grib_set !> @see grib_new_from_file, grib_release, grib_set
!> !>
!> !>
!> @param[in] msgid id of the loaded in memory !> @param[in] msgid id of the message loaded in memory
!> @param[in] key key name !> @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] 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[out] status GRIB_SUCCESS if OK, integer value on error
@ -127,7 +127,7 @@
!> the list of number of points for each latitude in a reduced grid and the list of !> 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 !> vertical levels. In these cases the \em value array must be allocated by the caller
!> and their required dimension can be obtained with \ref grib_get_size. \n !> and their required dimension can be obtained with \ref grib_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 !> 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 !> exit with an error message.\n Otherwise the error message can be

30
fortran/grib_f90_long_int.f90
View File

@ -65,9 +65,9 @@
grib_index_select_real8 grib_index_select_real8
end interface grib_index_select 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. !> 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 !> the list of number of points for each latitude in a reduced grid and the list of
@ -79,7 +79,7 @@
!> Analogous conversions are always provided when possible. !> Analogous conversions are always provided when possible.
!> Illegal conversions are real to integer and character to any other type. !> 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 !> 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 !> exit with an error message.\n Otherwise the error message can be
@ -90,10 +90,10 @@
!> @see grib_new_from_file, grib_release, grib_set !> @see grib_new_from_file, grib_release, grib_set
!> !>
!> !>
!> @param[in] gribid id of the grib loaded in memory !> @param[in] msgid id of the message loaded in memory
!> @param[in] key key name !> @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] 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[out] status GRIB_SUCCESS if OK, integer value on error
interface grib_get interface grib_get
module procedure grib_get_int, & module procedure grib_get_int, &
grib_get_long, & grib_get_long, &
@ -114,7 +114,7 @@
!> exit with an error message.\n Otherwise the error message can be !> exit with an error message.\n Otherwise the error message can be
!> gathered with @ref grib_get_error_string. !> gathered with @ref grib_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 key name of the key
!> @param size size of the array key !> @param size size of the array key
!> @param status GRIB_SUCCESS if OK, integer value on error !> @param status GRIB_SUCCESS if OK, integer value on error
@ -123,15 +123,15 @@
grib_get_size_long grib_get_size_long
end interface grib_get_size 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. !> 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 !> 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 !> vertical levels. In these cases the \em value array must be allocated by the caller
!> and their required dimension can be obtained with \ref grib_get_size. \n !> and their required dimension can be obtained with \ref grib_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 !> 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 !> exit with an error message.\n Otherwise the error message can be
@ -141,10 +141,10 @@
!> !>
!> @see grib_new_from_file, grib_release, grib_get !> @see grib_new_from_file, grib_release, grib_get
!> !>
!> @param[in] gribid id of the grib loaded in memory !> @param[in] msgid id of the message loaded in memory
!> @param[in] key key name !> @param[in] key key name
!> @param[out] value value can be a scalar or array of integer(4),real(4),real(8) !> @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[out] status GRIB_SUCCESS if OK, integer value on error
interface grib_set interface grib_set
module procedure grib_set_int, & module procedure grib_set_int, &
grib_set_long, & grib_set_long, &