cdi.h 40.1 KB
Newer Older
1
2
3
4
5
6
/*
  CDI C header file

  This is the only file that must be included to use the CDI library from C.
*/

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

10
#include <stdio.h>
Uwe Schulzweida's avatar
Uwe Schulzweida committed
11
#include <sys/types.h>
Uwe Schulzweida's avatar
Uwe Schulzweida committed
12
/*
Uwe Schulzweida's avatar
Uwe Schulzweida committed
13
14
15
#if defined(__cplusplus)
extern "C" {
#endif
Uwe Schulzweida's avatar
Uwe Schulzweida committed
16
*/
Deike Kleberg's avatar
Deike Kleberg committed
17
18
#define  CDI_MAX_NAME           256   /* max length of a name                 */

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

22
23
/* Byte order */

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

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

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

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

/* File types */

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

55
56
/* Compress types */

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

64
/* external data types */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
65
66
67
68
69

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

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

117
118
/* Chunks */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
123
124
/* GRID types */

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

/* ZAXIS types */

143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
#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
169

170
171
/* TIME types */

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

/* TSTEP types */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
177
178
179
180
181
182
183
184
185
186
187
188
189
190
#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
191

Uwe Schulzweida's avatar
Uwe Schulzweida committed
192
193
194
195
/* TAXIS types */

#define  TAXIS_ABSOLUTE           1
#define  TAXIS_RELATIVE           2
196
#define  TAXIS_FORECAST           3
Uwe Schulzweida's avatar
Uwe Schulzweida committed
197
198
199
200
201

/* TUNIT types */

#define  TUNIT_SECOND             1
#define  TUNIT_MINUTE             2
202
203
204
205
206
207
208
209
210
#define  TUNIT_QUARTER            3
#define  TUNIT_30MINUTES          4
#define  TUNIT_HOUR               5
#define  TUNIT_3HOURS             6
#define  TUNIT_6HOURS             7
#define  TUNIT_12HOURS            8
#define  TUNIT_DAY                9
#define  TUNIT_MONTH             10
#define  TUNIT_YEAR              11
Uwe Schulzweida's avatar
Uwe Schulzweida committed
211
212
213

/* CALENDAR types */

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

221
222
/* number of unsigned char needed to store UUID */
#define  CDI_UUID_SIZE           16
223

224
225
226
/* CDI control routines */

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

228
char   *cdiStringError(int cdiErrno);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
229
230
231

void    cdiDebug(int debug);

