Commit 5662351e authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

vlistInqVarTsteptype: added docu

parent 6e839071
......@@ -55,6 +55,7 @@ Function catalog:
vlistDefVar Define a Variable
vlistInqVarGrid Get the Grid ID of a Variable
vlistInqVarZaxis Get the Zaxis ID of a Variable
vlistInqVarTsteptype Get the timestep type of a Variable
vlistDefVarCode Define the code number of a Variable
vlistInqVarCode Get the Code number of a Variable
vlistDefVarName Define the name of a Variable
......
......@@ -35,7 +35,7 @@ vlistInqTaxis vlist
vlistDefVar vlist_var
vlistInqVarGrid vlist_var
vlistInqVarZaxis vlist_var
vlistInqVarTime vlist_var
vlistInqVarTsteptype vlist_var
vlistDefVarCode vlist_var
vlistInqVarCode vlist_var
vlistDefVarName vlist_var
......
......@@ -18,7 +18,7 @@ The function {\tt gridCreate} creates a horizontal Grid.
The type of the grid, one of the set of predefined {\CDI} grid types.
The valid {\CDI} grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
{\tt GRID\_LONLAT}, {\tt GRID\_LCC}, {\tt GRID\_SPECTRAL},
{\tt GRID\_GME}, {\tt GRID\_CURVILINEAR} and {\tt GRID\_UNSTRUCTURED} and.
{\tt GRID\_GME}, {\tt GRID\_CURVILINEAR} and {\tt GRID\_UNSTRUCTURED}.
\item[{\tt size}]
Number of gridpoints.
......
......@@ -1521,6 +1521,21 @@ Get the standard name of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarStdname})}
\section*{\tt
\ifpdf
\hyperref[vlistInqVarTsteptype]{vlistInqVarTsteptype}
\else
vlistInqVarTsteptype
\fi
}
\begin{verbatim}
int vlistInqVarTsteptype(int vlistID, int varID);
\end{verbatim}
Get the timestep type of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarTsteptype})}
\section*{\tt
\ifpdf
\hyperref[vlistInqVarUnits]{vlistInqVarUnits}
......
......@@ -22,7 +22,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}.
\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}.
The valid {\CDI} timestep types are {\tt TSTEP\_CONSTANT}, {\tt TSTEP\_INSTANT},
{\tt TSTEP\_ACCUM}, {\tt TSTEP\_AVG}, {\tt TSTEP\_MAX}, {\tt TSTEP\_MIN} and {\tt TSTEP\_SD}.
\end{deflist}
\end{minipage}
......@@ -57,7 +58,7 @@ and add a variable with {\tt vlistDefVar}.
\index{vlistInqVarGrid}
\label{vlistInqVarGrid}
The function {\tt vlistInqVarGrid} returns the grid ID of a variable.
The function {\tt vlistInqVarGrid} returns the grid ID of a Variable.
\subsubsection*{Usage}
......@@ -77,7 +78,7 @@ Variable identifier.
\subsubsection*{Result}
{\tt vlistInqVarGrid} returns the grid ID of the variable.
{\tt vlistInqVarGrid} returns the grid ID of the Variable.
......@@ -109,6 +110,37 @@ Variable identifier.
\subsection{Get the timestep type of a Variable: {\tt vlistInqVarTsteptype}}
\index{vlistInqVarTsteptype}
\label{vlistInqVarTsteptype}
The function {\tt vlistInqVarTsteptype} returns the timestep type of a Variable.
\subsubsection*{Usage}
\begin{verbatim}
int vlistInqVarTsteptype(int vlistID, int varID);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt vlistID\ }
\item[{\tt vlistID}]
Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\tt vlistInqVarTsteptype} returns the timestep type of the Variable,
one of the set of predefined {\CDI} timestep types.
The valid {\CDI} timestep types are {\tt TSTEP\_CONSTANT}, {\tt TSTEP\_INSTANT},
{\tt TSTEP\_ACCUM}, {\tt TSTEP\_AVG}, {\tt TSTEP\_MAX}, {\tt TSTEP\_MIN} and {\tt TSTEP\_SD}.
\subsection{Define the code number of a Variable: {\tt vlistDefVarCode}}
\index{vlistDefVarCode}
\label{vlistDefVarCode}
......
......@@ -18,7 +18,7 @@ The function {\tt gridCreate} creates a horizontal Grid.
The type of the grid, one of the set of predefined {\CDI} grid types.
The valid {\CDI} grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
{\tt GRID\_LONLAT}, {\tt GRID\_LCC}, {\tt GRID\_SPECTRAL},
{\tt GRID\_GME}, {\tt GRID\_CURVILINEAR} and {\tt GRID\_UNSTRUCTURED} and.
{\tt GRID\_GME}, {\tt GRID\_CURVILINEAR} and {\tt GRID\_UNSTRUCTURED}.
\item[{\tt size}]
Number of gridpoints.
......
......@@ -1539,6 +1539,21 @@ Get the standard name of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarStdname})}
\section*{\tt
\ifpdf
\hyperref[vlistInqVarTsteptype]{vlistInqVarTsteptype}
\else
vlistInqVarTsteptype
\fi
}
\begin{verbatim}
INTEGER FUNCTION vlistInqVarTsteptype(INTEGER vlistID, INTEGER varID)
\end{verbatim}
Get the timestep type of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarTsteptype})}
\section*{\tt
\ifpdf
\hyperref[vlistInqVarUnits]{vlistInqVarUnits}
......
......@@ -23,7 +23,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}.
\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}.
The valid {\CDI} timestep types are {\tt TSTEP\_CONSTANT}, {\tt TSTEP\_INSTANT},
{\tt TSTEP\_ACCUM}, {\tt TSTEP\_AVG}, {\tt TSTEP\_MAX}, {\tt TSTEP\_MIN} and {\tt TSTEP\_SD}.
\end{deflist}
\end{minipage}
......@@ -58,7 +59,7 @@ and add a variable with {\tt vlistDefVar}.
\index{vlistInqVarGrid}
\label{vlistInqVarGrid}
The function {\tt vlistInqVarGrid} returns the grid ID of a variable.
The function {\tt vlistInqVarGrid} returns the grid ID of a Variable.
\subsubsection*{Usage}
......@@ -78,7 +79,7 @@ Variable identifier.
\subsubsection*{Result}
{\tt vlistInqVarGrid} returns the grid ID of the variable.
{\tt vlistInqVarGrid} returns the grid ID of the Variable.
......@@ -110,6 +111,37 @@ Variable identifier.
\subsection{Get the timestep type of a Variable: {\tt vlistInqVarTsteptype}}
\index{vlistInqVarTsteptype}
\label{vlistInqVarTsteptype}
The function {\tt vlistInqVarTsteptype} returns the timestep type of a Variable.
\subsubsection*{Usage}
\begin{verbatim}
INTEGER FUNCTION vlistInqVarTsteptype(INTEGER vlistID, INTEGER varID)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt vlistID\ }
\item[{\tt vlistID}]
Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\tt vlistInqVarTsteptype} returns the timestep type of the Variable,
one of the set of predefined {\CDI} timestep types.
The valid {\CDI} timestep types are {\tt TSTEP\_CONSTANT}, {\tt TSTEP\_INSTANT},
{\tt TSTEP\_ACCUM}, {\tt TSTEP\_AVG}, {\tt TSTEP\_MAX}, {\tt TSTEP\_MIN} and {\tt TSTEP\_SD}.
\subsection{Define the code number of a Variable: {\tt vlistDefVarCode}}
\index{vlistDefVarCode}
\label{vlistDefVarCode}
......
This module contains functions to add new variables to a
variable list and to get information about variables from
a variable list. To add new variables to a variables list
one of the following time types must be specified:
one of the following timestep types must be specified:
\vspace*{3mm}
\hspace*{8mm}\begin{minipage}{15cm}
\begin{deflist}{{\large\tt TSTEP\_CONSTANT \ \ }}
\item[{\large\tt TSTEP\_CONSTANT }] For time constant variables
\item[{\large\tt TSTEP\_INSTANT }] For time varying variables
\item[{\large\tt TSTEP\_CONSTANT }] The data values have no time dimension.
\item[{\large\tt TSTEP\_INSTANT }] The data values are representative of points in space or time (instantaneous).
\item[{\large\tt TSTEP\_ACCUM }] The data values are representative of a sum or accumulation over the cell.
\item[{\large\tt TSTEP\_AVG }] Mean (average value)
\item[{\large\tt TSTEP\_MAX }] Maximum
\item[{\large\tt TSTEP\_MIN }] Minimum
\item[{\large\tt TSTEP\_SD }] Standard deviation
\end{deflist}
\end{minipage}
\vspace*{3mm}
......
......@@ -539,6 +539,8 @@ int vlistInqVarZaxis(int vlistID, int varID);
int vlistInqVarID(int vlistID, int code);
void vlistDefVarTsteptype(int vlistID, int varID, int tsteptype);
/* vlistInqVarTsteptype: Get the timestep type of a Variable */
int vlistInqVarTsteptype(int vlistID, int varID);
void vlistDefVarCompType(int vlistID, int varID, int comptype);
......
......@@ -516,7 +516,7 @@ void gridGenYvals(int gridtype, int ysize, double yfirst, double ylast, double y
@Item gridtype The type of the grid, one of the set of predefined CDI grid types.
The valid CDI grid types are @func{GRID_GENERIC}, @func{GRID_GAUSSIAN},
@func{GRID_LONLAT}, @func{GRID_LCC}, @func{GRID_SPECTRAL},
@func{GRID_GME}, @func{GRID_CURVILINEAR} and @func{GRID_UNSTRUCTURED} and.
@func{GRID_GME}, @func{GRID_CURVILINEAR} and @func{GRID_UNSTRUCTURED}.
@Item size Number of gridpoints.
@Description
......
......@@ -17,7 +17,6 @@
#if defined (HAVE_LIBGRIB_API)
# include "file.h"
# include <grib_api.h>
#endif
......@@ -172,7 +171,8 @@ int vlistDefVarTiles(int vlistID, int gridID, int zaxisID, int tsteptype, int ti
@Item gridID Grid ID, from a previous call to @fref{gridCreate}.
@Item zaxisID Z-axis ID, from a previous call to @fref{zaxisCreate}.
@Item tsteptype One of the set of predefined CDI timestep types.
The valid CDI timestep types are @func{TSTEP_CONSTANT} and @func{TSTEP_INSTANT}.
The valid CDI timestep types are @func{TSTEP_CONSTANT}, @func{TSTEP_INSTANT},
@func{TSTEP_ACCUM}, @func{TSTEP_AVG}, @func{TSTEP_MAX}, @func{TSTEP_MIN} and @func{TSTEP_SD}.
@Description
The function @func{vlistDefVar} adds a new variable to vlistID.
......@@ -304,10 +304,10 @@ void vlistInqVar(int vlistID, int varID, int *gridID, int *zaxisID, int *tstepty
@Item varID Variable identifier.
@Description
The function @func{vlistInqVarGrid} returns the grid ID of a variable.
The function @func{vlistInqVarGrid} returns the grid ID of a Variable.
@Result
@func{vlistInqVarGrid} returns the grid ID of the variable.
@func{vlistInqVarGrid} returns the grid ID of the Variable.
@EndFunction
*/
......@@ -1231,7 +1231,26 @@ void vlistDefVarTsteptype(int vlistID, int varID, int tsteptype)
}
}
/*
@Function vlistInqVarTsteptype
@Title Get the timestep type of a Variable
@Prototype int vlistInqVarTsteptype(int vlistID, int varID)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate} or @fref{streamInqVlist}.
@Item varID Variable identifier.
@Description
The function @func{vlistInqVarTsteptype} returns the timestep type of a Variable.
@Result
@func{vlistInqVarTsteptype} returns the timestep type of the Variable,
one of the set of predefined CDI timestep types.
The valid CDI timestep types are @func{TSTEP_CONSTANT}, @func{TSTEP_INSTANT},
@func{TSTEP_ACCUM}, @func{TSTEP_AVG}, @func{TSTEP_MAX}, @func{TSTEP_MIN} and @func{TSTEP_SD}.
@EndFunction
*/
int vlistInqVarTsteptype(int vlistID, int varID)
{
vlist_t *vlistptr = vlist_to_pointer(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