FUNCTIONS 5.73 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1
2
3
4
5
6
7
8
9
10
11
12
13
===========================
CDI  Climate Data Interface
===========================

Function catalog:

-------------------------------------------------------------
   stream
-------------------------------------------------------------
   streamOpenWrite      Create a new dataset
   streamOpenRead       Open a dataset for reading
   streamClose          Close an open dataset
   streamInqFiletype    Get the filetype
14
15
   streamDefByteorder   Define the byte order
   streamInqByteorder   Get the byte order
Uwe Schulzweida's avatar
Uwe Schulzweida committed
16
17
   streamDefVlist       Define the variable list
   streamInqVlist       Get the variable list
18
19
   streamDefTimestep    Define time step
   streamInqTimestep    Get time step
Uwe Schulzweida's avatar
Uwe Schulzweida committed
20
21
22
23
24
25
26
   streamWriteVar       Write a variable
   streamReadVar        Read a variable
   streamWriteVarSlice  Write a horizontal slice of a variable
   streamReadVarSlice   Read a horizontal slice of a variable
-------------------------------------------------------------
   vlist
-------------------------------------------------------------
27
28
   vlistCreate          Create a variable list
   vlistDestroy         Destroy a variable list
Uwe Schulzweida's avatar
Uwe Schulzweida committed
29
30
31
32
33
34
35
   vlistCopy            Copy a variable list
   vlistDuplicate       Duplicate a variable list
   vlistCat             Concatenate two variable lists
   vlistCopyFlag        Copy some entries of a variable list
   vlistNvars           Number of variables in a variable list
   vlistNgrids          Number of grids in a variable list
   vlistNzaxis          Number of zaxis in a variable list
36
37
   vlistDefTaxis        Define the time axis
   vlistInqTaxis        Get the time axis
Uwe Schulzweida's avatar
Uwe Schulzweida committed
38
39
40
41
-------------------------------------------------------------
   vlist_var
-------------------------------------------------------------
   vlistDefVar          Define a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
42
43
   vlistInqVarGrid      Get the Grid ID of a Variable
   vlistInqVarZaxis     Get the Zaxis ID of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
44
45
46
47
48
49
   vlistDefVarCode      Define the code number of a Variable
   vlistInqVarCode      Get the Code number of a Variable
   vlistDefVarName      Define the name of a Variable
   vlistInqVarName      Get the name of a Variable
   vlistDefVarLongname  Define the long name of a Variable
   vlistInqVarLongname  Get the longname of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
50
51
   vlistDefVarStdname   Define the standard name of a Variable
   vlistInqVarStdname   Get the standard name of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
52
53
54
   vlistDefVarUnits     Define the units of a Variable
   vlistInqVarUnits     Get the units of a Variable
   vlistDefVarDatatype  Define the data type of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
55
   vlistInqVarDatatype  Get the data type of a Variable
Uwe Schulzweida's avatar
Uwe Schulzweida committed
56
57
58
59
60
   vlistDefVarMissval   Define the missing value of a Variable
   vlistInqVarMissval   Get the missing value of a Variable
-------------------------------------------------------------
   grid
-------------------------------------------------------------
61
62
63
   gridCreate           Create a horizontal Grid
   gridDestroy          Destroy a horizontal Grid
   gridDuplicate        Duplicate a horizontal Grid
Uwe Schulzweida's avatar
Uwe Schulzweida committed
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
   gridInqType          Get the type of a Grid
   gridInqSize          Get the size of a Grid
   gridDefXsize         Define the number of values of a X-axis
   gridInqXsize         Get the number of values of a X-axis
   gridDefYsize         Define the number of values of a Y-axis
   gridInqYsize         Get the number of values of a Y-axis
   gridDefXvals         Define the values of a X-axis
   gridInqXvals         Get all values of a X-axis
   gridDefYvals         Define the values of a Y-axis
   gridInqYvals         Get all values of a Y-axis
   gridDefXbounds       Define the bounds of a X-axis
   gridInqXbounds       Get the bounds of a X-axis
   gridDefYbounds       Define the bounds of a Y-axis
   gridInqYbounds       Get the bounds of a Y-axis
   gridDefXname         Define the name of a X-axis
   gridInqXname         Get the name of a X-axis
   gridDefXlongname     Define the longname of a X-axis
   gridInqXlongname     Get the longname of a X-axis
   gridDefXunits        Define the units of a X-axis
   gridInqXunits        Get the units of a X-axis
   gridDefYname         Define the name of a Y-axis
   gridInqYname         Get the name of a Y-axis
   gridDefYlongname     Define the longname of a Y-axis
   gridInqYlongname     Get the longname of a Y-axis
   gridDefYunits        Define the units of a Y-axis
   gridInqYunits        Get the units of a Y-axis
-------------------------------------------------------------
   zaxis
-------------------------------------------------------------
93
94
   zaxisCreate          Create a vertical Z-axis
   zaxisDestroy         Destroy a vertical Z-axis
Uwe Schulzweida's avatar
Uwe Schulzweida committed
95
96
97
98
99
100
101
102
103
104
105
106
107
108
   zaxisInqType         Get the type of a Z-axis
   zaxisInqSize         Get the size of a Z-axis
   zaxisDefLevels       Define the levels of a Z-axis
   zaxisInqLevels       Get all levels of a Z-axis
   zaxisInqLevel        Get one level of a Z-axis
   zaxisDefName         Define the name of a Z-axis
   zaxisInqName         Get the name of a Z-axis
   zaxisDefLongname     Define the longname of a Z-axis
   zaxisInqLongname     Get the longname of a Z-axis
   zaxisDefUnits        Define the units of a Z-axis
   zaxisInqUnits        Get the units of a Z-axis
-------------------------------------------------------------
   taxis
-------------------------------------------------------------
109
110
   taxisCreate          Create a Time axis
   taxisDestroy         Destroy a Time axis
Uwe Schulzweida's avatar
Uwe Schulzweida committed
111
112
113
114
115
116
117
118
119
120
   taxisDefRdate        Define the reference date
   taxisInqRdate        Get the reference date
   taxisDefRtime        Define the reference time
   taxisInqRtime        Get the reference time
   taxisDefVdate        Define the verification date
   taxisInqVdate        Get the verification date
   taxisDefVtime        Define the verification time
   taxisInqVtime        Get the verification time
   taxisDefCalendar     Define the calendar
   taxisInqCalendar     Get the calendar