cdi.h 31.6 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
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.
*/

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
12
13
14
15
16
#if defined(__cplusplus)
extern "C" {
#endif

#define  CDI_UNDEFID             -1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
17
#define  CDI_GLOBAL              -1   /* Global var ID for vlist              */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
18

19
20
/* Byte order */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
21
22
#define  CDI_BIGENDIAN            0   /* Byte order BIGENDIAN                 */
#define  CDI_LITTLEENDIAN         1   /* Byte order LITTLEENDIAN              */
23

Uwe Schulzweida's avatar
Uwe Schulzweida committed
24
25
26
#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
27

Uwe Schulzweida's avatar
Uwe Schulzweida committed
28
29
/* Error identifier */

30
31
32
33
34
35
#define	 CDI_NOERR        	  0   /* No Error                             */
#define  CDI_ESYSTEM            -10   /* Operating system error               */
#define  CDI_EINVAL             -20   /* Invalid argument                     */
#define  CDI_EUFTYPE            -21   /* Unsupported file type                */
#define  CDI_ELIBNAVAIL         -22   /* xxx library not available            */
#define  CDI_EUFSTRUCT          -23   /* Unsupported file structure           */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
36
#define  CDI_EUNC4              -24   /* Unsupported netCDF4 structure        */
37
#define  CDI_ELIMIT             -99   /* Internal limits exceeded             */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
38
39
40

/* File types */

41
#define  FILETYPE_GRB             1   /* File type GRIB                       */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
42
#define  FILETYPE_GRB2            2   /* File type GRIB version 2             */
43
#define  FILETYPE_NC              3   /* File type netCDF                     */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
44
#define  FILETYPE_NC2             4   /* File type netCDF version 2 (64-bit)  */
45
46
47
48
49
#define  FILETYPE_NC4             5   /* File type netCDF version 4           */
#define  FILETYPE_NC4C            6   /* File type netCDF version 4 (classic) */
#define  FILETYPE_SRV             7   /* File type SERVICE                    */
#define  FILETYPE_EXT             8   /* File type EXTRA                      */
#define  FILETYPE_IEG             9   /* File type IEG                        */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
50

51
52
/* Compress types */

53
#define  COMPRESS_NONE            0
54
55
56
#define  COMPRESS_SZIP            1
#define  COMPRESS_GZIP            2
#define  COMPRESS_BZIP2           3
57
#define  COMPRESS_ZIP             4
58
#define  COMPRESS_JPEG            5
59

60
/* external data types */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
61
62
63
64
65

#define  DATATYPE_PACK            0
#define  DATATYPE_PACK1           1
#define  DATATYPE_PACK2           2
#define  DATATYPE_PACK3           3
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
#define  DATATYPE_PACK4           4
#define  DATATYPE_PACK5           5
#define  DATATYPE_PACK6           6
#define  DATATYPE_PACK7           7
#define  DATATYPE_PACK8           8
#define  DATATYPE_PACK9           9
#define  DATATYPE_PACK10         10
#define  DATATYPE_PACK11         11
#define  DATATYPE_PACK12         12
#define  DATATYPE_PACK13         13
#define  DATATYPE_PACK14         14
#define  DATATYPE_PACK15         15
#define  DATATYPE_PACK16         16
#define  DATATYPE_PACK17         17
#define  DATATYPE_PACK18         18
#define  DATATYPE_PACK19         19
#define  DATATYPE_PACK20         20
#define  DATATYPE_PACK21         21
#define  DATATYPE_PACK22         22
#define  DATATYPE_PACK23         23
#define  DATATYPE_PACK24         24
#define  DATATYPE_PACK25         25
#define  DATATYPE_PACK26         26
#define  DATATYPE_PACK27         27
#define  DATATYPE_PACK28         28
#define  DATATYPE_PACK29         29
#define  DATATYPE_PACK30         30
#define  DATATYPE_PACK31         31
#define  DATATYPE_PACK32         32
95
96
#define  DATATYPE_CPX32          64
#define  DATATYPE_CPX64         128
97
98
99
100
101
#define  DATATYPE_FLT32         132
#define  DATATYPE_FLT64         164
#define  DATATYPE_INT8          208
#define  DATATYPE_INT16         216
#define  DATATYPE_INT32         232
Uwe Schulzweida's avatar
Uwe Schulzweida committed
102
#define  DATATYPE_UINT8         308
103
104
#define  DATATYPE_UINT16        316
#define  DATATYPE_UINT32        332
Uwe Schulzweida's avatar
Uwe Schulzweida committed
105

106
107
108
109
110
/* internal data types */

#define  DATATYPE_INT           251
#define  DATATYPE_FLT           252
#define  DATATYPE_TXT           253
111
#define  DATATYPE_CPX           254
112
113


Uwe Schulzweida's avatar
Uwe Schulzweida committed
114
115
/* GRID types */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
116
117
118
119
120
121
122
123
124
125
126
127
128
129
#define  GRID_GENERIC             1  /* Generic grid                            */
#define  GRID_GAUSSIAN            2  /* Regular Gaussian lon/lat grid           */
#define  GRID_GAUSSIAN_REDUCED    3  /* Reduced Gaussian lon/lat grid           */
#define  GRID_LONLAT              4  /* Regular longitude/latitude grid         */
#define  GRID_SPECTRAL            5  /* Spherical harmonic coefficients         */
#define  GRID_FOURIER             6  /* Fourier coefficients                    */
#define  GRID_GME                 7  /* Icosahedral-hexagonal GME grid          */
#define  GRID_TRAJECTORY          8  /* Trajectory                              */
#define  GRID_UNSTRUCTURED        9  /* General unstructured grid               */
#define  GRID_CURVILINEAR        10  /* Curvilinear grid                        */
#define  GRID_LCC                11  /* Lambert Conformal Conic (GRIB)          */
#define  GRID_LCC2               12  /* Lambert Conformal Conic (PROJ)          */
#define  GRID_LAEA               13  /* Lambert Azimuthal Equal Area            */
#define  GRID_SINUSOIDAL         14  /* Sinusoidal                              */
130
#define  GRID_REFERENCE          15  /* Reference to the grid                   */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
131
132
133

/* ZAXIS types */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
134
135
136
137
138
139
140
141
142
143
144
145
146
#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 in meters           */
#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                          */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

/* TAXIS types */

#define  TAXIS_ABSOLUTE           1
#define  TAXIS_RELATIVE           2

/* TIME types */

#define  TIME_CONSTANT            1
#define  TIME_VARIABLE            2

/* TUNIT types */

#define  TUNIT_SECOND             1
#define  TUNIT_MINUTE             2
#define  TUNIT_HOUR               3
#define  TUNIT_DAY                4
#define  TUNIT_MONTH              5
#define  TUNIT_YEAR               6
166
#define  TUNIT_QUARTER            7
167
168
169
#define  TUNIT_3HOURS             8
#define  TUNIT_6HOURS             9
#define  TUNIT_12HOURS           10
Uwe Schulzweida's avatar
Uwe Schulzweida committed
170

Uwe Schulzweida's avatar
Uwe Schulzweida committed
171
172
173
174
175
176
177
178
/* TSTEP types */

#define  TSTEP_INSTANT            1
#define  TSTEP_AVG                2
#define  TSTEP_ACCUM              3
#define  TSTEP_MAX                4
#define  TSTEP_MIN                5
#define  TSTEP_DIFF               6
179
180
181
#define  TSTEP_RANGE              7
#define  TSTEP_INSTANT2           8
#define  TSTEP_INSTANT3           9
Uwe Schulzweida's avatar
Uwe Schulzweida committed
182

Uwe Schulzweida's avatar
Uwe Schulzweida committed
183
184
/* CALENDAR types */

185
#define  CALENDAR_STANDARD        0  /* don't change this value (used also in cgribexlib)! */
186
#define  CALENDAR_PROLEPTIC       1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
187
188
189
#define  CALENDAR_360DAYS         2
#define  CALENDAR_365DAYS         3
#define  CALENDAR_366DAYS         4
190
#define  CALENDAR_NONE            5
Uwe Schulzweida's avatar
Uwe Schulzweida committed
191
192
193
194


/* CDI control routines */

195
char   *cdiStringError(int cdiErrno);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
196
197
198

void    cdiDebug(int debug);

199
char   *cdiLibraryVersion(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
200
201
202
203
void    cdiPrintVersion(void);

void    cdiDefMissval(double missval);
double  cdiInqMissval(void);
204
void    cdiDefGlobal(const char *string, int val);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
205

Uwe Schulzweida's avatar
Uwe Schulzweida committed
206
207
/* CDI converter routines */

208
209
210
/* parameter */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
212
213
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
214
215

/* date format:  YYYYMMDD */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
216
/* time format:    hhmmss */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
217
218
219
220
221
222
223
224

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

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


Uwe Schulzweida's avatar
Uwe Schulzweida committed
225
226
/* STREAM control routines */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
227
228
/*      streamOpenRead: Open a dataset for reading */
int     streamOpenRead(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
229

Uwe Schulzweida's avatar
Uwe Schulzweida committed
230
231
/*      streamOpenWrite: Create a new dataset */
int     streamOpenWrite(const char *path, int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
232

Uwe Schulzweida's avatar
Uwe Schulzweida committed
233
int     streamOpenAppend(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
234

Uwe Schulzweida's avatar
Uwe Schulzweida committed
235
/*      streamClose: Close an open dataset */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
236
237
void    streamClose(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
238
239
240
/*      streamSync: Synchronize an Open Dataset to Disk */
void    streamSync(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
241
242
243
244
245
246
/*      streamDefVlist: Define the Vlist for a stream */
void    streamDefVlist(int streamID, int vlistID);

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

247
/*      streamInqFiletype: Get the filetype */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
248
int     streamInqFiletype(int streamID);
249

250
/*      streamDefByteorder: Define the byteorder */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
251
void    streamDefByteorder(int streamID, int byteorder);
252
253

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

256
257
258
259
260
261
262
263
264
265
266
267
/*      streamDefZtype: Define compression type */
void    streamDefZtype(int streamID, int ztype);

/*      streamDefZlevel: Define compression level */
void    streamDefZlevel(int streamID, int zlevel);

/*      streamInqZtype: Get compression type */
int     streamInqZtype(int streamID);

/*      streamInqZlevel: Get compression level */
int     streamInqZlevel(int streamID);

268
/*      streamDefTimestep: Define time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
269
int     streamDefTimestep(int streamID, int tsID);
270
271

/*      streamInqTimestep: Get time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
272
273
274
275
276
int     streamInqTimestep(int streamID, int tsID);

char   *streamFilename(int streamID);
char   *streamFilesuffix(int filetype);
int     streamNtsteps(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
277
off_t   streamNvals(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
278
279
280
281
282


/* STREAM var I/O routines */

/*      streamReadVar: Read a variable */
283
void    streamReadVar(int streamID, int varID, double *data_vec, int *nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
284
285

/*      streamWriteVar: Write a variable */
286
void    streamWriteVar(int streamID, int varID, const double *data_vec, int nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
287
288

/*      streamReadVarSlice: Read a horizontal slice of a variable */
289
void    streamReadVarSlice(int streamID, int varID, int levelID, double *data_vec, int *nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
290
291

/*      streamWriteVarSlice: Write a horizontal slice of a variable */
292
void    streamWriteVarSlice(int streamID, int varID, int levelID, const double *data_vec, int nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
293
294
295
296
297
298


/* STREAM record I/O routines */

void    streamInqRecord(int streamID, int *varID, int *levelID);
void    streamDefRecord(int streamID, int  varID, int  levelID);
299
300
void    streamReadRecord(int streamID, double *data_vec, int *nmiss);
void    streamWriteRecord(int streamID, const double *data_vec, int nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
301
302
303
304
305
306
void    streamCopyRecord(int streamIDdest, int streamIDsrc);

void    streamInqGinfo(int streamID, int *intnum, float *fltnum);

/* VLIST routines */

307
308
/*      vlistCreate: Create a variable list */
int     vlistCreate(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
309

310
/*      vlistDestroy: Destroy a variable list */
311
void    vlistDestroy(int vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331

/*      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
332
333
334
/*      vlistNumber: Number type in a variable list */
int     vlistNumber(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
/*      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);

void    vlistDefNtsteps(int vlistID, int nts);
int     vlistNtsteps(int vlistID);
int     vlistGridsizeMax(int vlistID);
int     vlistGrid(int vlistID, int index);
int     vlistGridIndex(int vlistID, int gridID);
void    vlistChangeGridIndex(int vlistID, int index, int gridID);
void    vlistChangeGrid(int vlistID, int gridID1, int gridID2);
int     vlistZaxis(int vlistID, int index);
int     vlistZaxisIndex(int vlistID, int zaxisID);
void    vlistChangeZaxisIndex(int vlistID, int index, int zaxisID);
void    vlistChangeZaxis(int vlistID, int zaxisID1, int zaxisID2);
int     vlistNrecs(int vlistID);
356
357

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
363
364
365
366
367
368
369
370
371
372
373
374
375
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 */

/*      vlistDefVar: Create a new Variable */
int     vlistDefVar(int vlistID, int gridID, int zaxisID, int timeID);

376
void    vlistChangeVarGrid(int vlistID, int varID, int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
377
378
379
380
381
382
383
void    vlistChangeVarZaxis(int vlistID, int varID, int zaxisID);

void    vlistInqVar(int vlistID, int varID, int *gridID, int *zaxisID, int *timeID);
int     vlistInqVarGrid(int vlistID, int varID);
int     vlistInqVarZaxis(int vlistID, int varID);
int     vlistInqVarTime(int vlistID, int varID);

384
385
386
387
void    vlistDefVarZtype(int vlistID, int varID, int ztype);
int     vlistInqVarZtype(int vlistID, int varID);
void    vlistDefVarZlevel(int vlistID, int varID, int zlevel);
int     vlistInqVarZlevel(int vlistID, int varID);
388

389
390
391
392
393
394
/*      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
395
/*      vlistDefVarCode: Define the code number of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
396
397
void    vlistDefVarCode(int vlistID, int varID, int code);

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

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

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

407
408
int     vlistInqVarNumber(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
409
410
411
412
413
414
415
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
416
/*      vlistDefVarName: Define the name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
417
418
void    vlistDefVarName(int vlistID, int varID, const char *name);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
422
423
424
425
426
427
/*      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
428
/*      vlistDefVarLongname: Define the long name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
429
430
void    vlistDefVarLongname(int vlistID, int varID, const char *longname);

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

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

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
443
/*      vlistInqVarMissval: Get the missing value of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
444
445
446
447
448
449
double  vlistInqVarMissval(int vlistID, int varID);

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);
450
451
452

void    vlistDefVarTsteptype(int vlistID, int varID, int tsteptype);
int     vlistInqVarTsteptype(int vlistID, int varID);
453
454
455
456
void    vlistDefVarTimave(int vlistID, int varID, int timave);
int     vlistInqVarTimave(int vlistID, int varID);
void    vlistDefVarTimaccu(int vlistID, int varID, int timaccu);
int     vlistInqVarTimaccu(int vlistID, int varID);
457

Uwe Schulzweida's avatar
Uwe Schulzweida committed
458
459
460
461
462
463
464
465
int     vlistInqVarSize(int vlistID, int varID);

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


470
471
/* VLIST attributes */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
472
/*      vlistInqNatts: Get number of variable attributes assigned to this variable */
473
int     vlistInqNatts(int vlistID, int varID, int *nattsp);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
474
/*      vlistInqAtt: Get information about an attribute */
475
476
int     vlistInqAtt(int vlistID, int varID, int attrnum, char *name, int *typep, int *lenp);
int     vlistDelAtt(int vlistID, int varID, const char *name);
477

Uwe Schulzweida's avatar
Uwe Schulzweida committed
478
/*      vlistDefAttInt: Define an integer attribute */
479
480
481
482
int     vlistDefAttInt(int vlistID, int varID, const char *name, int type, int len, const int *ip_vec);
/*      vlistDefAttFlt: Define a floating point attribute */
int     vlistDefAttFlt(int vlistID, int varID, const char *name, int type, int len, const double *dp_vec);
/*      vlistDefAttTxt: Define a text attribute */
483
int     vlistDefAttTxt(int vlistID, int varID, const char *name, int len, const char *tp);
484

Uwe Schulzweida's avatar
Uwe Schulzweida committed
485
/*      vlistInqAttInt: Get the value(s) of an integer attribute */
486
int     vlistInqAttInt(int vlistID, int varID, const char *name, int mlen, int *ip_vec);
487
/*      vlistInqAttFlt: Get the value(s) of a floating point attribute */
488
int     vlistInqAttFlt(int vlistID, int varID, const char *name, int mlen, double *dp_vec);
489
/*      vlistInqAttTxt: Get the value(s) of a text attribute */
490
int     vlistInqAttTxt(int vlistID, int varID, const char *name, int mlen, char *tp);
491
492


Uwe Schulzweida's avatar
Uwe Schulzweida committed
493
494
495
496
497
/* GRID routines */

void    gridName(int gridtype, char *gridname);
char   *gridNamePtr(int gridtype);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
498
499
void    gridCompress(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
500
501
502
void    gridDefMaskGME(int gridID, const int *mask_vec);
int     gridInqMaskGME(int gridID, int *mask_vec);

503
504
void    gridDefMask(int gridID, const int *mask_vec);
int     gridInqMask(int gridID, int *mask_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
505

Uwe Schulzweida's avatar
Uwe Schulzweida committed
506
void    gridPrint(int gridID, int opt);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
507
508
int     gridSize(void);

509
/*      gridCreate: Create a horizontal Grid */
510
int     gridCreate(int gridtype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
511

512
513
514
/*      gridDestroy: Destroy a horizontal Grid */
void    gridDestroy(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
515
516
517
/*      gridDuplicate: Duplicate a Grid */
int     gridDuplicate(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
/*      gridInqType: Get the type of a Grid */
int     gridInqType(int gridID);

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

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

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

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

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

/*      gridDefXvals: Define the values of a X-axis */
537
void    gridDefXvals(int gridID, const double *xvals_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
538
539

/*      gridInqXvals: Get all values of a X-axis */
540
int     gridInqXvals(int gridID, double *xvals_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
541
542

/*      gridDefYvals: Define the values of a Y-axis */
543
void    gridDefYvals(int gridID, const double *yvals_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
544
545

/*      gridInqYvals: Get all values of a Y-axis */
546
int     gridInqYvals(int gridID, double *yvals_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
547
548

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

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

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

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

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

/*      gridDefYunits: Define the units of a Y-axis */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
564
void    gridDefYunits(int gridID, const char *yunits);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603

/*      gridInqXname: Get the name of a X-axis */
void    gridInqXname(int gridID, char *xname);

/*      gridInqXlongname: Get the longname of a X-axis */
void    gridInqXlongname(int gridID, char *xlongname);

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

/*      gridInqXunits: Get the units of a X-axis */
void    gridInqXunits(int gridID, char *xunits);

/*      gridInqYname: Get the name of a Y-axis */
void    gridInqYname(int gridID, char *yname);

/*      gridInqYlongname: Get the longname of a Y-axis */
void    gridInqYlongname(int gridID, char *ylongname);

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

/*      gridInqYunits: Get the units of a Y-axis */
void    gridInqYunits(int gridID, char *yunits);

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

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

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

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

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

605
int     gridIsCircular(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
int     gridIsRotated(int gridID);
double  gridInqXpole(int gridID);
void    gridDefXpole(int gridID, double xpole);
double  gridInqYpole(int gridID);
void    gridDefYpole(int gridID, double ypole);
double  gridInqAngle(int gridID);
void    gridDefAngle(int gridID, double angle);
void    gridDefTrunc(int gridID, int trunc);
int     gridInqTrunc(int gridID);
/* Hexagonal GME grid */
int     gridInqGMEnd(int gridID);
void    gridDefGMEnd(int gridID, int nd);
int     gridInqGMEni(int gridID);
void    gridDefGMEni(int gridID, int ni);
int     gridInqGMEni2(int gridID);
void    gridDefGMEni2(int gridID, int ni2);
int     gridInqGMEni3(int gridID);
void    gridDefGMEni3(int gridID, int ni3);

625
/* Reference grid */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
626
627
628
629
int     gridInqNumber(int gridID);
void    gridDefNumber(int gridID, int number);
int     gridInqPosition(int gridID);
void    gridDefPosition(int gridID, int position);
630
631
int     gridInqReference(int gridID, char *reference);
void    gridDefReference(int gridID, const char *reference);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
632
633


634
/* Lambert Conformal Conic grid (GRIB version) */
635
636
void gridDefLCC(int gridID, double originLon, double originLat, double lonParY, double lat1, double lat2, double xinc, double yinc, int projflag, int scanflag);
void gridInqLCC(int gridID, double *originLon, double *originLat, double *lonParY, double *lat1, double *lat2, double *xinc, double *yinc, int *projflag, int *scanflag);
637

638
639
640
641
/* Lambert Conformal Conic 2 grid (PROJ version) */
void gridDefLcc2(int gridID, double earth_radius, double lon_0, double lat_0, double lat_1, double lat_2);
void gridInqLcc2(int gridID, double *earth_radius, double *lon_0, double *lat_0, double *lat_1, double *lat_2);

642
643
644
645
646
/* Lambert Azimuthal Equal Area grid */
void gridDefLaea(int gridID, double earth_radius, double lon_0, double lat_0);
void gridInqLaea(int gridID, double *earth_radius, double *lon_0, double *lat_0);


647
648
void    gridDefArea(int gridID, const double *area_vec);
void    gridInqArea(int gridID, double *area_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
649
650
651
652
653
654
655
656
657
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 */
658
void    gridDefXbounds(int gridID, const double *xbounds_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
659
660

/*      gridInqXbounds: Get the bounds of a X-axis */
661
int     gridInqXbounds(int gridID, double *xbounds_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
662
663

/*      gridDefYbounds: Define the bounds of a Y-axis */
664
void    gridDefYbounds(int gridID, const double *ybounds_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
665
666

/*      gridInqYbounds: Get the bounds of a Y-axis */
667
int     gridInqYbounds(int gridID, double *ybounds_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
668

669
670
void    gridDefRowlon(int gridID, int nrowlon, const int *rowlon_vec);
void    gridInqRowlon(int gridID, int *rowlon_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
671
672
void    gridChangeType(int gridID, int gridtype);

673
674
675
void    gridDefComplexPacking(int gridID, int lpack);
int     gridInqComplexPacking(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
676
677
/* ZAXIS routines */

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

680
/*      zaxisCreate: Create a vertical Z-axis */
681
int     zaxisCreate(int zaxistype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
682

683
684
685
/*      zaxisDestroy: Destroy a vertical Z-axis */
void    zaxisDestroy(int zaxisID);

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

void    zaxisResize(int zaxisID, int size);

void    zaxisPrint(int zaxisID);
int     zaxisSize(void);

/*      zaxisDefLevels: Define the levels of a Z-axis */
701
void    zaxisDefLevels(int zaxisID, const double *levels_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
702
703

/*      zaxisInqLevels: Get all levels of a Z-axis */
704
void    zaxisInqLevels(int zaxisID, double *levels_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726

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

/*      zaxisDefName: Define the name of a Z-axis */
void    zaxisDefName(int zaxisID, const char *name);

/*      zaxisDefLongname: Define the longname of a Z-axis */
void    zaxisDefLongname(int zaxisID, const char *longname);

/*      zaxisDefUnits: Define the units of a Z-axis */
void    zaxisDefUnits(int zaxisID, const char *units);

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

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

727
728
729
/*      zaxisInqStdname: Get the standard name of a Z-axis */
void    zaxisInqStdname(int zaxisID, char *stdname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
730
731
732
733
734
/*      zaxisInqUnits: Get the units of a Z-axis */
void    zaxisInqUnits(int zaxisID, char *units);

void    zaxisDefPrec(int zaxisID, int prec);
int     zaxisInqPrec(int zaxisID);
735

736
737
int     zaxisInqPositive(int zaxisID);

738
739
740
void    zaxisDefLtype(int zaxisID, int ltype);
int     zaxisInqLtype(int zaxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
741
const double *zaxisInqLevelsPtr(int zaxisID);
742
void    zaxisDefVct(int zaxisID, int size, const double *vct_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
743
744
int     zaxisInqVctSize(int zaxisID);
const double *zaxisInqVctPtr(int zaxisID);
745
746
747
int     zaxisInqLbounds(int zaxisID, double *lbounds_vec);
int     zaxisInqUbounds(int zaxisID, double *ubounds_vec);
int     zaxisInqWeights(int zaxisID, double *weights_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
748
749
double  zaxisInqLbound(int zaxisID, int index);
double  zaxisInqUbound(int zaxisID, int index);
750
751
752
void    zaxisDefLbounds(int zaxisID, const double *lbounds_vec);
void    zaxisDefUbounds(int zaxisID, const double *ubounds_vec);
void    zaxisDefWeights(int zaxisID, const double *weights_vec);
753
void    zaxisChangeType(int zaxisID, int zaxistype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
754
755
756

/* TAXIS routines */

757
/*      taxisCreate: Create a Time axis */
758
int     taxisCreate(int timetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
759

760
761
762
/*      taxisDestroy: Destroy a Time axis */
void    taxisDestroy(int taxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
int     taxisDuplicate(int taxisID);

void    taxisCopyTimestep(int taxisIDdes, int taxisIDsrc);

void    taxisDefType(int taxisID, int type);

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

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

/*      taxisDefRdate: Define the reference date */
void    taxisDefRdate(int taxisID, int date);

/*      taxisDefRtime: Define the reference date */
void    taxisDefRtime(int taxisID, int time);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
781
int     taxisHasBounds(int taxisID);
782
783

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

785
786
787
788
void    taxisDefVdateBounds(int taxisID, int vdate_lb, int vdate_ub);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
789
790
791
792
void    taxisInqVdateBounds(int taxisID, int *vdate_lb, int *vdate_ub);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
/*      taxisDefCalendar: Define the calendar */
void    taxisDefCalendar(int taxisID, int calendar);

void    taxisDefTunit(int taxisID, int tunit);

void    taxisDefNumavg(int taxisID, int numavg);

int     taxisInqType(int taxisID);

/*      taxisInqVdate: Get the verification date */
int     taxisInqVdate(int taxisID);

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

/*      taxisInqRdate: Get the reference date */
int     taxisInqRdate(int taxisID);

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

/*      taxisInqCalendar: Get the calendar */
int     taxisInqCalendar(int taxisID);

int     taxisInqTunit(int taxisID);

int     taxisInqNumavg(int taxisID);

char   *tunitNamePtr(int tunitID);


/* Institut routines */

int     institutDef(int center, int subcenter, const char *name, const char *longname);
int     institutInq(int center, int subcenter, const char *name, const char *longname);
int     institutInqNumber(void);
int     institutInqCenter(int instID);
int     institutInqSubcenter(int instID);
char   *institutInqNamePtr(int instID);
char   *institutInqLongnamePtr(int instID);

/* Model routines */

int     modelDef(int instID, int modelgribID, const char *name);
int     modelInq(int instID, int modelgribID, char *name);
int     modelInqInstitut(int modelID);
int     modelInqGribID(int modelID);
char   *modelInqNamePtr(int modelID);

/* Table routines */

void    tableWriteC(const char *filename, int tableID);
void    tableWrite(const char *filename, int tableID);
int     tableRead(const char *tablefile);
int     tableDef(int modelID, int tablenum, const char *tablename);

char   *tableInqNamePtr(int tableID);
void    tableDefEntry(int tableID, int code, const char *name, const char *longname, const char *units);

int     tableInq(int modelID, int tablenum, const char *tablename);
int     tableInqNumber(void);

int     tableInqNum(int tableID);
int     tableInqModel(int tableID);

void    tableInqPar(int tableID, int code, char *name, char *longname, char *units);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
860
int     tableInqParCode(int tableID, char *name, int *code);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
int     tableInqParName(int tableID, int code, char *name);
int     tableInqParLongname(int tableID, int code, char *longname);
int     tableInqParUnits(int tableID, int code, char *units);

char   *tableInqParNamePtr(int tableID, int parID);
char   *tableInqParLongnamePtr(int tableID, int parID);
char   *tableInqParUnitsPtr(int tableID, int parID);

/* History routines */

void    streamDefHistory(int streamID, int size, const char *history);
int     streamInqHistorySize(int streamID);
void    streamInqHistoryString(int streamID, char *history);

#if defined (__cplusplus)
}
#endif

#endif  /* _CDI_H */