cdi.h 50.9 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
39
40
41
42
43
#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
#define  CDI_EUFTYPE              -21   // Unsupported file type
#define  CDI_ELIBNAVAIL           -22   // xxx library not available
#define  CDI_EUFSTRUCT            -23   // Unsupported file structure
#define  CDI_EUNC4                -24   // Unsupported NetCDF4 structure
#define  CDI_ELIMIT               -99   // Internal limits exceeded
Uwe Schulzweida's avatar
Uwe Schulzweida committed
44
45
46

/* File types */

47
48
49
50
51
52
53
54
55
56
#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

57
58
59
60
61
62
63
64
65
#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
66

67
68
/* Compress types */

69
70
71
72
73
74
#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
75

76
/* external data types */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
77

78
79
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
#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
Uwe Schulzweida's avatar
Uwe Schulzweida committed
121

122
/* internal data types */
123
124
125
126
127
128
#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
129

130
131
/* Chunks */

132
133
134
#define  CDI_CHUNK_AUTO             1  /* use default chunk size                                */
#define  CDI_CHUNK_GRID             2
#define  CDI_CHUNK_LINES            3
135

Uwe Schulzweida's avatar
Uwe Schulzweida committed
136
137
/* GRID types */

138
139
140
141
142
143
144
145
146
147
148
#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)                        */
149
#define  GRID_PROJECTION           12  /* Projected coordinates                                 */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
150

151
152
153
#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                          */
154
#define  CDI_PROJ_SINU             24  /* Sinusoidal                                            */
155

Uwe Schulzweida's avatar
Uwe Schulzweida committed
156
157
/* ZAXIS types */

158
159
160
161
162
#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                     */
163
#define  ZAXIS_HEIGHT               5  /* Height above ground                                   */
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
#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
184

185
186
187
188
/* SUBTYPE types */

enum {
  SUBTYPE_TILES                         = 0  /* Tiles variable                                  */
189
};
190
191
192
193

#define MAX_KV_PAIRS_MATCH 10

/* Data structure defining a key-value search, possibly with multiple
194
   key-value pairs in combination.
195
196
197
198
199
200
201
202
203
204

   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;



205
206
/* TIME types */

207
208
#define  TIME_CONSTANT              0  /* obsolate, use TSTEP_CONSTANT                          */
#define  TIME_VARIABLE              1  /* obsolate, use TSTEP_INSTANT                           */
209
210
211

/* TSTEP types */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
212
213
214
215
216
217
218
219
220
221
222
223
224
225
#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
226

Uwe Schulzweida's avatar
Uwe Schulzweida committed
227
228
229
230
/* TAXIS types */

#define  TAXIS_ABSOLUTE           1
#define  TAXIS_RELATIVE           2
231
#define  TAXIS_FORECAST           3
Uwe Schulzweida's avatar
Uwe Schulzweida committed
232
233
234
235
236

/* TUNIT types */

#define  TUNIT_SECOND             1
#define  TUNIT_MINUTE             2
237
238
239
240
241
242
243
244
245
#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
246
247
248

/* CALENDAR types */

249
#define  CALENDAR_STANDARD        0  /* don't change this value (used also in cgribexlib)! */
250
#define  CALENDAR_PROLEPTIC       1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
251
252
253
#define  CALENDAR_360DAYS         2
#define  CALENDAR_365DAYS         3
#define  CALENDAR_366DAYS         4
254
#define  CALENDAR_NONE            5
Uwe Schulzweida's avatar
Uwe Schulzweida committed
255

256
257
/* number of unsigned char needed to store UUID */
#define  CDI_UUID_SIZE           16
258

259
260
/* Structs that are used to return data to the user */

261
typedef struct CdiParam { int discipline; int category; int number; } CdiParam;
262
263
264
265
266
267


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

268
269
270
/* CDI control routines */

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

272
const char *cdiStringError(int cdiErrno);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
273
274
275

void    cdiDebug(int debug);

