c_zaxis.tex 8.12 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1
2


Uwe Schulzweida's avatar
Uwe Schulzweida committed
3
\subsection{Create a vertical Z-axis: {\tt zaxisCreate}}
4
5
\index{zaxisCreate}
\label{zaxisCreate}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
6

7
The function {\tt zaxisCreate} creates a vertical Z-axis.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
8

Uwe Schulzweida's avatar
Uwe Schulzweida committed
9
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
10
11

\begin{verbatim}
12
    int zaxisCreate(int zaxistype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
13
14
15
16
17
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxistype\ }
\item[{\tt zaxistype}]
Uwe Schulzweida's avatar
Uwe Schulzweida committed
18
19
The type of the Z-axis, one of the set of predefined {\CDI} Z-axis types.
                      The valid {\CDI} Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
Uwe Schulzweida's avatar
Uwe Schulzweida committed
20
                      {\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_SIGMA}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
Uwe Schulzweida's avatar
Uwe Schulzweida committed
21
22
23
24
25
26
27
                      {\tt ZAXIS\_DEPTH\_BELOW\_SEA} and {\tt ZAXIS\_DEPTH\_BELOW\_LAND}.
\item[{\tt size}]
Number of levels

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
28
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
29

Uwe Schulzweida's avatar
Uwe Schulzweida committed
30
{\tt zaxisCreate} returns an identifier to the Z-axis.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
31
32


Uwe Schulzweida's avatar
Uwe Schulzweida committed
33
\subsubsection*{Example}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
34
35
36

Here is an example using {\tt zaxisCreate} to create a pressure level Z-axis:

Uwe Schulzweida's avatar
Uwe Schulzweida committed
37
38
\begin{lstlisting}[language=C, backgroundcolor=\color{zebg}, basicstyle=\footnotesize]

Uwe Schulzweida's avatar
Uwe Schulzweida committed
39
40
41
42
43
44
45
46
47
48
49
50
    #include "cdi.h"
       ...
    #define  NLEV    5
       ...
    double levs[NLEV] = {101300, 92500, 85000, 50000, 20000};
    int zaxisID;
       ...
    zaxisID = zaxisCreate(ZAXIS_PRESSURE, NLEV);
    zaxisDefLevels(zaxisID, levs);
       ...
\end{lstlisting}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
51

Uwe Schulzweida's avatar
Uwe Schulzweida committed
52
\subsection{Destroy a vertical Z-axis: {\tt zaxisDestroy}}
53
54
\index{zaxisDestroy}
\label{zaxisDestroy}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
55
\subsubsection*{Usage}
56
57
58
59
60
61
62
63

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxisID\ }
\item[{\tt zaxisID}]
64
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
65
66
67
68
69

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
70
\subsection{Get the type of a Z-axis: {\tt zaxisInqType}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
71
72
73
74
75
\index{zaxisInqType}
\label{zaxisInqType}

The function {\tt zaxisInqType} returns the type of a Z-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
76
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
77
78
79
80
81
82
83
84

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxisID\ }
\item[{\tt zaxisID}]
85
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
86
87
88
89

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
90
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
91
92

{\tt zaxisInqType} returns the type of the Z-axis,
Uwe Schulzweida's avatar
Uwe Schulzweida committed
93
94
one of the set of predefined {\CDI} Z-axis types.
The valid {\CDI} Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
Uwe Schulzweida's avatar
Uwe Schulzweida committed
95
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_SIGMA}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
Uwe Schulzweida's avatar
Uwe Schulzweida committed
96
97
98
99
{\tt ZAXIS\_DEPTH\_BELOW\_SEA} and {\tt ZAXIS\_DEPTH\_BELOW\_LAND}.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
100
\subsection{Get the size of a Z-axis: {\tt zaxisInqSize}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
101
102
103
104
105
\index{zaxisInqSize}
\label{zaxisInqSize}

The function {\tt zaxisInqSize} returns the size of a Z-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
106
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
107
108
109
110
111
112
113
114

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxisID\ }
\item[{\tt zaxisID}]
115
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
116
117
118
119

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
120
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
121
122
123
124
125

