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
#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

117
/* internal data types */
118
119
120
121
122
123
#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
124
#define  CDI_DATATYPE_UINT        257
125

126
127
/* Chunks */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
128
#define  CDI_CHUNK_AUTO             1  // use default chunk size
129
130
#define  CDI_CHUNK_GRID             2
#define  CDI_CHUNK_LINES            3
131

Uwe Schulzweida's avatar
Uwe Schulzweida committed
132
133
/* GRID types */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
#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
152

Uwe Schulzweida's avatar
Uwe Schulzweida committed
153
154
/* ZAXIS types */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
#define  ZAXIS_SURFACE              0  // Surface level
#define  ZAXIS_GENERIC              1  // Generic level
#define  ZAXIS_HYBRID               2  // Hybrid level
#define  ZAXIS_HYBRID_HALF          3  // Hybrid half level
#define  ZAXIS_PRESSURE             4  // Isobaric pressure level in Pascal
#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
182

183
184
185
/* SUBTYPE types */

enum {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
186
  SUBTYPE_TILES                   = 0  // Tiles variable
187
};
188
189
190
191

#define MAX_KV_PAIRS_MATCH 10

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

   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;



203
204
/* TIME types */

205
206
207
#define  TIME_CONSTANT              0  /* Time constant              */
#define  TIME_VARYING               1  /* Time varying               */
#define  TIME_VARIABLE              1  /* obsolate, use TIME_VARYING */
208
209
210

/* TSTEP types */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
225
226
227
228
/* TAXIS types */

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

/* TUNIT types */

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

/* CALENDAR types */

247
#define  CALENDAR_STANDARD        0  /* don't change this value (used also in cgribexlib)! */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
248
249
250
251
252
253
#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
254

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

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

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


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

267
268
269
/* CDI control routines */

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

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

void    cdiDebug(int debug);

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

278
279
int     cdiHaveFiletype(int filetype);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
280
281
void    cdiDefMissval(double missval);
double  cdiInqMissval(void);
282
double  cdiInqGridMissval(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
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
305
306
307
308
309

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

367
size_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[], size_t nmiss);
void    streamWriteVarF(int streamID, int varID, const float data[], size_t 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[], size_t *nmiss);
void    streamReadVarF(int streamID, int varID, float data[], size_t *nmiss);
380
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
381
382

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

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
393

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