276
const char *cdiLibraryVersion(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
277
278
void    cdiPrintVersion(void);

279
280
int     cdiHaveFiletype(int filetype);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
281
282
void    cdiDefMissval(double missval);
double  cdiInqMissval(void);
283
void    cdiDefGlobal(const char *string, int val);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
284

285
int     namespaceNew(void);
286
void    namespaceSetActive(int namespaceID);
287
int     namespaceGetActive(void);
288
289
290
void    namespaceDelete(int namespaceID);


Uwe Schulzweida's avatar
Uwe Schulzweida committed
291
292
/* CDI converter routines */

293
294
295
/* parameter */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
297
298
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
299
300

/* date format:  YYYYMMDD */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
301
/* time format:    hhmmss */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
302
303
304
305
306
307
308
309

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
310
311
/* STREAM control routines */

312
313
int     cdiGetFiletype(const char *path, int *byteorder);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
314
315
/*      streamOpenRead: Open a dataset for reading */
int     streamOpenRead(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
316

Uwe Schulzweida's avatar
Uwe Schulzweida committed
317
318
/*      streamOpenWrite: Create a new dataset */
int     streamOpenWrite(const char *path, int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
319

Uwe Schulzweida's avatar
Uwe Schulzweida committed
320
int     streamOpenAppend(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
321

Uwe Schulzweida's avatar
Uwe Schulzweida committed
322
/*      streamClose: Close an open dataset */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
323
324
void    streamClose(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
325
326
327
/*      streamSync: Synchronize an Open Dataset to Disk */
void    streamSync(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
328
329
330
331
332
333
/*      streamDefVlist: Define the Vlist for a stream */
void    streamDefVlist(int streamID, int vlistID);

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

334
/*      streamInqFiletype: Get the filetype */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
335
int     streamInqFiletype(int streamID);
336

337
/*      streamDefByteorder: Define the byteorder */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
338
void    streamDefByteorder(int streamID, int byteorder);
339
340

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

Deike Kleberg's avatar
Deike Kleberg committed
343
344
/*      streamDefCompType: Define compression type */
void    streamDefCompType(int streamID, int comptype);
345

Deike Kleberg's avatar
Deike Kleberg committed
346
347
/*      streamInqCompType: Get compression type */
int     streamInqCompType(int streamID);
348

Uwe Schulzweida's avatar
Uwe Schulzweida committed
349
350
351
/*      streamDefCompLevel: Define compression level */
void    streamDefCompLevel(int streamID, int complevel);

Deike Kleberg's avatar
Deike Kleberg committed
352
353
/*      streamInqCompLevel: Get compression level */
int     streamInqCompLevel(int streamID);
354

355
/*      streamDefTimestep: Define time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
356
int     streamDefTimestep(int streamID, int tsID);
357
358

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
361
362
363
/*      PIO: query currently set timestep id  */
int     streamInqCurTimestepID(int streamID);

364
365
const char *streamFilename(int streamID);
const char *streamFilesuffix(int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
366

Uwe Schulzweida's avatar
Uwe Schulzweida committed
367
off_t   streamNvals(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
368

369
int     streamInqNvars(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
370

371
/* STREAM var I/O routines (random access) */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
372
373

/*      streamWriteVar: Write a variable */
374
375
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
376

Uwe Schulzweida's avatar
Uwe Schulzweida committed
377
/*      streamReadVar: Read a variable */
378
379
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
380
381

/*      streamWriteVarSlice: Write a horizontal slice of a variable */
382
383
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
384

Uwe Schulzweida's avatar
Uwe Schulzweida committed
385
/*      streamReadVarSlice: Read a horizontal slice of a variable */
386
387
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
388

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
391

392
/* STREAM record I/O routines (sequential access) */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
393
394

void    streamDefRecord(int streamID, int  varID, int  levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
395
void    streamInqRecord(int streamID, int *varID, int *levelID);
396
397
398
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);
399
void    streamReadRecordF(int streamID, float data[], int *nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
400
401
void    streamCopyRecord(int streamIDdest, int streamIDsrc);

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

404
405
406
407

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

//Creation & Destruction
408
409
410
411
412
413
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);
414
415

//Advancing an iterator
416
int cdiIterator_nextField(CdiIterator *me);      //Points the iterator at the next field, returns CDI_EEOF if there are no more fields in the file.
417
418
419

//Introspecting metadata
//All outXXX arguments to these functions may be NULL.
420
421
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.
422
char *cdiIterator_inqRTime(CdiIterator *me);      //Returns the reference date as an ISO-8601 coded string. The caller is responsible to Free() the returned string.
423
424
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
425
426
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.
427
428
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.
429
CdiParam cdiIterator_inqParam(CdiIterator *me);
430
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.
431
432
int cdiIterator_inqDatatype(CdiIterator *me);
int cdiIterator_inqTsteptype(CdiIterator *me);
433
char *cdiIterator_inqVariableName(CdiIterator *me);        //The caller is responsible to Free() the returned buffer.
434
int cdiIterator_inqGridId(CdiIterator *me);         //The returned id is only valid until the next call to cdiIteratorNextField().
435
436

//Reading data
437
438
void cdiIterator_readField(CdiIterator *me, double data[], size_t *nmiss_optional);
void cdiIterator_readFieldF(CdiIterator *me, float data[], size_t *nmiss_optional);
439
440
441
442
//TODO[NH]: Add functions to read partial fields.


//Direct access to grib fields
443
444
CdiGribIterator *cdiGribIterator_clone(CdiIterator *me);  //Returns NULL if the associated file is not a GRIB file.
void cdiGribIterator_delete(CdiGribIterator *me);
445
446

//Callthroughs to GRIB-API
447
448
449
450
451
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().
452
int cdiGribIterator_getLongArray(CdiGribIterator *me, const char *key, long *value, size_t *array_size);       //Same semantics as grib_get_long_array().
453
int cdiGribIterator_getDoubleArray(CdiGribIterator *me, const char *key, double *value, size_t *array_size);       //Same semantics as grib_get_double_array().
454
455

//Convenience functions for accessing GRIB-API keys
456
457
458
459
460
461
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.
462

Uwe Schulzweida's avatar
Uwe Schulzweida committed
463
464
/* VLIST routines */

465
466
/*      vlistCreate: Create a variable list */
int     vlistCreate(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
467

468
/*      vlistDestroy: Destroy a variable list */
469
void    vlistDestroy(int vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489

/*      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
490
491
492
/*      vlistNumber: Number type in a variable list */
int     vlistNumber(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
493
494
495
496
497
498
499
500
501
/*      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);

502
503
504
/*      vlistNsubtypes: Number of subtypes in a variable list */
int     vlistNsubtypes(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
505
506
507
508
509
510
511
512
513
514
515
516
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);
517
518
int     vlistSubtype(int vlistID, int index);
int     vlistSubtypeIndex(int vlistID, int subtypeID);
519
520

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
526
527
528
529
530
531
532
533
534
535
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 */

536
/*      vlistDefVarTiles: Create a new tile-based variable */
537
538
539
int     vlistDefVarTiles(int vlistID, int gridID, int zaxisID, int tsteptype, int tilesetID);

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

542
void    vlistChangeVarGrid(int vlistID, int varID, int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
543
544
void    vlistChangeVarZaxis(int vlistID, int varID, int zaxisID);

545
void    vlistInqVar(int vlistID, int varID, int *gridID, int *zaxisID, int *tsteptype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
546
547
int     vlistInqVarGrid(int vlistID, int varID);
int     vlistInqVarZaxis(int vlistID, int varID);
548
549
550
551
552

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

void    vlistDefVarTsteptype(int vlistID, int varID, int tsteptype);
553
554

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

Deike Kleberg's avatar
Deike Kleberg committed
557
558
559
560
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);
561

562
563
564
565
566
567
/*      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
568
/*      vlistDefVarCode: Define the code number of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
569
570
void    vlistDefVarCode(int vlistID, int varID, int code);

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

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

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

580
581
582
void    vlistDefVarChunkType(int vlistID, int varID, int chunktype);
int     vlistInqVarChunkType(int vlistID, int varID);

583
584
585
void    vlistDefVarXYZ(int vlistID, int varID, int xyz);
int     vlistInqVarXYZ(int vlistID, int varID);

586
587
int     vlistInqVarNumber(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
588
589
590
591
592
593
594
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
595
/*      vlistDefVarName: Define the name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
596
597
void    vlistDefVarName(int vlistID, int varID, const char *name);

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

601
/*      vlistCopyVarName: Safe and convenient version of vlistInqVarName */
602
char   *vlistCopyVarName(int vlistId, int varId);
603

Uwe Schulzweida's avatar
Uwe Schulzweida committed
604
605
606
607
608
609
/*      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
610
/*      vlistDefVarLongname: Define the long name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
611
612
void    vlistDefVarLongname(int vlistID, int varID, const char *longname);

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

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

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

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

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

628
629
630
631
632
633
/*      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
634
635
636
637
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);
638

639
640
641
642
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);
643

644
645
646
void    vlistDefVarTypeOfGeneratingProcess(int vlistID, int varID, int typeOfGeneratingProcess);
int     vlistInqVarTypeOfGeneratingProcess(int vlistID, int varID);

647
648
649
void    vlistDefVarProductDefinitionTemplate(int vlistID, int varID, int productDefinitionTemplate);
int     vlistInqVarProductDefinitionTemplate(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
650
651
652
653
654
655
656
657
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);
658
659
int     vlistMergedVar(int vlistID, int varID);
int     vlistMergedLevel(int vlistID, int varID, int levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
660

661
662
663
/*     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
664

665
/* cdiClearAdditionalKeys: Clear the list of additional GRIB keys. */
Thomas Jahns's avatar
Thomas Jahns committed
666
void    cdiClearAdditionalKeys(void);
667
668
/* cdiDefAdditionalKey: Register an additional GRIB key which is read when file is opened. */
void    cdiDefAdditionalKey(const char *string);
669
670
671
672
673
674

/* 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);

675
/* vlistHasVarKey: returns 1 if meta-data key was read, 0 otherwise. */
676
int     vlistHasVarKey(int vlistID, int varID, const char *name);
677
/* vlistInqVarDblKey: raw access to GRIB meta-data */
678
double  vlistInqVarDblKey(int vlistID, int varID, const char *name);
679
/* vlistInqVarIntKey: raw access to GRIB meta-data */
680
int     vlistInqVarIntKey(int vlistID, int varID, const char *name);
681

682
683
684
685
/* needed only for CDO operator after */
const char *vlistInqVarNamePtr(int vlistID, int varID);
const char *vlistInqVarLongnamePtr(int vlistID, int varID);
const char *vlistInqVarUnitsPtr(int vlistID, int varID);
686

687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
/* 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);

/*      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);
708
709


Uwe Schulzweida's avatar
Uwe Schulzweida committed
710
711
712
/* GRID routines */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
715
716
void    gridCompress(int gridID);

717
718
void    gridDefMaskGME(int gridID, const int mask[]);
int     gridInqMaskGME(int gridID, int mask[]);
719

720
721
void    gridDefMask(int gridID, const int mask[]);
int     gridInqMask(int gridID, int mask[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
722

723
void    gridPrint(int gridID, int index, int opt);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
724

725
/*      gridCreate: Create a horizontal Grid */
726
int     gridCreate(int gridtype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
727

728
729
730
/*      gridDestroy: Destroy a horizontal Grid */
void    gridDestroy(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
731
732
733
/*      gridDuplicate: Duplicate a Grid */
int     gridDuplicate(int gridID);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
737
738
739
/*      gridInqProj: Get the projection ID of a Grid */
int     gridInqProj(int gridID);

740
741
742
/*      gridDefProjType: Define the projection type */
void    gridDefProjType(int gridID, int projtype);

743
744
745
/*      gridInqProjType: Get the projection type */
int     gridInqProjType(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
/*      gridInqType: Get the type of a Grid */
int     gridInqType(int gridID);

/*      gridInqSize: Get the size of a Grid */
int     gridInqSize(int gridID);

/*      gridDefXsize: Define the size of a X-axis */
void    gridDefXsize(int gridID, int xsize);

/*      gridInqXsize: Get the size of a X-axis */
int     gridInqXsize(int gridID);

/*      gridDefYsize: Define the size of a Y-axis */
void    gridDefYsize(int gridID, int ysize);

/*      gridInqYsize: Get the size of a Y-axis */
int     gridInqYsize(int gridID);

764
765
766
767
768
769
/*      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
770
/*      gridDefXvals: Define the values of a X-axis */
771
void    gridDefXvals(int gridID, const double xvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
772
773

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

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

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

782
/* CDI grid string key values */
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
#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
#define  CDI_KEY_MAPNAME     921  // Grid mapping var name
#define  CDI_KEY_MAPPING     922  // Grid mapping name

/* 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
800
#define  CDI_KEY_PSNAME      950  // Z-axis surface pressure name
801

802
803
//      cdiGridDefKeyStr: Define a CDI grid string value from a key
int     cdiGridDefKeyStr(int gridID, int key, int size, const char *mesg);
804

805
806
//      cdiGridInqKeyStr: Get a CDI grid string value from a key
int     cdiGridInqKeyStr(int gridID, int key, int size, char *mesg);
807

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

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

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

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

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

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

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

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

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

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
841
842
/*      gridInqYunits: Get the units of a Y-axis */
void    gridInqYunits(int gridID, char *yunits);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863

/*      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 */
double  gridInqXval(int gridID, int index);

/*      gridInqYval: Get one value of a Y-axis */
double  gridInqYval(int gridID, int index);

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

865
int     gridIsCircular(int gridID);
866

Uwe Schulzweida's avatar
Uwe Schulzweida committed
867
int     gridInqTrunc(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
868
void    gridDefTrunc(int gridID, int trunc);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
869

870
871
872
/* Reference of an unstructured grid */

/*      gridDefNumber: Define the reference number for an unstructured grid */
873
void    gridDefNumber(int gridID, int number);
874
875
876
877
878

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

/*      gridDefPosition: Define the position of grid in the reference file */
879
void    gridDefPosition(int gridID, int position);
880
881
882
883
884

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

/*      gridDefReference: Define the reference URI for an unstructured grid */
885
void    gridDefReference(int gridID, const char *reference);
886
887
888
889
890

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

/*      gridDefUUID: Define the UUID of an unstructured grid */
891
#ifdef __cplusplus
892
void    gridDefUUID(int gridID, const unsigned char *uuid);
893
894
895
#else
void    gridDefUUID(int gridID, const unsigned char uuid[CDI_UUID_SIZE]);
#endif
896

897
/*      gridInqUUID: Get the UUID of an unstructured grid */
Thomas Jahns's avatar
Thomas Jahns committed
898
#ifdef __cplusplus
899
void    gridInqUUID(int gridID, unsigned char *uuid);
Thomas Jahns's avatar
Thomas Jahns committed
900
901
902
#else
void    gridInqUUID(int gridID, unsigned char uuid[CDI_UUID_SIZE]);
#endif
903

904
905
/* Rotated Lon/Lat grid */
void    gridDefParamRLL(int gridID, double xpole, double ypole, double angle);
906
907
908
909
910
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);
911

912
  /* Lambert Conformal Conic grid (GRIB version) */
913
914
void    gridDefParamLCC(int gridID, double originLon, double originLat, double lonParY, double lat1, double lat2, double xinc, double yinc, int projflag, int scanflag);
void    gridInqParamLCC(int gridID, double *originLon, double *originLat, double *lonParY, double *lat1, double *lat2, double *xinc, double *yinc, int *projflag, int *scanflag);
915

916
917
void    gridDefArea(int gridID, const double area[]);
void    gridInqArea(int gridID, double area[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
918
919
920
921
922
923
924
925
926
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 */
927
void    gridDefXbounds(int gridID, const double xbounds[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
928
929

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

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

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

938
939
void    gridDefRowlon(int gridID, int nrowlon, const int rowlon[]);
void    gridInqRowlon(int gridID, int rowlon[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
940
941
void    gridChangeType(int gridID, int gridtype);

942
943
944
void    gridDefComplexPacking(int gridID, int lpack);
int     gridInqComplexPacking(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
945
946
/* ZAXIS routines */

947
void    zaxisName(int zaxistype, char *zaxisname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
948

949
/*      zaxisCreate: Create a vertical Z-axis */
950
int     zaxisCreate(int zaxistype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
951

952
953
954
/*      zaxisDestroy: Destroy a vertical Z-axis */
void    zaxisDestroy(int zaxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
955
956
957
958
959
960
961
962
963
/*      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);

964
void    zaxisPrint(int zaxisID, int index);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
965
966

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

/*      zaxisInqLevels: Get all levels of a Z-axis */
970
int     zaxisInqLevels(int zaxisID, double levels[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
971
972
973
974
975
976
977

/*      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);

978
979
980
981
982
983
/*      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);

984
/*      zaxisDefNumber: Define the reference number for a generalized Z-axis */
985
void    zaxisDefNumber(int gridID, int number);
986

987
/*      zaxisInqNumber: Get the reference number to a generalized Z-axis */
988
int     zaxisInqNumber(int gridID);
989

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

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

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

999
1000
//      cdiZaxisInqKeyStr: Get a CDI Z-axis string value from a key
int     cdiZaxisInqKeyStr(int zaxisID, int key, int size, char *mesg);
1001

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1002
/*      zaxisDefName: Define the name of a Z-axis */
1003
void    zaxisDefName(int zaxisID, const char *name_optional);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1004
1005
1006
1007

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

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

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

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

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1023
1024
void    zaxisDefPrec(int zaxisID, int prec);
int     zaxisInqPrec(int zaxisID);
1025

1026
void    zaxisDefPositive(int zaxisID, int positive);
Deike Kleberg's avatar
Deike Kleberg committed
1027
1028
int     zaxisInqPositive(int zaxisID);

1029
1030
1031
void    zaxisDefScalar(int zaxisID);
int     zaxisInqScalar(int zaxisID);

1032
1033
1034
void    zaxisDefLtype(int zaxisID, int ltype);
int     zaxisInqLtype(int zaxisID);

1035
1036
void    zaxisDefVct(int zaxisID, int size, const double vct[]);
void    zaxisInqVct(int zaxisID, double vct[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1037
1038
int     zaxisInqVctSize(int zaxisID);
const double *zaxisInqVctPtr(int zaxisID);
1039
void    zaxisDefLbounds(int zaxisID, const double lbounds[]);
1040
int     zaxisInqLbounds(int zaxisID, double lbounds_optional[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1041
double  zaxisInqLbound(int zaxisID, int index);
1042
void    zaxisDefUbounds(int zaxisID, const double ubounds[]);
1043
int     zaxisInqUbounds(int zaxisID, double ubounds_optional[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1044
double  zaxisInqUbound(int zaxisID, int index);
1045
void    zaxisDefWeights(int zaxisID, const double weights[]);
1046
int     zaxisInqWeights(int zaxisID, double weights_optional[]);
1047
void    zaxisChangeType(int zaxisID, int zaxistype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1048
1049
1050

/* TAXIS routines */

1051
/*      taxisCreate: Create a Time axis */
1052
int     taxisCreate(int timetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1053

1054
1055
1056
/*      taxisDestroy: Destroy a Time axis */
void    taxisDestroy(int taxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
int     taxisDuplicate(int taxisID);

void    taxisCopyTimestep(int taxisIDdes, int taxisIDsrc);

void    taxisDefType(int taxisID, int type);

/*      taxisDefVdate: Define the verification date */
void    taxisDefVdate(int taxisID, int date);

/*      taxisDefVtime: Define the verification time */
void    taxisDefVtime(int taxisID, int time);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1069
1070
1071
1072
1073
1074
/*      taxisInqVdate: Get the verification date */
int     taxisInqVdate(int taxisID);

/*      taxisInqVtime: Get the verification time */
int     taxisInqVtime(int taxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1075
1076
1077
/*      taxisDefRdate: Define the reference date */
void    taxisDefRdate(int taxisID, int date);

1078
/*      taxisDefRtime: Define the reference time */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1079
1080
void    taxisDefRtime(int taxisID, int time);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1081
1082
1083
1084
1085
1086
/*      taxisInqRdate: Get the reference date */
int     taxisInqRdate(int taxisID);

/*      taxisInqRtime: Get the reference time */
int     taxisInqRtime(int taxisID);

1087
1088
1089
1090
1091
1092
/*      taxisDefFdate: Define the forecast reference date */
void    taxisDefFdate(int taxisID, int date);

/*      taxisDefFtime: Define the forecast reference time */
void    taxisDefFtime(int taxisID, int time);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1093
1094
1095
1096
1097
1098
/*      taxisInqFdate: Get the forecast reference date */
int     taxisInqFdate(int taxisID);

/*      taxisInqFtime: Get the forecast reference time */
int     taxisInqFtime(int taxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1099
int     taxisHasBounds(int taxisID);
1100
1101

void    taxisDeleteBounds(int taxisID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1102

1103
1104
1105
1106
void    taxisDefVdateBounds(int taxisID, int vdate_lb, int vdate_ub);

void    taxisDefVtimeBounds(int taxisID, int vtime_lb, int vtime_ub);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1107
1108
1109
1110
void    taxisInqVdateBounds(int taxisID, int *vdate_lb, int *vdate_ub);

void    taxisInqVtimeBounds(int taxisID, int *vtime_lb, int *vtime_ub);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1111