cdi.h 29 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1
2
3
#ifndef  _CDI_H
#define  _CDI_H

Uwe Schulzweida's avatar
Uwe Schulzweida committed
4
5
#include <sys/types.h>

Uwe Schulzweida's avatar
Uwe Schulzweida committed
6
7
8
9
10
#if defined(__cplusplus)
extern "C" {
#endif

#define  CDI_UNDEFID             -1
11
#define  CDI_GLOBAL              -1   /* Global var ID for vlist  */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
12
#define  CDI_UNDEFPARAM  2147483647
Uwe Schulzweida's avatar
Uwe Schulzweida committed
13

14
15
16
17
18
/* Byte order */

#define  CDI_BIGENDIAN            0   /* Byte order BIGENDIAN     */
#define  CDI_LITTLEENDIAN         1   /* Byte order LITTLEENDIAN  */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
19
20
21
22
#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
23
24
/* Error identifier */

25
26
27
28
29
30
#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
31
#define  CDI_EUNC4              -24   /* Unsupported netCDF4 structure        */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
32
33
34

/* File types */

35
#define  FILETYPE_GRB             1   /* File type GRIB                       */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
36
#define  FILETYPE_GRB2            2   /* File type GRIB version 2             */
37
#define  FILETYPE_NC              3   /* File type netCDF                     */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
38
#define  FILETYPE_NC2             4   /* File type netCDF version 2 (64-bit)  */
39
40
41
42
#define  FILETYPE_NC4             5   /* File type netCDF version 4 (classic) */
#define  FILETYPE_SRV             6   /* File type SERVICE                    */
#define  FILETYPE_EXT             7   /* File type EXTRA                      */
#define  FILETYPE_IEG             8   /* File type IEG                        */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
43

44
45
/* Compress types */

46
#define  COMPRESS_NONE            0
47
48
49
#define  COMPRESS_SZIP            1
#define  COMPRESS_GZIP            2
#define  COMPRESS_BZIP2           3
50
#define  COMPRESS_ZIP             4
51
#define  COMPRESS_JPEG            5
52

53
/* external data types */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
54
55
56
57
58

#define  DATATYPE_PACK            0
#define  DATATYPE_PACK1           1
#define  DATATYPE_PACK2           2
#define  DATATYPE_PACK3           3
59
60
61
62
63
64
65
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
#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
#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
93
#define  DATATYPE_UINT8         308
94
95
#define  DATATYPE_UINT16        316
#define  DATATYPE_UINT32        332
Uwe Schulzweida's avatar
Uwe Schulzweida committed
96

97
98
99
100
101
102
103
/* internal data types */

#define  DATATYPE_INT           251
#define  DATATYPE_FLT           252
#define  DATATYPE_TXT           253


Uwe Schulzweida's avatar
Uwe Schulzweida committed
104
105
106
107
108
109
110
111
/* GRID types */

#define  GRID_GENERIC             1
#define  GRID_GAUSSIAN            2
#define  GRID_GAUSSIAN_REDUCED    3
#define  GRID_LONLAT              4
#define  GRID_SPECTRAL            5
#define  GRID_FOURIER             6
112
#define  GRID_GME                 7  /* Icosahedral-hexagonal GME Grid */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
113
114
115
#define  GRID_TRAJECTORY          8
#define  GRID_CELL                9
#define  GRID_CURVILINEAR        10
116
117
118
119
#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                     */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
120
121
122
123
124
125
126
127
128
129
130
131
132
133

/* ZAXIS types */

#define  ZAXIS_SURFACE            0
#define  ZAXIS_GENERIC            1
#define  ZAXIS_HYBRID             2
#define  ZAXIS_HYBRID_HALF        3
#define  ZAXIS_PRESSURE           4
#define  ZAXIS_HEIGHT             5
#define  ZAXIS_DEPTH_BELOW_SEA    6
#define  ZAXIS_DEPTH_BELOW_LAND   7
#define  ZAXIS_ISENTROPIC         8
#define  ZAXIS_TRAJECTORY         9
#define  ZAXIS_ALTITUDE          10
Uwe Schulzweida's avatar
Uwe Schulzweida committed
134
#define  ZAXIS_SIGMA             11
135
#define  ZAXIS_MEANSEA           12
Uwe Schulzweida's avatar
Uwe Schulzweida committed
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

/* 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
155
#define  TUNIT_QUARTER            7
Uwe Schulzweida's avatar
Uwe Schulzweida committed
156
157
158

/* CALENDAR types */

159
160
#define  CALENDAR_STANDARD        0  /* don't change this value (used also in griblib)! */
#define  CALENDAR_PROLEPTIC       1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
161
162
163
#define  CALENDAR_360DAYS         2
#define  CALENDAR_365DAYS         3
#define  CALENDAR_366DAYS         4
164
#define  CALENDAR_NONE            5
Uwe Schulzweida's avatar
Uwe Schulzweida committed
165
166
167
168


/* CDI control routines */

169
char   *cdiStringError(int cdiErrno);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
170
171
172

void    cdiDebug(int debug);

173
char   *cdiLibraryVersion(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
174
175
176
177
void    cdiPrintVersion(void);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
180
181
182
183
/* CDI converter routines */

/* param format:  DDDCCCNNN */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
184
185
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
186
187

/* date format:  YYYYMMDD */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
188
/* time format:    hhmmss */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
189
190
191
192
193
194
195
196

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
197
198
/* STREAM control routines */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
199
200
/*      streamOpenRead: Open a dataset for reading */
int     streamOpenRead(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
201

Uwe Schulzweida's avatar
Uwe Schulzweida committed
202
203
/*      streamOpenWrite: Create a new dataset */
int     streamOpenWrite(const char *path, int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
204

Uwe Schulzweida's avatar
Uwe Schulzweida committed
205
int     streamOpenAppend(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
206

Uwe Schulzweida's avatar
Uwe Schulzweida committed
207
/*      streamClose: Close an open dataset */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
208
209
void    streamClose(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
210
211
212
/*      streamSync: Synchronize an Open Dataset to Disk */
void    streamSync(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
213
214
215
216
217
218
/*      streamDefVlist: Define the Vlist for a stream */
void    streamDefVlist(int streamID, int vlistID);

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

219
/*      streamInqFiletype: Get the filetype */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
220
int     streamInqFiletype(int streamID);
221

222
/*      streamDefByteorder: Define the byteorder */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
223
void    streamDefByteorder(int streamID, int byteorder);
224
225

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

228
229
230
231
232
233
234
235
236
237
238
239
/*      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);

240
/*      streamDefTimestep: Define time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
241
int     streamDefTimestep(int streamID, int tsID);
242
243

/*      streamInqTimestep: Get time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
244
245
246
247
248
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
249
off_t   streamNvals(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
250
251
252
253
254


/* STREAM var I/O routines */

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

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

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

/*      streamWriteVarSlice: Write a horizontal slice of a variable */
264
void    streamWriteVarSlice(int streamID, int varID, int levelID, const double *data_vec, int nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
265
266
267
268
269
270


/* STREAM record I/O routines */

void    streamInqRecord(int streamID, int *varID, int *levelID);
void    streamDefRecord(int streamID, int  varID, int  levelID);
271
272
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
273
274
275
276
277
278
void    streamCopyRecord(int streamIDdest, int streamIDsrc);

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

/* VLIST routines */

279
280
/*      vlistCreate: Create a variable list */
int     vlistCreate(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
281

282
/*      vlistDestroy: Destroy a variable list */
283
void    vlistDestroy(int vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303

/*      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
304
305
306
/*      vlistNumber: Number type in a variable list */
int     vlistNumber(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
/*      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);
328
329

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
335
336
337
338
339
340
341
342
343
344
345
346
347
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);

348
void    vlistChangeVarGrid(int vlistID, int varID, int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
349
350
351
352
353
354
355
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);

356
357
358
359
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);
360

361
362
363
364
365
366
/*      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
367
/*      vlistDefVarCode: Define the code number of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
368
369
void    vlistDefVarCode(int vlistID, int varID, int code);

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

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
379
380
381
382
383
384
/*      vlistDefVarNumber: Define the number type of a Variable */
void    vlistDefVarNumber(int vlistID, int varID, int number);

/*      vlistInqVarNumber: Get the number type of a Variable */
int     vlistInqVarNumber(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
385
386
387
388
389
390
391
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
392
/*      vlistDefVarName: Define the name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
393
394
void    vlistDefVarName(int vlistID, int varID, const char *name);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
398
399
400
401
402
403
/*      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
404
/*      vlistDefVarLongname: Define the long name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
405
406
void    vlistDefVarLongname(int vlistID, int varID, const char *longname);

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

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

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
419
/*      vlistInqVarMissval: Get the missing value of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
420
421
422
423
424
425
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);
426
427
428
429
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);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
430
int     vlistInqVarSize(int vlistID, int varID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
431
int     vlistInqVarID(int vlistID, int code);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
432
433
434
435
436
437
438

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);
439
440
int     vlistMergedVar(int vlistID, int varID);
int     vlistMergedLevel(int vlistID, int varID, int levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
441
442


443
444
/* VLIST attributes */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
445
/*      vlistInqNatts: Get number of variable attributes assigned to this variable */
446
int     vlistInqNatts(int vlistID, int varID, int *nattsp);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
447
/*      vlistInqAtt: Get information about an attribute */
448
449
int     vlistInqAtt(int vlistID, int varID, int attrnum, char *name, int *typep, int *lenp);
int     vlistDelAtt(int vlistID, int varID, const char *name);
450

Uwe Schulzweida's avatar
Uwe Schulzweida committed
451
/*      vlistDefAttInt: Define an integer attribute */
452
int     vlistDefAttInt(int vlistID, int varID, const char *name, int len, const int *ip_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
453
/*      vlistDefAttInt: Define a floating point attribute */
454
int     vlistDefAttFlt(int vlistID, int varID, const char *name, int len, const double *dp_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
455
/*      vlistDefAttInt: Define a text attribute */
456
int     vlistDefAttTxt(int vlistID, int varID, const char *name, int len, const char *tp);
457

Uwe Schulzweida's avatar
Uwe Schulzweida committed
458
/*      vlistInqAttInt: Get the value(s) of an integer attribute */
459
int     vlistInqAttInt(int vlistID, int varID, const char *name, int mlen, int *ip_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
460
/*      vlistInqAttInt: Get the value(s) of a floating point attribute */
461
int     vlistInqAttFlt(int vlistID, int varID, const char *name, int mlen, double *dp_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
462
/*      vlistInqAttInt: Get the value(s) of a text attribute */
463
int     vlistInqAttTxt(int vlistID, int varID, const char *name, int mlen, char *tp);
464
465


Uwe Schulzweida's avatar
Uwe Schulzweida committed
466
467
468
469
470
/* GRID routines */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
471
472
void    gridCompress(int gridID);

473
474
void    gridDefMask(int gridID, const int *mask_vec);
int     gridInqMask(int gridID, int *mask_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
475

Uwe Schulzweida's avatar
Uwe Schulzweida committed
476
void    gridPrint(int gridID, int opt);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
477
478
int     gridSize(void);

479
/*      gridCreate: Create a horizontal Grid */
480
int     gridCreate(int gridtype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
481

482
483
484
/*      gridDestroy: Destroy a horizontal Grid */
void    gridDestroy(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
485
486
487
/*      gridDuplicate: Duplicate a Grid */
int     gridDuplicate(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
/*      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 */
507
void    gridDefXvals(int gridID, const double *xvals_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
508
509

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

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

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

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

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

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

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

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

/*      gridDefYunits: Define the units of a Y-axis */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
534
void    gridDefYunits(int gridID, const char *yunits);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573

/*      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
574

575
int     gridIsCircular(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
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);

595
/* Lambert Conformal Conic grid (GRIB version) */
596
597
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);
598

599
600
601
602
/* 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);

603
604
605
606
607
/* 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);


608
609
void    gridDefArea(int gridID, const double *area_vec);
void    gridInqArea(int gridID, double *area_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
610
611
612
613
614
615
616
617
618
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 */
619
void    gridDefXbounds(int gridID, const double *xbounds_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
620
621

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

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

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

630
631
void    gridDefRowlon(int gridID, int nrowlon, const int *rowlon_vec);
void    gridInqRowlon(int gridID, int *rowlon_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
632
633
634
635
void    gridChangeType(int gridID, int gridtype);

/* ZAXIS routines */

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

638
/*      zaxisCreate: Create a vertical Z-axis */
639
int     zaxisCreate(int zaxistype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
640

641
642
643
/*      zaxisDestroy: Destroy a vertical Z-axis */
void    zaxisDestroy(int zaxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
/*      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 */
659
void    zaxisDefLevels(int zaxisID, const double *levels_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
660
661

/*      zaxisInqLevels: Get all levels of a Z-axis */
662
void    zaxisInqLevels(int zaxisID, double *levels_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689

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

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

void    zaxisDefPrec(int zaxisID, int prec);
int     zaxisInqPrec(int zaxisID);
690
691
692
693

void    zaxisDefLtype(int zaxisID, int ltype);
int     zaxisInqLtype(int zaxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
694
const double *zaxisInqLevelsPtr(int zaxisID);
695
void    zaxisDefVct(int zaxisID, int size, const double *vct_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
696
697
int     zaxisInqVctSize(int zaxisID);
const double *zaxisInqVctPtr(int zaxisID);
698
699
700
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
701
702
double  zaxisInqLbound(int zaxisID, int index);
double  zaxisInqUbound(int zaxisID, int index);
703
704
705
void    zaxisDefLbounds(int zaxisID, const double *lbounds_vec);
void    zaxisDefUbounds(int zaxisID, const double *ubounds_vec);
void    zaxisDefWeights(int zaxisID, const double *weights_vec);
706
void    zaxisChangeType(int zaxisID, int zaxistype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
707
708
709

/* TAXIS routines */

710
/*      taxisCreate: Create a Time axis */
711
int     taxisCreate(int timetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
712

713
714
715
/*      taxisDestroy: Destroy a Time axis */
void    taxisDestroy(int taxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
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
734
735
int     taxisHasBounds(int taxisID);

736
737
738
739
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
740
741
742
743
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
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
/*      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
811
int     tableInqParCode(int tableID, char *name, int *code);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
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 */