void    streamDefRecord(int streamID, int  varID, int  levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
397
void    streamInqRecord(int streamID, int *varID, int *levelID);
398
399
void    streamWriteRecord(int streamID, const double data[], size_t nmiss);
void    streamWriteRecordF(int streamID, const float data[], size_t nmiss);
400
401
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
402
403
void    streamCopyRecord(int streamIDdest, int streamIDsrc);

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

406
407
408
409

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

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

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

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

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


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

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

//Convenience functions for accessing GRIB-API keys
459
460
461
462
463
464
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.
465

Uwe Schulzweida's avatar
Uwe Schulzweida committed
466
467
/* VLIST routines */

468
469
/*      vlistCreate: Create a variable list */
int     vlistCreate(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
470

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

/*      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
493
494
495
/*      vlistNumber: Number type in a variable list */
int     vlistNumber(int vlistID);

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

505
506
507
/*      vlistNsubtypes: Number of subtypes in a variable list */
int     vlistNsubtypes(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
508
509
void    vlistDefNtsteps(int vlistID, int nts);
int     vlistNtsteps(int vlistID);
510
size_t  vlistGridsizeMax(int vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
511
512
513
514
515
516
517
518
519
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);
520
521
int     vlistSubtype(int vlistID, int index);
int     vlistSubtypeIndex(int vlistID, int subtypeID);
522
523

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
529
530
531
532
533
534
535
536
537
538
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 */

539
/*      vlistDefVarTiles: Create a new tile-based variable */
540
int     vlistDefVarTiles(int vlistID, int gridID, int zaxisID, int timetype, int tilesetID);
541
542

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

545
void    vlistChangeVarGrid(int vlistID, int varID, int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
546
547
void    vlistChangeVarZaxis(int vlistID, int varID, int zaxisID);

548
void    vlistInqVar(int vlistID, int varID, int *gridID, int *zaxisID, int *timetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
549
550
int     vlistInqVarGrid(int vlistID, int varID);
int     vlistInqVarZaxis(int vlistID, int varID);
551
552
553
554

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

555
void    vlistDefVarTimetype(int vlistID, int varID, int timetype);
556
557
int     vlistInqVarTimetype(int vlistID, int varID);

558
void    vlistDefVarTsteptype(int vlistID, int varID, int tsteptype);
559
560

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

Deike Kleberg's avatar
Deike Kleberg committed
563
564
565
566
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);
567

568
569
570
571
572
573
/*      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
574
/*      vlistDefVarCode: Define the code number of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
575
576
void    vlistDefVarCode(int vlistID, int varID, int code);

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

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

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

586
587
588
void    vlistDefVarChunkType(int vlistID, int varID, int chunktype);
int     vlistInqVarChunkType(int vlistID, int varID);

589
590
591
void    vlistDefVarXYZ(int vlistID, int varID, int xyz);
int     vlistInqVarXYZ(int vlistID, int varID);

592
593
int     vlistInqVarNumber(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
594
595
596
597
598
599
600
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
601
/*      vlistDefVarName: Define the name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
602
603
void    vlistDefVarName(int vlistID, int varID, const char *name);

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

607
/*      vlistCopyVarName: Safe and convenient version of vlistInqVarName */
608
char   *vlistCopyVarName(int vlistId, int varId);
609

Uwe Schulzweida's avatar
Uwe Schulzweida committed
610
611
612
613
614
615
/*      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
616
/*      vlistDefVarLongname: Define the long name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
617
618
void    vlistDefVarLongname(int vlistID, int varID, const char *longname);

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

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

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

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

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

634
635
636
637
638
639
/*      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
640
641
642
643
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);
644

645
646
void    vlistDefVarTimave(int vlistID, int varID, int timave);
int     vlistInqVarTimave(int vlistID, int varID);
647

648
size_t  vlistInqVarSize(int vlistID, int varID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
649
650
651
652
653
654
655

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

659
/* cdiClearAdditionalKeys: Clear the list of additional GRIB keys. */
Thomas Jahns's avatar
Thomas Jahns committed
660
void    cdiClearAdditionalKeys(void);
661
662
/* cdiDefAdditionalKey: Register an additional GRIB key which is read when file is opened. */
void    cdiDefAdditionalKey(const char *string);
663
664
665
666
667
668

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

669
/* vlistHasVarKey: returns 1 if meta-data key was read, 0 otherwise. */
670
int     vlistHasVarKey(int vlistID, int varID, const char *name);
671
/* vlistInqVarDblKey: raw access to GRIB meta-data */
672
double  vlistInqVarDblKey(int vlistID, int varID, const char *name);
673
/* vlistInqVarIntKey: raw access to GRIB meta-data */
674
int     vlistInqVarIntKey(int vlistID, int varID, const char *name);
675

676
677
678
679
680
681
682
683
/* 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);

684
685
int     cdiCopyAtts(int cdiID1, int varID1, int cdiID2, int varID2);

686
687
688
689
690
691
692
693
694
695
696
697
698
/*      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);
699
700


Uwe Schulzweida's avatar
Uwe Schulzweida committed
701
702
703
/* GRID routines */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
706
707
void    gridCompress(int gridID);

708
709
void    gridDefMaskGME(int gridID, const int mask[]);
int     gridInqMaskGME(int gridID, int mask[]);
710

711
712
void    gridDefMask(int gridID, const int mask[]);
int     gridInqMask(int gridID, int mask[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
713

714
void    gridPrint(int gridID, int opt);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
715

716
/*      gridCreate: Create a horizontal Grid */
717
int     gridCreate(int gridtype, size_t size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
718

719
720
721
/*      gridDestroy: Destroy a horizontal Grid */
void    gridDestroy(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
722
723
724
/*      gridDuplicate: Duplicate a Grid */
int     gridDuplicate(int gridID);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
728
729
730
/*      gridInqProj: Get the projection ID of a Grid */
int     gridInqProj(int gridID);

731
732
733
/*      gridInqProjType: Get the projection type */
int     gridInqProjType(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
734
735
736
737
/*      gridInqType: Get the type of a Grid */
int     gridInqType(int gridID);

/*      gridInqSize: Get the size of a Grid */
738
size_t  gridInqSize(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
739
740

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

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

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

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

752
753
754
755
756
757
/*      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
758
/*      gridDefXvals: Define the values of a X-axis */
759
void    gridDefXvals(int gridID, const double xvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
760
761

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
764
765
766
767
/*      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 */
768
size_t  gridInqXCvals(int gridID, char *xcvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
769

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
776
777
778
779
/*      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 */
780
size_t  gridInqYCvals(int gridID, char *ycvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
781

782
// CDI var keys
783
784
785
786
#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
787
788
789
#define  CDI_KEY_TYPEOFPROCESSEDDATA           805  // GRIB2 typeOfProcessedData
#define  CDI_KEY_SHAPEOFTHEEARTH               806  // GRIB2 shapeOfTheEarth
#define  CDI_KEY_BACKGROUNDPROCESS             807  // GRIB2 backgroundProcess
790
791
792
#define  CDI_KEY_TYPEOFENSEMBLEFORECAST        808  // GRIB2 typeOfEnsembleForecast
#define  CDI_KEY_NUMBEROFFORECASTSINENSEMBLE   809  // GRIB2 numberOfForecastsInEnsemble
#define  CDI_KEY_PERTURBATIONNUMBER            810  // GRIB2 perturbationNumber
793
794
#define  CDI_KEY_CENTRE                        811  // GRIB2 centre
#define  CDI_KEY_SUBCENTRE                     812  // GRIB2 subCentre
795
796
797
798
799
#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
800
801
802
#define  CDI_KEY_GRIB2LOCALSECTIONNUMBER       818  // GRIB2 grib2LocalSectionNumber
#define  CDI_KEY_SECTION2PADDINGLENGTH         819  // GRIB2 length of section2Padding
#define  CDI_KEY_SECTION2PADDING               820  // GRIB2 section2Padding
803

804
//      cdiDefKeyInt: Define an integer value from a key of a CDI variable
805
806
int     cdiDefKeyInt(int cdiID, int varID, int key, int value);

807
//      cdiInqKeyInt: Get an integer value from a key of a CDI variable
808
809
int     cdiInqKeyInt(int cdiID, int varID, int key, int *value);

810
//      cdiDefKeyBytes: Define a bytes array from a key of a CDI variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
811
int     cdiDefKeyBytes(int cdiID, int varID, int key, const unsigned char bytes[], int length);
812
813

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

816
817
818
819
820
821
//      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
822
823
824
//      cdiInqKeyLen: Get the length of the string representation of the key
int     cdiInqKeyLen(int cdiID, int varID, int key, int *length);

825
826
int     cdiCopyKeys(int cdiID1, int varID1, int cdiID2, int varID2);

827
// CDI grid keys
828
829
830
831
832
833
834
835
836
#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
837
838
#define  CDI_KEY_MAPPING     921  // Grid mapping var name
#define  CDI_KEY_MAPNAME     922  // Grid mapping name
839

840
// CDI zaxis keys
841
842
843
844
#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
845
#define  CDI_KEY_PSNAME      950  // Z-axis surface pressure name
846
847
#define  CDI_KEY_P0NAME      951  // Z-axis reference pressure name
#define  CDI_KEY_P0VALUE     952  // Z-axis reference pressure in Pa
848

849
850
//      cdiGridDefKeyStr: Define a CDI grid string value from a key
int     cdiGridDefKeyStr(int gridID, int key, int size, const char *mesg);
851

852
853
//      cdiGridInqKeyStr: Get a CDI grid string value from a key
int     cdiGridInqKeyStr(int gridID, int key, int size, char *mesg);
854

855
856
857
858
859
860
//      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);

861
862
863
864
865
866
//      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
867
/*      gridDefXname: Define the name of a X-axis */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
868
void    gridDefXname(int gridID, const char *xname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
869

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

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

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

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

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

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

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

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

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
900
901
/*      gridInqYunits: Get the units of a Y-axis */
void    gridInqYunits(int gridID, char *yunits);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
902
903
904
905
906
907
908

/*      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
909
/*      gridDefDatatype: Define the data type of a Grid */
910
void    gridDefDatatype(int gridID, int prec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
911

Uwe Schulzweida's avatar
Uwe Schulzweida committed
912
/*      gridInqDatatype: Get the data type of a Grid */
913
int     gridInqDatatype(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
914
915

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

/*      gridInqYval: Get one value of a Y-axis */
919
double  gridInqYval(int gridID, size_t index);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
920
921
922

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

924
int     gridIsCircular(int gridID);
925

Uwe Schulzweida's avatar
Uwe Schulzweida committed
926
int     gridInqTrunc(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
927
void    gridDefTrunc(int gridID, int trunc);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
928

929
930
931
/* Reference of an unstructured grid */

/*      gridDefNumber: Define the reference number for an unstructured grid */
932
void    gridDefNumber(int gridID, int number);
933
934
935
936
937

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

/*      gridDefPosition: Define the position of grid in the reference file */
938
void    gridDefPosition(int gridID, int position);
939
940
941
942
943

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

/*      gridDefReference: Define the reference URI for an unstructured grid */
944
void    gridDefReference(int gridID, const char *reference);
945
946
947
948
949

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

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

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

955
956
/* Rotated Lon/Lat grid */
void    gridDefParamRLL(int gridID, double xpole, double ypole, double angle);
957
958
959
960
961
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);
962

963
/* Lambert Conformal Conic grid */
964
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);
965
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);
966

967
968
969
970
/* Polar stereographic grid */
void gridDefParamSTERE(int gridID, double missval, double lon_0, double lat_ts, double lat_0, double a, double xval_0, double yval_0, double x_0, double y_0);
int gridInqParamSTERE(int gridID, double missval, double *lon_0, double *lat_ts, double *lat_0, double *a, double *xval_0, double *yval_0, double *x_0, double *y_0);

971
972
void    gridDefArea(int gridID, const double area[]);
void    gridInqArea(int gridID, double area[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
973
974
975
976
977
978
979
980
981
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 */
982
void    gridDefXbounds(int gridID, const double xbounds[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
983
984

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

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

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

995
996
void    gridDefRowlon(int gridID, int nrowlon, const int rowlon[]);
void    gridInqRowlon(int gridID, int rowlon[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
997
998
void    gridChangeType(int gridID, int gridtype);

999
1000
1001
void    gridDefComplexPacking(int gridID, int lpack);
int     gridInqComplexPacking(int gridID);

1002
void    gridDefUvRelativeToGrid(int gridID, int uvRelativeToGrid);
1003
1004
int     gridInqUvRelativeToGrid(int gridID);

1005
1006
1007
void    gridDefScanningMode(int gridID, int mode);
int     gridInqScanningMode(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1008
1009
/* ZAXIS routines */

1010
void    zaxisName(int zaxistype, char *zaxisname);
1011
const char *zaxisNamePtr(int leveltype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1012

1013
/*      zaxisCreate: Create a vertical Z-axis */
1014
int     zaxisCreate(int zaxistype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1015

1016
1017
1018
/*      zaxisDestroy: Destroy a vertical Z-axis */
void    zaxisDestroy(int zaxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1019
1020
1021
1022
1023
1024
1025
1026
1027
/*      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);

1028
void    zaxisPrint(int zaxisID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1029
1030

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

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

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

1039
1040
1041
/*      zaxisInqCLen: Get maximal string length of character Z-axis */
int     zaxisInqCLen(int zaxisID);

1042
1043
/*      zaxisInqCVals: Get all string values of a character Z-axis */
int     zaxisInqCVals(int zaxisID, char ***clevels);
1044

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1045
1046
1047
1048
1049
1050
/*      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);