Commit dd8d0b44 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update.

parent b1c3ffe5
......@@ -71,16 +71,16 @@ Function catalog:
vlistDefVarMissval Define the missing value of a Variable
vlistInqVarMissval Get the missing value of a Variable
-------------------------------------------------------------
vlist_att
-------------------------------------------------------------
vlistInqNatts Get number of attributes
vlistInqAtt Get information about an attribute
vlistDefAttInt Define an integer attribute
vlistInqAttInt Get the value(s) of an integer attribute
vlistDefAttFlt Define a floating point attribute
vlistInqAttFlt Get the value(s) of a floating point attribute
vlistDefAttTxt Define a text attribute
vlistInqAttTxt Get the value(s) of a text attribute
cdi_att
-------------------------------------------------------------
cdiInqNatts Get number of attributes
cdiInqAtt Get information about an attribute
cdiDefAttInt Define an integer attribute
cdiInqAttInt Get the value(s) of an integer attribute
cdiDefAttFlt Define a floating point attribute
cdiInqAttFlt Get the value(s) of a floating point attribute
cdiDefAttTxt Define a text attribute
cdiInqAttTxt Get the value(s) of a text attribute
-------------------------------------------------------------
grid
-------------------------------------------------------------
......
......@@ -50,15 +50,15 @@ vlistDefVarDatatype vlist_var
vlistInqVarDatatype vlist_var
vlistDefVarMissval vlist_var
vlistInqVarMissval vlist_var
vlistInqNatts vlist_att
vlistInqAtt vlist_att
vlistDelAtt vlist_att
vlistDefAttInt vlist_att
vlistInqAttInt vlist_att
vlistDefAttFlt vlist_att
vlistInqAttFlt vlist_att
vlistDefAttTxt vlist_att
vlistInqAttTxt vlist_att
cdiInqNatts cdi_att
cdiInqAtt cdi_att
cdiDelAtt cdi_att
cdiDefAttInt cdi_att
cdiInqAttInt cdi_att
cdiDefAttFlt cdi_att
cdiInqAttFlt cdi_att
cdiDefAttTxt cdi_att
cdiInqAttTxt cdi_att
gridCreate grid
gridDestroy grid
gridDuplicate grid
......
\subsection{Get number of attributes: {\tt vlistInqNatts}}
\index{vlistInqNatts}
\label{vlistInqNatts}
\subsection{Get number of attributes: {\tt cdiInqNatts}}
\index{cdiInqNatts}
\label{cdiInqNatts}
The function {\tt vlistInqNatts} gets the number of attributes assigned to this variable.
The function {\tt cdiInqNatts} gets the number of attributes assigned to this variable.
\subsubsection*{Usage}
\begin{verbatim}
int vlistInqNatts(int vlistID, int varID, int *nattsp);
int cdiInqNatts(int cdiID, int varID, int *nattsp);
\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}}.
\begin{deflist}{\tt nattsp\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}, {\htmlref{\tt gridCreate}{gridCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt nattsp}]
......@@ -25,22 +25,22 @@ Pointer to location for returned number of attributes.
\end{minipage}
\subsection{Get information about an attribute: {\tt vlistInqAtt}}
\index{vlistInqAtt}
\label{vlistInqAtt}
\subsection{Get information about an attribute: {\tt cdiInqAtt}}
\index{cdiInqAtt}
\label{cdiInqAtt}
The function {\tt vlistInqAtt} gets information about an attribute.
The function {\tt cdiInqAtt} gets information about an attribute.
\subsubsection*{Usage}
\begin{verbatim}
int vlistInqAtt(int vlistID, int varID, int attnum, char *name, int *typep, int *lenp);
int cdiInqAtt(int cdiID, int varID, int attnum, char *name, int *typep, int *lenp);
\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}}.
\begin{deflist}{\tt attnum\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}, {\htmlref{\tt gridCreate}{gridCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt attnum}]
......@@ -58,23 +58,23 @@ Pointer to location for returned attribute number.
\end{minipage}
\subsection{Define an integer attribute: {\tt vlistDefAttInt}}
\index{vlistDefAttInt}
\label{vlistDefAttInt}
\subsection{Define an integer attribute: {\tt cdiDefAttInt}}
\index{cdiDefAttInt}
\label{cdiDefAttInt}
The function {\tt vlistDefAttInt} defines an integer attribute.
The function {\tt cdiDefAttInt} defines an integer attribute.
\subsubsection*{Usage}
\begin{verbatim}
int vlistDefAttInt(int vlistID, int varID, const char *name, int type, int len,
const int *ip);
int cdiDefAttInt(int cdiID, int varID, const char *name, int type, int len,
const int *ip);
\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}}.
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}} or {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
......@@ -90,22 +90,22 @@ Pointer to one or more integer values.
\end{minipage}
\subsection{Get the value(s) of an integer attribute: {\tt vlistInqAttInt}}
\index{vlistInqAttInt}
\label{vlistInqAttInt}
\subsection{Get the value(s) of an integer attribute: {\tt cdiInqAttInt}}
\index{cdiInqAttInt}
\label{cdiInqAttInt}
The function {\tt vlistInqAttInt} gets the values(s) of an integer attribute.
The function {\tt cdiInqAttInt} gets the values(s) of an integer attribute.
\subsubsection*{Usage}
\begin{verbatim}
int vlistInqAttInt(int vlistID, int varID, const char *name, int mlen, int *ip);
int cdiInqAttInt(int cdiID, int varID, const char *name, int mlen, int *ip);
\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}}.
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}, {\htmlref{\tt gridCreate}{gridCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
......@@ -119,23 +119,23 @@ Pointer location for returned integer attribute value(s).
\end{minipage}
\subsection{Define a floating point attribute: {\tt vlistDefAttFlt}}
\index{vlistDefAttFlt}
\label{vlistDefAttFlt}
\subsection{Define a floating point attribute: {\tt cdiDefAttFlt}}
\index{cdiDefAttFlt}
\label{cdiDefAttFlt}
The function {\tt vlistDefAttFlt} defines a floating point attribute.
The function {\tt cdiDefAttFlt} defines a floating point attribute.
\subsubsection*{Usage}
\begin{verbatim}
int vlistDefAttFlt(int vlistID, int varID, const char *name, int type, int len,
const double *dp);
int cdiDefAttFlt(int cdiID, int varID, const char *name, int type, int len,
const double *dp);
\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}}.
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}} or {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
......@@ -151,22 +151,22 @@ Pointer to one or more floating point values.
\end{minipage}
\subsection{Get the value(s) of a floating point attribute: {\tt vlistInqAttFlt}}
\index{vlistInqAttFlt}
\label{vlistInqAttFlt}
\subsection{Get the value(s) of a floating point attribute: {\tt cdiInqAttFlt}}
\index{cdiInqAttFlt}
\label{cdiInqAttFlt}
The function {\tt vlistInqAttFlt} gets the values(s) of a floating point attribute.
The function {\tt cdiInqAttFlt} gets the values(s) of a floating point attribute.
\subsubsection*{Usage}
\begin{verbatim}
int vlistInqAttFlt(int vlistID, int varID, const char *name, int mlen, double *dp);
int cdiInqAttFlt(int cdiID, int varID, const char *name, int mlen, double *dp);
\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}}.
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}, {\htmlref{\tt gridCreate}{gridCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
......@@ -180,22 +180,22 @@ Pointer location for returned floating point attribute value(s).
\end{minipage}
\subsection{Define a text attribute: {\tt vlistDefAttTxt}}
\index{vlistDefAttTxt}
\label{vlistDefAttTxt}
\subsection{Define a text attribute: {\tt cdiDefAttTxt}}
\index{cdiDefAttTxt}
\label{cdiDefAttTxt}
The function {\tt vlistDefAttTxt} defines a text attribute.
The function {\tt cdiDefAttTxt} defines a text attribute.
\subsubsection*{Usage}
\begin{verbatim}
int vlistDefAttTxt(int vlistID, int varID, const char *name, int len, const char *tp);
int cdiDefAttTxt(int cdiID, int varID, const char *name, int len, const char *tp);
\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}}.
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}} or {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
......@@ -209,22 +209,22 @@ Pointer to one or more character values.
\end{minipage}
\subsection{Get the value(s) of a text attribute: {\tt vlistInqAttTxt}}
\index{vlistInqAttTxt}
\label{vlistInqAttTxt}
\subsection{Get the value(s) of a text attribute: {\tt cdiInqAttTxt}}
\index{cdiInqAttTxt}
\label{cdiInqAttTxt}
The function {\tt vlistInqAttTxt} gets the values(s) of a text attribute.
The function {\tt cdiInqAttTxt} gets the values(s) of a text attribute.
\subsubsection*{Usage}
\begin{verbatim}
int vlistInqAttTxt(int vlistID, int varID, const char *name, int mlen, char *tp);
int cdiInqAttTxt(int cdiID, int varID, const char *name, int mlen, char *tp);
\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}}.
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}, {\htmlref{\tt gridCreate}{gridCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
......
\section*{\tt
\ifpdf
\hyperref[cdiDefAttFlt]{cdiDefAttFlt}
\else
cdiDefAttFlt
\fi
}
\begin{verbatim}
int cdiDefAttFlt(int cdiID, int varID, const char *name, int type, int len,
const double *dp);
\end{verbatim}
Define a floating point attribute
\ifpdfoutput{}{(\ref{cdiDefAttFlt})}
\section*{\tt
\ifpdf
\hyperref[cdiDefAttInt]{cdiDefAttInt}
\else
cdiDefAttInt
\fi
}
\begin{verbatim}
int cdiDefAttInt(int cdiID, int varID, const char *name, int type, int len,
const int *ip);
\end{verbatim}
Define an integer attribute
\ifpdfoutput{}{(\ref{cdiDefAttInt})}
\section*{\tt
\ifpdf
\hyperref[cdiDefAttTxt]{cdiDefAttTxt}
\else
cdiDefAttTxt
\fi
}
\begin{verbatim}
int cdiDefAttTxt(int cdiID, int varID, const char *name, int len, const char *tp);
\end{verbatim}
Define a text attribute
\ifpdfoutput{}{(\ref{cdiDefAttTxt})}
\section*{\tt
\ifpdf
\hyperref[cdiInqAtt]{cdiInqAtt}
\else
cdiInqAtt
\fi
}
\begin{verbatim}
int cdiInqAtt(int cdiID, int varID, int attnum, char *name, int *typep, int *lenp);
\end{verbatim}
Get information about an attribute
\ifpdfoutput{}{(\ref{cdiInqAtt})}
\section*{\tt
\ifpdf
\hyperref[cdiInqAttFlt]{cdiInqAttFlt}
\else
cdiInqAttFlt
\fi
}
\begin{verbatim}
int cdiInqAttFlt(int cdiID, int varID, const char *name, int mlen, double *dp);
\end{verbatim}
Get the value(s) of a floating point attribute
\ifpdfoutput{}{(\ref{cdiInqAttFlt})}
\section*{\tt
\ifpdf
\hyperref[cdiInqAttInt]{cdiInqAttInt}
\else
cdiInqAttInt
\fi
}
\begin{verbatim}
int cdiInqAttInt(int cdiID, int varID, const char *name, int mlen, int *ip);
\end{verbatim}
Get the value(s) of an integer attribute
\ifpdfoutput{}{(\ref{cdiInqAttInt})}
\section*{\tt
\ifpdf
\hyperref[cdiInqAttTxt]{cdiInqAttTxt}
\else
cdiInqAttTxt
\fi
}
\begin{verbatim}
int cdiInqAttTxt(int cdiID, int varID, const char *name, int mlen, char *tp);
\end{verbatim}
Get the value(s) of a text attribute
\ifpdfoutput{}{(\ref{cdiInqAttTxt})}
\section*{\tt
\ifpdf
\hyperref[cdiInqNatts]{cdiInqNatts}
\else
cdiInqNatts
\fi
}
\begin{verbatim}
int cdiInqNatts(int cdiID, int varID, int *nattsp);
\end{verbatim}
Get number of attributes
\ifpdfoutput{}{(\ref{cdiInqNatts})}
\section*{\tt
\ifpdf
\hyperref[gridCreate]{gridCreate}
......@@ -1114,53 +1236,6 @@ Create a variable list
\ifpdfoutput{}{(\ref{vlistCreate})}
\section*{\tt
\ifpdf
\hyperref[vlistDefAttFlt]{vlistDefAttFlt}
\else
vlistDefAttFlt
\fi
}
\begin{verbatim}
int vlistDefAttFlt(int vlistID, int varID, const char *name, int type, int len,
const double *dp);
\end{verbatim}
Define a floating point attribute
\ifpdfoutput{}{(\ref{vlistDefAttFlt})}
\section*{\tt
\ifpdf
\hyperref[vlistDefAttInt]{vlistDefAttInt}
\else
vlistDefAttInt
\fi
}
\begin{verbatim}
int vlistDefAttInt(int vlistID, int varID, const char *name, int type, int len,
const int *ip);
\end{verbatim}
Define an integer attribute
\ifpdfoutput{}{(\ref{vlistDefAttInt})}
\section*{\tt
\ifpdf
\hyperref[vlistDefAttTxt]{vlistDefAttTxt}
\else
vlistDefAttTxt
\fi
}
\begin{verbatim}
int vlistDefAttTxt(int vlistID, int varID, const char *name, int len, const char *tp);
\end{verbatim}
Define a text attribute
\ifpdfoutput{}{(\ref{vlistDefAttTxt})}
\section*{\tt
\ifpdf
\hyperref[vlistDefTaxis]{vlistDefTaxis}
......@@ -1326,81 +1401,6 @@ Duplicate a variable list
\ifpdfoutput{}{(\ref{vlistDuplicate})}
\section*{\tt
\ifpdf
\hyperref[vlistInqAtt]{vlistInqAtt}
\else
vlistInqAtt
\fi
}
\begin{verbatim}
int vlistInqAtt(int vlistID, int varID, int attnum, char *name, int *typep, int *lenp);
\end{verbatim}
Get information about an attribute
\ifpdfoutput{}{(\ref{vlistInqAtt})}
\section*{\tt
\ifpdf
\hyperref[vlistInqAttFlt]{vlistInqAttFlt}
\else
vlistInqAttFlt
\fi
}
\begin{verbatim}
int vlistInqAttFlt(int vlistID, int varID, const char *name, int mlen, double *dp);
\end{verbatim}
Get the value(s) of a floating point attribute
\ifpdfoutput{}{(\ref{vlistInqAttFlt})}
\section*{\tt
\ifpdf
\hyperref[vlistInqAttInt]{vlistInqAttInt}
\else
vlistInqAttInt
\fi
}
\begin{verbatim}
int vlistInqAttInt(int vlistID, int varID, const char *name, int mlen, int *ip);
\end{verbatim}
Get the value(s) of an integer attribute
\ifpdfoutput{}{(\ref{vlistInqAttInt})}
\section*{\tt
\ifpdf
\hyperref[vlistInqAttTxt]{vlistInqAttTxt}
\else
vlistInqAttTxt
\fi
}
\begin{verbatim}
int vlistInqAttTxt(int vlistID, int varID, const char *name, int mlen, char *tp);
\end{verbatim}
Get the value(s) of a text attribute
\ifpdfoutput{}{(\ref{vlistInqAttTxt})}
\section*{\tt
\ifpdf
\hyperref[vlistInqNatts]{vlistInqNatts}
\else
vlistInqNatts
\fi
}
\begin{verbatim}
int vlistInqNatts(int vlistID, int varID, int *nattsp);
\end{verbatim}
Get number of attributes
\ifpdfoutput{}{(\ref{vlistInqNatts})}
\section*{\tt
\ifpdf
\hyperref[vlistInqTaxis]{vlistInqTaxis}
......
......@@ -193,7 +193,7 @@
\newpage
\section{Attributes}
\input{attribute}
\input{c_vlist_att}
\input{c_cdi_att}
\newpage
......
......@@ -190,7 +190,7 @@
\newpage
\section{Attributes}
\input{attribute}
\input{f_vlist_att}
\input{f_cdi_att}
\newpage
......
\section*{\tt
\ifpdf
\hyperref[cdiDefAttFlt]{cdiDefAttFlt}
\else
cdiDefAttFlt
\fi
}
\begin{verbatim}
INTEGER FUNCTION cdiDefAttFlt(INTEGER cdiID, INTEGER varID, CHARACTER*(*) name,
INTEGER type, INTEGER len, REAL*8 dp)
\end{verbatim}
Define a floating point attribute
\ifpdfoutput{}{(\ref{cdiDefAttFlt})}
\section*{\tt
\ifpdf
\hyperref[cdiDefAttInt]{cdiDefAttInt}
\else
cdiDefAttInt
\fi
}
\begin{verbatim}
INTEGER FUNCTION cdiDefAttInt(INTEGER cdiID, INTEGER varID, CHARACTER*(*) name,
INTEGER type, INTEGER len, INTEGER ip)
\end{verbatim}
Define an integer attribute
\ifpdfoutput{}{(\ref{cdiDefAttInt})}
\section*{\tt
\ifpdf
\hyperref[cdiDefAttTxt]{cdiDefAttTxt}
\else
cdiDefAttTxt
\fi
}
\begin{verbatim}
INTEGER FUNCTION cdiDefAttTxt(INTEGER cdiID, INTEGER varID, CHARACTER*(*) name,
INTEGER len, CHARACTER*(*) tp)
\end{verbatim}
Define a text attribute
\ifpdfoutput{}{(\ref{cdiDefAttTxt})}
\section*{\tt
\ifpdf
\hyperref[cdiInqAtt]{cdiInqAtt}
\else
cdiInqAtt
\fi