Commit 1803f401 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

docu update

parent 62169775
...@@ -47,6 +47,8 @@ Function catalog: ...@@ -47,6 +47,8 @@ Function catalog:
vlistInqVarName Get the name of a Variable vlistInqVarName Get the name of a Variable
vlistDefVarLongname Define the long name of a Variable vlistDefVarLongname Define the long name of a Variable
vlistInqVarLongname Get the longname of a Variable vlistInqVarLongname Get the longname of a Variable
vlistDefVarStdname Define the standard name of a Variable
vlistInqVarStdname Get the standard name of a Variable
vlistDefVarUnits Define the units of a Variable vlistDefVarUnits Define the units of a Variable
vlistInqVarUnits Get the units of a Variable vlistInqVarUnits Get the units of a Variable
vlistDefVarDatatype Define the data type of a Variable vlistDefVarDatatype Define the data type of a Variable
......
...@@ -596,6 +596,15 @@ Define the missing value of a Variable ...@@ -596,6 +596,15 @@ Define the missing value of a Variable
Define the name of a Variable Define the name of a Variable
\section*{\tt \htmlref{vlistDefVarStdname}{vlistDefVarStdname}}
\begin{verbatim}
void vlistDefVarStdname(int vlistID, int varID, const char *stdname);
\end{verbatim}
Define the standard name of a Variable
\section*{\tt \htmlref{vlistDefVarUnits}{vlistDefVarUnits}} \section*{\tt \htmlref{vlistDefVarUnits}{vlistDefVarUnits}}
\begin{verbatim} \begin{verbatim}
...@@ -686,6 +695,15 @@ Get the missing value of a Variable ...@@ -686,6 +695,15 @@ Get the missing value of a Variable
Get the name of a Variable Get the name of a Variable
\section*{\tt \htmlref{vlistInqVarStdname}{vlistInqVarStdname}}
\begin{verbatim}
void vlistInqVarStdname(int vlistID, int varID, char *stdname);
\end{verbatim}
Get the standard name of a Variable
\section*{\tt \htmlref{vlistInqVarUnits}{vlistInqVarUnits}} \section*{\tt \htmlref{vlistInqVarUnits}{vlistInqVarUnits}}
\begin{verbatim} \begin{verbatim}
......
...@@ -272,6 +272,61 @@ Variable description ...@@ -272,6 +272,61 @@ Variable description
\subsection{Define the standard name of a Variable: {\tt vlistDefVarStdname}}
\index{vlistDefVarStdname}
\label{vlistDefVarStdname}
The function {\tt vlistDefVarStdname} defines the standard name of a variable.
\subsubsection*{Usage}
\begin{verbatim}
void vlistDefVarStdname(int vlistID, int varID, const char *stdname);
\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
\item[{\tt stdname}]
Standard name of the variable
\end{deflist}
\end{minipage}
\subsection{Get the standard name of a Variable: {\tt vlistInqVarStdname}}
\index{vlistInqVarStdname}
\label{vlistInqVarStdname}
The function {\tt vlistInqVarStdname} returns the standard name of a variable.
\subsubsection*{Usage}
\begin{verbatim}
void vlistInqVarStdname(int vlistID, int varID, char *stdname);
\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
\item[{\tt stdname}]
Variable standard name
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\tt vlistInqVarName} returns the standard name of the variable to the parameter stdname.
\subsection{Define the units of a Variable: {\tt vlistDefVarUnits}} \subsection{Define the units of a Variable: {\tt vlistDefVarUnits}}
\index{vlistDefVarUnits} \index{vlistDefVarUnits}
\label{vlistDefVarUnits} \label{vlistDefVarUnits}
......
...@@ -124,7 +124,7 @@ ...@@ -124,7 +124,7 @@
\end{picture} \end{picture}
\begin{flushright} \begin{flushright}
\large\bf{Climate Data Interface \\ Version 1.4.0 \\ October 2009} \large\bf{Climate Data Interface \\ Version 1.4.1 \\ December 2009}
\end{flushright} \end{flushright}
\vfill \vfill
......
...@@ -123,7 +123,7 @@ ...@@ -123,7 +123,7 @@
\end{picture} \end{picture}
\begin{flushright} \begin{flushright}
\large\bf{Climate Data Interface \\ Version 1.4.0 \\ October 2009} \large\bf{Climate Data Interface \\ Version 1.4.1 \\ December 2009}
\end{flushright} \end{flushright}
\vfill \vfill
......
...@@ -600,6 +600,16 @@ Define the missing value of a Variable ...@@ -600,6 +600,16 @@ Define the missing value of a Variable
Define the name of a Variable Define the name of a Variable
\section*{\tt \htmlref{vlistDefVarStdname}{vlistDefVarStdname}}
\begin{verbatim}
SUBROUTINE vlistDefVarStdname(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) stdname)
\end{verbatim}
Define the standard name of a Variable
\section*{\tt \htmlref{vlistDefVarUnits}{vlistDefVarUnits}} \section*{\tt \htmlref{vlistDefVarUnits}{vlistDefVarUnits}}
\begin{verbatim} \begin{verbatim}
...@@ -691,6 +701,16 @@ Get the missing value of a Variable ...@@ -691,6 +701,16 @@ Get the missing value of a Variable
Get the name of a Variable Get the name of a Variable
\section*{\tt \htmlref{vlistInqVarStdname}{vlistInqVarStdname}}
\begin{verbatim}
SUBROUTINE vlistInqVarStdname(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) stdname)
\end{verbatim}
Get the standard name of a Variable
\section*{\tt \htmlref{vlistInqVarUnits}{vlistInqVarUnits}} \section*{\tt \htmlref{vlistInqVarUnits}{vlistInqVarUnits}}
\begin{verbatim} \begin{verbatim}
......
...@@ -275,6 +275,63 @@ Variable description ...@@ -275,6 +275,63 @@ Variable description
\subsection{Define the standard name of a Variable: {\tt vlistDefVarStdname}}
\index{vlistDefVarStdname}
\label{vlistDefVarStdname}
The function {\tt vlistDefVarStdname} defines the standard name of a variable.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE vlistDefVarStdname(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) stdname)
\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
\item[{\tt stdname}]
Standard name of the variable
\end{deflist}
\end{minipage}
\subsection{Get the standard name of a Variable: {\tt vlistInqVarStdname}}
\index{vlistInqVarStdname}
\label{vlistInqVarStdname}
The function {\tt vlistInqVarStdname} returns the standard name of a variable.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE vlistInqVarStdname(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) stdname)
\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
\item[{\tt stdname}]
Variable standard name
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\tt vlistInqVarName} returns the standard name of the variable to the parameter stdname.
\subsection{Define the units of a Variable: {\tt vlistDefVarUnits}} \subsection{Define the units of a Variable: {\tt vlistDefVarUnits}}
\index{vlistDefVarUnits} \index{vlistDefVarUnits}
\label{vlistDefVarUnits} \label{vlistDefVarUnits}
......
...@@ -358,16 +358,18 @@ void vlistDefVarName(int vlistID, int varID, const char *name); ...@@ -358,16 +358,18 @@ void vlistDefVarName(int vlistID, int varID, const char *name);
/* vlistInqVarName: Get the name of a Variable */ /* vlistInqVarName: Get the name of a Variable */
void vlistInqVarName(int vlistID, int varID, char *name); void vlistInqVarName(int vlistID, int varID, char *name);
/* vlistDefVarStdname: Define the standard name of a Variable */
void vlistDefVarStdname(int vlistID, int varID, const char *stdname);
/* vlistInqVarStdname: Get the standard name of a Variable */
void vlistInqVarStdname(int vlistID, int varID, char *stdname);
/* vlistDefVarLongname: Define the long name of a Variable */ /* vlistDefVarLongname: Define the long name of a Variable */
void vlistDefVarLongname(int vlistID, int varID, const char *longname); void vlistDefVarLongname(int vlistID, int varID, const char *longname);
void vlistDefVarStdname(int vlistID, int varID, const char *stdname);
/* vlistInqVarLongname: Get the long name of a Variable */ /* vlistInqVarLongname: Get the long name of a Variable */
void vlistInqVarLongname(int vlistID, int varID, char *longname); void vlistInqVarLongname(int vlistID, int varID, char *longname);
void vlistInqVarStdname(int vlistID, int varID, char *stdname);
/* vlistDefVarUnits: Define the units of a Variable */ /* vlistDefVarUnits: Define the units of a Variable */
void vlistDefVarUnits(int vlistID, int varID, const char *units); void vlistDefVarUnits(int vlistID, int varID, const char *units);
......
...@@ -528,6 +528,24 @@ void vlistInqVarLongname(int vlistID, int varID, char *longname) ...@@ -528,6 +528,24 @@ void vlistInqVarLongname(int vlistID, int varID, char *longname)
} }
/*
@Function vlistInqVarStdname
@Title Get the standard name of a Variable
@Prototype void vlistInqVarStdname(int vlistID, int varID, char *stdname)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate}
@Item varID Variable identifier
@Item stdname Variable standard name
@Description
The function @func{vlistInqVarStdname} returns the standard name of a variable.
@Result
@func{vlistInqVarName} returns the standard name of the variable to the parameter stdname.
@EndFunction
*/
void vlistInqVarStdname(int vlistID, int varID, char *stdname) void vlistInqVarStdname(int vlistID, int varID, char *stdname)
{ {
static char func[] = "vlistInqVarStdname"; static char func[] = "vlistInqVarStdname";
...@@ -860,6 +878,21 @@ void vlistDefVarLongname(int vlistID, int varID, const char *longname) ...@@ -860,6 +878,21 @@ void vlistDefVarLongname(int vlistID, int varID, const char *longname)
} }
/*
@Function vlistDefVarStdname
@Title Define the standard name of a Variable
@Prototype void vlistDefVarStdname(int vlistID, int varID, const char *stdname)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate}
@Item varID Variable identifier
@Item stdname Standard name of the variable
@Description
The function @func{vlistDefVarStdname} defines the standard name of a variable.
@EndFunction
*/
void vlistDefVarStdname(int vlistID, int varID, const char *stdname) void vlistDefVarStdname(int vlistID, int varID, const char *stdname)
{ {
static char func[] = "vlistDefVarStdname"; static char func[] = "vlistDefVarStdname";
......
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