cdi.h 38.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

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

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

Deike Kleberg's avatar
Deike Kleberg committed
16
17
#define  CDI_MAX_NAME           256   /* max length of a name                 */

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

21
22
/* Byte order */

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

26
27
28
#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
29

Uwe Schulzweida's avatar
Uwe Schulzweida committed
30
31
/* Error identifier */

32
33
34
35
36
37
#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
38
#define  CDI_EUNC4              -24   /* Unsupported netCDF4 structure        */
39
#define  CDI_ELIMIT             -99   /* Internal limits exceeded             */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
40
41
42

/* File types */

43
#define  FILETYPE_GRB             1   /* File type GRIB                       */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
44
#define  FILETYPE_GRB2            2   /* File type GRIB version 2             */
45
#define  FILETYPE_NC              3   /* File type netCDF                     */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
46
#define  FILETYPE_NC2             4   /* File type netCDF version 2 (64-bit)  */
Deike Kleberg's avatar
Deike Kleberg committed
47
48
49
50
51
#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
52

53
54
/* Compress types */

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

62
/* external data types */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
63
64
65
66
67

#define  DATATYPE_PACK            0
#define  DATATYPE_PACK1           1
#define  DATATYPE_PACK2           2
#define  DATATYPE_PACK3           3
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
95
96
#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
97
98
#define  DATATYPE_CPX32          64
#define  DATATYPE_CPX64         128
99
100
101
102
103
#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
104
#define  DATATYPE_UINT8         308
105
106
#define  DATATYPE_UINT16        316
#define  DATATYPE_UINT32        332
Uwe Schulzweida's avatar
Uwe Schulzweida committed
107

108
109
110
111
/* internal data types */
#define  DATATYPE_INT           251
#define  DATATYPE_FLT           252
#define  DATATYPE_TXT           253
112
#define  DATATYPE_CPX           254
113
#define  DATATYPE_UCHAR         255
114

115
116
/* Chunks */

117
118
119
#define  CHUNK_AUTO                 1  /* use default chunk size                                */
#define  CHUNK_GRID                 2
#define  CHUNK_LINES                3
120

Uwe Schulzweida's avatar
Uwe Schulzweida committed
121
122
/* GRID types */

123
124
125
126
127
128
129
130
131
132
133
134
135
136
#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                                            */
137
#define  GRID_PROJECTION           15  /* Projected coordiantes                                 */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
138
139
140

/* ZAXIS types */

141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
#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                                        */
#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                                */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
167

168
169
/* TIME types */

170
171
#define  TIME_CONSTANT              0  /* obsolate, use TSTEP_CONSTANT                          */
#define  TIME_VARIABLE              1  /* obsolate, use TSTEP_INSTANT                           */
172
173
174

/* TSTEP types */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
175
176
177
178
179
180
181
182
183
184
185
186
187
188
#define  TSTEP_CONSTANT             0  /* Constant            */
#define  TSTEP_INSTANT              1  /* Instant             */
#define  TSTEP_AVG                  2  /* Average             */
#define  TSTEP_ACCUM                3  /* Accumulation        */
#define  TSTEP_MAX                  4  /* Maximum             */
#define  TSTEP_MIN                  5  /* Minimum             */
#define  TSTEP_DIFF                 6  /* Difference          */
#define  TSTEP_RMS                  7  /* Root mean square    */
#define  TSTEP_SD                   8  /* Standard deviation  */
#define  TSTEP_COV                  9  /* Covariance          */
#define  TSTEP_RATIO               10  /* Ratio               */
#define  TSTEP_RANGE               11
#define  TSTEP_INSTANT2            12
#define  TSTEP_INSTANT3            13
189

Uwe Schulzweida's avatar
Uwe Schulzweida committed
190
191
192
193
194
195
196
197
198
199
200
201
202
/* TAXIS types */

#define  TAXIS_ABSOLUTE           1
#define  TAXIS_RELATIVE           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
203
#define  TUNIT_QUARTER            7
204
205
206
#define  TUNIT_3HOURS             8
#define  TUNIT_6HOURS             9
#define  TUNIT_12HOURS           10
Uwe Schulzweida's avatar
Uwe Schulzweida committed
207
208
209

/* CALENDAR types */

210
#define  CALENDAR_STANDARD        0  /* don't change this value (used also in cgribexlib)! */
211
#define  CALENDAR_PROLEPTIC       1
Uwe Schulzweida's avatar
Uwe Schulzweida committed
212
213
214
#define  CALENDAR_360DAYS         2
#define  CALENDAR_365DAYS         3
#define  CALENDAR_366DAYS         4
215
#define  CALENDAR_NONE            5
Uwe Schulzweida's avatar
Uwe Schulzweida committed
216

217

218
219
220
/* CDI control routines */

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

222
char   *cdiStringError(int cdiErrno);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
223
224
225

void    cdiDebug(int debug);

226
char   *cdiLibraryVersion(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
227
228
void    cdiPrintVersion(void);

229
230
int     cdiHaveFiletype(int filetype);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
231
232
void    cdiDefMissval(double missval);
double  cdiInqMissval(void);
233
void    cdiDefGlobal(const char *string, int val);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
234

235
236
237
238
239
int     namespaceNew();
void    namespaceSetActive(int namespaceID);
void    namespaceDelete(int namespaceID);


Uwe Schulzweida's avatar
Uwe Schulzweida committed
240
241
/* CDI converter routines */

242
243
244
/* parameter */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
246
247
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
248
249

/* date format:  YYYYMMDD */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
250
/* time format:    hhmmss */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
251
252
253
254
255
256
257
258

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
259
260
/* STREAM control routines */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
261
262
/*      streamOpenRead: Open a dataset for reading */
int     streamOpenRead(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
263

Uwe Schulzweida's avatar
Uwe Schulzweida committed
264
265
/*      streamOpenWrite: Create a new dataset */
int     streamOpenWrite(const char *path, int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
266

Uwe Schulzweida's avatar
Uwe Schulzweida committed
267
int     streamOpenAppend(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
268

Uwe Schulzweida's avatar
Uwe Schulzweida committed
269
/*      streamClose: Close an open dataset */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
270
271
void    streamClose(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
272
273
274
/*      streamSync: Synchronize an Open Dataset to Disk */
void    streamSync(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
275
276
277
278
279
/*      streamDefVlist: Define the Vlist for a stream */
void    streamDefVlist(int streamID, int vlistID);

/*      streamInqVlist: Get the Vlist of a stream */
int     streamInqVlist(int streamID);
280
int     streamInqVlistIDorig(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
281

282
/*      streamInqFiletype: Get the filetype */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
283
int     streamInqFiletype(int streamID);
284

285
/*      streamDefByteorder: Define the byteorder */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
286
void    streamDefByteorder(int streamID, int byteorder);
287
288

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

Deike Kleberg's avatar
Deike Kleberg committed
291
292
/*      streamDefCompType: Define compression type */
void    streamDefCompType(int streamID, int comptype);
293

Deike Kleberg's avatar
Deike Kleberg committed
294
295
/*      streamDefCompLevel: Define compression level */
void    streamDefCompLevel(int streamID, int complevel);
296

Deike Kleberg's avatar
Deike Kleberg committed
297
298
/*      streamInqCompType: Get compression type */
int     streamInqCompType(int streamID);
299

Deike Kleberg's avatar
Deike Kleberg committed
300
301
/*      streamInqCompLevel: Get compression level */
int     streamInqCompLevel(int streamID);
302

303
/*      streamDefTimestep: Define time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
304
int     streamDefTimestep(int streamID, int tsID);
305

306
307
308
/* query currently set timestep id  */
int streamInqCurTimestepID(int streamID);

309
/*      streamInqTimestep: Get time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
310
311
312
313
314
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
315
off_t   streamNvals(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
316

Deike Kleberg's avatar
Deike Kleberg committed
317
int     streamInqNvars ( int streamID );
Uwe Schulzweida's avatar
Uwe Schulzweida committed
318
319
320
321

/* STREAM var I/O routines */

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

/*      streamWriteVar: Write a variable */
325
void    streamWriteVar(int streamID, int varID, const double *data_vec, int nmiss);
326
void    streamWriteVarF(int streamID, int varID, const float *data_vec, int nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
327
328

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

/*      streamWriteVarSlice: Write a horizontal slice of a variable */
332
void    streamWriteVarSlice(int streamID, int varID, int levelID, const double *data_vec, int nmiss);
333
void    streamWriteVarSliceF(int streamID, int varID, int levelID, const float *data_vec, int nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
334

335
336
337
void    streamWriteVarChunk(int streamID, int varID, const int rect[][2],
                            const double *data_vec, int nmiss);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
338
339
340
341
342

/* STREAM record I/O routines */

void    streamInqRecord(int streamID, int *varID, int *levelID);
void    streamDefRecord(int streamID, int  varID, int  levelID);
343
344
void    streamReadRecord(int streamID, double *data_vec, int *nmiss);
void    streamWriteRecord(int streamID, const double *data_vec, int nmiss);
345
void    streamWriteRecordF(int streamID, const float *data_vec, int nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
346
347
void    streamCopyRecord(int streamIDdest, int streamIDsrc);

348
void    streamInqGinfo(int streamID, int *intnum, float *fltnum, off_t *bignum);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
349
350
351

/* VLIST routines */

352
353
/*      vlistCreate: Create a variable list */
int     vlistCreate(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
354

355
/*      vlistDestroy: Destroy a variable list */
356
void    vlistDestroy(int vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376

/*      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
377
378
379
/*      vlistNumber: Number type in a variable list */
int     vlistNumber(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
/*      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);
401
402

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
408
409
410
411
412
413
414
415
416
417
418
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 */
419
int     vlistDefVar(int vlistID, int gridID, int zaxisID, int tsteptype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
420

421
void    vlistChangeVarGrid(int vlistID, int varID, int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
422
423
void    vlistChangeVarZaxis(int vlistID, int varID, int zaxisID);

424
void    vlistInqVar(int vlistID, int varID, int *gridID, int *zaxisID, int *tsteptype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
425
426
int     vlistInqVarGrid(int vlistID, int varID);
int     vlistInqVarZaxis(int vlistID, int varID);
427
428
429
430
431
432

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

int     vlistInqVarTsteptype(int vlistID, int varID);
void    vlistDefVarTsteptype(int vlistID, int varID, int tsteptype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
433

Deike Kleberg's avatar
Deike Kleberg committed
434
435
436
437
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);
438

439
440
441
442
443
444
/*      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
445
/*      vlistDefVarCode: Define the code number of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
446
447
void    vlistDefVarCode(int vlistID, int varID, int code);

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

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

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

457
458
459
void    vlistDefVarChunkType(int vlistID, int varID, int chunktype);
int     vlistInqVarChunkType(int vlistID, int varID);

460
461
462
void    vlistDefVarXYZ(int vlistID, int varID, int xyz);
int     vlistInqVarXYZ(int vlistID, int varID);

463
464
int     vlistInqVarNumber(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
465
466
467
468
469
470
471
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
472
/*      vlistDefVarName: Define the name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
473
474
void    vlistDefVarName(int vlistID, int varID, const char *name);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
478
479
480
481
482
483
/*      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
484
/*      vlistDefVarLongname: Define the long name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
485
486
void    vlistDefVarLongname(int vlistID, int varID, const char *longname);

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

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

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

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

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

502
503
504
505
506
507
/*      vlistDefVarExtra: Define extra information of a Variable */
void    vlistDefVarExtra(int vlistID, int varID, const char *extra);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
508
509
510
511
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);
512

513
514
515
516
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);
517

518
519
520
void    vlistDefVarTypeOfGeneratingProcess(int vlistID, int varID, int typeOfGeneratingProcess);
int     vlistInqVarTypeOfGeneratingProcess(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
521
522
523
524
525
526
527
528
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);
529
530
int     vlistMergedVar(int vlistID, int varID);
int     vlistMergedLevel(int vlistID, int varID, int levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
531

532
533
534
/*     Ensemble info routines */
void    vlistDefVarEnsemble(int vlistID, int varID, int ensID, int ensCount, int forecast_type);
int     vlistInqVarEnsemble(int vlistID, int varID, int *ensID, int *ensCount, int *forecast_type);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
535

536
537
538
539
/* cdiClearAdditionalKeys: Clear the list of additional GRIB keys. */
void    cdiClearAdditionalKeys();
/* cdiDefAdditionalKey: Register an additional GRIB key which is read when file is opened. */
void    cdiDefAdditionalKey(const char *string);
540
541
542
543
544
545

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

546
/* vlistHasVarKey: returns 1 if meta-data key was read, 0 otherwise. */
547
int     vlistHasVarKey(int vlistID, int varID, const char *name);
548
/* vlistInqVarDblKey: raw access to GRIB meta-data */
549
double  vlistInqVarDblKey(int vlistID, int varID, const char *name);
550
/* vlistInqVarIntKey: raw access to GRIB meta-data */
551
int     vlistInqVarIntKey(int vlistID, int varID, const char *name);
552
553


554
555
/* VLIST attributes */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
556
/*      vlistInqNatts: Get number of variable attributes assigned to this variable */
557
int     vlistInqNatts(int vlistID, int varID, int *nattsp);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
558
/*      vlistInqAtt: Get information about an attribute */
559
560
int     vlistInqAtt(int vlistID, int varID, int attrnum, char *name, int *typep, int *lenp);
int     vlistDelAtt(int vlistID, int varID, const char *name);
561

Uwe Schulzweida's avatar
Uwe Schulzweida committed
562
/*      vlistDefAttInt: Define an integer attribute */
563
564
565
566
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 */
567
int     vlistDefAttTxt(int vlistID, int varID, const char *name, int len, const char *tp_cbuf);
568

Uwe Schulzweida's avatar
Uwe Schulzweida committed
569
/*      vlistInqAttInt: Get the value(s) of an integer attribute */
570
int     vlistInqAttInt(int vlistID, int varID, const char *name, int mlen, int *ip_vec);
571
/*      vlistInqAttFlt: Get the value(s) of a floating point attribute */
572
int     vlistInqAttFlt(int vlistID, int varID, const char *name, int mlen, double *dp_vec);
573
/*      vlistInqAttTxt: Get the value(s) of a text attribute */
574
int     vlistInqAttTxt(int vlistID, int varID, const char *name, int mlen, char *tp_cbuf);
575
576


Uwe Schulzweida's avatar
Uwe Schulzweida committed
577
578
579
580
581
/* GRID routines */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
582
583
void    gridCompress(int gridID);

584
585
586
void    gridDefMaskGME(int gridID, const int *mask_vec);
int     gridInqMaskGME(int gridID, int *mask_vec);

587
588
void    gridDefMask(int gridID, const int *mask_vec);
int     gridInqMask(int gridID, int *mask_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
589

Uwe Schulzweida's avatar
Uwe Schulzweida committed
590
void    gridPrint(int gridID, int opt);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
591

592
/*      gridCreate: Create a horizontal Grid */
593
int     gridCreate(int gridtype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
594

595
596
597
/*      gridDestroy: Destroy a horizontal Grid */
void    gridDestroy(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
598
599
600
/*      gridDuplicate: Duplicate a Grid */
int     gridDuplicate(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
/*      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);

619
620
621
622
623
624
/*      gridDefNP: Define the number of parallels between a pole and the equator */
void    gridDefNP(int gridID, int np);

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

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

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

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

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

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

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

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

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

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

/*      gridDefYunits: Define the units of a Y-axis */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
653
void    gridDefYunits(int gridID, const char *yunits);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
654
655
656
657
658
659
660
661
662
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
690
691
692

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

694
int     gridIsCircular(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
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);

714
715
716
/* Reference of an unstructured grid */

/*      gridDefNumber: Define the reference number for an unstructured grid */
717
void    gridDefNumber(int gridID, int number);
718
719
720
721
722

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

/*      gridDefPosition: Define the position of grid in the reference file */
723
void    gridDefPosition(int gridID, int position);
724
725
726
727
728

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

/*      gridDefReference: Define the reference URI for an unstructured grid */
729
void    gridDefReference(int gridID, const char *reference);
730
731
732
733
734

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

/*      gridDefUUID: Define the UUID of an unstructured grid */
735
void    gridDefUUID(int gridID, const char *uuid_cbuf);
736

737
/*      gridInqUUID: Get the UUID of an unstructured grid */
738
void    gridInqUUID(int gridID, char *uuid_cbuf);
739

740

741
/* Lambert Conformal Conic grid (GRIB version) */
742
743
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);
744

745
746
747
748
/* 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);

749
750
751
752
753
/* 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);


754
755
void    gridDefArea(int gridID, const double *area_vec);
void    gridInqArea(int gridID, double *area_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
756
757
758
759
760
761
762
763
764
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 */
765
void    gridDefXbounds(int gridID, const double *xbounds_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
766
767

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

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

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

776
777
void    gridDefRowlon(int gridID, int nrowlon, const int *rowlon_vec);
void    gridInqRowlon(int gridID, int *rowlon_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
778
779
void    gridChangeType(int gridID, int gridtype);

780
781
782
void    gridDefComplexPacking(int gridID, int lpack);
int     gridInqComplexPacking(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
783
784
/* ZAXIS routines */

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

787
/*      zaxisCreate: Create a vertical Z-axis */
788
int     zaxisCreate(int zaxistype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
789

790
791
792
/*      zaxisDestroy: Destroy a vertical Z-axis */
void    zaxisDestroy(int zaxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
793
794
795
796
797
798
799
800
801
802
803
804
805
806
/*      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);

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

/*      zaxisInqLevels: Get all levels of a Z-axis */
810
void    zaxisInqLevels(int zaxisID, double *levels_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
811
812
813
814
815
816
817

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

818
819
820
821
822
823
/*      zaxisDefNlevRef: Define the number of half levels of a generalized Z-axis */
void    zaxisDefNlevRef(int gridID, int nhlev);

/*      zaxisInqNlevRef: Get the number of half levels of a generalized Z-axis */
int     zaxisInqNlevRef(int gridID);

824
/*      zaxisDefNumber: Define the reference number for a generalized Z-axis */
825
void    zaxisDefNumber(int gridID, int number);
826

827
/*      zaxisInqNumber: Get the reference number to a generalized Z-axis */
828
int     zaxisInqNumber(int gridID);
829

830
/*      zaxisDefUUID: Define the UUID of a generalized Z-axis */
831
void    zaxisDefUUID(int zaxisID, const char *uuid_cbuf);
832

833
/*      zaxisInqUUID: Get the UUID of a generalized Z-axis */
834
void    zaxisInqUUID(int zaxisID, char *uuid_cbuf);
835

Uwe Schulzweida's avatar
Uwe Schulzweida committed
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
/*      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);

Deike Kleberg's avatar
Deike Kleberg committed
851
852
853
/*      zaxisInqStdname: Get the standard name of a Z-axis */
void    zaxisInqStdname(int zaxisID, char *stdname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
854
855
856
857
858
/*      zaxisInqUnits: Get the units of a Z-axis */
void    zaxisInqUnits(int zaxisID, char *units);

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

860
void    zaxisDefPositive(int zaxisID, int positive);
Deike Kleberg's avatar
Deike Kleberg committed
861
862
int     zaxisInqPositive(int zaxisID);

863
864
865
void    zaxisDefLtype(int zaxisID, int ltype);
int     zaxisInqLtype(int zaxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
866
const double *zaxisInqLevelsPtr(int zaxisID);
867
void    zaxisDefVct(int zaxisID, int size, const double *vct_vec);
868
void    zaxisInqVct(int zaxisID, double *vct_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
869
870
int     zaxisInqVctSize(int zaxisID);
const double *zaxisInqVctPtr(int zaxisID);
871
872
873
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
874
875
double  zaxisInqLbound(int zaxisID, int index);
double  zaxisInqUbound(int zaxisID, int index);
876
877
878
void    zaxisDefLbounds(int zaxisID, const double *lbounds_vec);
void    zaxisDefUbounds(int zaxisID, const double *ubounds_vec);
void    zaxisDefWeights(int zaxisID, const double *weights_vec);
879
void    zaxisChangeType(int zaxisID, int zaxistype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
880
881
882

/* TAXIS routines */

883
/*      taxisCreate: Create a Time axis */
884
int     taxisCreate(int timetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
885

886
887
888
/*      taxisDestroy: Destroy a Time axis */
void    taxisDestroy(int taxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
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
907
int     taxisHasBounds(int taxisID);
908
909

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

911
912
913
914
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
915
916
917
918
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
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
/*      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
986
int     tableInqParCode(int tableID, char *name, int *code);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
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

1005
#endif  /* CDI_H_ */
1006
1007
1008
1009
1010
1011
1012
1013
1014
/*
 * Local Variables:
 * c-file-style: "Java"
 * c-basic-offset: 2
 * indent-tabs-mode: nil
 * show-trailing-whitespace: t
 * require-trailing-newline: t
 * End:
 */