cdi.h 52.7 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
#define  CDI_MAX_NAME             256   // Max length of a name
Deike Kleberg's avatar
Deike Kleberg committed
19

20
#define  CDI_UNDEFID               -1
21 22 23
#define  CDI_GLOBAL                -1   // Global var ID for vlist and grid
#define  CDI_XAXIS                  1   // X-axis ID for grid
#define  CDI_YAXIS                  2   // Y-axis ID for grid
Uwe Schulzweida's avatar
Uwe Schulzweida committed
24

25
// Byte order
26

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

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

35
// Error identifier
Uwe Schulzweida's avatar
Uwe Schulzweida committed
36

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

51
// File types
Uwe Schulzweida's avatar
Uwe Schulzweida committed
52

53 54 55
#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
56
#define  CDI_FILETYPE_NC2           4   // File type NetCDF version 2 (64-bit offset)
57 58
#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
59 60 61 62
#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
63

64
// Compress types
65

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

72
// external data types
Uwe Schulzweida's avatar
Uwe Schulzweida committed
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
#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

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

127
// Chunks
128

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

133
// GRID types
Uwe Schulzweida's avatar
Uwe Schulzweida committed
134

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

154
// ZAXIS types
Uwe Schulzweida's avatar
Uwe Schulzweida committed
155

Uwe Schulzweida's avatar
Uwe Schulzweida committed
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 182
#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
183

184
// SUBTYPE types
185 186

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

#define MAX_KV_PAIRS_MATCH 10

