cdi.h 52.2 KB
Newer Older
1
2
3
4
5
6
/*
  CDI C header file

  This is the only file that must be included to use the CDI library from C.
*/

7
8
#ifndef  CDI_H_
#define  CDI_H_
Uwe Schulzweida's avatar
Uwe Schulzweida committed
9

10
#include <stdio.h>
Uwe Schulzweida's avatar
Uwe Schulzweida committed
11
#include <sys/types.h>
12

13
#ifdef __cplusplus
Uwe Schulzweida's avatar
Uwe Schulzweida committed
14
15
extern "C" {
#endif
16
17


18
#define  CDI_MAX_NAME             256   // max length of a name
Deike Kleberg's avatar
Deike Kleberg committed
19

20
21
#define  CDI_UNDEFID               -1
#define  CDI_GLOBAL                -1   // Global var ID for vlist
Uwe Schulzweida's avatar
Uwe Schulzweida committed
22

23
24
/* Byte order */

25
26
27
#define  CDI_BIGENDIAN              0   // Byte order BIGENDIAN
#define  CDI_LITTLEENDIAN           1   // Byte order LITTLEENDIAN
#define  CDI_PDPENDIAN              2
28

29
30
31
#define  CDI_REAL                   1   // Real numbers
#define  CDI_COMP                   2   // Complex numbers
#define  CDI_BOTH                   3   // Both numbers
Uwe Schulzweida's avatar
Uwe Schulzweida committed
32

Uwe Schulzweida's avatar
Uwe Schulzweida committed
33
34
/* Error identifier */

35
36
37
38
#define	 CDI_NOERR        	    0   // No Error
#define  CDI_EEOF                  -1   // The end of file was encountered
#define  CDI_ESYSTEM              -10   // Operating system error
#define  CDI_EINVAL               -20   // Invalid argument
39
40
41
42
43
44
45
#define  CDI_EISDIR               -21   // Is a directory
#define  CDI_EISEMPTY             -22   // Is empty
#define  CDI_EUFTYPE              -23   // Unsupported file type
#define  CDI_ELIBNAVAIL           -24   // xxx library not available
#define  CDI_EUFSTRUCT            -25   // Unsupported file structure
#define  CDI_EUNC4                -26   // Unsupported NetCDF4 structure
#define  CDI_EDIMSIZE             -27   // Invalid dimension size
46
#define  CDI_ELIMIT               -99   // Internal limits exceeded
Uwe Schulzweida's avatar
Uwe Schulzweida committed
47
48
49

/* File types */

50
51
52
53
54
55
56
57
58
59
#define  CDI_FILETYPE_GRB           1   // File type GRIB
#define  CDI_FILETYPE_GRB2          2   // File type GRIB version 2
#define  CDI_FILETYPE_NC            3   // File type NetCDF
#define  CDI_FILETYPE_NC2           4   // File type NetCDF version 2 (64-bit)
#define  CDI_FILETYPE_NC4           5   // File type NetCDF version 4
#define  CDI_FILETYPE_NC4C          6   // File type NetCDF version 4 (classic)
#define  CDI_FILETYPE_SRV           7   // File type SERVICE
#define  CDI_FILETYPE_EXT           8   // File type EXTRA
#define  CDI_FILETYPE_IEG           9   // File type IEG

60
61
62
63
64
65
66
67
68
#define  FILETYPE_GRB           1
#define  FILETYPE_GRB2          2
#define  FILETYPE_NC            3
#define  FILETYPE_NC2           4
#define  FILETYPE_NC4           5
#define  FILETYPE_NC4C          6
#define  FILETYPE_SRV           7
#define  FILETYPE_EXT           8
#define  FILETYPE_IEG           9
Uwe Schulzweida's avatar
Uwe Schulzweida committed
69

70
71
/* Compress types */

72
73
74
75
76
77
#define  CDI_COMPRESS_NONE          0
#define  CDI_COMPRESS_SZIP          1
#define  CDI_COMPRESS_GZIP          2
#define  CDI_COMPRESS_BZIP2         3
#define  CDI_COMPRESS_ZIP           4
#define  CDI_COMPRESS_JPEG          5
78

79
/* external data types */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
80

81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
#define  CDI_DATATYPE_PACK          0
#define  CDI_DATATYPE_PACK1         1
#define  CDI_DATATYPE_PACK2         2
#define  CDI_DATATYPE_PACK3         3
#define  CDI_DATATYPE_PACK4         4
#define  CDI_DATATYPE_PACK5         5
#define  CDI_DATATYPE_PACK6         6
#define  CDI_DATATYPE_PACK7         7
#define  CDI_DATATYPE_PACK8         8
#define  CDI_DATATYPE_PACK9         9
#define  CDI_DATATYPE_PACK10       10
#define  CDI_DATATYPE_PACK11       11
#define  CDI_DATATYPE_PACK12       12
#define  CDI_DATATYPE_PACK13       13
#define  CDI_DATATYPE_PACK14       14
#define  CDI_DATATYPE_PACK15       15
#define  CDI_DATATYPE_PACK16       16
#define  CDI_DATATYPE_PACK17       17
#define  CDI_DATATYPE_PACK18       18
#define  CDI_DATATYPE_PACK19       19
#define  CDI_DATATYPE_PACK20       20
#define  CDI_DATATYPE_PACK21       21
#define  CDI_DATATYPE_PACK22       22
#define  CDI_DATATYPE_PACK23       23
#define  CDI_DATATYPE_PACK24       24
#define  CDI_DATATYPE_PACK25       25
#define  CDI_DATATYPE_PACK26       26
#define  CDI_DATATYPE_PACK27       27
#define  CDI_DATATYPE_PACK28       28
#define  CDI_DATATYPE_PACK29       29
#define  CDI_DATATYPE_PACK30       30
#define  CDI_DATATYPE_PACK31       31
#define  CDI_DATATYPE_PACK32       32
#define  CDI_DATATYPE_CPX32        64
#define  CDI_DATATYPE_CPX64       128
#define  CDI_DATATYPE_FLT32       132
#define  CDI_DATATYPE_FLT64       164
#define  CDI_DATATYPE_INT8        208
#define  CDI_DATATYPE_INT16       216
#define  CDI_DATATYPE_INT32       232
#define  CDI_DATATYPE_UINT8       308
#define  CDI_DATATYPE_UINT16      316
#define  CDI_DATATYPE_UINT32      332

#define  DATATYPE_PACK            0
#define  DATATYPE_PACK8           8
#define  DATATYPE_PACK16         16
#define  DATATYPE_PACK24         24
#define  DATATYPE_FLT32         132
#define  DATATYPE_FLT64         164
#define  DATATYPE_INT32         232
Uwe Schulzweida's avatar
Uwe Schulzweida committed
132

133
/* internal data types */
134
135
136
137
138
139
140
141
142
143
144
145
146
#define  CDI_DATATYPE_INT         251
#define  CDI_DATATYPE_FLT         252
#define  CDI_DATATYPE_TXT         253
#define  CDI_DATATYPE_CPX         254
#define  CDI_DATATYPE_UCHAR       255
#define  CDI_DATATYPE_LONG        256

#define  DATATYPE_INT           251
#define  DATATYPE_FLT           252
#define  DATATYPE_TXT           253
#define  DATATYPE_CPX           254
#define  DATATYPE_UCHAR         255
#define  DATATYPE_LONG          256
147

148
149
/* Chunks */

150
151
152
#define  CDI_CHUNK_AUTO             1  /* use default chunk size                                */
#define  CDI_CHUNK_GRID             2
#define  CDI_CHUNK_LINES            3
153

Uwe Schulzweida's avatar
Uwe Schulzweida committed
154
155
/* GRID types */

156
157
158
159
160
161
162
163
164
165
166
#define  GRID_GENERIC               1  /* Generic grid                                          */
#define  GRID_GAUSSIAN              2  /* Regular Gaussian lon/lat grid                         */
#define  GRID_GAUSSIAN_REDUCED      3  /* Reduced Gaussian lon/lat grid                         */
#define  GRID_LONLAT                4  /* Regular longitude/latitude grid                       */
#define  GRID_SPECTRAL              5  /* Spherical harmonic coefficients                       */
#define  GRID_FOURIER               6  /* Fourier coefficients                                  */
#define  GRID_GME                   7  /* Icosahedral-hexagonal GME grid                        */
#define  GRID_TRAJECTORY            8  /* Trajectory                                            */
#define  GRID_UNSTRUCTURED          9  /* General unstructured grid                             */
#define  GRID_CURVILINEAR          10  /* Curvilinear grid                                      */
#define  GRID_LCC                  11  /* Lambert Conformal Conic (GRIB)                        */
167
#define  GRID_PROJECTION           12  /* Projected coordinates                                 */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
168
#define  GRID_CHARXY               13  /* One horizontal character dimension                    */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
169

170
171
172
#define  CDI_PROJ_RLL              21  /* Rotated Latitude Longitude                            */
#define  CDI_PROJ_LCC              22  /* Lambert Conformal Conic                               */
#define  CDI_PROJ_LAEA             23  /* Lambert Azimuthal Equal Area                          */
173
#define  CDI_PROJ_SINU             24  /* Sinusoidal                                            */
174

Uwe Schulzweida's avatar
Uwe Schulzweida committed
175
176
/* ZAXIS types */

177
178
179
180
181
#define  ZAXIS_SURFACE              0  /* Surface level                                         */
#define  ZAXIS_GENERIC              1  /* Generic level                                         */
#define  ZAXIS_HYBRID               2  /* Hybrid level                                          */
#define  ZAXIS_HYBRID_HALF          3  /* Hybrid half level                                     */
#define  ZAXIS_PRESSURE             4  /* Isobaric pressure level in Pascal                     */
182
#define  ZAXIS_HEIGHT               5  /* Height above ground                                   */
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
#define  ZAXIS_DEPTH_BELOW_SEA      6  /* Depth below sea level in meters                       */
#define  ZAXIS_DEPTH_BELOW_LAND     7  /* Depth below land surface in centimeters               */
#define  ZAXIS_ISENTROPIC           8  /* Isentropic                                            */
#define  ZAXIS_TRAJECTORY           9  /* Trajectory                                            */
#define  ZAXIS_ALTITUDE            10  /* Altitude above mean sea level in meters               */
#define  ZAXIS_SIGMA               11  /* Sigma level                                           */
#define  ZAXIS_MEANSEA             12  /* Mean sea level                                        */
#define  ZAXIS_TOA                 13  /* Norminal top of atmosphere                            */
#define  ZAXIS_SEA_BOTTOM          14  /* Sea bottom                                            */
#define  ZAXIS_ATMOSPHERE          15  /* Entire atmosphere                                     */
#define  ZAXIS_CLOUD_BASE          16  /* Cloud base level                                      */
#define  ZAXIS_CLOUD_TOP           17  /* Level of cloud tops                                   */
#define  ZAXIS_ISOTHERM_ZERO       18  /* Level of 0o C isotherm                                */
#define  ZAXIS_SNOW                19  /* Snow level                                            */
#define  ZAXIS_LAKE_BOTTOM         20  /* Lake or River Bottom                                  */
#define  ZAXIS_SEDIMENT_BOTTOM     21  /* Bottom Of Sediment Layer                              */
#define  ZAXIS_SEDIMENT_BOTTOM_TA  22  /* Bottom Of Thermally Active Sediment Layer             */
#define  ZAXIS_SEDIMENT_BOTTOM_TW  23  /* Bottom Of Sediment Layer Penetrated By Thermal Wave   */
#define  ZAXIS_MIX_LAYER           24  /* Mixing Layer                                          */
#define  ZAXIS_REFERENCE           25  /* zaxis reference number                                */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
203
#define  ZAXIS_CHAR                26  /* Area types                                            */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
204

205
206
207
208
/* SUBTYPE types */

enum {
  SUBTYPE_TILES                         = 0  /* Tiles variable                                  */
209
};
210
211
212
213

#define MAX_KV_PAIRS_MATCH 10

/* Data structure defining a key-value search, possibly with multiple
214
   key-value pairs in combination.
215
216
217
218
219
220
221
222
223
224

   Currently, only multiple pairs combined by AND are supported.
*/
typedef struct  {
  int nAND;                                   /* no. of key-value pairs that have to match */
  int key_value_pairs[2][MAX_KV_PAIRS_MATCH]; /* key-value pairs */
} subtype_query_t;



225
226
/* TIME types */

227
228
#define  TIME_CONSTANT              0  /* obsolate, use TSTEP_CONSTANT                          */
#define  TIME_VARIABLE              1  /* obsolate, use TSTEP_INSTANT                           */
229
230
231

/* TSTEP types */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
232
233
234
235
236
237
238
239
240
241
242
243
244
245
#define  TSTEP_CONSTANT             0  /* Constant            */
#define  TSTEP_INSTANT              1  /* Instant             */
#define  TSTEP_AVG                  2  /* Average             */
#define  TSTEP_ACCUM                3  /* Accumulation        */
#define  TSTEP_MAX                  4  /* Maximum             */
#define  TSTEP_MIN                  5  /* Minimum             */
#define  TSTEP_DIFF                 6  /* Difference          */
#define  TSTEP_RMS                  7  /* Root mean square    */
#define  TSTEP_SD                   8  /* Standard deviation  */
#define  TSTEP_COV                  9  /* Covariance          */
#define  TSTEP_RATIO               10  /* Ratio               */
#define  TSTEP_RANGE               11
#define  TSTEP_INSTANT2            12
#define  TSTEP_INSTANT3            13
246

Uwe Schulzweida's avatar
Uwe Schulzweida committed
247
248
249
250
/* TAXIS types */

#define  TAXIS_ABSOLUTE           1
#define  TAXIS_RELATIVE           2
251
#define  TAXIS_FORECAST           3
Uwe Schulzweida's avatar
Uwe Schulzweida committed
252
253
254
255
256

/* TUNIT types */

#define  TUNIT_SECOND             1
#define  TUNIT_MINUTE             2
257
258
259
260
261
262
263
264
265
#define  TUNIT_QUARTER            3
#define  TUNIT_30MINUTES          4
#define  TUNIT_HOUR               5
#define  TUNIT_3HOURS             6
#define  TUNIT_6HOURS             7
#define  TUNIT_12HOURS            8
#define  TUNIT_DAY                9
#define  TUNIT_MONTH             10
#define  TUNIT_YEAR              11
Uwe Schulzweida's avatar
Uwe Schulzweida committed
266
267
268

/* CALENDAR types */

269
#define  CALENDAR_STANDARD        0  /* don't change this value (used also in cgribexlib)! */
270
#define  CALENDAR_PROLEPTIC       1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
271
272
273
#define  CALENDAR_360DAYS         2
#define  CALENDAR_365DAYS         3
#define  CALENDAR_366DAYS         4
274
#define  CALENDAR_NONE            5
Uwe Schulzweida's avatar
Uwe Schulzweida committed
275

276
277
/* number of unsigned char needed to store UUID */
#define  CDI_UUID_SIZE           16
278

279
280
/* Structs that are used to return data to the user */

281
typedef struct CdiParam { int discipline; int category; int number; } CdiParam;
282
283
284
285
286
287


/* Opaque types */
typedef struct CdiIterator CdiIterator;
typedef struct CdiGribIterator CdiGribIterator;

288
289
290
/* CDI control routines */

void    cdiReset(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
291

292
const char *cdiStringError(int cdiErrno);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
293
294
295

void    cdiDebug(int debug);

296
const char *cdiLibraryVersion(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
297
298
void    cdiPrintVersion(void);

299
300
int     cdiHaveFiletype(int filetype);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
301
302
void    cdiDefMissval(double missval);
double  cdiInqMissval(void);
303
void    cdiDefGlobal(const char *string, int val);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
304

305
int     namespaceNew(void);
306
void    namespaceSetActive(int namespaceID);
307
int     namespaceGetActive(void);
308
309
310
void    namespaceDelete(int namespaceID);


Uwe Schulzweida's avatar
Uwe Schulzweida committed
311
312
/* CDI converter routines */

313
314
315
/* parameter */

void    cdiParamToString(int param, char *paramstr, int maxlen);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
316

Uwe Schulzweida's avatar
Uwe Schulzweida committed
317
318
void    cdiDecodeParam(int param, int *pnum, int *pcat, int *pdis);
int     cdiEncodeParam(int pnum, int pcat, int pdis);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
319
320

/* date format:  YYYYMMDD */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
321
/* time format:    hhmmss */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
322
323
324
325
326
327
328
329

void    cdiDecodeDate(int date, int *year, int *month, int *day);
int     cdiEncodeDate(int year, int month, int day);

void    cdiDecodeTime(int time, int *hour, int *minute, int *second);
int     cdiEncodeTime(int hour, int minute, int second);


Uwe Schulzweida's avatar
Uwe Schulzweida committed
330
331
/* STREAM control routines */

332
333
int     cdiGetFiletype(const char *path, int *byteorder);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
334
335
/*      streamOpenRead: Open a dataset for reading */
int     streamOpenRead(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
336

Uwe Schulzweida's avatar
Uwe Schulzweida committed
337
338
/*      streamOpenWrite: Create a new dataset */
int     streamOpenWrite(const char *path, int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
339

Uwe Schulzweida's avatar
Uwe Schulzweida committed
340
int     streamOpenAppend(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
341

Uwe Schulzweida's avatar
Uwe Schulzweida committed
342
/*      streamClose: Close an open dataset */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
343
344
void    streamClose(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
345
346
347
/*      streamSync: Synchronize an Open Dataset to Disk */
void    streamSync(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
348
349
350
351
352
353
/*      streamDefVlist: Define the Vlist for a stream */
void    streamDefVlist(int streamID, int vlistID);

/*      streamInqVlist: Get the Vlist of a stream */
int     streamInqVlist(int streamID);

354
/*      streamInqFiletype: Get the filetype */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
355
int     streamInqFiletype(int streamID);
356

357
/*      streamDefByteorder: Define the byteorder */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
358
void    streamDefByteorder(int streamID, int byteorder);
359
360

/*      streamInqByteorder: Get the byteorder */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
361
362
int     streamInqByteorder(int streamID);

Deike Kleberg's avatar
Deike Kleberg committed
363
364
/*      streamDefCompType: Define compression type */
void    streamDefCompType(int streamID, int comptype);
365

Deike Kleberg's avatar
Deike Kleberg committed
366
367
/*      streamInqCompType: Get compression type */
int     streamInqCompType(int streamID);
368

Uwe Schulzweida's avatar
Uwe Schulzweida committed
369
370
371
/*      streamDefCompLevel: Define compression level */
void    streamDefCompLevel(int streamID, int complevel);

Deike Kleberg's avatar
Deike Kleberg committed
372
373
/*      streamInqCompLevel: Get compression level */
int     streamInqCompLevel(int streamID);
374

375
/*      streamDefTimestep: Define time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
376
int     streamDefTimestep(int streamID, int tsID);
377
378

/*      streamInqTimestep: Get time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
379
380
int     streamInqTimestep(int streamID, int tsID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
381
382
383
/*      PIO: query currently set timestep id  */
int     streamInqCurTimestepID(int streamID);

384
385
const char *streamFilename(int streamID);
const char *streamFilesuffix(int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
386

387
size_t  streamNvals(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
388

389
int     streamInqNvars(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
390

391
/* STREAM var I/O routines (random access) */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
392
393

/*      streamWriteVar: Write a variable */
394
395
void    streamWriteVar(int streamID, int varID, const double data[], int nmiss);
void    streamWriteVarF(int streamID, int varID, const float data[], int nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
396

Uwe Schulzweida's avatar
Uwe Schulzweida committed
397
/*      streamReadVar: Read a variable */
398
399
void    streamReadVar(int streamID, int varID, double data[], int *nmiss);
void    streamReadVarF(int streamID, int varID, float data[], int *nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
400
401

/*      streamWriteVarSlice: Write a horizontal slice of a variable */
402
403
void    streamWriteVarSlice(int streamID, int varID, int levelID, const double data[], int nmiss);
void    streamWriteVarSliceF(int streamID, int varID, int levelID, const float data[], int nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
404

Uwe Schulzweida's avatar
Uwe Schulzweida committed
405
/*      streamReadVarSlice: Read a horizontal slice of a variable */
406
407
void    streamReadVarSlice(int streamID, int varID, int levelID, double data[], int *nmiss);
void    streamReadVarSliceF(int streamID, int varID, int levelID, float data[], int *nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
408

409
void    streamWriteVarChunk(int streamID, int varID, const int rect[3][2], const double data[], int nmiss);
410

Uwe Schulzweida's avatar
Uwe Schulzweida committed
411

412
/* STREAM record I/O routines (sequential access) */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
413
414

void    streamDefRecord(int streamID, int  varID, int  levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
415
void    streamInqRecord(int streamID, int *varID, int *levelID);
416
417
418
void    streamWriteRecord(int streamID, const double data[], int nmiss);
void    streamWriteRecordF(int streamID, const float data[], int nmiss);
void    streamReadRecord(int streamID, double data[], int *nmiss);
419
void    streamReadRecordF(int streamID, float data[], int *nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
420
421
void    streamCopyRecord(int streamIDdest, int streamIDsrc);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
422
void    streamInqGRIBinfo(int streamID, int *intnum, float *fltnum, off_t *bignum);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
423

424
425
426
427

/* File driven I/O (may yield better performance than using the streamXXX functions) */

//Creation & Destruction
428
429
430
431
432
433
CdiIterator *cdiIterator_new(const char *path);  //Requires a subsequent call to cdiIteratorNextField() to point the iterator at the first field.
CdiIterator *cdiIterator_clone(CdiIterator *me);
char *cdiIterator_serialize(CdiIterator *me);  //Returns a malloc'ed string.
CdiIterator *cdiIterator_deserialize(const char *description);  //description is a string that was returned by cdiIteratorSerialize(). Returns a copy of the original iterator.
void cdiIterator_print(CdiIterator *me, FILE *stream);
void cdiIterator_delete(CdiIterator *me);
434
435

//Advancing an iterator
436
int cdiIterator_nextField(CdiIterator *me);      //Points the iterator at the next field, returns CDI_EEOF if there are no more fields in the file.
437
438
439

//Introspecting metadata
//All outXXX arguments to these functions may be NULL.
440
441
char *cdiIterator_inqStartTime(CdiIterator *me);      //Returns the (start) time as an ISO-8601 coded string. The caller is responsible to Free() the returned string.
char *cdiIterator_inqEndTime(CdiIterator *me);      //Returns the end time of an integration period as an ISO-8601 coded string, or NULL if there is no end time. The caller is responsible to Free() the returned string.
442
char *cdiIterator_inqRTime(CdiIterator *me);      //Returns the reference date as an ISO-8601 coded string. The caller is responsible to Free() the returned string.
443
444
char *cdiIterator_inqVTime(CdiIterator *me);      //Returns the validity date as an ISO-8601 coded string. The caller is responsible to Free() the returned string.
int cdiIterator_inqLevelType(CdiIterator *me, int levelSelector, char **outName_optional, char **outLongName_optional, char **outStdName_optional, char **outUnit_optional);      //callers are responsible to Free() strings that they request
445
446
int cdiIterator_inqLevel(CdiIterator *me, int levelSelector, double *outValue1_optional, double *outValue2_optional);       //outValue2 is only written to if the level is a hybrid level
int cdiIterator_inqLevelUuid(CdiIterator *me, int *outVgridNumber_optional, int *outLevelCount_optional, unsigned char outUuid_optional[CDI_UUID_SIZE]);   //outUuid must point to a buffer of 16 bytes, returns an error code if no generalized zaxis is used.
447
448
int cdiIterator_inqTile(CdiIterator *me, int *outTileIndex, int *outTileAttribute); //Returns CDI_EINVAL if there is no tile information connected to the current field, *outTileIndex and *outTileAttribute will be set to -1 in this case.
int cdiIterator_inqTileCount(CdiIterator *me, int *outTileCount, int *outTileAttributeCount); //outTileAttributeCount is the count for the tile associated with the current field, a total attribute count cannot be inquired. Returns CDI_EINVAL if there is no tile information connected to the current field, *outTileCount and *outTileAttributeCount will be set to 0 in this case.
449
CdiParam cdiIterator_inqParam(CdiIterator *me);
450
void cdiIterator_inqParamParts(CdiIterator *me, int *outDiscipline, int *outCategory, int *outNumber);	//Some FORTRAN compilers produce wrong code for the cdiIterator_inqParam()-wrapper, rendering it unusable from FORTRAN. This function is the workaround.
451
452
int cdiIterator_inqDatatype(CdiIterator *me);
int cdiIterator_inqTsteptype(CdiIterator *me);
453
char *cdiIterator_inqVariableName(CdiIterator *me);        //The caller is responsible to Free() the returned buffer.
454
int cdiIterator_inqGridId(CdiIterator *me);         //The returned id is only valid until the next call to cdiIteratorNextField().
455
456

//Reading data
457
458
void cdiIterator_readField(CdiIterator *me, double data[], size_t *nmiss_optional);
void cdiIterator_readFieldF(CdiIterator *me, float data[], size_t *nmiss_optional);
459
460
461
462
//TODO[NH]: Add functions to read partial fields.


//Direct access to grib fields
463
464
CdiGribIterator *cdiGribIterator_clone(CdiIterator *me);  //Returns NULL if the associated file is not a GRIB file.
void cdiGribIterator_delete(CdiGribIterator *me);
465
466

//Callthroughs to GRIB-API
467
468
469
470
471
int cdiGribIterator_getLong(CdiGribIterator *me, const char *key, long *value); //Same semantics as grib_get_long().
int cdiGribIterator_getDouble(CdiGribIterator *me, const char *key, double *value); //Same semantics as grib_get_double().
int cdiGribIterator_getLength(CdiGribIterator *me, const char *key, size_t *value);     //Same semantics as grib_get_length().
int cdiGribIterator_getString(CdiGribIterator *me, const char *key, char *value, size_t *length);       //Same semantics as grib_get_string().
int cdiGribIterator_getSize(CdiGribIterator *me, const char *key, size_t *value);     //Same semantics as grib_get_size().
472
int cdiGribIterator_getLongArray(CdiGribIterator *me, const char *key, long *value, size_t *array_size);       //Same semantics as grib_get_long_array().
473
int cdiGribIterator_getDoubleArray(CdiGribIterator *me, const char *key, double *value, size_t *array_size);       //Same semantics as grib_get_double_array().
474
475

//Convenience functions for accessing GRIB-API keys
476
477
478
479
480
481
int cdiGribIterator_inqEdition(CdiGribIterator *me);
long cdiGribIterator_inqLongValue(CdiGribIterator *me, const char *key);   //Aborts on failure to fetch the given key.
long cdiGribIterator_inqLongDefaultValue(CdiGribIterator *me, const char *key, long defaultValue); //Returns the default value if the given key is not present.
double cdiGribIterator_inqDoubleValue(CdiGribIterator *me, const char *key);   //Aborts on failure to fetch the given key.
double cdiGribIterator_inqDoubleDefaultValue(CdiGribIterator *me, const char *key, double defaultValue); //Returns the default value if the given key is not present.
char *cdiGribIterator_inqStringValue(CdiGribIterator *me, const char *key);        //Returns a malloc'ed string.
482

Uwe Schulzweida's avatar
Uwe Schulzweida committed
483
484
/* VLIST routines */

485
486
/*      vlistCreate: Create a variable list */
int     vlistCreate(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
487

488
/*      vlistDestroy: Destroy a variable list */
489
void    vlistDestroy(int vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509

/*      vlistDuplicate: Duplicate a variable list */
int     vlistDuplicate(int vlistID);

/*      vlistCopy: Copy a variable list */
void    vlistCopy(int vlistID2, int vlistID1);

/*      vlistCopyFlag: Copy some entries of a variable list */
void    vlistCopyFlag(int vlistID2, int vlistID1);

void    vlistClearFlag(int vlistID);

/*      vlistCat: Concatenate two variable lists */
void    vlistCat(int vlistID2, int vlistID1);

/*      vlistMerge: Merge two variable lists */
void    vlistMerge(int vlistID2, int vlistID1);

void    vlistPrint(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
510
511
512
/*      vlistNumber: Number type in a variable list */
int     vlistNumber(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
513
514
515
516
517
518
519
520
521
/*      vlistNvars: Number of variables in a variable list */
int     vlistNvars(int vlistID);

/*      vlistNgrids: Number of grids in a variable list */
int     vlistNgrids(int vlistID);

/*      vlistNzaxis: Number of zaxis in a variable list */
int     vlistNzaxis(int vlistID);

522
523
524
/*      vlistNsubtypes: Number of subtypes in a variable list */
int     vlistNsubtypes(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
525
526
527
528
529
530
531
532
533
534
535
536
void    vlistDefNtsteps(int vlistID, int nts);
int     vlistNtsteps(int vlistID);
int     vlistGridsizeMax(int vlistID);
int     vlistGrid(int vlistID, int index);
int     vlistGridIndex(int vlistID, int gridID);
void    vlistChangeGridIndex(int vlistID, int index, int gridID);
void    vlistChangeGrid(int vlistID, int gridID1, int gridID2);
int     vlistZaxis(int vlistID, int index);
int     vlistZaxisIndex(int vlistID, int zaxisID);
void    vlistChangeZaxisIndex(int vlistID, int index, int zaxisID);
void    vlistChangeZaxis(int vlistID, int zaxisID1, int zaxisID2);
int     vlistNrecs(int vlistID);
537
538
int     vlistSubtype(int vlistID, int index);
int     vlistSubtypeIndex(int vlistID, int subtypeID);
539
540

/*      vlistDefTaxis: Define the time axis of a variable list */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
541
void    vlistDefTaxis(int vlistID, int taxisID);
542
543

/*      vlistInqTaxis: Get the time axis of a variable list */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
544
int     vlistInqTaxis(int vlistID);
545

Uwe Schulzweida's avatar
Uwe Schulzweida committed
546
547
548
549
550
551
552
553
554
555
void    vlistDefTable(int vlistID, int tableID);
int     vlistInqTable(int vlistID);
void    vlistDefInstitut(int vlistID, int instID);
int     vlistInqInstitut(int vlistID);
void    vlistDefModel(int vlistID, int modelID);
int     vlistInqModel(int vlistID);


/* VLIST VAR routines */

556
/*      vlistDefVarTiles: Create a new tile-based variable */
557
558
559
int     vlistDefVarTiles(int vlistID, int gridID, int zaxisID, int tsteptype, int tilesetID);

/*      vlistDefVar: Create a new variable */
560
int     vlistDefVar(int vlistID, int gridID, int zaxisID, int tsteptype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
561

562
void    vlistChangeVarGrid(int vlistID, int varID, int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
563
564
void    vlistChangeVarZaxis(int vlistID, int varID, int zaxisID);

565
void    vlistInqVar(int vlistID, int varID, int *gridID, int *zaxisID, int *tsteptype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
566
567
int     vlistInqVarGrid(int vlistID, int varID);
int     vlistInqVarZaxis(int vlistID, int varID);
568
569
570
571
572

/* used in MPIOM */
int     vlistInqVarID(int vlistID, int code);

void    vlistDefVarTsteptype(int vlistID, int varID, int tsteptype);
573
574

/*      vlistInqVarTsteptype: Get the timestep type of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
575
int     vlistInqVarTsteptype(int vlistID, int varID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
576

Deike Kleberg's avatar
Deike Kleberg committed
577
578
579
580
void    vlistDefVarCompType(int vlistID, int varID, int comptype);
int     vlistInqVarCompType(int vlistID, int varID);
void    vlistDefVarCompLevel(int vlistID, int varID, int complevel);
int     vlistInqVarCompLevel(int vlistID, int varID);
581

582
583
584
585
586
587
/*      vlistDefVarParam: Define the parameter number of a Variable */
void    vlistDefVarParam(int vlistID, int varID, int param);

/*      vlistInqVarParam: Get the parameter number of a Variable */
int     vlistInqVarParam(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
588
/*      vlistDefVarCode: Define the code number of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
589
590
void    vlistDefVarCode(int vlistID, int varID, int code);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
591
/*      vlistInqVarCode: Get the code number of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
592
593
int     vlistInqVarCode(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
594
/*      vlistDefVarDatatype: Define the data type of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
595
596
void    vlistDefVarDatatype(int vlistID, int varID, int datatype);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
597
/*      vlistInqVarDatatype: Get the data type of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
598
599
int     vlistInqVarDatatype(int vlistID, int varID);

600
601
602
void    vlistDefVarChunkType(int vlistID, int varID, int chunktype);
int     vlistInqVarChunkType(int vlistID, int varID);

603
604
605
void    vlistDefVarXYZ(int vlistID, int varID, int xyz);
int     vlistInqVarXYZ(int vlistID, int varID);

606
607
int     vlistInqVarNumber(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
608
609
610
611
612
613
614
void    vlistDefVarInstitut(int vlistID, int varID, int instID);
int     vlistInqVarInstitut(int vlistID, int varID);
void    vlistDefVarModel(int vlistID, int varID, int modelID);
int     vlistInqVarModel(int vlistID, int varID);
void    vlistDefVarTable(int vlistID, int varID, int tableID);
int     vlistInqVarTable(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
615
/*      vlistDefVarName: Define the name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
616
617
void    vlistDefVarName(int vlistID, int varID, const char *name);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
618
/*      vlistInqVarName: Get the name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
619
620
void    vlistInqVarName(int vlistID, int varID, char *name);

621
/*      vlistCopyVarName: Safe and convenient version of vlistInqVarName */
622
char   *vlistCopyVarName(int vlistId, int varId);
623

Uwe Schulzweida's avatar
Uwe Schulzweida committed
624
625
626
627
628
629
/*      vlistDefVarStdname: Define the standard name of a Variable */
void    vlistDefVarStdname(int vlistID, int varID, const char *stdname);

/*      vlistInqVarStdname: Get the standard name of a Variable */
void    vlistInqVarStdname(int vlistID, int varID, char *stdname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
630
/*      vlistDefVarLongname: Define the long name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
631
632
void    vlistDefVarLongname(int vlistID, int varID, const char *longname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
633
/*      vlistInqVarLongname: Get the long name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
634
void    vlistInqVarLongname(int vlistID, int varID, char *longname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
635

Uwe Schulzweida's avatar
Uwe Schulzweida committed
636
/*      vlistDefVarUnits: Define the units of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
637
638
void    vlistDefVarUnits(int vlistID, int varID, const char *units);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
639
/*      vlistInqVarUnits: Get the units of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
640
641
void    vlistInqVarUnits(int vlistID, int varID, char *units);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
642
/*      vlistDefVarMissval: Define the missing value of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
643
644
void    vlistDefVarMissval(int vlistID, int varID, double missval);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
645
/*      vlistInqVarMissval: Get the missing value of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
646
647
double  vlistInqVarMissval(int vlistID, int varID);

648
649
650
651
652
653
/*      vlistDefVarExtra: Define extra information of a Variable */
void    vlistDefVarExtra(int vlistID, int varID, const char *extra);

/*      vlistInqVarExtra: Get extra information of a Variable */
void    vlistInqVarExtra(int vlistID, int varID, char *extra);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
654
655
656
657
void    vlistDefVarScalefactor(int vlistID, int varID, double scalefactor);
double  vlistInqVarScalefactor(int vlistID, int varID);
void    vlistDefVarAddoffset(int vlistID, int varID, double addoffset);
double  vlistInqVarAddoffset(int vlistID, int varID);
658

659
660
661
662
void    vlistDefVarTimave(int vlistID, int varID, int timave);
int     vlistInqVarTimave(int vlistID, int varID);
void    vlistDefVarTimaccu(int vlistID, int varID, int timaccu);
int     vlistInqVarTimaccu(int vlistID, int varID);
663

664
665
666
void    vlistDefVarTypeOfGeneratingProcess(int vlistID, int varID, int typeOfGeneratingProcess);
int     vlistInqVarTypeOfGeneratingProcess(int vlistID, int varID);

667
668
669
void    vlistDefVarProductDefinitionTemplate(int vlistID, int varID, int productDefinitionTemplate);
int     vlistInqVarProductDefinitionTemplate(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
670
671
672
673
674
675
676
677
int     vlistInqVarSize(int vlistID, int varID);

void    vlistDefIndex(int vlistID, int varID, int levID, int index);
int     vlistInqIndex(int vlistID, int varID, int levID);
void    vlistDefFlag(int vlistID, int varID, int levID, int flag);
int     vlistInqFlag(int vlistID, int varID, int levID);
int     vlistFindVar(int vlistID, int fvarID);
int     vlistFindLevel(int vlistID, int fvarID, int flevelID);
678
679
int     vlistMergedVar(int vlistID, int varID);
int     vlistMergedLevel(int vlistID, int varID, int levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
680

681
682
683
/*     Ensemble info routines */
void    vlistDefVarEnsemble(int vlistID, int varID, int ensID, int ensCount, int forecast_type);
int     vlistInqVarEnsemble(int vlistID, int varID, int *ensID, int *ensCount, int *forecast_type);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
684

685
/* cdiClearAdditionalKeys: Clear the list of additional GRIB keys. */
Thomas Jahns's avatar
Thomas Jahns committed
686
void    cdiClearAdditionalKeys(void);
687
688
/* cdiDefAdditionalKey: Register an additional GRIB key which is read when file is opened. */
void    cdiDefAdditionalKey(const char *string);
689
690
691
692
693
694

/* vlistDefVarIntKey: Set an arbitrary keyword/integer value pair for GRIB API */
void    vlistDefVarIntKey(int vlistID, int varID, const char *name, int value);
/* vlistDefVarDblKey: Set an arbitrary keyword/double value pair for GRIB API */
void    vlistDefVarDblKey(int vlistID, int varID, const char *name, double value);

695
/* vlistHasVarKey: returns 1 if meta-data key was read, 0 otherwise. */
696
int     vlistHasVarKey(int vlistID, int varID, const char *name);
697
/* vlistInqVarDblKey: raw access to GRIB meta-data */
698
double  vlistInqVarDblKey(int vlistID, int varID, const char *name);
699
/* vlistInqVarIntKey: raw access to GRIB meta-data */
700
int     vlistInqVarIntKey(int vlistID, int varID, const char *name);
701

702
703
704
705
706
707
708
709
/* CDI attributes */

/*      cdiInqNatts: Get number of attributes assigned to this variable */
int     cdiInqNatts(int cdiID, int varID, int *nattsp);
/*      cdiInqAtt: Get information about an attribute */
int     cdiInqAtt(int cdiID, int varID, int attrnum, char *name, int *typep, int *lenp);
int     cdiDelAtt(int cdiID, int varID, const char *name);

710
711
int     cdiCopyAtts(int cdiID1, int varID1, int cdiID2, int varID2);

712
713
714
715
716
717
718
719
720
721
722
723
724
/*      cdiDefAttInt: Define an integer attribute */
int     cdiDefAttInt(int cdiID, int varID, const char *name, int type, int len, const int ip[]);
/*      cdiDefAttFlt: Define a floating point attribute */
int     cdiDefAttFlt(int cdiID, int varID, const char *name, int type, int len, const double dp[]);
/*      cdiDefAttTxt: Define a text attribute */
int     cdiDefAttTxt(int cdiID, int varID, const char *name, int len, const char *tp_cbuf);

/*      cdiInqAttInt: Get the value(s) of an integer attribute */
int     cdiInqAttInt(int cdiID, int varID, const char *name, int mlen, int ip[]);
/*      cdiInqAttFlt: Get the value(s) of a floating point attribute */
int     cdiInqAttFlt(int cdiID, int varID, const char *name, int mlen, double dp[]);
/*      cdiInqAttTxt: Get the value(s) of a text attribute */
int     cdiInqAttTxt(int cdiID, int varID, const char *name, int mlen, char *tp_cbuf);
725
726


Uwe Schulzweida's avatar
Uwe Schulzweida committed
727
728
729
/* GRID routines */

void    gridName(int gridtype, char *gridname);
730
const char *gridNamePtr(int gridtype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
731

Uwe Schulzweida's avatar
Uwe Schulzweida committed
732
733
void    gridCompress(int gridID);

734
735
void    gridDefMaskGME(int gridID, const int mask[]);
int     gridInqMaskGME(int gridID, int mask[]);
736

737
738
void    gridDefMask(int gridID, const int mask[]);
int     gridInqMask(int gridID, int mask[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
739

740
void    gridPrint(int gridID, int opt);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
741

742
/*      gridCreate: Create a horizontal Grid */
743
int     gridCreate(int gridtype, size_t size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
744

745
746
747
/*      gridDestroy: Destroy a horizontal Grid */
void    gridDestroy(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
748
749
750
/*      gridDuplicate: Duplicate a Grid */
int     gridDuplicate(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
751
752
753
/*      gridDefProj: Define the projection ID of a Grid */
void    gridDefProj(int gridID, int projID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
754
755
756
/*      gridInqProj: Get the projection ID of a Grid */
int     gridInqProj(int gridID);

757
758
759
/*      gridInqProjType: Get the projection type */
int     gridInqProjType(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
760
761
762
763
/*      gridInqType: Get the type of a Grid */
int     gridInqType(int gridID);

/*      gridInqSize: Get the size of a Grid */
764
size_t  gridInqSize(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
765
766

/*      gridDefXsize: Define the size of a X-axis */
767
void    gridDefXsize(int gridID, size_t xsize);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
768
769

/*      gridInqXsize: Get the size of a X-axis */
770
size_t  gridInqXsize(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
771
772

/*      gridDefYsize: Define the size of a Y-axis */
773
void    gridDefYsize(int gridID, size_t ysize);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
774
775

/*      gridInqYsize: Get the size of a Y-axis */
776
size_t  gridInqYsize(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
777

778
779
780
781
782
783
/*      gridDefNP: Define the number of parallels between a pole and the equator */
void    gridDefNP(int gridID, int np);

/*      gridInqNP: Get the number of parallels between a pole and the equator */
int     gridInqNP(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
784
/*      gridDefXvals: Define the values of a X-axis */
785
void    gridDefXvals(int gridID, const double xvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
786
787

/*      gridInqXvals: Get all values of a X-axis */
788
size_t  gridInqXvals(int gridID, double xvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
789

Uwe Schulzweida's avatar
Uwe Schulzweida committed
790
791
792
793
/*      gridInqXIsc: Find out whether X-coordinate is of type CHAR */
int     gridInqXIsc(int gridID);

/*      gridInqXCvals: Get strings from X-axis in case grid is of type GRID_CHARXY */
794
size_t  gridInqXCvals(int gridID, char *xcvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
795

Uwe Schulzweida's avatar
Uwe Schulzweida committed
796
/*      gridDefYvals: Define the values of a Y-axis */
797
void    gridDefYvals(int gridID, const double yvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
798
799

/*      gridInqYvals: Get all values of a Y-axis */
800
size_t  gridInqYvals(int gridID, double yvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
801

Uwe Schulzweida's avatar
Uwe Schulzweida committed
802
803
804
805
/*      gridInqYIsc: Find out whether Y-coordinate is of type CHAR */
int     gridInqYIsc(int gridID);

/*      gridInqYCvals: Get strings from Y-axis in case grid is of type GRID_CHARXY */
806
size_t  gridInqYCvals(int gridID, char *ycvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
807

808
/* CDI grid string key values */
809
810
811
812
813
814
815
816
817
#define  CDI_KEY_XNAME       901  // X-axis name
#define  CDI_KEY_XDIMNAME    902  // X-axis dimension name
#define  CDI_KEY_XLONGNAME   903  // X-axis longname
#define  CDI_KEY_XUNITS      904  // X-axis units
#define  CDI_KEY_YNAME       911  // Y-axis name
#define  CDI_KEY_YDIMNAME    912  // Y-axis dimension name
#define  CDI_KEY_YLONGNAME   913  // Y-axis longname
#define  CDI_KEY_YUNITS      914  // Y-axis units
#define  CDI_KEY_VDIMNAME    920  // Vertex dimension name
818
819
#define  CDI_KEY_MAPPING     921  // Grid mapping var name
#define  CDI_KEY_MAPNAME     922  // Grid mapping name
820
821
822
823
824
825

/* CDI zaxis string key values */
#define  CDI_KEY_NAME        941  // Z-axis name
#define  CDI_KEY_DIMNAME     942  // Z-axis dimension name
#define  CDI_KEY_LONGNAME    943  // Z-axis longname
#define  CDI_KEY_UNITS       944  // Z-axis units
826
#define  CDI_KEY_PSNAME      950  // Z-axis surface pressure name
827
828
#define  CDI_KEY_P0NAME      951  // Z-axis reference pressure name
#define  CDI_KEY_P0VALUE     952  // Z-axis reference pressure in Pa
829

830
831
//      cdiGridDefKeyStr: Define a CDI grid string value from a key
int     cdiGridDefKeyStr(int gridID, int key, int size, const char *mesg);
832

833
834
//      cdiGridInqKeyStr: Get a CDI grid string value from a key
int     cdiGridInqKeyStr(int gridID, int key, int size, char *mesg);
835

836
837
838
839
840
841
//      cdiZaxisDefKeyFlt: Define a CDI Z-axis floating point value from a key
int     cdiZaxisDefKeyFlt(int zaxisID, int key, double value);

//      cdiZaxisInqKeyFlt: Get a CDI Z-axis floating point value from a key
int     cdiZaxisInqKeyFlt(int zaxisID, int key, double *value);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
842
/*      gridDefXname: Define the name of a X-axis */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
843
void    gridDefXname(int gridID, const char *xname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
844

Uwe Schulzweida's avatar
Uwe Schulzweida committed
845
846
847
/*      gridInqXname: Get the name of a X-axis */
void    gridInqXname(int gridID, char *xname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
848
/*      gridDefXlongname: Define the longname of a X-axis  */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
849
void    gridDefXlongname(int gridID, const char *xlongname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
850

Uwe Schulzweida's avatar
Uwe Schulzweida committed
851
852
853
/*      gridInqXlongname: Get the longname of a X-axis */
void    gridInqXlongname(int gridID, char *xlongname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
854
/*      gridDefXunits: Define the units of a X-axis */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
855
void    gridDefXunits(int gridID, const char *xunits);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
856

Uwe Schulzweida's avatar
Uwe Schulzweida committed
857
858
859
/*      gridInqXunits: Get the units of a X-axis */
void    gridInqXunits(int gridID, char *xunits);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
860
/*      gridDefYname: Define the name of a Y-axis */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
861
void    gridDefYname(int gridID, const char *yname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
862

Uwe Schulzweida's avatar
Uwe Schulzweida committed
863
864
865
/*      gridInqYname: Get the name of a Y-axis */
void    gridInqYname(int gridID, char *yname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
866
/*      gridDefYlongname: Define the longname of a Y-axis */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
867
void    gridDefYlongname(int gridID, const char *ylongname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
868

Uwe Schulzweida's avatar
Uwe Schulzweida committed
869
870
871
/*      gridInqYlongname: Get the longname of a Y-axis */
void    gridInqYlongname(int gridID, char *ylongname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
872
/*      gridDefYunits: Define the units of a Y-axis */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
873
void    gridDefYunits(int gridID, const char *yunits);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
874

Uwe Schulzweida's avatar
Uwe Schulzweida committed
875
876
/*      gridInqYunits: Get the units of a Y-axis */
void    gridInqYunits(int gridID, char *yunits);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
877
878
879
880
881
882
883
884
885
886
887
888
889
890

/*      gridInqXstdname: Get the standard name of a X-axis */
void    gridInqXstdname(int gridID, char *xstdname);

/*      gridInqYstdname: Get the standard name of a Y-axis */
void    gridInqYstdname(int gridID, char *ystdname);

/*      gridDefPrec: Define the precision of a Grid */
void    gridDefPrec(int gridID, int prec);

/*      gridInqPrec: Get the precision of a Grid */
int     gridInqPrec(int gridID);

/*      gridInqXval: Get one value of a X-axis */
891
double  gridInqXval(int gridID, size_t index);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
892
893

/*      gridInqYval: Get one value of a Y-axis */
894
double  gridInqYval(int gridID, size_t index);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
895
896
897

double  gridInqXinc(int gridID);
double  gridInqYinc(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
898

899
int     gridIsCircular(int gridID);
900

Uwe Schulzweida's avatar
Uwe Schulzweida committed
901
int     gridInqTrunc(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
902
void    gridDefTrunc(int gridID, int trunc);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
903

904
905
906
/* Reference of an unstructured grid */

/*      gridDefNumber: Define the reference number for an unstructured grid */
907
void    gridDefNumber(int gridID, int number);
908
909
910
911
912

/*      gridInqNumber: Get the reference number to an unstructured grid */
int     gridInqNumber(int gridID);

/*      gridDefPosition: Define the position of grid in the reference file */
913
void    gridDefPosition(int gridID, int position);
914
915
916
917
918

/*      gridInqPosition: Get the position of grid in the reference file */
int     gridInqPosition(int gridID);

/*      gridDefReference: Define the reference URI for an unstructured grid */
919
void    gridDefReference(int gridID, const char *reference);
920
921
922
923
924

/*      gridInqReference: Get the reference URI to an unstructured grid */
int     gridInqReference(int gridID, char *reference);

/*      gridDefUUID: Define the UUID of an unstructured grid */
925
#ifdef __cplusplus
926
void    gridDefUUID(int gridID, const unsigned char *uuid);
927
928
929
#else
void    gridDefUUID(int gridID, const unsigned char uuid[CDI_UUID_SIZE]);
#endif
930

931
/*      gridInqUUID: Get the UUID of an unstructured grid */
Thomas Jahns's avatar
Thomas Jahns committed
932
#ifdef __cplusplus
933
void    gridInqUUID(int gridID, unsigned char *uuid);
Thomas Jahns's avatar
Thomas Jahns committed
934
935
936
#else
void    gridInqUUID(int gridID, unsigned char uuid[CDI_UUID_SIZE]);
#endif
937

938
939
/* Rotated Lon/Lat grid */
void    gridDefParamRLL(int gridID, double xpole, double ypole, double angle);
940
941
942
943
944
void    gridInqParamRLL(int gridID, double *xpole, double *ypole, double *angle);

/* Hexagonal GME grid */
void    gridDefParamGME(int gridID, int nd, int ni, int ni2, int ni3);
void    gridInqParamGME(int gridID, int *nd, int *ni, int *ni2, int *ni3);
945

946
  /* Lambert Conformal Conic grid (GRIB version) */
947
void gridDefParamLCC(int gridID, double missval, double lon_0, double lat_0, double lat_1, double lat_2, double a, double rf, double xval_0, double yval_0, double x_0, double y_0);
948
int gridInqParamLCC(int gridID, double missval, double *lon_0, double *lat_0, double *lat_1, double *lat_2, double *a, double *rf, double *xval_0, double *yval_0, double *x_0, double *y_0);
949

950
951
void    gridDefArea(int gridID, const double area[]);
void    gridInqArea(int gridID, double area[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
952
953
954
955
956
957
958
959
960
int     gridHasArea(int gridID);

/*      gridDefNvertex: Define the number of vertex of a Gridbox */
void    gridDefNvertex(int gridID, int nvertex);

/*      gridInqNvertex: Get the number of vertex of a Gridbox */
int     gridInqNvertex(int gridID);

/*      gridDefXbounds: Define the bounds of a X-axis */
961
void    gridDefXbounds(int gridID, const double xbounds[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
962
963

/*      gridInqXbounds: Get the bounds of a X-axis */
964
size_t  gridInqXbounds(int gridID, double xbounds[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
965
966

/*      gridDefYbounds: Define the bounds of a Y-axis */
967
void    gridDefYbounds(int gridID, const double ybounds[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
968
969

/*      gridInqYbounds: Get the bounds of a Y-axis */
970
size_t  gridInqYbounds(int gridID, double ybounds[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
971

972
973
void    gridDefRowlon(int gridID, int nrowlon, const int rowlon[]);
void    gridInqRowlon(int gridID, int rowlon[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
974
975
void    gridChangeType(int gridID, int gridtype);

976
977
978
void    gridDefComplexPacking(int gridID, int lpack);
int     gridInqComplexPacking(int gridID);

979
void    gridDefUvRelativeToGrid(int gridID, int uvRelativeToGrid);
980
981
int     gridInqUvRelativeToGrid(int gridID);

982
983
984
void    gridDefScanningMode(int gridID, int mode);
int     gridInqScanningMode(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
985
986
/* ZAXIS routines */

987
void    zaxisName(int zaxistype, char *zaxisname);
988
const char *zaxisNamePtr(int leveltype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
989

990
/*      zaxisCreate: Create a vertical Z-axis */
991
int     zaxisCreate(int zaxistype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
992

993
994
995
/*      zaxisDestroy: Destroy a vertical Z-axis */
void    zaxisDestroy(int zaxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
996
997
998
999
1000
1001
1002
1003
1004
/*      zaxisInqType: Get the type of a Z-axis */
int     zaxisInqType(int zaxisID);

/*      zaxisInqSize: Get the size of a Z-axis */
int     zaxisInqSize(int zaxisID);

/*      zaxisDuplicate: Duplicate a Z-axis */
int     zaxisDuplicate(int zaxisID);

1005
void    zaxisPrint(int zaxisID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1006
1007

/*      zaxisDefLevels: Define the levels of a Z-axis */
1008
void    zaxisDefLevels(int zaxisID, const double levels[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1009

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1010
/*      zaxisDefCvals: Define area types of a Z-axis */
1011
void    zaxisDefCvals(int zaxisID, const char *cvals[], size_t clength);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1012

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1013
/*      zaxisInqLevels: Get all levels of a Z-axis */
1014
int     zaxisInqLevels(int zaxisID, double levels[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1015

1016
1017
1018
/*      zaxisInqCLen: Get maximal string length of character Z-axis */
int     zaxisInqCLen(int zaxisID);

1019
1020
/*      zaxisInqCVals: Get all string values of a character Z-axis */
int     zaxisInqCVals(int zaxisID, char ***clevels);
1021

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1022
1023
1024
1025
1026
1027
/*      zaxisDefLevel: Define one level of a Z-axis */
void    zaxisDefLevel(int zaxisID, int levelID, double levels);

/*      zaxisInqLevel: Get one level of a Z-axis */
double  zaxisInqLevel(int zaxisID, int levelID);

1028
1029
1030
1031
1032
1033
/*      zaxisDefNlevRef: Define the number of half levels of a generalized Z-axis */
void    zaxisDefNlevRef(int gridID, int nhlev);

/*      zaxisInqNlevRef: Get the number of half levels of a generalized Z-axis */
int     zaxisInqNlevRef(int gridID);

1034
/*      zaxisDefNumber: Define the reference number for a generalized Z-axis */
1035
void    zaxisDefNumber(int gridID, int number);
1036

1037
/*      zaxisInqNumber: Get the reference number to a generalized Z-axis */
1038
int     zaxisInqNumber(int gridID);
1039

1040
/*      zaxisDefUUID: Define the UUID of a generalized Z-axis */
1041
void    zaxisDefUUID(int zaxisID, const unsigned char uuid[CDI_UUID_SIZE]);
1042

1043
/*      zaxisInqUUID: Get the UUID of a generalized Z-axis */
1044
void    zaxisInqUUID(int zaxisID, unsigned char uuid[CDI_UUID_SIZE]);
1045

1046
1047
//      cdiZaxisDefKeyStr: Define a CDI Z-axis string value from a key
int     cdiZaxisDefKeyStr(int zaxisID, int key, int size, const char *mesg);
1048

1049
1050
//      cdiZaxisInqKeyStr: Get a CDI Z-axis string value from a key
int     cdiZaxisInqKeyStr(int zaxisID, int key, int size, char *mesg);
1051

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1052
/*      zaxisDefName: Define the name of a Z-axis */
1053
void    zaxisDefName(int zaxisID, const char *name_optional);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1054
1055
1056
1057

/*      zaxisInqName: Get the name of a Z-axis */
void    zaxisInqName(int zaxisID, char *name);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1058
/*      zaxisDefLongname: Define the longname of a Z-axis */
1059
void    zaxisDefLongname(int zaxisID, const char *longname_optional);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1060

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1061
1062
1063
/*      zaxisInqLongname: Get the longname of a Z-axis */
void    zaxisInqLongname(int zaxisID, char *longname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1064
/*      zaxisDefUnits: Define the units of a Z-axis */
1065
void    zaxisDefUnits(int zaxisID, const char *units_optional);
Deike Kleberg's avatar
Deike Kleberg committed
1066

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1067
1068
1069
/*      zaxisInqUnits: Get the units of a Z-axis */
void    zaxisInqUnits(int zaxisID, char *units);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1070
1071
1072
/*      zaxisInqStdname: Get the standard name of a Z-axis */
void    zaxisInqStdname(int zaxisID, char *stdname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1073
1074
void    zaxisDefPrec(int zaxisID, int prec);
int     zaxisInqPrec(int zaxisID);
1075

1076
void    zaxisDefPositive(int zaxisID, int positive);
Deike Kleberg's avatar
Deike Kleberg committed
1077
1078
int     zaxisInqPositive(