232
const char *cdiLibraryVersion(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
233
234
void    cdiPrintVersion(void);

235
236
int     cdiHaveFiletype(int filetype);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
237
238
void    cdiDefMissval(double missval);
double  cdiInqMissval(void);
239
void    cdiDefGlobal(const char *string, int val);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
240

241
242
243
244
245
int     namespaceNew();
void    namespaceSetActive(int namespaceID);
void    namespaceDelete(int namespaceID);


Uwe Schulzweida's avatar
Uwe Schulzweida committed
246
247
/* CDI converter routines */

248
249
250
/* parameter */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
252
253
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
254
255

/* date format:  YYYYMMDD */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
256
/* time format:    hhmmss */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
257
258
259
260
261
262
263
264

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
265
266
/* STREAM control routines */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
267
268
/*      streamOpenRead: Open a dataset for reading */
int     streamOpenRead(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
269

Uwe Schulzweida's avatar
Uwe Schulzweida committed
270
271
/*      streamOpenWrite: Create a new dataset */
int     streamOpenWrite(const char *path, int filetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
272

Uwe Schulzweida's avatar
Uwe Schulzweida committed
273
int     streamOpenAppend(const char *path);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
274

Uwe Schulzweida's avatar
Uwe Schulzweida committed
275
/*      streamClose: Close an open dataset */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
276
277
void    streamClose(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
278
279
280
/*      streamSync: Synchronize an Open Dataset to Disk */
void    streamSync(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
281
282
283
284
285
/*      streamDefVlist: Define the Vlist for a stream */
void    streamDefVlist(int streamID, int vlistID);

/*      streamInqVlist: Get the Vlist of a stream */
int     streamInqVlist(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
286
/*      PIO: */
287
int     streamInqVlistIDorig(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
288

289
/*      streamInqFiletype: Get the filetype */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
290
int     streamInqFiletype(int streamID);
291

292
/*      streamDefByteorder: Define the byteorder */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
293
void    streamDefByteorder(int streamID, int byteorder);
294
295

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

Deike Kleberg's avatar
Deike Kleberg committed
298
299
/*      streamDefCompType: Define compression type */
void    streamDefCompType(int streamID, int comptype);
300

Deike Kleberg's avatar
Deike Kleberg committed
301
302
/*      streamInqCompType: Get compression type */
int     streamInqCompType(int streamID);
303

Uwe Schulzweida's avatar
Uwe Schulzweida committed
304
305
306
/*      streamDefCompLevel: Define compression level */
void    streamDefCompLevel(int streamID, int complevel);

Deike Kleberg's avatar
Deike Kleberg committed
307
308
/*      streamInqCompLevel: Get compression level */
int     streamInqCompLevel(int streamID);
309

310
/*      streamDefTimestep: Define time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
311
int     streamDefTimestep(int streamID, int tsID);
312
313

/*      streamInqTimestep: Get time step */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
314
315
int     streamInqTimestep(int streamID, int tsID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
316
317
318
/*      PIO: query currently set timestep id  */
int     streamInqCurTimestepID(int streamID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
319
320
321
char   *streamFilename(int streamID);
char   *streamFilesuffix(int filetype);
int     streamNtsteps(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
322
off_t   streamNvals(int streamID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
323

Deike Kleberg's avatar
Deike Kleberg committed
324
int     streamInqNvars ( int streamID );
Uwe Schulzweida's avatar
Uwe Schulzweida committed
325
326
327
328

/* STREAM var I/O routines */

/*      streamWriteVar: Write a variable */
329
void    streamWriteVar(int streamID, int varID, const double *data_vec, int nmiss);
330
void    streamWriteVarF(int streamID, int varID, const float *data_vec, int nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
331

Uwe Schulzweida's avatar
Uwe Schulzweida committed
332
333
/*      streamReadVar: Read a variable */
void    streamReadVar(int streamID, int varID, double *data_vec, int *nmiss);
334
void    streamReadVarF(int streamID, int varID, float *data_vec, int *nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
335
336

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
340
341
/*      streamReadVarSlice: Read a horizontal slice of a variable */
void    streamReadVarSlice(int streamID, int varID, int levelID, double *data_vec, int *nmiss);
342
void    streamReadVarSliceF(int streamID, int varID, int levelID, float *data_vec, int *nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
343

344
345
346
void    streamWriteVarChunk(int streamID, int varID, const int rect[][2],
                            const double *data_vec, int nmiss);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
347
348
349
350

/* STREAM record I/O routines */

void    streamDefRecord(int streamID, int  varID, int  levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
351
void    streamInqRecord(int streamID, int *varID, int *levelID);
352
void    streamWriteRecord(int streamID, const double *data_vec, int nmiss);
353
void    streamWriteRecordF(int streamID, const float *data_vec, int nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
354
void    streamReadRecord(int streamID, double *data_vec, int *nmiss);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
355
356
void    streamCopyRecord(int streamIDdest, int streamIDsrc);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
357
void    streamInqGRIBinfo(int streamID, int *intnum, float *fltnum, off_t *bignum);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
358
359
360

/* VLIST routines */

361
362
/*      vlistCreate: Create a variable list */
int     vlistCreate(void);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
363

364
/*      vlistDestroy: Destroy a variable list */
365
void    vlistDestroy(int vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385

/*      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
386
387
388
/*      vlistNumber: Number type in a variable list */
int     vlistNumber(int vlistID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
/*      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);
410
411

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
417
418
419
420
421
422
423
424
425
426
427
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 */
428
int     vlistDefVar(int vlistID, int gridID, int zaxisID, int tsteptype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
429

430
void    vlistChangeVarGrid(int vlistID, int varID, int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
431
432
void    vlistChangeVarZaxis(int vlistID, int varID, int zaxisID);

433
void    vlistInqVar(int vlistID, int varID, int *gridID, int *zaxisID, int *tsteptype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
434
435
int     vlistInqVarGrid(int vlistID, int varID);
int     vlistInqVarZaxis(int vlistID, int varID);
436
437
438
439
440

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

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

Deike Kleberg's avatar
Deike Kleberg committed
443
444
445
446
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);
447

448
449
450
451
452
453
/*      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
454
/*      vlistDefVarCode: Define the code number of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
455
456
void    vlistDefVarCode(int vlistID, int varID, int code);

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

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

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

466
467
468
void    vlistDefVarChunkType(int vlistID, int varID, int chunktype);
int     vlistInqVarChunkType(int vlistID, int varID);

469
470
471
void    vlistDefVarXYZ(int vlistID, int varID, int xyz);
int     vlistInqVarXYZ(int vlistID, int varID);

472
473
int     vlistInqVarNumber(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
474
475
476
477
478
479
480
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
481
/*      vlistDefVarName: Define the name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
482
483
void    vlistDefVarName(int vlistID, int varID, const char *name);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
487
488
489
490
491
492
/*      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
493
/*      vlistDefVarLongname: Define the long name of a Variable */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
494
495
void    vlistDefVarLongname(int vlistID, int varID, const char *longname);

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

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

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

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

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

511
512
513
514
515
516
/*      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
517
518
519
520
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);
521

522
523
524
525
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);
526

527
528
529
void    vlistDefVarTypeOfGeneratingProcess(int vlistID, int varID, int typeOfGeneratingProcess);
int     vlistInqVarTypeOfGeneratingProcess(int vlistID, int varID);

530
531
532
void    vlistDefVarProductDefinitionTemplate(int vlistID, int varID, int productDefinitionTemplate);
int     vlistInqVarProductDefinitionTemplate(int vlistID, int varID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
533
534
535
536
537
538
539
540
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);
541
542
int     vlistMergedVar(int vlistID, int varID);
int     vlistMergedLevel(int vlistID, int varID, int levelID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
543

544
545
546
/*     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
547

548
549
550
551
/* 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);
552
553
554
555
556
557

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

558
/* vlistHasVarKey: returns 1 if meta-data key was read, 0 otherwise. */
559
int     vlistHasVarKey(int vlistID, int varID, const char *name);
560
/* vlistInqVarDblKey: raw access to GRIB meta-data */
561
double  vlistInqVarDblKey(int vlistID, int varID, const char *name);
562
/* vlistInqVarIntKey: raw access to GRIB meta-data */
563
int     vlistInqVarIntKey(int vlistID, int varID, const char *name);
564
565


566
567
/* VLIST attributes */

Uwe Schulzweida's avatar
Uwe Schulzweida committed
568
/*      vlistInqNatts: Get number of variable attributes assigned to this variable */
569
int     vlistInqNatts(int vlistID, int varID, int *nattsp);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
570
/*      vlistInqAtt: Get information about an attribute */
571
572
int     vlistInqAtt(int vlistID, int varID, int attrnum, char *name, int *typep, int *lenp);
int     vlistDelAtt(int vlistID, int varID, const char *name);
573

Uwe Schulzweida's avatar
Uwe Schulzweida committed
574
/*      vlistDefAttInt: Define an integer attribute */
575
576
577
578
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 */
579
int     vlistDefAttTxt(int vlistID, int varID, const char *name, int len, const char *tp_cbuf);
580

Uwe Schulzweida's avatar
Uwe Schulzweida committed
581
/*      vlistInqAttInt: Get the value(s) of an integer attribute */
582
int     vlistInqAttInt(int vlistID, int varID, const char *name, int mlen, int *ip_vec);
583
/*      vlistInqAttFlt: Get the value(s) of a floating point attribute */
584
int     vlistInqAttFlt(int vlistID, int varID, const char *name, int mlen, double *dp_vec);
585
/*      vlistInqAttTxt: Get the value(s) of a text attribute */
586
int     vlistInqAttTxt(int vlistID, int varID, const char *name, int mlen, char *tp_cbuf);
587
588


Uwe Schulzweida's avatar
Uwe Schulzweida committed
589
590
591
/* GRID routines */

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
594
595
void    gridCompress(int gridID);

596
597
598
void    gridDefMaskGME(int gridID, const int *mask_vec);
int     gridInqMaskGME(int gridID, int *mask_vec);

599
600
void    gridDefMask(int gridID, const int *mask_vec);
int     gridInqMask(int gridID, int *mask_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
601

Uwe Schulzweida's avatar
Uwe Schulzweida committed
602
void    gridPrint(int gridID, int opt);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
603

604
/*      gridCreate: Create a horizontal Grid */
605
int     gridCreate(int gridtype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
606

607
608
609
/*      gridDestroy: Destroy a horizontal Grid */
void    gridDestroy(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
610
611
612
/*      gridDuplicate: Duplicate a Grid */
int     gridDuplicate(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
/*      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);

631
632
633
634
635
636
/*      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
637
/*      gridDefXvals: Define the values of a X-axis */
638
void    gridDefXvals(int gridID, const double *xvals_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
639
640

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
682
683
/*      gridInqYunits: Get the units of a Y-axis */
void    gridInqYunits(int gridID, char *yunits);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704

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

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

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

706
int     gridIsCircular(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
707
708
int     gridIsRotated(int gridID);
void    gridDefXpole(int gridID, double xpole);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
709
double  gridInqXpole(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
710
void    gridDefYpole(int gridID, double ypole);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
711
double  gridInqYpole(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
712
void    gridDefAngle(int gridID, double angle);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
713
double  gridInqAngle(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
714
int     gridInqTrunc(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
715
void    gridDefTrunc(int gridID, int trunc);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
716
717
/* Hexagonal GME grid */
void    gridDefGMEnd(int gridID, int nd);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
718
int     gridInqGMEnd(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
719
void    gridDefGMEni(int gridID, int ni);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
720
int     gridInqGMEni(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
721
void    gridDefGMEni2(int gridID, int ni2);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
722
int     gridInqGMEni2(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
723
void    gridDefGMEni3(int gridID, int ni3);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
724
int     gridInqGMEni3(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
725

726
727
728
/* Reference of an unstructured grid */

/*      gridDefNumber: Define the reference number for an unstructured grid */
729
void    gridDefNumber(int gridID, int number);
730
731
732
733
734

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

/*      gridDefPosition: Define the position of grid in the reference file */
735
void    gridDefPosition(int gridID, int position);
736
737
738
739
740

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

/*      gridDefReference: Define the reference URI for an unstructured grid */
741
void    gridDefReference(int gridID, const char *reference);
742
743
744
745
746

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

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

749
/*      gridInqUUID: Get the UUID of an unstructured grid */
750
void    gridInqUUID(int gridID, char *uuid_cbuf);
751

752

753
/* Lambert Conformal Conic grid (GRIB version) */
754
755
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);
756

757
758
759
760
/* 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);

761
762
763
764
765
/* 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);


766
767
void    gridDefArea(int gridID, const double *area_vec);
void    gridInqArea(int gridID, double *area_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
768
769
770
771
772
773
774
775
776
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 */
777
void    gridDefXbounds(int gridID, const double *xbounds_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
778
779

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

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

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

788
789
void    gridDefRowlon(int gridID, int nrowlon, const int *rowlon_vec);
void    gridInqRowlon(int gridID, int *rowlon_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
790
791
void    gridChangeType(int gridID, int gridtype);

792
793
794
void    gridDefComplexPacking(int gridID, int lpack);
int     gridInqComplexPacking(int gridID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
795
796
/* ZAXIS routines */

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

799
/*      zaxisCreate: Create a vertical Z-axis */
800
int     zaxisCreate(int zaxistype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
801

802
803
804
/*      zaxisDestroy: Destroy a vertical Z-axis */
void    zaxisDestroy(int zaxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
805
806
807
808
809
810
811
812
813
814
815
816
817
818
/*      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 */
819
void    zaxisDefLevels(int zaxisID, const double *levels_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
820
821

/*      zaxisInqLevels: Get all levels of a Z-axis */
822
void    zaxisInqLevels(int zaxisID, double *levels_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
823
824
825
826
827
828
829

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

830
831
832
833
834
835
/*      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);

836
/*      zaxisDefNumber: Define the reference number for a generalized Z-axis */
837
void    zaxisDefNumber(int gridID, int number);
838

839
/*      zaxisInqNumber: Get the reference number to a generalized Z-axis */
840
int     zaxisInqNumber(int gridID);
841

842
/*      zaxisDefUUID: Define the UUID of a generalized Z-axis */
843
void    zaxisDefUUID(int zaxisID, const char *uuid_cbuf);
844

845
/*      zaxisInqUUID: Get the UUID of a generalized Z-axis */
846
void    zaxisInqUUID(int zaxisID, char *uuid_cbuf);
847

Uwe Schulzweida's avatar
Uwe Schulzweida committed
848
849
850
851
852
853
/*      zaxisDefName: Define the name of a Z-axis */
void    zaxisDefName(int zaxisID, const char *name);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
854
855
856
/*      zaxisDefLongname: Define the longname of a Z-axis */
void    zaxisDefLongname(int zaxisID, const char *longname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
857
858
859
/*      zaxisInqLongname: Get the longname of a Z-axis */
void    zaxisInqLongname(int zaxisID, char *longname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
860
861
/*      zaxisDefUnits: Define the units of a Z-axis */
void    zaxisDefUnits(int zaxisID, const char *units);
Deike Kleberg's avatar
Deike Kleberg committed
862

Uwe Schulzweida's avatar
Uwe Schulzweida committed
863
864
865
/*      zaxisInqUnits: Get the units of a Z-axis */
void    zaxisInqUnits(int zaxisID, char *units);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
866
867
868
/*      zaxisInqStdname: Get the standard name of a Z-axis */
void    zaxisInqStdname(int zaxisID, char *stdname);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
869
870
void    zaxisDefPrec(int zaxisID, int prec);
int     zaxisInqPrec(int zaxisID);
871

872
void    zaxisDefPositive(int zaxisID, int positive);
Deike Kleberg's avatar
Deike Kleberg committed
873
874
int     zaxisInqPositive(int zaxisID);

875
876
877
void    zaxisDefLtype(int zaxisID, int ltype);
int     zaxisInqLtype(int zaxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
878
const double *zaxisInqLevelsPtr(int zaxisID);
879
void    zaxisDefVct(int zaxisID, int size, const double *vct_vec);
880
void    zaxisInqVct(int zaxisID, double *vct_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
881
882
int     zaxisInqVctSize(int zaxisID);
const double *zaxisInqVctPtr(int zaxisID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
883
void    zaxisDefLbounds(int zaxisID, const double *lbounds_vec);
884
int     zaxisInqLbounds(int zaxisID, double *lbounds_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
885
double  zaxisInqLbound(int zaxisID, int index);
886
void    zaxisDefUbounds(int zaxisID, const double *ubounds_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
887
888
int     zaxisInqUbounds(int zaxisID, double *ubounds_vec);
double  zaxisInqUbound(int zaxisID, int index);
889
void    zaxisDefWeights(int zaxisID, const double *weights_vec);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
890
int     zaxisInqWeights(int zaxisID, double *weights_vec);
891
void    zaxisChangeType(int zaxisID, int zaxistype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
892
893
894

/* TAXIS routines */

895
/*      taxisCreate: Create a Time axis */
896
int     taxisCreate(int timetype);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
897

898
899
900
/*      taxisDestroy: Destroy a Time axis */
void    taxisDestroy(int taxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
901
902
903
904
905
906
907
908
909
910
911
912
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);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
913
914
915
916
917
918
/*      taxisInqVdate: Get the verification date */
int     taxisInqVdate(int taxisID);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
919
920
921
/*      taxisDefRdate: Define the reference date */
void    taxisDefRdate(int taxisID, int date);

922
/*      taxisDefRtime: Define the reference time */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
923
924
void    taxisDefRtime(int taxisID, int time);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
925
926
927
928
929
930
/*      taxisInqRdate: Get the reference date */
int     taxisInqRdate(int taxisID);

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

931
932
933
934
935
936
/*      taxisDefFdate: Define the forecast reference date */
void    taxisDefFdate(int taxisID, int date);

/*      taxisDefFtime: Define the forecast reference time */
void    taxisDefFtime(int taxisID, int time);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
937
938
939
940
941
942
/*      taxisInqFdate: Get the forecast reference date */
int     taxisInqFdate(int taxisID);

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

Uwe Schulzweida's avatar
Uwe Schulzweida committed
943
int     taxisHasBounds(int taxisID);
944
945

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

947
948
949
950
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
951
952
953
954
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
955
956
957
/*      taxisDefCalendar: Define the calendar */
void    taxisDefCalendar(int taxisID, int calendar);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
958
959
960
/*      taxisInqCalendar: Get the calendar */
int     taxisInqCalendar(int taxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
961
void    taxisDefTunit(int taxisID, int tunit);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
962
963
964
965
int     taxisInqTunit(int taxisID);

void    taxisDefForecastTunit(int taxisID, int tunit);
int     taxisInqForecastTunit(int taxisID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
966

967
968
969
void    taxisDefForecastPeriod(int taxisID, double fc_period);
double  taxisInqForecastPeriod(int taxisID);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
void    taxisDefNumavg(int taxisID, int numavg);

int     taxisInqType(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);
1000
void    tableFWriteC(FILE *ptfp, int tableID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
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
1016
int     tableInqParCode(int tableID, char *name, int *code);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1017
1018
1019
1020
int     tableInqParName(int tableID, int code, char *name);
int     tableInqParLongname(int tableID, int code, char *longname);
int     tableInqParUnits(int tableID, int code, char *units);

1021
1022
1023
const char *tableInqParNamePtr(int tableID, int parID);
const char *tableInqParLongnamePtr(int tableID, int parID);
const char *tableInqParUnitsPtr(int tableID, int parID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1024
1025
1026
1027
1028
1029
1030

/* History routines */

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

1031
1032
1033

void gribapiLibraryVersion(int *major_version, int *minor_version, int *revision_version);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
1034
/*
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1035
1036
1037
#if defined (__cplusplus)
}
#endif
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1038
*/
1039
#endif  /* CDI_H_ */
1040
1041
1042
1043
1044
1045
1046
1047
1048
/*
 * Local Variables:
 * c-file-style: "Java"
 * c-basic-offset: 2
 * indent-tabs-mode: nil
 * show-trailing-whitespace: t
 * require-trailing-newline: t
 * End:
 */