Commit 10b5bc4a authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent e07f502c
......@@ -3,6 +3,14 @@
* using CGRIBEX library version 1.4.6
* Version 1.4.6 released
2010-08-25 Uwe Schulzweida <Uwe.Schulzweida@zmaw.de>
* Added support for attribute type int16 and float32 [Request: Don Murray]
2010-08-24 Uwe Schulzweida <Uwe.Schulzweida@zmaw.de>
* Version 1.4.5.2 released [request: Luis Kornblueh]
2010-08-02 Uwe Schulzweida <Uwe.Schulzweida@zmaw.de>
* added grid mask support
......
......@@ -11,14 +11,16 @@ It is also possible to have attributes that are not associated with any variable
These are called global attributes and are identified by using CDI\_GLOBAL as a
variable pseudo-ID. Global attributes are usually related to the dataset as a whole.
CDI supports attributes with tree different data types. The data types
are defined by the following predefined constants:
CDI supports integer, floating point and text attributes. The data types are defined
by the following predefined constants:
\vspace*{3mm}
\hspace*{8mm}\begin{minipage}{15cm}
\begin{deflist}{{\large\tt DATATYPE\_TXT \ \ }}
\item[{\large\tt DATATYPE\_INT}] Integer attribute
\item[{\large\tt DATATYPE\_FLT}] Floating point attribute
\item[{\large\tt DATATYPE\_INT16}] 16-bit integer attribute
\item[{\large\tt DATATYPE\_INT32}] 32-bit integer attribute
\item[{\large\tt DATATYPE\_FLT32}] 32-bit floating point attribute
\item[{\large\tt DATATYPE\_FLT64}] 64-bit floating point attribute
\item[{\large\tt DATATYPE\_TXT}] Text attribute
\end{deflist}
\end{minipage}
......@@ -654,15 +654,35 @@ Copy some entries of a variable list.
Create a variable list.
\section*{\tt \htmlref{vlistDefAttFlt}{vlistDefAttFlt}}
\begin{verbatim}
int vlistDefAttFlt (intvlistID, intvarID, char *name, inttype, intlen,
double *dp_vec);
\end{verbatim}
Define a floating point attribute.
\section*{\tt \htmlref{vlistDefAttInt}{vlistDefAttInt}}
\begin{verbatim}
int vlistDefAttInt (intvlistID, intvarID, char *name, intlen, int *ip_vec);
int vlistDefAttInt (intvlistID, intvarID, char *name, inttype, intlen,
int *ip_vec);
\end{verbatim}
Define an integer attribute.
\section*{\tt \htmlref{vlistDefAttTxt}{vlistDefAttTxt}}
\begin{verbatim}
int vlistDefAttTxt (intvlistID, intvarID, char *name, intlen, char *tp);
\end{verbatim}
Define a text attribute.
\section*{\tt \htmlref{vlistDefTaxis}{vlistDefTaxis}}
\begin{verbatim}
......@@ -781,6 +801,15 @@ Duplicate a variable list.
Get information about an attribute.
\section*{\tt \htmlref{vlistInqAttFlt}{vlistInqAttFlt}}
\begin{verbatim}
int vlistInqAttFlt (intvlistID, intvarID, char *name, intmlen, double *dp_vec);
\end{verbatim}
Get the value(s) of a floating point attribute.
\section*{\tt \htmlref{vlistInqAttInt}{vlistInqAttInt}}
\begin{verbatim}
......@@ -790,6 +819,15 @@ Get information about an attribute.
Get the value(s) of an integer attribute.
\section*{\tt \htmlref{vlistInqAttTxt}{vlistInqAttTxt}}
\begin{verbatim}
int vlistInqAttTxt (intvlistID, intvarID, char *name, intmlen, char *tp);
\end{verbatim}
Get the value(s) of a text attribute.
\section*{\tt \htmlref{vlistInqNatts}{vlistInqNatts}}
\begin{verbatim}
......
......@@ -895,7 +895,7 @@ vlistDefAttFlt
\fi
}
\begin{verbatim}
int vlistDefAttFlt(int vlistID, int varID, const char *name, int len,
int vlistDefAttFlt(int vlistID, int varID, const char *name, int type, int len,
const double *dp);
\end{verbatim}
......@@ -911,7 +911,8 @@ vlistDefAttInt
\fi
}
\begin{verbatim}
int vlistDefAttInt(int vlistID, int varID, const char *name, int len, const int *ip);
int vlistDefAttInt(int vlistID, int varID, const char *name, int type, int len,
const int *ip);
\end{verbatim}
Define an integer attribute
......
......@@ -65,7 +65,8 @@ The function {\tt vlistDefAttInt} defines an integer attribute.
\subsubsection*{Usage}
\begin{verbatim}
int vlistDefAttInt(int vlistID, int varID, const char *name, int len, const int *ip);
int vlistDefAttInt(int vlistID, int varID, const char *name, int type, int len,
const int *ip);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -76,6 +77,8 @@ Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate
Variable identifier, or CDI\_GLOBAL for a global attribute
\item[{\tt name}]
Attribute name
\item[{\tt type}]
External data type (DATATYPE\_INT16 or DATATYPE\_INT32)
\item[{\tt len}]
Number of values provided for the attribute
\item[{\tt ip}]
......@@ -123,7 +126,7 @@ The function {\tt vlistDefAttFlt} defines a floating point attribute.
\subsubsection*{Usage}
\begin{verbatim}
int vlistDefAttFlt(int vlistID, int varID, const char *name, int len,
int vlistDefAttFlt(int vlistID, int varID, const char *name, int type, int len,
const double *dp);
\end{verbatim}
......@@ -135,6 +138,8 @@ Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate
Variable identifier, or CDI\_GLOBAL for a global attribute
\item[{\tt name}]
Attribute name
\item[{\tt type}]
External data type (DATATYPE\_FLT32 or DATATYPE\_FLT64)
\item[{\tt len}]
Number of values provided for the attribute
\item[{\tt dp}]
......
......@@ -135,7 +135,7 @@
\end{picture}
\begin{flushright}
\large\bf{Climate Data Interface \\ Version 1.4.4 \\ April 2010}
\large\bf{Climate Data Interface \\ Version 1.4.6 \\ September 2010}
\end{flushright}
\vfill
......
......@@ -132,7 +132,7 @@
\end{picture}
\begin{flushright}
\large\bf{Climate Data Interface \\ Version 1.4.4 \\ April 2010}
\large\bf{Climate Data Interface \\ Version 1.4.6 \\ September 2010}
\end{flushright}
\vfill
......
......@@ -656,16 +656,39 @@ 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 type, INTEGER len,
DOUBLEPRECISION dp_vec)
\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, INTEGER ip_vec)
CHARACTER*(*) name, INTEGER type, INTEGER len,
INTEGER ip_vec)
\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}
......@@ -788,6 +811,17 @@ Duplicate a variable list.
Get information about an attribute.
\section*{\tt \htmlref{vlistInqAttFlt}{vlistInqAttFlt}}
\begin{verbatim}
INTEGER FUNCTION vlistInqAttFlt (INTEGER vlistID, INTEGER varID,
CHARACTER*(*) name, INTEGER mlen,
DOUBLEPRECISION dp_vec)
\end{verbatim}
Get the value(s) of a floating point attribute.
\section*{\tt \htmlref{vlistInqAttInt}{vlistInqAttInt}}
\begin{verbatim}
......@@ -799,6 +833,17 @@ Get information about an attribute.
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,
CHARACTER*(*) tp)
\end{verbatim}
Get the value(s) of a text attribute.
\section*{\tt \htmlref{vlistInqNatts}{vlistInqNatts}}
\begin{verbatim}
......
......@@ -898,7 +898,8 @@ vlistDefAttFlt
}
\begin{verbatim}
INTEGER FUNCTION vlistDefAttFlt(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) name, INTEGER len, const REAL*8 dp)
CHARACTER*(*) name, INTEGER type, INTEGER len,
const REAL*8 dp)
\end{verbatim}
Define a floating point attribute
......@@ -914,7 +915,7 @@ vlistDefAttInt
}
\begin{verbatim}
INTEGER FUNCTION vlistDefAttInt(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) name, INTEGER len,
CHARACTER*(*) name, INTEGER type, INTEGER len,
const INTEGER ip)
\end{verbatim}
......
......@@ -67,7 +67,7 @@ The function {\tt vlistDefAttInt} defines an integer attribute.
\begin{verbatim}
INTEGER FUNCTION vlistDefAttInt(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) name, INTEGER len,
CHARACTER*(*) name, INTEGER type, INTEGER len,
const INTEGER ip)
\end{verbatim}
......@@ -79,6 +79,8 @@ Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate
Variable identifier, or CDI\_GLOBAL for a global attribute
\item[{\tt name}]
Attribute name
\item[{\tt type}]
External data type (DATATYPE\_INT16 or DATATYPE\_INT32)
\item[{\tt len}]
Number of values provided for the attribute
\item[{\tt ip}]
......@@ -128,7 +130,8 @@ The function {\tt vlistDefAttFlt} defines a floating point attribute.
\begin{verbatim}
INTEGER FUNCTION vlistDefAttFlt(INTEGER vlistID, INTEGER varID,
CHARACTER*(*) name, INTEGER len, const REAL*8 dp)
CHARACTER*(*) name, INTEGER type, INTEGER len,
const REAL*8 dp)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -139,6 +142,8 @@ Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate
Variable identifier, or CDI\_GLOBAL for a global attribute
\item[{\tt name}]
Attribute name
\item[{\tt type}]
External data type (DATATYPE\_FLT32 or DATATYPE\_FLT64)
\item[{\tt len}]
Number of values provided for the attribute
\item[{\tt dp}]
......
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