/* Data structure defining a key-value search, possibly with multiple
193
   key-value pairs in combination.
194 195 196 197

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



204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
// TIME types

#define  TIME_CONSTANT            0  // Time constant
#define  TIME_VARYING             1  // Time varying
#define  TIME_VARIABLE            1  // obsolate, use TIME_VARYING

// TSTEP types

#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
222 223 224 225
#define  TSTEP_SUM               11  // Summation
#define  TSTEP_RANGE             12
#define  TSTEP_INSTANT2          13
#define  TSTEP_INSTANT3          14
226 227

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

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

233
// TUNIT types
Uwe Schulzweida's avatar
Uwe Schulzweida committed
234 235 236

#define  TUNIT_SECOND             1
#define  TUNIT_MINUTE             2
237 238 239 240 241 242 243 244 245
#define  TUNIT_QUARTER            3
#define  TUNIT_30MINUTES          4
#define  TUNIT_HOUR               5
#define  TUNIT_3HOURS             6
#define  TUNIT_6HOURS             7
#define  TUNIT_12HOURS            8
#define  TUNIT_DAY                9
#define  TUNIT_MONTH             10
#define  TUNIT_YEAR              11
Uwe Schulzweida's avatar
Uwe Schulzweida committed
246

247
// CALENDAR types
Uwe Schulzweida's avatar
Uwe Schulzweida committed
248

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

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

260
// Structs that are used to return data to the user
261

262
typedef struct CdiParam { int discipline; int category; int number; } CdiParam;
263 264


265
// Opaque types
266 267 268
typedef struct CdiIterator CdiIterator;
typedef struct CdiGribIterator CdiGribIterator;

269
// CDI control routines
270 271

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

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

void    cdiDebug(int debug);

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

280 281
int     cdiHaveFiletype(int filetype);

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

287
int     namespaceNew(void);
288
void    namespaceSetActive(int namespaceID);
289
int     namespaceGetActive(void);
290 291 292
void    namespaceDelete(int namespaceID);


293
// CDI converter routines
Uwe Schulzweida's avatar
Uwe Schulzweida committed
294

295
// parameter
296 297

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

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

302 303
// date format:  YYYYMMDD
// time format:    hhmmss
Uwe Schulzweida's avatar
Uwe Schulzweida committed
304

305 306
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
307 308 309 310 311

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


312
// STREAM control routines
Uwe Schulzweida's avatar
Uwe Schulzweida committed
313

314 315
int     cdiGetFiletype(const char *path, int *byteorder);

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
322
int     streamOpenAppend(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
323

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

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

330 331 332
void    streamDefNumWorker(int streamID, int numWorker);

//      streamDefVlist: Define the Vlist for a stream
Uwe Schulzweida's avatar
Uwe Schulzweida committed
333 334
void    streamDefVlist(int streamID, int vlistID);

335
//      streamInqVlist: Get the Vlist of a stream
Uwe Schulzweida's avatar
Uwe Schulzweida committed
336 337
int     streamInqVlist(int streamID);

338
//      streamInqFiletype: Get the filetype
Uwe Schulzweida's avatar
Uwe Schulzweida committed
339
int     streamInqFiletype(int streamID);
340

341
//      streamDefByteorder: Define the byteorder
Uwe Schulzweida's avatar
Uwe Schulzweida committed
342
void    streamDefByteorder(int streamID, int byteorder);
343

344
//      streamInqByteorder: Get the byteorder
Uwe Schulzweida's avatar
Uwe Schulzweida committed
345 346
int     streamInqByteorder(int streamID);

347
//      streamDefCompType: Define compression type
Deike Kleberg's avatar
Deike Kleberg committed
348
void    streamDefCompType(int streamID, int comptype);
349

350
//      streamInqCompType: Get compression type
Deike Kleberg's avatar
Deike Kleberg committed
351
int     streamInqCompType(int streamID);
352

353
//      streamDefCompLevel: Define compression level
Uwe Schulzweida's avatar
Uwe Schulzweida committed
354 355
void    streamDefCompLevel(int streamID, int complevel);

356
//      streamInqCompLevel: Get compression level
Deike Kleberg's avatar
Deike Kleberg committed
357
int     streamInqCompLevel(int streamID);
358

359
//      streamDefTimestep: Define time step
Uwe Schulzweida's avatar
Uwe Schulzweida committed
360
int     streamDefTimestep(int streamID, int tsID);
361

362
//      streamInqTimestep: Get time step
Uwe Schulzweida's avatar
Uwe Schulzweida committed
363 364
int     streamInqTimestep(int streamID, int tsID);

365
//      PIO: query currently set timestep id
Uwe Schulzweida's avatar
Uwe Schulzweida committed
366 367
int     streamInqCurTimestepID(int streamID);

368 369
const char *streamFilename(int streamID);
const char *streamFilesuffix(int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
370

371
size_t  streamNvals(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
372

373
int     streamInqNvars(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
374

375
// STREAM var I/O routines (random access)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
376

377
//      streamWriteVar: Write a variable
378 379
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
380

381
//      streamReadVar: Read a variable
382 383
void    streamReadVar(int streamID, int varID, double data[], size_t *nmiss);
void    streamReadVarF(int streamID, int varID, float data[], size_t *nmiss);
384
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
385

386
//      streamWriteVarSlice: Write a horizontal slice of a variable
387 388
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);
389
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
390

391
//      streamReadVarSlice: Read a horizontal slice of a variable
392 393
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
394

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
397

398
// STREAM record I/O routines (sequential access)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
399 400

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

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

410

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

413 414
// Creation & Destruction
CdiIterator *cdiIterator_new(const char *path);  // Requires a subsequent call to cdiIteratorNextField() to point the iterator at the first field.
415
CdiIterator *cdiIterator_clone(CdiIterator *me);
416 417
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.
418 419
void cdiIterator_print(CdiIterator *me, FILE *stream);
void cdiIterator_delete(CdiIterator *me);
420

421 422 423 424 425 426 427 428 429 430 431 432 433 434
// Advancing an iterator
int cdiIterator_nextField(CdiIterator *me);      // Points the iterator at the next field, returns CDI_EEOF if there are no more fields in the file.

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

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


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

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

462
// Convenience functions for accessing GRIB-API keys
463
int cdiGribIterator_inqEdition(CdiGribIterator *me);
464 465 466 467 468
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.
469

470
// VLIST routines
Uwe Schulzweida's avatar
Uwe Schulzweida committed
471

472
//      vlistCreate: Create a variable list
473
int     vlistCreate(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
474

475
//      vlistDestroy: Destroy a variable list
476
void    vlistDestroy(int vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
477

478
//      vlistDuplicate: Duplicate a variable list
Uwe Schulzweida's avatar
Uwe Schulzweida committed
479 480
int     vlistDuplicate(int vlistID);

481
//      vlistCopy: Copy a variable list
Uwe Schulzweida's avatar
Uwe Schulzweida committed
482 483
void    vlistCopy(int vlistID2, int vlistID1);

484
//      vlistCopyFlag: Copy some entries of a variable list
Uwe Schulzweida's avatar
Uwe Schulzweida committed
485 486 487 488
void    vlistCopyFlag(int vlistID2, int vlistID1);

void    vlistClearFlag(int vlistID);

489
//      vlistCat: Concatenate two variable lists
Uwe Schulzweida's avatar
Uwe Schulzweida committed
490 491
void    vlistCat(int vlistID2, int vlistID1);

492
//      vlistMerge: Merge two variable lists
Uwe Schulzweida's avatar
Uwe Schulzweida committed
493 494 495 496
void    vlistMerge(int vlistID2, int vlistID1);

void    vlistPrint(int vlistID);

497
//      vlistNumber: Number type in a variable list
Uwe Schulzweida's avatar
Uwe Schulzweida committed
498 499
int     vlistNumber(int vlistID);

500
//      vlistNvars: Number of variables in a variable list
Uwe Schulzweida's avatar
Uwe Schulzweida committed
501 502
int     vlistNvars(int vlistID);

503
//      vlistNgrids: Number of grids in a variable list
Uwe Schulzweida's avatar
Uwe Schulzweida committed
504 505
int     vlistNgrids(int vlistID);

506
//      vlistNzaxis: Number of zaxis in a variable list
Uwe Schulzweida's avatar
Uwe Schulzweida committed
507 508
int     vlistNzaxis(int vlistID);

509
//      vlistNsubtypes: Number of subtypes in a variable list
510 511
int     vlistNsubtypes(int vlistID);

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

527
//      vlistDefTaxis: Define the time axis of a variable list
Uwe Schulzweida's avatar
Uwe Schulzweida committed
528
void    vlistDefTaxis(int vlistID, int taxisID);
529

530
//      vlistInqTaxis: Get the time axis of a variable list
Uwe Schulzweida's avatar
Uwe Schulzweida committed
531
int     vlistInqTaxis(int vlistID);
532

Uwe Schulzweida's avatar
Uwe Schulzweida committed
533 534 535 536 537 538 539 540
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);


541
// VLIST VAR routines
Uwe Schulzweida's avatar
Uwe Schulzweida committed
542

543
//      vlistDefVarTiles: Create a new tile-based variable
544
int     vlistDefVarTiles(int vlistID, int gridID, int zaxisID, int timetype, int tilesetID);
545

546
//      vlistDefVar: Create a new variable
547
int     vlistDefVar(int vlistID, int gridID, int zaxisID, int timetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
548

549
void    vlistChangeVarGrid(int vlistID, int varID, int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
550 551
void    vlistChangeVarZaxis(int vlistID, int varID, int zaxisID);

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

556
//      used in MPIOM
557 558
int     vlistInqVarID(int vlistID, int code);

559
void    vlistDefVarTimetype(int vlistID, int varID, int timetype);
560 561
int     vlistInqVarTimetype(int vlistID, int varID);

562
void    vlistDefVarTsteptype(int vlistID, int varID, int tsteptype);
563

564
//      vlistInqVarTsteptype: Get the timestep type of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
565
int     vlistInqVarTsteptype(int vlistID, int varID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
566

Deike Kleberg's avatar
Deike Kleberg committed
567 568 569 570
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);
571

572
//      vlistDefVarParam: Define the parameter number of a Variable
573 574
void    vlistDefVarParam(int vlistID, int varID, int param);

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

578
//      vlistDefVarCode: Define the code number of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
579 580
void    vlistDefVarCode(int vlistID, int varID, int code);

581
//      vlistInqVarCode: Get the code number of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
582 583
int     vlistInqVarCode(int vlistID, int varID);

584
//      vlistDefVarDatatype: Define the data type of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
585 586
void    vlistDefVarDatatype(int vlistID, int varID, int datatype);

587
//      vlistInqVarDatatype: Get the data type of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
588 589
int     vlistInqVarDatatype(int vlistID, int varID);

590 591 592
void    vlistDefVarChunkType(int vlistID, int varID, int chunktype);
int     vlistInqVarChunkType(int vlistID, int varID);

593 594 595
void    vlistDefVarXYZ(int vlistID, int varID, int xyz);
int     vlistInqVarXYZ(int vlistID, int varID);

596 597
int     vlistInqVarNumber(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
598 599 600 601 602 603 604
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);

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

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

611
//      vlistCopyVarName: Safe and convenient version of vlistInqVarName
612
char   *vlistCopyVarName(int vlistId, int varId);
613

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

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

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

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

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

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

632
//      vlistDefVarMissval: Define the missing value of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
633 634
void    vlistDefVarMissval(int vlistID, int varID, double missval);

635
//      vlistInqVarMissval: Get the missing value of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
636 637
double  vlistInqVarMissval(int vlistID, int varID);

638
//      vlistDefVarExtra: Define extra information of a Variable
639 640
void    vlistDefVarExtra(int vlistID, int varID, const char *extra);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
644 645 646 647
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);
648

649 650
void    vlistDefVarTimave(int vlistID, int varID, int timave);
int     vlistInqVarTimave(int vlistID, int varID);
651

652
size_t  vlistInqVarSize(int vlistID, int varID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
653 654 655 656 657 658 659

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

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

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

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

680
// CDI attributes
681

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

688 689
int     cdiCopyAtts(int cdiID1, int varID1, int cdiID2, int varID2);

690
//      cdiDefAttInt: Define an integer attribute
691
int     cdiDefAttInt(int cdiID, int varID, const char *name, int type, int len, const int ip[]);
692
//      cdiDefAttFlt: Define a floating point attribute
693
int     cdiDefAttFlt(int cdiID, int varID, const char *name, int type, int len, const double dp[]);
694
//      cdiDefAttTxt: Define a text attribute
695 696
int     cdiDefAttTxt(int cdiID, int varID, const char *name, int len, const char *tp_cbuf);

697
//      cdiInqAttInt: Get the value(s) of an integer attribute
698
int     cdiInqAttInt(int cdiID, int varID, const char *name, int mlen, int ip[]);
699
//      cdiInqAttFlt: Get the value(s) of a floating point attribute
700
int     cdiInqAttFlt(int cdiID, int varID, const char *name, int mlen, double dp[]);
701
//      cdiInqAttTxt: Get the value(s) of a text attribute
702
int     cdiInqAttTxt(int cdiID, int varID, const char *name, int mlen, char *tp_cbuf);
703 704


705
// GRID routines
Uwe Schulzweida's avatar
Uwe Schulzweida committed
706 707

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
710 711
void    gridCompress(int gridID);

712 713
void    gridDefMaskGME(int gridID, const int mask[]);
int     gridInqMaskGME(int gridID, int mask[]);
714

715 716
void    gridDefMask(int gridID, const int mask[]);
int     gridInqMask(int gridID, int mask[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
717

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

721
//      gridDestroy: Destroy a horizontal Grid
722 723
void    gridDestroy(int gridID);

724
//      gridDuplicate: Duplicate a Grid
Uwe Schulzweida's avatar
Uwe Schulzweida committed
725 726
int     gridDuplicate(int gridID);

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

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

733
//      gridInqProjType: Get the projection type
734 735
int     gridInqProjType(int gridID);

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

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

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

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

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

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

754
//      gridDefNP: Define the number of parallels between a pole and the equator
755 756
void    gridDefNP(int gridID, int np);

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

760
//      gridDefXvals: Define the values of a X-axis
761
void    gridDefXvals(int gridID, const double xvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
762

763
//      gridInqXvals: Get all values of a X-axis
764
size_t  gridInqXvals(int gridID, double xvals[]);
765
size_t  gridInqXvalsPart(int gridID, int start, size_t size, double xvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
766

767
//      gridInqXIsc: Find out whether X-coordinate is of type CHAR
Uwe Schulzweida's avatar
Uwe Schulzweida committed
768 769
int     gridInqXIsc(int gridID);

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

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

776
//      gridInqYvals: Get all values of a Y-axis
777
size_t  gridInqYvals(int gridID, double yvals[]);
778
size_t  gridInqYvalsPart(int gridID, int start, size_t size, double yvals[]);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
779

780
//      gridInqYIsc: Find out whether Y-coordinate is of type CHAR
Uwe Schulzweida's avatar
Uwe Schulzweida committed
781 782
int     gridInqYIsc(int gridID);

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

786
// CDI var keys
787 788 789