Skip to content

GitLab

L
libcdi
Commit f8719869 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files
Options

Docu update.

parent edb9ac46
Hide whitespace changes
Inline Side-by-side
Showing with 21 additions and 746 deletions
Obsolete_functions
View file @ f8719869
......@@ -2,9 +2,9 @@ vlistDefVarName(vlistID, varID, name) -> cdiDefKeyString(vlistID, varID,
vlistDefVarLongname(vlistID, varID, longname) -> cdiDefKeyString(vlistID, varID, CDI_KEY_LONGNAME, longname)
vlistDefVarUnits(vlistID, varID, units) -> cdiDefKeyString(vlistID, varID, CDI_KEY_UNITS, units)
vlistDefVarStdname(vlistID, varID, stdname) -> cdiDefKeyString(vlistID, varID, CDI_KEY_STDNAME, stdname)
vlistInqVarName(vlistID, varID, name) -> cdiInqKeyString(vlistID, varID, CDI_KEY_NAME, name, &length)
vlistInqVarLongname(vlistID, varID, longname) -> cdiInqKeyString(vlistID, varID, CDI_KEY_LONGNAME, longname, &length)
vlistInqVarUnits(vlistID, varID, units) -> cdiInqKeyString(vlistID, varID, CDI_KEY_UNITS, units, &length)
vlistInqVarName(vlistID, varID, name) -> cdiInqKeyString(vlistID, varID, CDI_KEY_NAME, name, &length) // partly obsolete
vlistInqVarLongname(vlistID, varID, longname) -> cdiInqKeyString(vlistID, varID, CDI_KEY_LONGNAME, longname, &length) // partly obsolete
vlistInqVarUnits(vlistID, varID, units) -> cdiInqKeyString(vlistID, varID, CDI_KEY_UNITS, units, &length) // partly obsolete
vlistInqVarStdname(vlistID, varID, stdname) -> cdiInqKeyString(vlistID, varID, CDI_KEY_STDNAME, stdname, &length)
gridDefXname(gridID, xname) -> cdiDefKeyString(gridID, CDI_XAXIS, CDI_KEY_NAME, xname)
......
doc/tex/FUNCTIONS
View file @ f8719869
......@@ -58,14 +58,6 @@ Function catalog:
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
vlistInqVarName Get the name of a Variable
vlistDefVarLongname Define the long name 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
vlistInqVarUnits Get the units of a Variable
vlistDefVarDatatype Define the data type of a Variable
vlistInqVarDatatype Get the data type of a Variable
vlistDefVarMissval Define the missing value of a Variable
......
doc/tex/Modules
View file @ f8719869
......@@ -38,14 +38,6 @@ vlistInqVarZaxis vlist_var
vlistInqVarTsteptype vlist_var
vlistDefVarCode vlist_var
vlistInqVarCode vlist_var
vlistDefVarName vlist_var
vlistInqVarName vlist_var
vlistDefVarLongname vlist_var
vlistInqVarLongname vlist_var
vlistDefVarStdname vlist_var
vlistInqVarStdname vlist_var
vlistDefVarUnits vlist_var
vlistInqVarUnits vlist_var
vlistDefVarDatatype vlist_var
vlistInqVarDatatype vlist_var
vlistDefVarMissval vlist_var
......
doc/tex/c_ref.tex
View file @ f8719869
......@@ -1117,21 +1117,6 @@ Define the data type of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarDatatype})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDefVarLongname]{vlistDefVarLongname}
\else
vlistDefVarLongname
\fi
}}
\begin{verbatim}
void vlistDefVarLongname(int vlistID, int varID, const char *longname);
\end{verbatim}
Define the long name of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarLongname})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDefVarMissval]{vlistDefVarMissval}
......@@ -1147,51 +1132,6 @@ Define the missing value of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarMissval})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDefVarName]{vlistDefVarName}
\else
vlistDefVarName
\fi
}}
\begin{verbatim}
void vlistDefVarName(int vlistID, int varID, const char *name);
\end{verbatim}
Define the name of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarName})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDefVarStdname]{vlistDefVarStdname}
\else
vlistDefVarStdname
\fi
}}
\begin{verbatim}
void vlistDefVarStdname(int vlistID, int varID, const char *stdname);
\end{verbatim}
Define the standard name of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarStdname})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDefVarUnits]{vlistDefVarUnits}
\else
vlistDefVarUnits
\fi
}}
\begin{verbatim}
void vlistDefVarUnits(int vlistID, int varID, const char *units);
\end{verbatim}
Define the units of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarUnits})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDestroy]{vlistDestroy}
......@@ -1282,21 +1222,6 @@ Get the Grid ID of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarGrid})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarLongname]{vlistInqVarLongname}
\else
vlistInqVarLongname
\fi
}}
\begin{verbatim}
void vlistInqVarLongname(int vlistID, int varID, char *longname);
\end{verbatim}
Get the longname of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarLongname})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarMissval]{vlistInqVarMissval}
......@@ -1312,36 +1237,6 @@ Get the missing value of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarMissval})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarName]{vlistInqVarName}
\else
vlistInqVarName
\fi
}}
\begin{verbatim}
void vlistInqVarName(int vlistID, int varID, char *name);
\end{verbatim}
Get the name of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarName})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarStdname]{vlistInqVarStdname}
\else
vlistInqVarStdname
\fi
}}
\begin{verbatim}
void vlistInqVarStdname(int vlistID, int varID, char *stdname);
\end{verbatim}
Get the standard name of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarStdname})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarTsteptype]{vlistInqVarTsteptype}
......@@ -1357,21 +1252,6 @@ Get the timestep type of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarTsteptype})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarUnits]{vlistInqVarUnits}
\else
vlistInqVarUnits
\fi
}}
\begin{verbatim}
void vlistInqVarUnits(int vlistID, int varID, char *units);
\end{verbatim}
Get the units of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarUnits})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarZaxis]{vlistInqVarZaxis}
......
doc/tex/c_vlist_var.tex
View file @ f8719869
......@@ -193,238 +193,6 @@ Variable identifier.
\subsection{Define the name of a Variable: \texttt{vlistDefVarName}}
\index{vlistDefVarName}
\label{vlistDefVarName}
The function {\texttt{vlistDefVarName}} defines the name of a variable.
\subsubsection*{Usage}
\begin{verbatim}
void vlistDefVarName(int vlistID, int varID, const char *name);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{vlistID}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}.
\item[\texttt{varID}]
Variable identifier.
\item[\texttt{name}]
Name of the variable.
\end{deflist}
\end{minipage}
\subsection{Get the name of a Variable: \texttt{vlistInqVarName}}
\index{vlistInqVarName}
\label{vlistInqVarName}
The function {\texttt{vlistInqVarName}} returns the name of a variable.
\subsubsection*{Usage}
\begin{verbatim}
void vlistInqVarName(int vlistID, int varID, char *name);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{vlistID}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
\item[\texttt{varID}]
Variable identifier.
\item[\texttt{name}]
Returned variable name. The caller must allocate space for the
returned string. The maximum possible length, in characters, of
the string is given by the predefined constant {\texttt{CDI\_MAX\_NAME}}.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\texttt{vlistInqVarName}} returns the name of the variable to the parameter name if available,
otherwise the result is an empty string.
\subsection{Define the long name of a Variable: \texttt{vlistDefVarLongname}}
\index{vlistDefVarLongname}
\label{vlistDefVarLongname}
The function {\texttt{vlistDefVarLongname}} defines the long name of a variable.
\subsubsection*{Usage}
\begin{verbatim}
void vlistDefVarLongname(int vlistID, int varID, const char *longname);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{longname}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}.
\item[\texttt{varID}]
Variable identifier.
\item[\texttt{longname}]
Long name of the variable.
\end{deflist}
\end{minipage}
\subsection{Get the longname of a Variable: \texttt{vlistInqVarLongname}}
\index{vlistInqVarLongname}
\label{vlistInqVarLongname}
The function {\texttt{vlistInqVarLongname}} returns the longname of a variable if available,
otherwise the result is an empty string.
\subsubsection*{Usage}
\begin{verbatim}
void vlistInqVarLongname(int vlistID, int varID, char *longname);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{longname}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
\item[\texttt{varID}]
Variable identifier.
\item[\texttt{longname}]
Long name of the variable. The caller must allocate space for the
returned string. The maximum possible length, in characters, of
the string is given by the predefined constant {\texttt{CDI\_MAX\_NAME}}.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\texttt{vlistInqVarLongname}} returns the longname of the variable to the parameter longname.
\subsection{Define the standard name of a Variable: \texttt{vlistDefVarStdname}}
\index{vlistDefVarStdname}
\label{vlistDefVarStdname}
The function {\texttt{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}{\texttt{vlistID}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}.
\item[\texttt{varID}]
Variable identifier.
\item[\texttt{stdname}]
Standard name of the variable.
\end{deflist}
\end{minipage}
\subsection{Get the standard name of a Variable: \texttt{vlistInqVarStdname}}
\index{vlistInqVarStdname}
\label{vlistInqVarStdname}
The function {\texttt{vlistInqVarStdname}} returns the standard name of a variable if available,
otherwise the result is an empty string.
\subsubsection*{Usage}
\begin{verbatim}
void vlistInqVarStdname(int vlistID, int varID, char *stdname);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{vlistID}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
\item[\texttt{varID}]
Variable identifier.
\item[\texttt{stdname}]
Standard name of the variable. The caller must allocate space for the
returned string. The maximum possible length, in characters, of
the string is given by the predefined constant {\texttt{CDI\_MAX\_NAME}}.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\texttt{vlistInqVarStdname}} returns the standard name of the variable to the parameter stdname.
\subsection{Define the units of a Variable: \texttt{vlistDefVarUnits}}
\index{vlistDefVarUnits}
\label{vlistDefVarUnits}
The function {\texttt{vlistDefVarUnits}} defines the units of a variable.
\subsubsection*{Usage}
\begin{verbatim}
void vlistDefVarUnits(int vlistID, int varID, const char *units);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{vlistID}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}.
\item[\texttt{varID}]
Variable identifier.
\item[\texttt{units}]
Units of the variable.
\end{deflist}
\end{minipage}
\subsection{Get the units of a Variable: \texttt{vlistInqVarUnits}}
\index{vlistInqVarUnits}
\label{vlistInqVarUnits}
The function {\texttt{vlistInqVarUnits}} returns the units of a variable if available,
otherwise the result is an empty string.
\subsubsection*{Usage}
\begin{verbatim}
void vlistInqVarUnits(int vlistID, int varID, char *units);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{vlistID}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
\item[\texttt{varID}]
Variable identifier.
\item[\texttt{units}]
Units of the variable. The caller must allocate space for the
returned string. The maximum possible length, in characters, of
the string is given by the predefined constant {\texttt{CDI\_MAX\_NAME}}.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\texttt{vlistInqVarUnits}} returns the units of the variable to the parameter units.
\subsection{Define the data type of a Variable: \texttt{vlistDefVarDatatype}}
\index{vlistDefVarDatatype}
\label{vlistDefVarDatatype}
......
doc/tex/f_ref.tex
View file @ f8719869
......@@ -1134,22 +1134,6 @@ Define the data type of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarDatatype})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDefVarLongname]{vlistDefVarLongname}
\else
vlistDefVarLongname
\fi
}}
\begin{verbatim}
SUBROUTINE vlistDefVarLongname(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) longname)
\end{verbatim}
Define the long name of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarLongname})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDefVarMissval]{vlistDefVarMissval}
......@@ -1165,52 +1149,6 @@ Define the missing value of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarMissval})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDefVarName]{vlistDefVarName}
\else
vlistDefVarName
\fi
}}
\begin{verbatim}
SUBROUTINE vlistDefVarName(INTEGER vlistID, INTEGER varID, CHARACTER*(*) name)
\end{verbatim}
Define the name of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarName})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDefVarStdname]{vlistDefVarStdname}
\else
vlistDefVarStdname
\fi
}}
\begin{verbatim}
SUBROUTINE vlistDefVarStdname(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) stdname)
\end{verbatim}
Define the standard name of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarStdname})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDefVarUnits]{vlistDefVarUnits}
\else
vlistDefVarUnits
\fi
}}
\begin{verbatim}
SUBROUTINE vlistDefVarUnits(INTEGER vlistID, INTEGER varID, CHARACTER*(*) units)
\end{verbatim}
Define the units of a Variable
\ifpdfoutput{}{(\ref{vlistDefVarUnits})}
\section*{\texttt{
\ifpdf
\hyperref[vlistDestroy]{vlistDestroy}
......@@ -1301,22 +1239,6 @@ Get the Grid ID of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarGrid})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarLongname]{vlistInqVarLongname}
\else
vlistInqVarLongname
\fi
}}
\begin{verbatim}
SUBROUTINE vlistInqVarLongname(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) longname)
\end{verbatim}
Get the longname of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarLongname})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarMissval]{vlistInqVarMissval}
......@@ -1332,37 +1254,6 @@ Get the missing value of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarMissval})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarName]{vlistInqVarName}
\else
vlistInqVarName
\fi
}}
\begin{verbatim}
SUBROUTINE vlistInqVarName(INTEGER vlistID, INTEGER varID, CHARACTER*(*) name)
\end{verbatim}
Get the name of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarName})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarStdname]{vlistInqVarStdname}
\else
vlistInqVarStdname
\fi
}}
\begin{verbatim}
SUBROUTINE vlistInqVarStdname(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) stdname)
\end{verbatim}
Get the standard name of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarStdname})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarTsteptype]{vlistInqVarTsteptype}
......@@ -1378,21 +1269,6 @@ Get the timestep type of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarTsteptype})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarUnits]{vlistInqVarUnits}
\else
vlistInqVarUnits
\fi
}}
\begin{verbatim}
SUBROUTINE vlistInqVarUnits(INTEGER vlistID, INTEGER varID, CHARACTER*(*) units)
\end{verbatim}
Get the units of a Variable
\ifpdfoutput{}{(\ref{vlistInqVarUnits})}
\section*{\texttt{
\ifpdf
\hyperref[vlistInqVarZaxis]{vlistInqVarZaxis}
......
doc/tex/f_vlist_var.tex
View file @ f8719869
......@@ -194,242 +194,6 @@ Variable identifier.
\subsection{Define the name of a Variable: \texttt{vlistDefVarName}}
\index{vlistDefVarName}
\label{vlistDefVarName}
The function {\texttt{vlistDefVarName}} defines the name of a variable.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE vlistDefVarName(INTEGER vlistID, INTEGER varID, CHARACTER*(*) name)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{vlistID}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}.
\item[\texttt{varID}]
Variable identifier.
\item[\texttt{name}]
Name of the variable.
\end{deflist}
\end{minipage}
\subsection{Get the name of a Variable: \texttt{vlistInqVarName}}
\index{vlistInqVarName}
\label{vlistInqVarName}
The function {\texttt{vlistInqVarName}} returns the name of a variable.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE vlistInqVarName(INTEGER vlistID, INTEGER varID, CHARACTER*(*) name)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{vlistID}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
\item[\texttt{varID}]
Variable identifier.
\item[\texttt{name}]
Returned variable name. The caller must allocate space for the
returned string. The maximum possible length, in characters, of
the string is given by the predefined constant {\texttt{CDI\_MAX\_NAME}}.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\texttt{vlistInqVarName}} returns the name of the variable to the parameter name if available,
otherwise the result is an empty string.
\subsection{Define the long name of a Variable: \texttt{vlistDefVarLongname}}
\index{vlistDefVarLongname}
\label{vlistDefVarLongname}
The function {\texttt{vlistDefVarLongname}} defines the long name of a variable.
\subsubsection*{Usage}