{\tt zaxisInqSize} returns the number of levels of a Z-axis.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
126
\subsection{Define the levels of a Z-axis: {\tt zaxisDefLevels}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
127
128
129
130
131
\index{zaxisDefLevels}
\label{zaxisDefLevels}

The function {\tt zaxisDefLevels} defines the levels of a Z-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
132
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
133
134
135
136
137
138
139
140

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxisID\ }
\item[{\tt zaxisID}]
141
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
142
143
144
145
146
147
148
\item[{\tt levels}]
All levels of the Z-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
149
\subsection{Get all levels of a Z-axis: {\tt zaxisInqLevels}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
150
151
152
153
154
\index{zaxisInqLevels}
\label{zaxisInqLevels}

The function {\tt zaxisInqLevels} returns all levels of a Z-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
155
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
156
157
158
159
160
161
162
163

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxisID\ }
\item[{\tt zaxisID}]
164
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
165
166
167
168
169
170
\item[{\tt levels}]
Levels of the Z-axis
    
\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
171
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
172
173
174
175

{\tt zaxisInqLevels} saves all levels to the parameter {\tt levels}.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
176
\subsection{Get one level of a Z-axis: {\tt zaxisInqLevel}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
177
178
179
180
181
\index{zaxisInqLevel}
\label{zaxisInqLevel}

The function {\tt zaxisInqLevel} returns one level of a Z-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
182
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
183
184
185
186
187
188
189
190

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxisID\ }
\item[{\tt zaxisID}]
191
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
192
193
194
195
196
197
\item[{\tt levelID}]
Level index (range: 0 to nlevel-1)

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
198
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
199
200
201
202

{\tt zaxisInqLevel} returns the level of a Z-axis.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
203
\subsection{Define the name of a Z-axis: {\tt zaxisDefName}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
204
205
206
207
208
\index{zaxisDefName}
\label{zaxisDefName}

The function {\tt zaxisDefName} defines the name of a Z-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
209
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
210
211
212
213
214
215
216
217

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxisID\ }
\item[{\tt zaxisID}]
218
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
219
220
221
222
223
224
225
\item[{\tt name}]
Name of the Z-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
226
\subsection{Get the name of a Z-axis: {\tt zaxisInqName}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
227
228
229
230
231
\index{zaxisInqName}
\label{zaxisInqName}

The function {\tt zaxisInqName} returns the name of a Z-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
232
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
233
234
235
236
237
238
239
240

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxisID\ }
\item[{\tt zaxisID}]
241
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
242
243
244
245
246
247
\item[{\tt name}]
Name of the Z-axis

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
248
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
249
250
251
252
253

{\tt zaxisInqName} returns the name of the Z-axis to the parameter name.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
254
\subsection{Define the longname of a Z-axis: {\tt zaxisDefLongname}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
255
256
257
258
259
\index{zaxisDefLongname}
\label{zaxisDefLongname}

The function {\tt zaxisDefLongname} defines the longname of a Z-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
260
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
261
262
263
264
265
266
267
268

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt longname\ }
\item[{\tt zaxisID}]
269
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
270
271
272
273
274
275
276
\item[{\tt longname}]
Longname of the Z-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
277
\subsection{Get the longname of a Z-axis: {\tt zaxisInqLongname}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
278
279
280
281
282
\index{zaxisInqLongname}
\label{zaxisInqLongname}

The function {\tt zaxisInqLongname} returns the longname of a Z-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
283
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
284
285
286
287
288
289
290
291

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt longname\ }
\item[{\tt zaxisID}]
292
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
293
294
295
296
297
298
\item[{\tt longname}]
Longname of the Z-axis

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
299
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
300
301
302
303
304

{\tt zaxisInqLongname} returns the longname of the Z-axis to the parameter longname.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
305
\subsection{Define the units of a Z-axis: {\tt zaxisDefUnits}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
306
307
308
309
310
\index{zaxisDefUnits}
\label{zaxisDefUnits}

The function {\tt zaxisDefUnits} defines the units of a Z-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
311
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
312
313
314
315
316
317
318
319

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxisID\ }
\item[{\tt zaxisID}]
320
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
321
322
323
324
325
326
327
\item[{\tt units}]
Units of the Z-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
328
\subsection{Get the units of a Z-axis: {\tt zaxisInqUnits}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
329
330
331
332
333
\index{zaxisInqUnits}
\label{zaxisInqUnits}

The function {\tt zaxisInqUnits} returns the units of a Z-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
334
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
335
336
337
338
339
340
341
342

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

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxisID\ }
\item[{\tt zaxisID}]
343
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
344
345
346
347
348
349
\item[{\tt units}]
Units of the Z-axis

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
350
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
351
352
353

{\tt zaxisInqUnits} returns the units of the Z-axis to the parameter units.