Commit 9b08aa33 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent 7ab7bb49
2012-06-06 Uwe Schulzweida <Uwe.Schulzweida@zmaw.de>
* added support for grib_api key stepType [request: Drte Liermann]
* changed TIME_CONSTANT and TIME_VARIABLE to TSTEP_CONSTANT and TSTEP_XXX
* renamed vlistInqVarTime() vlistInqVarTsteptype()
2012-06-01 Uwe Schulzweida <Uwe.Schulzweida@zmaw.de>
......
......@@ -1018,7 +1018,7 @@ vlistDefVar
\fi
}
\begin{verbatim}
int vlistDefVar(int vlistID, int gridID, int zaxisID, int timeID);
int vlistDefVar(int vlistID, int gridID, int zaxisID, int tsteptype);
\end{verbatim}
Define a Variable
......
......@@ -21,7 +21,7 @@ and add a variable with {\tt vlistDefVar}.
int vlistID, varID;
...
vlistID = vlistCreate();
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_VARIABLE);
varID = vlistDefVar(vlistID, gridID, zaxisID, TSTEP_INSTANT);
...
streamDefVlist(streamID, vlistID);
...
......
......@@ -9,20 +9,20 @@ The function {\tt vlistDefVar} adds a new variable to vlistID.
\subsubsection*{Usage}
\begin{verbatim}
int vlistDefVar(int vlistID, int gridID, int zaxisID, int timeID);
int vlistDefVar(int vlistID, int gridID, int zaxisID, int tsteptype);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt vlistID\ }
\begin{deflist}{\tt tsteptype\ }
\item[{\tt vlistID}]
Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}.
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt zaxisID}]
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}.
\item[{\tt timeID}]
One of the set of predefined {\CDI} time identifiers.
The valid {\CDI} time identifiers are {\tt TIME\_CONSTANT} and {\tt TIME\_VARIABLE}.
\item[{\tt tsteptype}]
One of the set of predefined {\CDI} timestep types.
The valid {\CDI} timestep types are {\tt TSTEP\_CONSTANT} and {\tt TSTEP\_INSTANT}.
\end{deflist}
\end{minipage}
......@@ -44,7 +44,7 @@ and add a variable with {\tt vlistDefVar}.
int vlistID, varID;
...
vlistID = vlistCreate();
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_VARIABLE);
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_INSTANT);
...
streamDefVlist(streamID, vlistID);
...
......
......@@ -1026,7 +1026,7 @@ vlistDefVar
}
\begin{verbatim}
INTEGER FUNCTION vlistDefVar(INTEGER vlistID, INTEGER gridID, INTEGER zaxisID,
INTEGER timeID)
INTEGER tsteptype)
\end{verbatim}
Define a Variable
......
......@@ -21,7 +21,7 @@ and add a variable with {\tt vlistDefVar}.
INTEGER vlistID, varID
...
vlistID = vlistCreate()
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_VARIABLE)
varID = vlistDefVar(vlistID, gridID, zaxisID, TSTEP_INSTANT)
...
streamDefVlist(streamID, vlistID)
...
......
......@@ -10,20 +10,20 @@ The function {\tt vlistDefVar} adds a new variable to vlistID.
\begin{verbatim}
INTEGER FUNCTION vlistDefVar(INTEGER vlistID, INTEGER gridID, INTEGER zaxisID,
INTEGER timeID)
INTEGER tsteptype)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt vlistID\ }
\begin{deflist}{\tt tsteptype\ }
\item[{\tt vlistID}]
Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}.
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt zaxisID}]
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}.
\item[{\tt timeID}]
One of the set of predefined {\CDI} time identifiers.
The valid {\CDI} time identifiers are {\tt TIME\_CONSTANT} and {\tt TIME\_VARIABLE}.
\item[{\tt tsteptype}]
One of the set of predefined {\CDI} timestep types.
The valid {\CDI} timestep types are {\tt TSTEP\_CONSTANT} and {\tt TSTEP\_INSTANT}.
\end{deflist}
\end{minipage}
......@@ -45,7 +45,7 @@ and add a variable with {\tt vlistDefVar}.
INTEGER vlistID, varID
...
vlistID = vlistCreate()
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_VARIABLE)
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_INSTANT)
...
streamDefVlist(streamID, vlistID)
...
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment