Skip to content

GitLab

Commit 8216fabe authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent 1803f401
Hide whitespace changes
Inline Side-by-side
Showing with 256 additions and 2 deletions
doc/tex/FUNCTIONS
View file @ 8216fabe
......@@ -55,6 +55,15 @@ Function catalog:
vlistInqVarDatatype Get the data type of a Variable
vlistDefVarMissval Define the missing value of a Variable
vlistInqVarMissval Get the missing value of a Variable
-------------------------------------------------------------
vlist_att
-------------------------------------------------------------
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
-------------------------------------------------------------
grid
-------------------------------------------------------------
......
doc/tex/Modules
View file @ 8216fabe
......@@ -38,14 +38,20 @@ vlistDefVarName vlist_var
vlistInqVarName vlist_var
vlistDefVarLongname vlist_var
vlistInqVarLongname vlist_var
vlistDefVarStdname vlist_var
vlistInqVarStdname vlist_var
vlistDefVarStdname vlist_var
vlistInqVarStdname vlist_var
vlistDefVarUnits vlist_var
vlistInqVarUnits vlist_var
vlistDefVarDatatype vlist_var
vlistInqVarDatatype vlist_var
vlistDefVarMissval vlist_var
vlistInqVarMissval vlist_var
vlistDefAttInt vlist_att
vlistInqAttInt vlist_att
vlistDefAttFlt vlist_att
vlistInqAttFlt vlist_att
vlistDefAttTxt vlist_att
vlistInqAttTxt vlist_att
gridCreate grid
gridDestroy grid
gridDuplicate grid
......
doc/tex/c_ref.tex
View file @ 8216fabe
......@@ -533,6 +533,34 @@ Copy some entries of a variable list
Create a variable list
\section*{\tt \htmlref{vlistDefAttFlt}{vlistDefAttFlt}}
\begin{verbatim}
int vlistDefAttFlt(int vlistID, int varID, const char *name, int len,
const double *dp);
\end{verbatim}
Define a floating point attribute
\section*{\tt \htmlref{vlistDefAttInt}{vlistDefAttInt}}
\begin{verbatim}
int vlistDefAttInt(int vlistID, int varID, const char *name, int len, const int *ip);
\end{verbatim}
Define an integer attribute
\section*{\tt \htmlref{vlistDefAttTxt}{vlistDefAttTxt}}
\begin{verbatim}
int vlistDefAttTxt(int vlistID, int varID, const char *name, int len, const char *tp);
\end{verbatim}
Define a text attribute
\section*{\tt \htmlref{vlistDefTaxis}{vlistDefTaxis}}
\begin{verbatim}
......@@ -632,6 +660,33 @@ Destroy a variable list
Duplicate a variable list
\section*{\tt \htmlref{vlistInqAttFlt}{vlistInqAttFlt}}
\begin{verbatim}
int vlistInqAttFlt(int vlistID, int varID, const char *name, int mlen, int *dp);
\end{verbatim}
Get the value(s) of a floating point attribute
\section*{\tt \htmlref{vlistInqAttInt}{vlistInqAttInt}}
\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
\section*{\tt \htmlref{vlistInqAttTxt}{vlistInqAttTxt}}
\begin{verbatim}
int vlistInqAttTxt(int vlistID, int varID, const char *name, int mlen, int *tp);
\end{verbatim}
Get the value(s) of a text attribute
\section*{\tt \htmlref{vlistInqTaxis}{vlistInqTaxis}}
\begin{verbatim}
......
doc/tex/cdi_cman.tex
View file @ 8216fabe
......@@ -177,6 +177,12 @@
\input{c_vlist_var}
\newpage
\section{Attributes}
\input{attribute}
\input{c_vlist_att}
\newpage
\section{Grid functions}
\input{grid}
......
doc/tex/cdi_fman.tex
View file @ 8216fabe
......@@ -176,6 +176,12 @@
\input{f_vlist_var}
\newpage
\section{Attributes}
\input{attribute}
\input{f_vlist_att}
\newpage
\section{Grid functions}
\input{grid}
......
doc/tex/f_ref.tex
View file @ 8216fabe
......@@ -535,6 +535,38 @@ Copy some entries of a variable list
Create a variable list
\section*{\tt \htmlref{vlistDefAttFlt}{vlistDefAttFlt}}
\begin{verbatim}
INTEGER FUNCTION vlistDefAttFlt(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) name, INTEGER len, const REAL*8 dp)
\end{verbatim}
Define a floating point attribute
\section*{\tt \htmlref{vlistDefAttInt}{vlistDefAttInt}}
\begin{verbatim}
INTEGER FUNCTION vlistDefAttInt(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) name, INTEGER len,
const INTEGER ip)
\end{verbatim}
Define an integer attribute
\section*{\tt \htmlref{vlistDefAttTxt}{vlistDefAttTxt}}
\begin{verbatim}
INTEGER FUNCTION vlistDefAttTxt(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) name, INTEGER len,
CHARACTER*(*) tp)
\end{verbatim}
Define a text attribute
\section*{\tt \htmlref{vlistDefTaxis}{vlistDefTaxis}}
\begin{verbatim}
......@@ -637,6 +669,36 @@ Destroy a variable list
Duplicate a variable list
\section*{\tt \htmlref{vlistInqAttFlt}{vlistInqAttFlt}}
\begin{verbatim}
INTEGER FUNCTION vlistInqAttFlt(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) name, INTEGER mlen, INTEGER dp)
\end{verbatim}
Get the value(s) of a floating point attribute
\section*{\tt \htmlref{vlistInqAttInt}{vlistInqAttInt}}
\begin{verbatim}
INTEGER FUNCTION vlistInqAttInt(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) name, INTEGER mlen, INTEGER ip)
\end{verbatim}
Get the value(s) of an integer attribute
\section*{\tt \htmlref{vlistInqAttTxt}{vlistInqAttTxt}}
\begin{verbatim}
INTEGER FUNCTION vlistInqAttTxt(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) name, INTEGER mlen, INTEGER tp)
\end{verbatim}
Get the value(s) of a text attribute
\section*{\tt \htmlref{vlistInqTaxis}{vlistInqTaxis}}
\begin{verbatim}
......
src/cdi.h
View file @ 8216fabe
......@@ -411,12 +411,18 @@ int vlistInqAtt(int vlistID, int varID, int attrnum, char *name, int *typep,
int vlistDelAtt(int vlistID, int varID, const char *name);
/* vlistDefAttInt: Define an integer attribute */
int vlistDefAttInt(int vlistID, int varID, const char *name, int len, const int *ip);
/* vlistDefAttInt: Define a floating point attribute */
int vlistDefAttFlt(int vlistID, int varID, const char *name, int len, const double *dp);
/* vlistDefAttInt: Define a text attribute */
int vlistDefAttTxt(int vlistID, int varID, const char *name, int len, const char *tp);
/* vlistInqAttInt: Get the value(s) of an integer attribute */
int vlistInqAttInt(int vlistID, int varID, const char *name, int mlen, int *ip);
/* vlistInqAttInt: Get the value(s) of a floating point attribute */
int vlistInqAttFlt(int vlistID, int varID, const char *name, int mlen, double *dp);
/* vlistInqAttInt: Get the value(s) of a text attribute */
int vlistInqAttTxt(int vlistID, int varID, const char *name, int mlen, char *tp);
......
src/vlist_att.c
View file @ 8216fabe
......@@ -282,6 +282,24 @@ int vlistCopyVarAtts(int vlistID1, int varID_1, int vlistID2, int varID_2)
}
/*
@Function vlistDefAttInt
@Title Define an integer attribute
@Prototype int vlistDefAttInt(int vlistID, int varID, const char *name, int len, const int *ip)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate}
@Item varID Variable identifier, or CDI_GLOBAL for a global attribute
@Item name Attribute name
@Item len Number of values provided for the attribute
@Item ip Pointer to one or more integer values
@Description
The function @func{vlistDefAttInt} defines an integer attribute.
@EndFunction
*/
int vlistDefAttInt(int vlistID, int varID, const char *name, int len, const int *ip)
{
int status;
......@@ -292,6 +310,24 @@ int vlistDefAttInt(int vlistID, int varID, const char *name, int len, const int
}
/*
@Function vlistDefAttFlt
@Title Define a floating point attribute
@Prototype int vlistDefAttFlt(int vlistID, int varID, const char *name, int len, const double *dp)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate}
@Item varID Variable identifier, or CDI_GLOBAL for a global attribute
@Item name Attribute name
@Item len Number of values provided for the attribute
@Item dp Pointer to one or more floating point values
@Description
The function @func{vlistDefAttFlt} defines a floating point attribute.
@EndFunction
*/
int vlistDefAttFlt(int vlistID, int varID, const char *name, int len, const double *dp)
{
int status;
......@@ -302,6 +338,24 @@ int vlistDefAttFlt(int vlistID, int varID, const char *name, int len, const doub
}
/*
@Function vlistDefAttTxt
@Title Define a text attribute
@Prototype int vlistDefAttTxt(int vlistID, int varID, const char *name, int len, const char *tp)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate}
@Item varID Variable identifier, or CDI_GLOBAL for a global attribute
@Item name Attribute name
@Item len Number of values provided for the attribute
@Item tp Pointer to one or more character values
@Description
The function @func{vlistDefAttTxt} defines a text attribute.
@EndFunction
*/
int vlistDefAttTxt(int vlistID, int varID, const char *name, int len, const char *tp)
{
int status;
......@@ -312,7 +366,23 @@ int vlistDefAttTxt(int vlistID, int varID, const char *name, int len, const char
}
/*
@Function vlistInqAttInt
@Title Get the value(s) of an integer attribute
@Prototype int vlistInqAttInt(int vlistID, int varID, const char *name, int mlen, int *ip)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate}
@Item varID Variable identifier, or CDI_GLOBAL for a global attribute
@Item name Attribute name
@Item mlen Number of allocated values provided for the attribute
@Item ip Pointer location for returned integer attribute value(s)
@Description
The function @func{vlistInqAttInt} gets the values(s) of an integer attribute.
@EndFunction
*/
int vlistInqAttInt(int vlistID, int varID, const char *name, int mlen, int *ip)
{
int status = CDI_NOERR;
......@@ -323,6 +393,23 @@ int vlistInqAttInt(int vlistID, int varID, const char *name, int mlen, int *ip)
}
/*
@Function vlistInqAttFlt
@Title Get the value(s) of a floating point attribute
@Prototype int vlistInqAttFlt(int vlistID, int varID, const char *name, int mlen, int *dp)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate}
@Item varID Variable identifier, or CDI_GLOBAL for a global attribute
@Item name Attribute name
@Item mlen Number of allocated values provided for the attribute
@Item dp Pointer location for returned floating point attribute value(s)
@Description
The function @func{vlistInqAttFlt} gets the values(s) of a floating point attribute.
@EndFunction
*/
int vlistInqAttFlt(int vlistID, int varID, const char *name, int mlen, double *dp)
{
int status = CDI_NOERR;
......@@ -333,6 +420,23 @@ int vlistInqAttFlt(int vlistID, int varID, const char *name, int mlen, double *d
}
/*
@Function vlistInqAttTxt
@Title Get the value(s) of a text attribute
@Prototype int vlistInqAttTxt(int vlistID, int varID, const char *name, int mlen, int *tp)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate}
@Item varID Variable identifier, or CDI_GLOBAL for a global attribute
@Item name Attribute name
@Item mlen Number of allocated values provided for the attribute
@Item tp Pointer location for returned text attribute value(s)
@Description
The function @func{vlistInqAttTxt} gets the values(s) of a text attribute.
@EndFunction
*/
int vlistInqAttTxt(int vlistID, int varID, const char *name, int mlen, char *tp)
{
int status = CDI_NOERR;
......
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