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

Comments

This commit is contained in:
Shahram Najm 2023-08-21 13:52:22 +01:00
parent db60bd7520
commit e8d0eaa3cd
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/eccodes.h
View File

@ -606,9 +606,9 @@ int codes_grib_get_data(const codes_handle* h, double* lats, double* lons, doubl
* Get the next value from a geoiterator. * Get the next value from a geoiterator.
* *
* @param i : the geoiterator * @param i : the geoiterator
* @param lat : on output latitude in degree * @param lat : output latitude in degrees
* @param lon : on output longitude in degree * @param lon : output longitude in degrees
* @param value : on output value of the point * @param value : output value of the point
* @return positive value if successful, 0 if no more data are available * @return positive value if successful, 0 if no more data are available
*/ */
int codes_grib_iterator_next(codes_iterator* i, double* lat, double* lon, double* value); int codes_grib_iterator_next(codes_iterator* i, double* lat, double* lon, double* value);
@ -617,9 +617,9 @@ int codes_grib_iterator_next(codes_iterator* i, double* lat, double* lon, double
* Get the previous value from a geoiterator. * Get the previous value from a geoiterator.
* *
* @param i : the geoiterator * @param i : the geoiterator
* @param lat : on output latitude in degree * @param lat : output latitude in degrees
* @param lon : on output longitude in degree * @param lon : output longitude in degrees
* @param value : on output value of the point* * @param value : output value of the point*
* @return positive value if successful, 0 if no more data are available * @return positive value if successful, 0 if no more data are available
*/ */
int codes_grib_iterator_previous(codes_iterator* i, double* lat, double* lon, double* value); int codes_grib_iterator_previous(codes_iterator* i, double* lat, double* lon, double* value);
@ -628,7 +628,7 @@ int codes_grib_iterator_previous(codes_iterator* i, double* lat, double* lon, do
* Test procedure for values in a geoiterator. * Test procedure for values in a geoiterator.
* *
* @param i : the geoiterator * @param i : the geoiterator
* @return boolean, 1 if the iterator still nave next values, 0 otherwise * @return boolean, 1 if the iterator still has next values, 0 otherwise
*/ */
int codes_grib_iterator_has_next(codes_iterator* i); int codes_grib_iterator_has_next(codes_iterator* i);
@ -685,7 +685,7 @@ int codes_grib_nearest_find(codes_nearest* nearest, const codes_handle* h, doubl
/** /**
* Frees a nearest object from memory * Frees a nearest object from memory
* *
* @param nearest : the nearest * @param nearest : the nearest neighbour object
* @return 0 if OK, integer value on error * @return 0 if OK, integer value on error
*/ */
int codes_grib_nearest_delete(codes_nearest* nearest); int codes_grib_nearest_delete(codes_nearest* nearest);

4
src/grib_api.h
View File

@ -599,7 +599,7 @@ grib_iterator* grib_iterator_new(const grib_handle* h, unsigned long flags, int*
/** /**
* Get latitude/longitude and data values. * Get latitude/longitude and data values.
* The Latitudes, longitudes and values arrays must be properly allocated by the caller. * The latitudes, longitudes and values arrays must be properly allocated by the caller.
* Their required dimension can be obtained by getting the value of the integer key "numberOfPoints". * Their required dimension can be obtained by getting the value of the integer key "numberOfPoints".
* *
* @param h : handle from which geography and data values are taken * @param h : handle from which geography and data values are taken
@ -636,7 +636,7 @@ int grib_iterator_previous(grib_iterator* i, double* lat, double* lon, double* v
* Test procedure for values in a geoiterator. * Test procedure for values in a geoiterator.
* *
* @param i : the geoiterator * @param i : the geoiterator
* @return boolean, 1 if the geoiterator still nave next values, 0 otherwise * @return boolean, 1 if the geoiterator still has next values, 0 otherwise
*/ */
int grib_iterator_has_next(grib_iterator* i); int grib_iterator_has_next(grib_iterator* i);