c_quick_ref.tex 28.6 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1
2
3
4
5
6
\chapter*{Quick Reference}
\addcontentsline{toc}{chapter}{Quick Reference}

This appendix provide a brief listing of the C language bindings of the
CDI library routines:

7
\section*{\tt \htmlref{cdiClearAdditionalKeys}{cdiClearAdditionalKeys}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
8
9

\begin{verbatim}
10
    void cdiClearAdditionalKeys ();
Uwe Schulzweida's avatar
Uwe Schulzweida committed
11
12
\end{verbatim}

13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
Clear the list of additional GRIB keys..


\section*{\tt \htmlref{cdiDefAdditionalKey}{cdiDefAdditionalKey}}

\begin{verbatim}
    void cdiDefAdditionalKey (const char *string);
\end{verbatim}

Register an additional GRIB key which is read when file is opened..


\section*{\tt \htmlref{gridCreate}{gridCreate}}

\begin{verbatim}
    int gridCreate (int gridtype, int size);
\end{verbatim}

Create a horizontal Grid.


\section*{\tt \htmlref{gridDefNP}{gridDefNP}}

\begin{verbatim}
    void gridDefNP (int gridID, int np);
\end{verbatim}

Define the number of parallels between a pole and the equator.


\section*{\tt \htmlref{gridDefNumber}{gridDefNumber}}

\begin{verbatim}
    void gridDefNumber (int gridID, int number);
\end{verbatim}

Define the reference number for an unstructured grid.


\section*{\tt \htmlref{gridDefNvertex}{gridDefNvertex}}

\begin{verbatim}
    void gridDefNvertex (int gridID, int nvertex);
\end{verbatim}

Define the number of vertex of a Gridbox.


\section*{\tt \htmlref{gridDefPosition}{gridDefPosition}}

\begin{verbatim}
    void gridDefPosition (int gridID, int position);
\end{verbatim}

Define the position of grid in the reference file.


\section*{\tt \htmlref{gridDefPrec}{gridDefPrec}}

\begin{verbatim}
    void gridDefPrec (int gridID, int prec);
\end{verbatim}

Define the precision of a Grid.


\section*{\tt \htmlref{gridDefReference}{gridDefReference}}

\begin{verbatim}
    void gridDefReference (int gridID, const char *reference);
\end{verbatim}

Define the reference URI for an unstructured grid.


\section*{\tt \htmlref{gridDefUUID}{gridDefUUID}}

\begin{verbatim}
91
    void gridDefUUID (int gridID, const unsigned char uuid[CDI_UUID_SIZE]);
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
\end{verbatim}

Define the UUID of an unstructured grid.


\section*{\tt \htmlref{gridDefXbounds}{gridDefXbounds}}

\begin{verbatim}
    void gridDefXbounds (int gridID, const double *xbounds_vec);
\end{verbatim}

Define the bounds of a X-axis.


\section*{\tt \htmlref{gridDefXlongname}{gridDefXlongname}}

\begin{verbatim}
    void gridDefXlongname (int gridID, const char *xlongname);
\end{verbatim}

Define the longname of a X-axis.


\section*{\tt \htmlref{gridDefXname}{gridDefXname}}

\begin{verbatim}
    void gridDefXname (int gridID, const char *xname);
\end{verbatim}

Define the name of a X-axis.


\section*{\tt \htmlref{gridDefXsize}{gridDefXsize}}

\begin{verbatim}
    void gridDefXsize (int gridID, int xsize);
\end{verbatim}

Define the size of a X-axis.


\section*{\tt \htmlref{gridDefXunits}{gridDefXunits}}

\begin{verbatim}
    void gridDefXunits (int gridID, const char *xunits);
\end{verbatim}

Define the units of a X-axis.


\section*{\tt \htmlref{gridDefXvals}{gridDefXvals}}

\begin{verbatim}
    void gridDefXvals (int gridID, const double *xvals_vec);
\end{verbatim}

Define the values of a X-axis.


\section*{\tt \htmlref{gridDefYbounds}{gridDefYbounds}}

\begin{verbatim}
    void gridDefYbounds (int gridID, const double *ybounds_vec);
\end{verbatim}

Define the bounds of a Y-axis.


\section*{\tt \htmlref{gridDefYlongname}{gridDefYlongname}}

\begin{verbatim}
    void gridDefYlongname (int gridID, const char *ylongname);
\end{verbatim}

Define the longname of a Y-axis.


\section*{\tt \htmlref{gridDefYname}{gridDefYname}}

\begin{verbatim}
    void gridDefYname (int gridID, const char *yname);
\end{verbatim}

Define the name of a Y-axis.


\section*{\tt \htmlref{gridDefYsize}{gridDefYsize}}

\begin{verbatim}
    void gridDefYsize (int gridID, int ysize);
\end{verbatim}

Define the size of a Y-axis.


\section*{\tt \htmlref{gridDefYunits}{gridDefYunits}}

\begin{verbatim}
    void gridDefYunits (int gridID, const char *yunits);
\end{verbatim}

Define the units of a Y-axis.


\section*{\tt \htmlref{gridDefYvals}{gridDefYvals}}

\begin{verbatim}
    void gridDefYvals (int gridID, const double *yvals_vec);
\end{verbatim}

Define the values of a Y-axis.


\section*{\tt \htmlref{gridDestroy}{gridDestroy}}

\begin{verbatim}
    void gridDestroy (int gridID);
\end{verbatim}

Destroy a horizontal Grid.


\section*{\tt \htmlref{gridDuplicate}{gridDuplicate}}

\begin{verbatim}
    int gridDuplicate (int gridID);
\end{verbatim}

Duplicate a Grid.


\section*{\tt \htmlref{gridInqNP}{gridInqNP}}

\begin{verbatim}
    int gridInqNP (int gridID);
\end{verbatim}

Get the number of parallels between a pole and the equator.


\section*{\tt \htmlref{gridInqNumber}{gridInqNumber}}

\begin{verbatim}
    int gridInqNumber (int gridID);
\end{verbatim}

Get the reference number to an unstructured grid.


\section*{\tt \htmlref{gridInqNvertex}{gridInqNvertex}}

\begin{verbatim}
    int gridInqNvertex (int gridID);
\end{verbatim}

Get the number of vertex of a Gridbox.


\section*{\tt \htmlref{gridInqPosition}{gridInqPosition}}

\begin{verbatim}
    int gridInqPosition (int gridID);
\end{verbatim}

Get the position of grid in the reference file.


\section*{\tt \htmlref{gridInqPrec}{gridInqPrec}}

\begin{verbatim}
    int gridInqPrec (int gridID);
\end{verbatim}

Get the precision of a Grid.


\section*{\tt \htmlref{gridInqReference}{gridInqReference}}

\begin{verbatim}
    int gridInqReference (int gridID, char *reference);
\end{verbatim}

Get the reference URI to an unstructured grid.


\section*{\tt \htmlref{gridInqSize}{gridInqSize}}

\begin{verbatim}
    int gridInqSize (int gridID);
\end{verbatim}

Get the size of a Grid.


\section*{\tt \htmlref{gridInqType}{gridInqType}}

\begin{verbatim}
    int gridInqType (int gridID);
\end{verbatim}

Get the type of a Grid.


\section*{\tt \htmlref{gridInqUUID}{gridInqUUID}}

\begin{verbatim}
Thomas Jahns's avatar
Thomas Jahns committed
298
    void gridInqUUID (int gridID, unsigned char uuid[CDI_UUID_SIZE]);
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
\end{verbatim}

Get the UUID of an unstructured grid.


\section*{\tt \htmlref{gridInqXbounds}{gridInqXbounds}}

\begin{verbatim}
    int gridInqXbounds (int gridID, double *xbounds_vec);
\end{verbatim}

Get the bounds of a X-axis.


\section*{\tt \htmlref{gridInqXlongname}{gridInqXlongname}}

\begin{verbatim}
    void gridInqXlongname (int gridID, char *xlongname);
\end{verbatim}

Get the longname of a X-axis.


\section*{\tt \htmlref{gridInqXname}{gridInqXname}}

\begin{verbatim}
    void gridInqXname (int gridID, char *xname);
\end{verbatim}

Get the name of a X-axis.


\section*{\tt \htmlref{gridInqXsize}{gridInqXsize}}

\begin{verbatim}
    int gridInqXsize (int gridID);
\end{verbatim}

Get the size of a X-axis.


\section*{\tt \htmlref{gridInqXstdname}{gridInqXstdname}}

\begin{verbatim}
    void gridInqXstdname (int gridID, char *xstdname);
\end{verbatim}

Get the standard name of a X-axis.


\section*{\tt \htmlref{gridInqXunits}{gridInqXunits}}

\begin{verbatim}
    void gridInqXunits (int gridID, char *xunits);
\end{verbatim}

Get the units of a X-axis.


\section*{\tt \htmlref{gridInqXval}{gridInqXval}}

\begin{verbatim}
    double gridInqXval (int gridID, int index);
\end{verbatim}

Get one value of a X-axis.


\section*{\tt \htmlref{gridInqXvals}{gridInqXvals}}

\begin{verbatim}
    int gridInqXvals (int gridID, double *xvals_vec);
\end{verbatim}

Get all values of a X-axis.


\section*{\tt \htmlref{gridInqYbounds}{gridInqYbounds}}

\begin{verbatim}
    int gridInqYbounds (int gridID, double *ybounds_vec);
\end{verbatim}

Get the bounds of a Y-axis.


\section*{\tt \htmlref{gridInqYlongname}{gridInqYlongname}}

\begin{verbatim}
    void gridInqYlongname (int gridID, char *ylongname);
\end{verbatim}

Get the longname of a Y-axis.


\section*{\tt \htmlref{gridInqYname}{gridInqYname}}

\begin{verbatim}
    void gridInqYname (int gridID, char *yname);
\end{verbatim}

Get the name of a Y-axis.


\section*{\tt \htmlref{gridInqYsize}{gridInqYsize}}

\begin{verbatim}
    int gridInqYsize (int gridID);
\end{verbatim}

Get the size of a Y-axis.


\section*{\tt \htmlref{gridInqYstdname}{gridInqYstdname}}

\begin{verbatim}
    void gridInqYstdname (int gridID, char *ystdname);
\end{verbatim}

Get the standard name of a Y-axis.


\section*{\tt \htmlref{gridInqYunits}{gridInqYunits}}

\begin{verbatim}
    void gridInqYunits (int gridID, char *yunits);
\end{verbatim}

Get the units of a Y-axis.


\section*{\tt \htmlref{gridInqYval}{gridInqYval}}

\begin{verbatim}
    double gridInqYval (int gridID, int index);
\end{verbatim}

Get one value of a Y-axis.


\section*{\tt \htmlref{gridInqYvals}{gridInqYvals}}

\begin{verbatim}
    int gridInqYvals (int gridID, double *yvals_vec);
\end{verbatim}

Get all values of a Y-axis.


\section*{\tt \htmlref{streamClose}{streamClose}}

\begin{verbatim}
    void streamClose (int streamID);
\end{verbatim}

Close an open dataset.


\section*{\tt \htmlref{streamDefByteorder}{streamDefByteorder}}

\begin{verbatim}
    void streamDefByteorder (int streamID, int byteorder);
\end{verbatim}

Define the byteorder.


\section*{\tt \htmlref{streamDefCompLevel}{streamDefCompLevel}}

\begin{verbatim}
    void streamDefCompLevel (int streamID, int complevel);
\end{verbatim}

Define compression level.


\section*{\tt \htmlref{streamDefCompType}{streamDefCompType}}

\begin{verbatim}
    void streamDefCompType (int streamID, int comptype);
\end{verbatim}

Define compression type.


\section*{\tt \htmlref{streamDefTimestep}{streamDefTimestep}}

\begin{verbatim}
    int streamDefTimestep (int streamID, int tsID);
\end{verbatim}

Define time step.


\section*{\tt \htmlref{streamDefVlist}{streamDefVlist}}

\begin{verbatim}
    void streamDefVlist (int streamID, int vlistID);
\end{verbatim}

Define the Vlist for a stream.


\section*{\tt \htmlref{streamInqByteorder}{streamInqByteorder}}

\begin{verbatim}
    int streamInqByteorder (int streamID);
\end{verbatim}

Get the byteorder.


\section*{\tt \htmlref{streamInqCompLevel}{streamInqCompLevel}}

\begin{verbatim}
    int streamInqCompLevel (int streamID);
\end{verbatim}

Get compression level.


\section*{\tt \htmlref{streamInqCompType}{streamInqCompType}}

\begin{verbatim}
    int streamInqCompType (int streamID);
\end{verbatim}

Get compression type.


\section*{\tt \htmlref{streamInqFiletype}{streamInqFiletype}}

\begin{verbatim}
    int streamInqFiletype (int streamID);
\end{verbatim}

Get the filetype.


\section*{\tt \htmlref{streamInqTimestep}{streamInqTimestep}}

\begin{verbatim}
    int streamInqTimestep (int streamID, int tsID);
\end{verbatim}

Get time step.


\section*{\tt \htmlref{streamInqVlist}{streamInqVlist}}

\begin{verbatim}
    int streamInqVlist (int streamID);
\end{verbatim}

Get the Vlist of a stream.


\section*{\tt \htmlref{streamOpenRead}{streamOpenRead}}

\begin{verbatim}
    int streamOpenRead (const char *path);
\end{verbatim}

Open a dataset for reading.


\section*{\tt \htmlref{streamOpenWrite}{streamOpenWrite}}

\begin{verbatim}
    int streamOpenWrite (const char *path, int filetype);
\end{verbatim}

Create a new dataset.


\section*{\tt \htmlref{streamReadVar}{streamReadVar}}

\begin{verbatim}
    void streamReadVar (int streamID, int varID, double *data_vec, int *nmiss);
\end{verbatim}

Read a variable.


\section*{\tt \htmlref{streamReadVarSlice}{streamReadVarSlice}}

\begin{verbatim}
    void streamReadVarSlice (int streamID, int varID, int levelID, double *data_vec,
                             int *nmiss);
\end{verbatim}

Read a horizontal slice of a variable.


\section*{\tt \htmlref{streamSync}{streamSync}}

\begin{verbatim}
    void streamSync (int streamID);
\end{verbatim}

Synchronize an Open Dataset to Disk.


\section*{\tt \htmlref{streamWriteVar}{streamWriteVar}}

\begin{verbatim}
    void streamWriteVar (int streamID, int varID, const double *data_vec, int nmiss);
\end{verbatim}

Write a variable.


\section*{\tt \htmlref{streamWriteVarSlice}{streamWriteVarSlice}}

\begin{verbatim}
    void streamWriteVarSlice (int streamID, int varID, int levelID,
                              const double *data_vec, int nmiss);
\end{verbatim}

Write a horizontal slice of a variable.


621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
\section*{\tt \htmlref{subtypeCreate}{subtypeCreate}}

\begin{verbatim}
    int subtypeCreate (int subtype);
\end{verbatim}

Create a variable subtype.


\section*{\tt \htmlref{subtypeDefActiveIndex}{subtypeDefActiveIndex}}

\begin{verbatim}
    void subtypeDefActiveIndex (int subtypeID, int index);
\end{verbatim}

Set the currently active index of a subtype (e.g. current tile index)..


\section*{\tt \htmlref{subtypeInqActiveIndex}{subtypeInqActiveIndex}}

\begin{verbatim}
    int subtypeInqActiveIndex (int subtypeID);
\end{verbatim}

Get the currently active index of a subtype (e.g. current tile index)..


\section*{\tt \htmlref{subtypeInqSize}{subtypeInqSize}}

\begin{verbatim}
    int subtypeInqSize (int subtypeID);
\end{verbatim}

Get the size of a subtype (e.g. no. of tiles)..


\section*{\tt \htmlref{subtypeInqTile}{subtypeInqTile}}

\begin{verbatim}
660
    int subtypeInqTile (int subtypeID, int tileindex, int attribute);
661
662
663
664
665
\end{verbatim}

Specialized version of subtypeInqSubEntry looking for tile/attribute pair..


666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
\section*{\tt \htmlref{taxisCreate}{taxisCreate}}

\begin{verbatim}
    int taxisCreate (int timetype);
\end{verbatim}

Create a Time axis.


\section*{\tt \htmlref{taxisDefCalendar}{taxisDefCalendar}}

\begin{verbatim}
    void taxisDefCalendar (int taxisID, int calendar);
\end{verbatim}

Define the calendar.


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
\section*{\tt \htmlref{taxisDefFdate}{taxisDefFdate}}

\begin{verbatim}
    void taxisDefFdate (int taxisID, int date);
\end{verbatim}

Define the forecast reference date.


\section*{\tt \htmlref{taxisDefFtime}{taxisDefFtime}}

\begin{verbatim}
    void taxisDefFtime (int taxisID, int time);
\end{verbatim}

Define the forecast reference time.


702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
\section*{\tt \htmlref{taxisDefRdate}{taxisDefRdate}}

\begin{verbatim}
    void taxisDefRdate (int taxisID, int date);
\end{verbatim}

Define the reference date.


\section*{\tt \htmlref{taxisDefRtime}{taxisDefRtime}}

\begin{verbatim}
    void taxisDefRtime (int taxisID, int time);
\end{verbatim}

717
Define the reference time.
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755


\section*{\tt \htmlref{taxisDefVdate}{taxisDefVdate}}

\begin{verbatim}
    void taxisDefVdate (int taxisID, int date);
\end{verbatim}

Define the verification date.


\section*{\tt \htmlref{taxisDefVtime}{taxisDefVtime}}

\begin{verbatim}
    void taxisDefVtime (int taxisID, int time);
\end{verbatim}

Define the verification time.


\section*{\tt \htmlref{taxisDestroy}{taxisDestroy}}

\begin{verbatim}
    void taxisDestroy (int taxisID);
\end{verbatim}

Destroy a Time axis.


\section*{\tt \htmlref{taxisInqCalendar}{taxisInqCalendar}}

\begin{verbatim}
    int taxisInqCalendar (int taxisID);
\end{verbatim}

Get the calendar.


756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
\section*{\tt \htmlref{taxisInqFdate}{taxisInqFdate}}

\begin{verbatim}
    int taxisInqFdate (int taxisID);
\end{verbatim}

Get the forecast reference date.


\section*{\tt \htmlref{taxisInqFtime}{taxisInqFtime}}

\begin{verbatim}
    int taxisInqFtime (int taxisID);
\end{verbatim}

Get the forecast reference time.


774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
\section*{\tt \htmlref{taxisInqRdate}{taxisInqRdate}}

\begin{verbatim}
    int taxisInqRdate (int taxisID);
\end{verbatim}

Get the reference date.


\section*{\tt \htmlref{taxisInqRtime}{taxisInqRtime}}

\begin{verbatim}
    int taxisInqRtime (int taxisID);
\end{verbatim}

Get the reference time.


\section*{\tt \htmlref{taxisInqVdate}{taxisInqVdate}}

\begin{verbatim}
    int taxisInqVdate (int taxisID);
\end{verbatim}

Get the verification date.


\section*{\tt \htmlref{taxisInqVtime}{taxisInqVtime}}

\begin{verbatim}
    int taxisInqVtime (int taxisID);
\end{verbatim}

Get the verification time.


\section*{\tt \htmlref{vlistCat}{vlistCat}}

\begin{verbatim}
    void vlistCat (int vlistID2, int vlistID1);
\end{verbatim}

Concatenate two variable lists.


\section*{\tt \htmlref{vlistCopy}{vlistCopy}}

\begin{verbatim}
    void vlistCopy (int vlistID2, int vlistID1);
\end{verbatim}

Copy a variable list.


\section*{\tt \htmlref{vlistCopyFlag}{vlistCopyFlag}}

\begin{verbatim}
    void vlistCopyFlag (int vlistID2, int vlistID1);
\end{verbatim}

Copy some entries of a variable list.


837
838
839
840
841
842
843
844
845
\section*{\tt \htmlref{vlistCopyVarName}{vlistCopyVarName}}

\begin{verbatim}
    char *vlistCopyVarName (int vlistId, int varId);
\end{verbatim}

Safe and convenient version of vlistInqVarName.


846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
\section*{\tt \htmlref{vlistCreate}{vlistCreate}}

\begin{verbatim}
    int vlistCreate ();
\end{verbatim}

Create a variable list.


\section*{\tt \htmlref{vlistDefAttFlt}{vlistDefAttFlt}}

\begin{verbatim}
    int vlistDefAttFlt (int vlistID, int varID, const char *name, int type, int len,
                        const double *dp_vec);
\end{verbatim}

Define a floating point attribute.


\section*{\tt \htmlref{vlistDefAttInt}{vlistDefAttInt}}

\begin{verbatim}
    int vlistDefAttInt (int vlistID, int varID, const char *name, int type, int len,
                        const int *ip_vec);
\end{verbatim}

Define an integer attribute.


\section*{\tt \htmlref{vlistDefAttTxt}{vlistDefAttTxt}}

\begin{verbatim}
    int vlistDefAttTxt (int vlistID, int varID, const char *name, int len,
                        const char *tp_cbuf);
\end{verbatim}

Define a text attribute.


\section*{\tt \htmlref{vlistDefTaxis}{vlistDefTaxis}}

\begin{verbatim}
    void vlistDefTaxis (int vlistID, int taxisID);
\end{verbatim}

Define the time axis of a variable list.


\section*{\tt \htmlref{vlistDefVar}{vlistDefVar}}

\begin{verbatim}
    int vlistDefVar (int vlistID, int gridID, int zaxisID, int tsteptype);
\end{verbatim}

900
Create a new variable.
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
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
986
987
988
989
990
991
992


\section*{\tt \htmlref{vlistDefVarCode}{vlistDefVarCode}}

\begin{verbatim}
    void vlistDefVarCode (int vlistID, int varID, int code);
\end{verbatim}

Define the code number of a Variable.


\section*{\tt \htmlref{vlistDefVarDatatype}{vlistDefVarDatatype}}

\begin{verbatim}
    void vlistDefVarDatatype (int vlistID, int varID, int datatype);
\end{verbatim}

Define the data type of a Variable.


\section*{\tt \htmlref{vlistDefVarDblKey}{vlistDefVarDblKey}}

\begin{verbatim}
    void vlistDefVarDblKey (int vlistID, int varID, const char *name, double value);
\end{verbatim}

Set an arbitrary keyword/double value pair for GRIB API.


\section*{\tt \htmlref{vlistDefVarExtra}{vlistDefVarExtra}}

\begin{verbatim}
    void vlistDefVarExtra (int vlistID, int varID, const char *extra);
\end{verbatim}

Define extra information of a Variable.


\section*{\tt \htmlref{vlistDefVarIntKey}{vlistDefVarIntKey}}

\begin{verbatim}
    void vlistDefVarIntKey (int vlistID, int varID, const char *name, int value);
\end{verbatim}

Set an arbitrary keyword/integer value pair for GRIB API.


\section*{\tt \htmlref{vlistDefVarLongname}{vlistDefVarLongname}}

\begin{verbatim}
    void vlistDefVarLongname (int vlistID, int varID, const char *longname);
\end{verbatim}

Define the long name of a Variable.


\section*{\tt \htmlref{vlistDefVarMissval}{vlistDefVarMissval}}

\begin{verbatim}
    void vlistDefVarMissval (int vlistID, int varID, double missval);
\end{verbatim}

Define the missing value of a Variable.


\section*{\tt \htmlref{vlistDefVarName}{vlistDefVarName}}

\begin{verbatim}
    void vlistDefVarName (int vlistID, int varID, const char *name);
\end{verbatim}

Define the name of a Variable.


\section*{\tt \htmlref{vlistDefVarParam}{vlistDefVarParam}}

\begin{verbatim}
    void vlistDefVarParam (int vlistID, int varID, int param);
\end{verbatim}

Define the parameter number of a Variable.


\section*{\tt \htmlref{vlistDefVarStdname}{vlistDefVarStdname}}

\begin{verbatim}
    void vlistDefVarStdname (int vlistID, int varID, const char *stdname);
\end{verbatim}

Define the standard name of a Variable.


Thomas Jahns's avatar
Thomas Jahns committed
993
994
995
996
997
998
999
1000
1001
1002
\section*{\tt \htmlref{vlistDefVarTiles}{vlistDefVarTiles}}

\begin{verbatim}
    int vlistDefVarTiles (int vlistID, int gridID, int zaxisID, int tsteptype,
                          int tilesetID);
\end{verbatim}

Create a new tile-based variable.


1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
\section*{\tt \htmlref{vlistDefVarUnits}{vlistDefVarUnits}}

\begin{verbatim}
    void vlistDefVarUnits (int vlistID, int varID, const char *units);
\end{verbatim}

Define the units of a Variable.


\section*{\tt \htmlref{vlistDestroy}{vlistDestroy}}

\begin{verbatim}
    void vlistDestroy (int vlistID);
\end{verbatim}

Destroy a variable list.


\section*{\tt \htmlref{vlistDuplicate}{vlistDuplicate}}

\begin{verbatim}
    int vlistDuplicate (int vlistID);
\end{verbatim}

Duplicate a variable list.


\section*{\tt \htmlref{vlistHasVarKey}{vlistHasVarKey}}

\begin{verbatim}
    int vlistHasVarKey (int vlistID, int varID, const char *name);
\end{verbatim}

returns 1 if meta-data key was read, 0 otherwise..


\section*{\tt \htmlref{vlistInqAtt}{vlistInqAtt}}

\begin{verbatim}
    int vlistInqAtt (int vlistID, int varID, int attrnum, char *name, int *typep,
                     int *lenp);
\end{verbatim}

Get information about an attribute.


\section*{\tt \htmlref{vlistInqAttFlt}{vlistInqAttFlt}}

\begin{verbatim}
    int vlistInqAttFlt (int vlistID, int varID, const char *name, int mlen,
                        double *dp_vec);
\end{verbatim}

Get the value(s) of a floating point attribute.


\section*{\tt \htmlref{vlistInqAttInt}{vlistInqAttInt}}

\begin{verbatim}
    int vlistInqAttInt (int vlistID, int varID, const char *name, int mlen,
                        int *ip_vec);
\end{verbatim}

Get the value(s) of an integer attribute.


\section*{\tt \htmlref{vlistInqAttTxt}{vlistInqAttTxt}}

\begin{verbatim}
    int vlistInqAttTxt (int vlistID, int varID, const char *name, int mlen,
                        char *tp_cbuf);
\end{verbatim}

Get the value(s) of a text attribute.


\section*{\tt \htmlref{vlistInqNatts}{vlistInqNatts}}

\begin{verbatim}
    int vlistInqNatts (int vlistID, int varID, int *nattsp);
\end{verbatim}

Get number of variable attributes assigned to this variable.


\section*{\tt \htmlref{vlistInqTaxis}{vlistInqTaxis}}

\begin{verbatim}
    int vlistInqTaxis (int vlistID);
\end{verbatim}

Get the time axis of a variable list.


\section*{\tt \htmlref{vlistInqVarCode}{vlistInqVarCode}}

\begin{verbatim}
    int vlistInqVarCode (int vlistID, int varID);
\end{verbatim}

Get the code number of a Variable.


\section*{\tt \htmlref{vlistInqVarDatatype}{vlistInqVarDatatype}}

\begin{verbatim}
    int vlistInqVarDatatype (int vlistID, int varID);
\end{verbatim}

Get the data type of a Variable.


\section*{\tt \htmlref{vlistInqVarDblKey}{vlistInqVarDblKey}}

\begin{verbatim}
    double vlistInqVarDblKey (int vlistID, int varID, const char *name);
\end{verbatim}

raw access to GRIB meta-data.


\section*{\tt \htmlref{vlistInqVarExtra}{vlistInqVarExtra}}

\begin{verbatim}
    void vlistInqVarExtra (int vlistID, int varID, char *extra);
\end{verbatim}

Get extra information of a Variable.


\section*{\tt \htmlref{vlistInqVarIntKey}{vlistInqVarIntKey}}

\begin{verbatim}
    int vlistInqVarIntKey (int vlistID, int varID, const char *name);
\end{verbatim}

raw access to GRIB meta-data.


\section*{\tt \htmlref{vlistInqVarLongname}{vlistInqVarLongname}}

\begin{verbatim}
    void vlistInqVarLongname (int vlistID, int varID, char *longname);
\end{verbatim}

Get the long name of a Variable.


\section*{\tt \htmlref{vlistInqVarMissval}{vlistInqVarMissval}}

\begin{verbatim}
    double vlistInqVarMissval (int vlistID, int varID);
\end{verbatim}

Get the missing value of a Variable.


\section*{\tt \htmlref{vlistInqVarName}{vlistInqVarName}}

\begin{verbatim}
    void vlistInqVarName (int vlistID, int varID, char *name);
\end{verbatim}

Get the name of a Variable.


\section*{\tt \htmlref{vlistInqVarParam}{vlistInqVarParam}}

\begin{verbatim}
    int vlistInqVarParam (int vlistID, int varID);
\end{verbatim}

Get the parameter number of a Variable.


\section*{\tt \htmlref{vlistInqVarStdname}{vlistInqVarStdname}}

\begin{verbatim}
    void vlistInqVarStdname (int vlistID, int varID, char *stdname);
\end{verbatim}

Get the standard name of a Variable.


1187
1188
1189
1190
1191
1192
1193
1194
1195
\section*{\tt \htmlref{vlistInqVarSubtype}{vlistInqVarSubtype}}

\begin{verbatim}
    int vlistInqVarSubtype (int vlistID, int varID);
\end{verbatim}

Return subtype ID for a given variable..


1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
\section*{\tt \htmlref{vlistInqVarUnits}{vlistInqVarUnits}}

\begin{verbatim}
    void vlistInqVarUnits (int vlistID, int varID, char *units);
\end{verbatim}

Get the units of a Variable.


\section*{\tt \htmlref{vlistMerge}{vlistMerge}}

\begin{verbatim}
    void vlistMerge (int vlistID2, int vlistID1);
\end{verbatim}

Merge two variable lists.


\section*{\tt \htmlref{vlistNgrids}{vlistNgrids}}

\begin{verbatim}
    int vlistNgrids (int vlistID);
\end{verbatim}

Number of grids in a variable list.


1223
1224
1225
1226
1227
1228
1229
1230
1231
\section*{\tt \htmlref{vlistNsubtypes}{vlistNsubtypes}}

\begin{verbatim}
    int vlistNsubtypes (int vlistID);
\end{verbatim}

Number of subtypes in a variable list.


1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
\section*{\tt \htmlref{vlistNumber}{vlistNumber}}

\begin{verbatim}
    int vlistNumber (int vlistID);
\end{verbatim}

Number type in a variable list.


\section*{\tt \htmlref{vlistNvars}{vlistNvars}}

\begin{verbatim}
    int vlistNvars (int vlistID);
\end{verbatim}

Number of variables in a variable list.


\section*{\tt \htmlref{vlistNzaxis}{vlistNzaxis}}

\begin{verbatim}
    int vlistNzaxis (int vlistID);
\end{verbatim}

Number of zaxis in a variable list.


\section*{\tt \htmlref{zaxisCreate}{zaxisCreate}}

\begin{verbatim}
    int zaxisCreate (int zaxistype, int size);
\end{verbatim}

Create a vertical Z-axis.


\section*{\tt \htmlref{zaxisDefLevel}{zaxisDefLevel}}

\begin{verbatim}
    void zaxisDefLevel (int zaxisID, int levelID, double levels);
\end{verbatim}

Define one level of a Z-axis.


\section*{\tt \htmlref{zaxisDefLevels}{zaxisDefLevels}}

\begin{verbatim}
    void zaxisDefLevels (int zaxisID, const double *levels_vec);
\end{verbatim}

Define the levels of a Z-axis.


\section*{\tt \htmlref{zaxisDefLongname}{zaxisDefLongname}}

\begin{verbatim}
    void zaxisDefLongname (int zaxisID, const char *longname);
\end{verbatim}

Define the longname of a Z-axis.


\section*{\tt \htmlref{zaxisDefName}{zaxisDefName}}

\begin{verbatim}
    void zaxisDefName (int zaxisID, const char *name);
\end{verbatim}

Define the name of a Z-axis.


\section*{\tt \htmlref{zaxisDefNlevRef}{zaxisDefNlevRef}}

\begin{verbatim}
    void zaxisDefNlevRef (int gridID, int nhlev);
\end{verbatim}

Define the number of half levels of a generalized Z-axis.


\section*{\tt \htmlref{zaxisDefNumber}{zaxisDefNumber}}

\begin{verbatim}
    void zaxisDefNumber (int gridID, int number);
\end{verbatim}

Define the reference number for a generalized Z-axis.


\section*{\tt \htmlref{zaxisDefUUID}{zaxisDefUUID}}

\begin{verbatim}
1325
    void zaxisDefUUID (int zaxisID, const unsigned char uuid[CDI_UUID_SIZE]);
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
\end{verbatim}

Define the UUID of a generalized Z-axis.


\section*{\tt \htmlref{zaxisDefUnits}{zaxisDefUnits}}

\begin{verbatim}
    void zaxisDefUnits (int zaxisID, const char *units);
\end{verbatim}

Define the units of a Z-axis.


\section*{\tt \htmlref{zaxisDestroy}{zaxisDestroy}}

\begin{verbatim}
    void zaxisDestroy (int zaxisID);
\end{verbatim}

Destroy a vertical Z-axis.


\section*{\tt \htmlref{zaxisDuplicate}{zaxisDuplicate}}

\begin{verbatim}
    int zaxisDuplicate (int zaxisID);
\end{verbatim}

Duplicate a Z-axis.


\section*{\tt \htmlref{zaxisInqLevel}{zaxisInqLevel}}

\begin{verbatim}
    double zaxisInqLevel (int zaxisID, int levelID);
\end{verbatim}

Get one level of a Z-axis.


\section*{\tt \htmlref{zaxisInqLevels}{zaxisInqLevels}}

\begin{verbatim}
    void zaxisInqLevels (int zaxisID, double *levels_vec);
\end{verbatim}

Get all levels of a Z-axis.


\section*{\tt \htmlref{zaxisInqLongname}{zaxisInqLongname}}

\begin{verbatim}
    void zaxisInqLongname (int zaxisID, char *longname);
\end{verbatim}

Get the longname of a Z-axis.


\section*{\tt \htmlref{zaxisInqName}{zaxisInqName}}

\begin{verbatim}
    void zaxisInqName (int zaxisID, char *name);
\end{verbatim}

Get the name of a Z-axis.


\section*{\tt \htmlref{zaxisInqNlevRef}{zaxisInqNlevRef}}

\begin{verbatim}
    int zaxisInqNlevRef (int gridID);
\end{verbatim}

Get the number of half levels of a generalized Z-axis.


\section*{\tt \htmlref{zaxisInqNumber}{zaxisInqNumber}}

\begin{verbatim}
    int zaxisInqNumber (int gridID);
\end{verbatim}

Get the reference number to a generalized Z-axis.


\section*{\tt \htmlref{zaxisInqSize}{zaxisInqSize}}

\begin{verbatim}
    int zaxisInqSize (int zaxisID);
\end{verbatim}

Get the size of a Z-axis.


\section*{\tt \htmlref{zaxisInqStdname}{zaxisInqStdname}}

\begin{verbatim}
    void zaxisInqStdname (int zaxisID, char *stdname);
\end{verbatim}

Get the standard name of a Z-axis.


\section*{\tt \htmlref{zaxisInqType}{zaxisInqType}}

\begin{verbatim}
    int zaxisInqType (int zaxisID);
\end{verbatim}

Get the type of a Z-axis.


\section*{\tt \htmlref{zaxisInqUUID}{zaxisInqUUID}}

\begin{verbatim}
1442
    void zaxisInqUUID (int zaxisID, unsigned char uuid[CDI_UUID_SIZE]);
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
\end{verbatim}

Get the UUID of a generalized Z-axis.


\section*{\tt \htmlref{zaxisInqUnits}{zaxisInqUnits}}

\begin{verbatim}
    void zaxisInqUnits (int zaxisID, char *units);
\end{verbatim}

Get the units of a Z-axis.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1455
1456