Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
mpim-sw
libcdi
Commits
44966d85
Commit
44966d85
authored
Jul 14, 2006
by
Uwe Schulzweida
Browse files
Docu update
parent
4a6002c8
Changes
9
Hide whitespace changes
Inline
Side-by-side
doc/tex/FUNCTIONS
View file @
44966d85
...
...
@@ -39,6 +39,8 @@ Function catalog:
vlist_var
-------------------------------------------------------------
vlistDefVar Define a Variable
vlistInqVarGrid Get the Grid ID of a Variable
vlistInqVarZaxis Get the Zaxis ID 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
...
...
doc/tex/Modules
View file @
44966d85
...
...
@@ -24,8 +24,8 @@ vlistNzaxis vlist
vlistDefTaxis vlist
vlistInqTaxis vlist
vlistDefVar vlist_var
vlistInqVarGrid vlist_var
vlistInqVarZaxis vlist_var
vlistInqVarGrid vlist_var
vlistInqVarZaxis vlist_var
vlistInqVarTime vlist_var
vlistDefVarCode vlist_var
vlistInqVarCode vlist_var
...
...
doc/tex/c_ref.tex
View file @
44966d85
...
...
@@ -650,6 +650,15 @@ Get the Code number of a Variable
Get the data type of a Variable
\section*
{
\tt
\htmlref
{
vlistInqVarGrid
}{
vlistInqVarGrid
}}
\begin{verbatim}
int vlistInqVarGrid(int vlistID, int varID);
\end{verbatim}
Get the Grid ID of a Variable
\section*
{
\tt
\htmlref
{
vlistInqVarLongname
}{
vlistInqVarLongname
}}
\begin{verbatim}
...
...
@@ -686,6 +695,15 @@ Get the name of a Variable
Get the units of a Variable
\section*
{
\tt
\htmlref
{
vlistInqVarZaxis
}{
vlistInqVarZaxis
}}
\begin{verbatim}
int vlistInqVarZaxis(int vlistID, int varID);
\end{verbatim}
Get the Zaxis ID of a Variable
\section*
{
\tt
\htmlref
{
vlistNgrids
}{
vlistNgrids
}}
\begin{verbatim}
...
...
doc/tex/c_vlist_var.tex
View file @
44966d85
...
...
@@ -53,6 +53,62 @@ and add a variable with {\tt vlistDefVar}.
\end{lstlisting}
\subsection
{
Get the Grid ID of a Variable:
{
\tt
vlistInqVarGrid
}}
\index
{
vlistInqVarGrid
}
\label
{
vlistInqVarGrid
}
The function
{
\tt
vlistInqVarGrid
}
returns the grid ID of a variable.
\subsubsection*
{
Usage
}
\begin{verbatim}
int vlistInqVarGrid(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
}}
\item
[{\tt varID}]
Variable identifier
\end{deflist}
\end{minipage}
\subsubsection*
{
Result
}
{
\tt
vlistInqVarGrid
}
returns the grid ID of the variable.
\subsection
{
Get the Zaxis ID of a Variable:
{
\tt
vlistInqVarZaxis
}}
\index
{
vlistInqVarZaxis
}
\label
{
vlistInqVarZaxis
}
The function
{
\tt
vlistInqVarZaxis
}
returns the zaxis ID of a variable.
\subsubsection*
{
Usage
}
\begin{verbatim}
int vlistInqVarZaxis(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
}}
\item
[{\tt varID}]
Variable identifier
\end{deflist}
\end{minipage}
\subsubsection*
{
Result
}
{
\tt
vlistInqVarZaxis
}
returns the zaxis ID of the variable.
\subsection
{
Define the code number of a Variable:
{
\tt
vlistDefVarCode
}}
\index
{
vlistDefVarCode
}
\label
{
vlistDefVarCode
}
...
...
doc/tex/cdi_cman.tex
View file @
44966d85
...
...
@@ -124,7 +124,7 @@
\end{picture}
\begin{flushright}
\large\bf
{
Climate Data Interface
\\
Version 1.0.
0
\\
June
2006
}
\large\bf
{
Climate Data Interface
\\
Version 1.0.
1
\\
August
2006
}
\end{flushright}
\vfill
...
...
doc/tex/cdi_fman.tex
View file @
44966d85
...
...
@@ -123,7 +123,7 @@
\end{picture}
\begin{flushright}
\large\bf
{
Climate Data Interface
\\
Version 1.0.
0
\\
June
2006
}
\large\bf
{
Climate Data Interface
\\
Version 1.0.
1
\\
August
2006
}
\end{flushright}
\vfill
...
...
doc/tex/f_ref.tex
View file @
44966d85
...
...
@@ -654,6 +654,15 @@ Get the Code number of a Variable
Get the data type of a Variable
\section*
{
\tt
\htmlref
{
vlistInqVarGrid
}{
vlistInqVarGrid
}}
\begin{verbatim}
INTEGER FUNCTION vlistInqVarGrid(INTEGER vlistID, INTEGER varID)
\end{verbatim}
Get the Grid ID of a Variable
\section*
{
\tt
\htmlref
{
vlistInqVarLongname
}{
vlistInqVarLongname
}}
\begin{verbatim}
...
...
@@ -691,6 +700,15 @@ Get the name of a Variable
Get the units of a Variable
\section*
{
\tt
\htmlref
{
vlistInqVarZaxis
}{
vlistInqVarZaxis
}}
\begin{verbatim}
INTEGER FUNCTION vlistInqVarZaxis(INTEGER vlistID, INTEGER varID)
\end{verbatim}
Get the Zaxis ID of a Variable
\section*
{
\tt
\htmlref
{
vlistNgrids
}{
vlistNgrids
}}
\begin{verbatim}
...
...
doc/tex/f_vlist_var.tex
View file @
44966d85
...
...
@@ -54,6 +54,62 @@ and add a variable with {\tt vlistDefVar}.
\end{lstlisting}
\subsection
{
Get the Grid ID of a Variable:
{
\tt
vlistInqVarGrid
}}
\index
{
vlistInqVarGrid
}
\label
{
vlistInqVarGrid
}
The function
{
\tt
vlistInqVarGrid
}
returns the grid ID of a variable.
\subsubsection*
{
Usage
}
\begin{verbatim}
INTEGER FUNCTION vlistInqVarGrid(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
}}
\item
[{\tt varID}]
Variable identifier
\end{deflist}
\end{minipage}
\subsubsection*
{
Result
}
{
\tt
vlistInqVarGrid
}
returns the grid ID of the variable.
\subsection
{
Get the Zaxis ID of a Variable:
{
\tt
vlistInqVarZaxis
}}
\index
{
vlistInqVarZaxis
}
\label
{
vlistInqVarZaxis
}
The function
{
\tt
vlistInqVarZaxis
}
returns the zaxis ID of a variable.
\subsubsection*
{
Usage
}
\begin{verbatim}
INTEGER FUNCTION vlistInqVarZaxis(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
}}
\item
[{\tt varID}]
Variable identifier
\end{deflist}
\end{minipage}
\subsubsection*
{
Result
}
{
\tt
vlistInqVarZaxis
}
returns the zaxis ID of the variable.
\subsection
{
Define the code number of a Variable:
{
\tt
vlistDefVarCode
}}
\index
{
vlistDefVarCode
}
\label
{
vlistDefVarCode
}
...
...
src/vlist_var.c
View file @
44966d85
...
...
@@ -276,6 +276,23 @@ void vlistInqVar(int vlistID, int varID, int *gridID, int *zaxisID, int *timeID)
}
/*
@Function vlistInqVarGrid
@Title Get the Grid ID of a Variable
@Prototype int vlistInqVarGrid(int vlistID, int varID)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate}
@Item varID Variable identifier
@Description
The function @func{vlistInqVarGrid} returns the grid ID of a variable.
@Result
@func{vlistInqVarGrid} returns the grid ID of the variable.
@EndFunction
*/
int
vlistInqVarGrid
(
int
vlistID
,
int
varID
)
{
static
char
func
[]
=
"vlistInqVarGrid"
;
...
...
@@ -289,6 +306,23 @@ int vlistInqVarGrid(int vlistID, int varID)
}
/*
@Function vlistInqVarZaxis
@Title Get the Zaxis ID of a Variable
@Prototype int vlistInqVarZaxis(int vlistID, int varID)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate}
@Item varID Variable identifier
@Description
The function @func{vlistInqVarZaxis} returns the zaxis ID of a variable.
@Result
@func{vlistInqVarZaxis} returns the zaxis ID of the variable.
@EndFunction
*/
int
vlistInqVarZaxis
(
int
vlistID
,
int
varID
)
{
static
char
func
[]
=
"vlistInqVarZaxis"
;
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment