cdi.h 53 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>
11
#include <stdint.h>    // int64_t
Uwe Schulzweida's avatar
Uwe Schulzweida committed
12
#include <sys/types.h>
13

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


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

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

24
25
/* Byte order */

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

30
31
32
#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
33

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

36
37
#define	 CDI_NOERR        	    0   // No Error
#define  CDI_EEOF                  -1   // The end of file was encountered
38
#define  CDI_ETMOF                 -9   // Too many open files
39
40
#define  CDI_ESYSTEM              -10   // Operating system error
#define  CDI_EINVAL               -20   // Invalid argument
41
42
43
44
45
46
47
#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
48
#define  CDI_ELIMIT               -99   // Internal limits exceeded
Uwe Schulzweida's avatar
Uwe Schulzweida committed
49
50
51

/* File types */

52
53
54
#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
Uwe Schulzweida's avatar
Uwe Schulzweida committed
55
#define  CDI_FILETYPE_NC2           4   // File type NetCDF version 2 (64-bit offset)
56
57
#define  CDI_FILETYPE_NC4           5   // File type NetCDF version 4
#define  CDI_FILETYPE_NC4C          6   // File type NetCDF version 4 (classic)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
58
59
60
61
#define  CDI_FILETYPE_NC5           7   // File type NetCDF version 5 (64-bit data)
#define  CDI_FILETYPE_SRV           8   // File type SERVICE
#define  CDI_FILETYPE_EXT           9   // File type EXTRA
#define  CDI_FILETYPE_IEG          10   // File type IEG
62

63
64
/* Compress types */

65
66
#define  CDI_COMPRESS_NONE          0
#define  CDI_COMPRESS_SZIP          1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
67
68
69
#define  CDI_COMPRESS_AEC           2
#define  CDI_COMPRESS_ZIP           3
#define  CDI_COMPRESS_JPEG          4
70

71
/* external data types */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
72

73
74
75
76
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
121
122
123
#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
124

125
/* internal data types */
126
127
128
129
130
131
#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
132
#define  CDI_DATATYPE_UINT        257
133
134
135
136
137
138
139

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

141
142
/* Chunks */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
143
#define  CDI_CHUNK_AUTO             1  // use default chunk size
144
145
#define  CDI_CHUNK_GRID             2
#define  CDI_CHUNK_LINES            3
146

Uwe Schulzweida's avatar
Uwe Schulzweida committed
147
148
/* GRID types */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
149
150
151
152
153
154
155
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_PROJECTION           12  // Projected coordinates
#define  GRID_CHARXY               13  // One horizontal character dimension

#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
#define  CDI_PROJ_SINU             24  // Sinusoidal
#define  CDI_PROJ_STERE            25  // Polar stereographic
167

Uwe Schulzweida's avatar
Uwe Schulzweida committed
168
169
/* ZAXIS types */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
#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
#define  ZAXIS_HEIGHT               5  // Height above ground
#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
#define  ZAXIS_CHAR                26  // Area types
Uwe Schulzweida's avatar
Uwe Schulzweida committed
197

198
199
200
/* SUBTYPE types */

enum {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
201
  SUBTYPE_TILES                   = 0  // Tiles variable
202
};
203
204
205
206

#define MAX_KV_PAIRS_MATCH 10

/* Data structure defining a key-value search, possibly with multiple
207
   key-value pairs in combination.
208
209
210
211
212
213
214
215
216
217

   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;



218
219
/* TIME types */

220
221
222
#define  TIME_CONSTANT              0  /* Time constant              */
#define  TIME_VARYING               1  /* Time varying               */
#define  TIME_VARIABLE              1  /* obsolate, use TIME_VARYING */
223
224
225

/* TSTEP types */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
226
227
228
229
230
231
232
233
234
235
236
237
238
#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
239

Uwe Schulzweida's avatar
Uwe Schulzweida committed
240
241
242
243
/* TAXIS types */

#define  TAXIS_ABSOLUTE           1
#define  TAXIS_RELATIVE           2
244
#define  TAXIS_FORECAST           3
Uwe Schulzweida's avatar
Uwe Schulzweida committed
245
246
247
248
249

/* TUNIT types */

#define  TUNIT_SECOND             1
#define  TUNIT_MINUTE             2
250
251
252
253
254
255
256
257
258
#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
259
260
261

/* CALENDAR types */

262
#define  CALENDAR_STANDARD        0  /* don't change this value (used also in cgribexlib)! */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
263
264
265
266
267
268
#define  CALENDAR_GREGORIAN       1
#define  CALENDAR_PROLEPTIC       2
#define  CALENDAR_360DAYS         3
#define  CALENDAR_365DAYS         4
#define  CALENDAR_366DAYS         5
#define  CALENDAR_NONE            6
Uwe Schulzweida's avatar
Uwe Schulzweida committed
269

270
271
/* number of unsigned char needed to store UUID */
#define  CDI_UUID_SIZE           16
272

273
274
/* Structs that are used to return data to the user */

275
typedef struct CdiParam { int discipline; int category; int number; } CdiParam;
276
277
278
279
280
281


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

282
283
284
/* CDI control routines */

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

286
const char *cdiStringError(int cdiErrno);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
287
288
289

void    cdiDebug(int debug);

290
const char *cdiLibraryVersion(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
291
292
void    cdiPrintVersion(void);

293
294
int     cdiHaveFiletype(int filetype);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
295
296
void    cdiDefMissval(double missval);
double  cdiInqMissval(void);
297
void    cdiDefGlobal(const char *string, int val);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
298

299
int     namespaceNew(void);
300
void    namespaceSetActive(int namespaceID);
301
int     namespaceGetActive(void);
302
303
304
void    namespaceDelete(int namespaceID);


Uwe Schulzweida's avatar
Uwe Schulzweida committed
305
306
/* CDI converter routines */

307
308
309
/* parameter */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
311
312
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
313
314

/* date format:  YYYYMMDD */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
315
/* time format:    hhmmss */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
316

317
318
void    cdiDecodeDate(int64_t date, int *year, int *month, int *day);
int64_t cdiEncodeDate(int year, int month, int day);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
319
320
321
322
323

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
324
325
/* STREAM control routines */

326
327
int     cdiGetFiletype(const char *path, int *byteorder);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
328
329
/*      streamOpenRead: Open a dataset for reading */
int     streamOpenRead(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
330

Uwe Schulzweida's avatar
Uwe Schulzweida committed
331
332
/*      streamOpenWrite: Create a new dataset */
int     streamOpenWrite(const char *path, int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
333

Uwe Schulzweida's avatar
Uwe Schulzweida committed
334
int     streamOpenAppend(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
335

Uwe Schulzweida's avatar
Uwe Schulzweida committed
336
/*      streamClose: Close an open dataset */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
337
338
void    streamClose(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
339
340
341
/*      streamSync: Synchronize an Open Dataset to Disk */
void    streamSync(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
342
343
344
345
346
347
/*      streamDefVlist: Define the Vlist for a stream */
void    streamDefVlist(int streamID, int vlistID);

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

348
/*      streamInqFiletype: Get the filetype */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
349
int     streamInqFiletype(int streamID);
350

351
/*      streamDefByteorder: Define the byteorder */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
352
void    streamDefByteorder(int streamID, int byteorder);
353
354

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

Deike Kleberg's avatar
Deike Kleberg committed
357
358
/*      streamDefCompType: Define compression type */
void    streamDefCompType(int streamID, int comptype);
359

Deike Kleberg's avatar
Deike Kleberg committed
360
361
/*      streamInqCompType: Get compression type */
int     streamInqCompType(int streamID);
362

Uwe Schulzweida's avatar
Uwe Schulzweida committed
363
364
365
/*      streamDefCompLevel: Define compression level */
void    streamDefCompLevel(int streamID, int complevel);

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

369
/*      streamDefTimestep: Define time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
370
int     streamDefTimestep(int streamID, int tsID);
371
372

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
375
376
377
/*      PIO: query currently set timestep id  */
int     streamInqCurTimestepID(int streamID);

378
379
const char *streamFilename(int streamID);
const char *streamFilesuffix(int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
380

381
size_t  streamNvals(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
382

383
int     streamInqNvars(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
384

385
/* STREAM var I/O routines (random access) */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
386
387

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
391
/*      streamReadVar: Read a variable */
392
393
void    streamReadVar(int streamID, int varID, double data[], size_t *nmiss);
void    streamReadVarF(int streamID, int varID, float data[], size_t *nmiss);
394
void    streamReadVarPart(int streamID, int varID, int varType, int start, size_t size, void *data, size_t *nmiss, int memtype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
395
396

/*      streamWriteVarSlice: Write a horizontal slice of a variable */
397
398
void    streamWriteVarSlice(int streamID, int varID, int levelID, const double data[], size_t nmiss);
void    streamWriteVarSliceF(int streamID, int varID, int levelID, const float data[], size_t nmiss);
399
void    streamReadVarSlicePart(int streamID, int varID, int levelID, int varType, int start, size_t size, void *data, size_t *nmiss, int memtype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
400

Uwe Schulzweida's avatar
Uwe Schulzweida committed
401
/*      streamReadVarSlice: Read a horizontal slice of a variable */
402
403
void    streamReadVarSlice(int streamID, int varID, int levelID, double data[], size_t *nmiss);
void    streamReadVarSliceF(int streamID, int varID, int levelID, float data[], size_t *nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
404

405
void    streamWriteVarChunk(int streamID, int varID, const int rect[3][2], const double data[], size_t nmiss);
406

Uwe Schulzweida's avatar
Uwe Schulzweida committed
407

408
/* STREAM record I/O routines (sequential access) */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
409
410

void    streamDefRecord(int streamID, int  varID, int  levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
411
void    streamInqRecord(int streamID, int *varID, int *levelID);
412
413
void    streamWriteRecord(int streamID, const double data[], size_t nmiss);
void    streamWriteRecordF(int streamID, const float data[], size_t nmiss);
414
415
void    streamReadRecord(int streamID, double data[], size_t *nmiss);
void    streamReadRecordF(int streamID, float data[], size_t *nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
416
417
void    streamCopyRecord(int streamIDdest, int streamIDsrc);

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

420
421
422
423

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

//Creation & Destruction
424
425
426
427
428
429
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);
430
431

//Advancing an iterator
432
int cdiIterator_nextField(CdiIterator *me);      //Points the iterator at the next field, returns CDI_EEOF if there are no more fields in the file.
433
434
435

//Introspecting metadata
//All outXXX arguments to these functions may be NULL.
436
437
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.
438
char *cdiIterator_inqRTime(CdiIterator *me);      //Returns the reference date as an ISO-8601 coded string. The caller is responsible to Free() the returned string.
439
440
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
441
442
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.
443
444
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.
445
CdiParam cdiIterator_inqParam(CdiIterator *me);
446
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.
447
int cdiIterator_inqDatatype(CdiIterator *me);
448
int cdiIterator_inqFiletype(CdiIterator *me);
449
int cdiIterator_inqTsteptype(CdiIterator *me);
450
char *cdiIterator_inqVariableName(CdiIterator *me);        //The caller is responsible to Free() the returned buffer.
451
int cdiIterator_inqGridId(CdiIterator *me);         //The returned id is only valid until the next call to cdiIteratorNextField().
452
453

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


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

//Callthroughs to GRIB-API
464
465
466
467
468
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().
469
int cdiGribIterator_getLongArray(CdiGribIterator *me, const char *key, long *value, size_t *array_size);       //Same semantics as grib_get_long_array().
470
int cdiGribIterator_getDoubleArray(CdiGribIterator *me, const char *key, double *value, size_t *array_size);       //Same semantics as grib_get_double_array().
471
472

//Convenience functions for accessing GRIB-API keys
473
474
475
476
477
478
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.
479

Uwe Schulzweida's avatar
Uwe Schulzweida committed
480
481
/* VLIST routines */

482
483
/*      vlistCreate: Create a variable list */
int     vlistCreate(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
484

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

/*      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
507
508
509
/*      vlistNumber: Number type in a variable list */
int     vlistNumber(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
510
511
512
513
514
515
516
517
518
/*      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);

519
520
521
/*      vlistNsubtypes: Number of subtypes in a variable list */
int     vlistNsubtypes(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
522
523
void    vlistDefNtsteps(int vlistID, int nts);
int     vlistNtsteps(int vlistID);
524
size_t  vlistGridsizeMax(int vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
525
526
527
528
529
530
531
532
533
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);
534
535
int     vlistSubtype(int vlistID, int index);
int     vlistSubtypeIndex(int vlistID, int subtypeID);
536
537

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
543
544
545
546
547
548
549
550
551
552
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 */

553
/*      vlistDefVarTiles: Create a new tile-based variable */
554
int     vlistDefVarTiles(int vlistID, int gridID, int zaxisID, int timetype, int tilesetID);
555
556

/*      vlistDefVar: Create a new variable */
557
int     vlistDefVar(int vlistID, int gridID, int zaxisID, int timetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
558

559
void    vlistChangeVarGrid(int vlistID, int varID, int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
560
561
void    vlistChangeVarZaxis(int vlistID, int varID, int zaxisID);

562
void    vlistInqVar(int vlistID, int varID, int *gridID, int *zaxisID, int *timetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
563
564
int     vlistInqVarGrid(int vlistID, int varID);
int     vlistInqVarZaxis(int vlistID, int varID);
565
566
567
568

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

569
void    vlistDefVarTimetype(int vlistID, int varID, int timetype);
570
571
int     vlistInqVarTimetype(int vlistID, int varID);

572
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
void    vlistDefVarTimave(int vlistID, int varID, int timave);
int     vlistInqVarTimave(int vlistID, int varID);
661

662
size_t  vlistInqVarSize(int vlistID, int varID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
663
664
665
666
667
668
669

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);
670
671
int     vlistMergedVar(int vlistID, int varID);
int     vlistMergedLevel(int vlistID, int varID, int levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
672

673
/* cdiClearAdditionalKeys: Clear the list of additional GRIB keys. */
Thomas Jahns's avatar
Thomas Jahns committed
674
void    cdiClearAdditionalKeys(void);
675
676
/* cdiDefAdditionalKey: Register an additional GRIB key which is read when file is opened. */
void    cdiDefAdditionalKey(const char *string);
677
678
679
680
681
682

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

683
/* vlistHasVarKey: returns 1 if meta-data key was read, 0 otherwise. */
684
int     vlistHasVarKey(int vlistID, int varID, const char *name);
685
/* vlistInqVarDblKey: raw access to GRIB meta-data */
686
double  vlistInqVarDblKey(int vlistID, int varID, const char *name);
687
/* vlistInqVarIntKey: raw access to GRIB meta-data */
688
int     vlistInqVarIntKey(int vlistID, int varID, const char *name);
689

690
691
692
693
694
695
696
697
/* 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);

698
699
int     cdiCopyAtts(int cdiID1, int varID1, int cdiID2, int varID2);

700
701
702
703
704
705
706
707
708
709
710
711
712
/*      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);
713
714


Uwe Schulzweida's avatar
Uwe Schulzweida committed
715
716
717
/* GRID routines */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
720
721
void    gridCompress(int gridID);

722
723
void    gridDefMaskGME(int gridID, const int mask[]);
int     gridInqMaskGME(int gridID, int mask[]);
724

725
726
void    gridDefMask(int gridID, const int mask[]);
int     gridInqMask(int gridID, int mask[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
727

728
void    gridPrint(int gridID, int opt);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
729

730
/*      gridCreate: Create a horizontal Grid */
731
int     gridCreate(int gridtype, size_t size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
732

733
734
735
/*      gridDestroy: Destroy a horizontal Grid */
void    gridDestroy(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
736
737
738
/*      gridDuplicate: Duplicate a Grid */
int     gridDuplicate(int gridID);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
742
743
744
/*      gridInqProj: Get the projection ID of a Grid */
int     gridInqProj(int gridID);

745
746
747
/*      gridInqProjType: Get the projection type */
int     gridInqProjType(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
748
749
750
751
/*      gridInqType: Get the type of a Grid */
int     gridInqType(int gridID);

/*      gridInqSize: Get the size of a Grid */
752
size_t  gridInqSize(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
753
754

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

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

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

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

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
778
779
780
781
/*      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 */
782
size_t  gridInqXCvals(int gridID, char *xcvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
783

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
790
791
792
793
/*      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 */
794
size_t  gridInqYCvals(int gridID, char *ycvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
795

796
// CDI var keys
797
798
799
800
#define  CDI_KEY_TABLESVERSION                 801  // GRIB2 tablesVersion
#define  CDI_KEY_LOCALTABLESVERSION            802  // GRIB2 localTablesVersion
#define  CDI_KEY_TYPEOFGENERATINGPROCESS       803  // GRIB2 typeOfGeneratingProcess
#define  CDI_KEY_PRODUCTDEFINITIONTEMPLATE     804  // GRIB2 productDefinitionTemplate
801
802
803
#define  CDI_KEY_TYPEOFPROCESSEDDATA           805  // GRIB2 typeOfProcessedData
#define  CDI_KEY_SHAPEOFTHEEARTH               806  // GRIB2 shapeOfTheEarth
#define  CDI_KEY_BACKGROUNDPROCESS             807  // GRIB2 backgroundProcess
804
805
806
#define  CDI_KEY_TYPEOFENSEMBLEFORECAST        808  // GRIB2 typeOfEnsembleForecast
#define  CDI_KEY_NUMBEROFFORECASTSINENSEMBLE   809  // GRIB2 numberOfForecastsInEnsemble
#define  CDI_KEY_PERTURBATIONNUMBER            810  // GRIB2 perturbationNumber
807
808
#define  CDI_KEY_CENTRE                        811  // GRIB2 centre
#define  CDI_KEY_SUBCENTRE                     812  // GRIB2 subCentre
809
810
811
812
813
#define  CDI_KEY_MPIMTYPE                      813  // GRIB2 mpimType
#define  CDI_KEY_MPIMCLASS                     814  // GRIB2 mpimClass
#define  CDI_KEY_MPIMUSER                      815  // GRIB2 mpimUser
#define  CDI_KEY_REVSTATUS                     816  // GRIB2 revStatus
#define  CDI_KEY_REVNUMBER                     817  // GRIB2 revNumber
814
815
816
#define  CDI_KEY_GRIB2LOCALSECTIONNUMBER       818  // GRIB2 grib2LocalSectionNumber
#define  CDI_KEY_SECTION2PADDINGLENGTH         819  // GRIB2 length of section2Padding
#define  CDI_KEY_SECTION2PADDING               820  // GRIB2 section2Padding
817

818
//      cdiDefKeyInt: Define an integer value from a key of a CDI variable
819
820
int     cdiDefKeyInt(int cdiID, int varID, int key, int value);

821
//      cdiInqKeyInt: Get an integer value from a key of a CDI variable
822
823
int     cdiInqKeyInt(int cdiID, int varID, int key, int *value);

824
//      cdiDefKeyBytes: Define a bytes array from a key of a CDI variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
825
int     cdiDefKeyBytes(int cdiID, int varID, int key, const unsigned char bytes[], int length);
826
827

//      cdiInqKeyBytes: Get a bytes array from a key of a CDI variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
828
int     cdiInqKeyBytes(int cdiID, int varID, int key, unsigned char bytes[], int *length);
829

830
831
832
833
834
835
//      cdiDefKeyString: Define a string value from a key of a CDI variable
int     cdiDefKeyString(int cdiID, int varID, int key, const char *string);

//      cdiInqKeyString: Get a string value from a key of a CDI variable
int     cdiInqKeyString(int cdiID, int varID, int key, char *string, int *length);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
836
837
838
//      cdiInqKeyLen: Get the length of the string representation of the key
int     cdiInqKeyLen(int cdiID, int varID, int key, int *length);

839
840
int     cdiCopyKeys(int cdiID1, int varID1, int cdiID2, int varID2);

841
// CDI grid keys
842
843
844
845
846
847
848
849
850
#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
851
852
#define  CDI_KEY_MAPPING     921  // Grid mapping var name
#define  CDI_KEY_MAPNAME     922  // Grid mapping name
853

854
// CDI zaxis keys
855
856
857
858
#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
859
#define  CDI_KEY_PSNAME      950  // Z-axis surface pressure name
860
861
#define  CDI_KEY_P0NAME      951  // Z-axis reference pressure name
#define  CDI_KEY_P0VALUE     952  // Z-axis reference pressure in Pa
862

863
864
//      cdiGridDefKeyStr: Define a CDI grid string value from a key
int     cdiGridDefKeyStr(int gridID, int key, int size, const char *mesg);
865

866
867
//      cdiGridInqKeyStr: Get a CDI grid string value from a key
int     cdiGridInqKeyStr(int gridID, int key, int size, char *mesg);
868

869
870
871
872
873
874
//      cdiZaxisDefKeyStr: Define a CDI Z-axis string value from a key
int     cdiZaxisDefKeyStr(int zaxisID, int key, int size, const char *mesg);

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

875
876
877
878
879
880
//      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
881
/*      gridDefXname: Define the name of a X-axis */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
882
void    gridDefXname(int gridID, const char *xname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
883

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

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

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

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

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

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

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

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

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
914
915
/*      gridInqYunits: Get the units of a Y-axis */
void    gridInqYunits(int gridID, char *yunits);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
916
917
918
919
920
921
922

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
923
/*      gridDefDatatype: Define the data type of a Grid */
924
void    gridDefDatatype(int gridID, int prec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
925

Uwe Schulzweida's avatar
Uwe Schulzweida committed
926
/*      gridInqDatatype: Get the data type of a Grid */
927
int     gridInqDatatype(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
928
929

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

/*      gridInqYval: Get one value of a Y-axis */
933
double  gridInqYval(int gridID, size_t index);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
934
935
936

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

938
int     gridIsCircular(int gridID);
939

Uwe Schulzweida's avatar
Uwe Schulzweida committed
940
int     gridInqTrunc(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
941
void    gridDefTrunc(int gridID, int trunc);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
942

943
944
945
/* Reference of an unstructured grid */

/*      gridDefNumber: Define the reference number for an unstructured grid */
946
void    gridDefNumber(int gridID, int number);
947
948
949
950
951

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

/*      gridDefPosition: Define the position of grid in the reference file */
952
void    gridDefPosition(int gridID, int position);
953
954
955
956
957

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

/*      gridDefReference: Define the reference URI for an unstructured grid */
958
void    gridDefReference(int gridID, const char *reference);
959
960
961
962
963

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

/*      gridDefUUID: Define the UUID of an unstructured grid */
964
void    gridDefUUID(int gridID, const unsigned char uuid[CDI_UUID_SIZE]);
965

966
/*      gridInqUUID: Get the UUID of an unstructured grid */
Thomas Jahns's avatar
Thomas Jahns committed
967
void    gridInqUUID(int gridID, unsigned char uuid[CDI_UUID_SIZE]);
968

969
970
/* Rotated Lon/Lat grid */
void    gridDefParamRLL(int gridID, double xpole, double ypole, double angle);
971
972
973
974
975
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);
976

977
  /* Lambert Conformal Conic grid (GRIB version) */
978
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);
979
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);
980

981
982
void    gridDefArea(int gridID, const double area[]);
void    gridInqArea(int gridID, double area[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
983
984
985
986
987
988
989
990
991
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 */
992
void    gridDefXbounds(int gridID, const double xbounds[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
993
994

/*      gridInqXbounds: Get the bounds of a X-axis */
995
size_t  gridInqXbounds(int gridID, double xbounds[]);
996
size_t  gridInqXboundsPart(int gridID, int start, size_t size, double xbounds[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
997
998

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

/*      gridInqYbounds: Get the bounds of a Y-axis */
1002
size_t  gridInqYbounds(int gridID, double ybounds[]);
1003
size_t  gridInqYboundsPart(int gridID, int start, size_t size, double ybounds[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1004

1005
1006
void    gridDefRowlon(int gridID, int nrowlon, const int rowlon[]);
void    gridInqRowlon(int gridID, int rowlon[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1007
1008
void    gridChangeType(int gridID, int gridtype);

1009
1010
1011
void    gridDefComplexPacking(int gridID, int lpack);
int     gridInqComplexPacking(int gridID);

1012
void    gridDefUvRelativeToGrid(int gridID, int uvRelativeToGrid);
1013
1014
int     gridInqUvRelativeToGrid(int gridID);

1015
1016
1017
void    gridDefScanningMode(int gridID, int mode);
int     gridInqScanningMode(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1018
1019
/* ZAXIS routines */

1020
void    zaxisName(int zaxistype, char *zaxisname);
1021
const char *zaxisNamePtr(int leveltype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1022

1023
/*      zaxisCreate: Create a vertical Z-axis */
1024
int     zaxisCreate(int zaxistype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1025

1026
1027
1028
/*      zaxisDestroy: Destroy a vertical Z-axis */
void    zaxisDestroy(int zaxisID);