Commit 08cc299a authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update.

parent 40005c73
......@@ -9,7 +9,7 @@ The function {\texttt{gridCreate}} creates a horizontal Grid.
\subsubsection*{Usage}
\begin{verbatim}
int gridCreate(int gridtype, int size);
int gridCreate(int gridtype, size_t size);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -137,7 +137,7 @@ The function {\texttt{gridInqSize}} returns the size of a Grid.
\subsubsection*{Usage}
\begin{verbatim}
int gridInqSize(int gridID);
size_t gridInqSize(int gridID);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -163,7 +163,7 @@ The function {\texttt{gridDefXsize}} defines the number of values of a X-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefXsize(int gridID, int xsize);
void gridDefXsize(int gridID, size_t xsize);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -186,7 +186,7 @@ The function {\texttt{gridInqXsize}} returns the number of values of a X-axis.
\subsubsection*{Usage}
\begin{verbatim}
int gridInqXsize(int gridID);
size_t gridInqXsize(int gridID);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -212,7 +212,7 @@ The function {\texttt{gridDefYsize}} defines the number of values of a Y-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefYsize(int gridID, int ysize);
void gridDefYsize(int gridID, size_t ysize);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -235,7 +235,7 @@ The function {\texttt{gridInqYsize}} returns the number of values of a Y-axis.
\subsubsection*{Usage}
\begin{verbatim}
int gridInqYsize(int gridID);
size_t gridInqYsize(int gridID);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -335,7 +335,7 @@ The function {\texttt{gridInqXvals}} returns all values of the X-axis.
\subsubsection*{Usage}
\begin{verbatim}
int gridInqXvals(int gridID, double *xvals);
size_t gridInqXvals(int gridID, double *xvals);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -389,7 +389,7 @@ The function {\texttt{gridInqYvals}} returns all values of the Y-axis.
\subsubsection*{Usage}
\begin{verbatim}
int gridInqYvals(int gridID, double *yvals);
size_t gridInqYvals(int gridID, double *yvals);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -443,7 +443,7 @@ The function {\texttt{gridInqXbounds}} returns the bounds of the X-axis.
\subsubsection*{Usage}
\begin{verbatim}
int gridInqXbounds(int gridID, double *xbounds);
size_t gridInqXbounds(int gridID, double *xbounds);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -497,7 +497,7 @@ The function {\texttt{gridInqYbounds}} returns the bounds of the Y-axis.
\subsubsection*{Usage}
\begin{verbatim}
int gridInqYbounds(int gridID, double *ybounds);
size_t gridInqYbounds(int gridID, double *ybounds);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......
......@@ -130,7 +130,7 @@ gridCreate
\fi
}}
\begin{verbatim}
int gridCreate(int gridtype, int size);
int gridCreate(int gridtype, size_t size);
\end{verbatim}
Create a horizontal Grid
......@@ -265,7 +265,7 @@ gridDefXsize
\fi
}}
\begin{verbatim}
void gridDefXsize(int gridID, int xsize);
void gridDefXsize(int gridID, size_t xsize);
\end{verbatim}
Define the number of values of a X-axis
......@@ -355,7 +355,7 @@ gridDefYsize
\fi
}}
\begin{verbatim}
void gridDefYsize(int gridID, int ysize);
void gridDefYsize(int gridID, size_t ysize);
\end{verbatim}
Define the number of values of a Y-axis
......@@ -490,7 +490,7 @@ gridInqSize
\fi
}}
\begin{verbatim}
int gridInqSize(int gridID);
size_t gridInqSize(int gridID);
\end{verbatim}
Get the size of a Grid
......@@ -535,7 +535,7 @@ gridInqXbounds
\fi
}}
\begin{verbatim}
int gridInqXbounds(int gridID, double *xbounds);
size_t gridInqXbounds(int gridID, double *xbounds);
\end{verbatim}
Get the bounds of a X-axis
......@@ -580,7 +580,7 @@ gridInqXsize
\fi
}}
\begin{verbatim}
int gridInqXsize(int gridID);
size_t gridInqXsize(int gridID);
\end{verbatim}
Get the number of values of a X-axis
......@@ -610,7 +610,7 @@ gridInqXvals
\fi
}}
\begin{verbatim}
int gridInqXvals(int gridID, double *xvals);
size_t gridInqXvals(int gridID, double *xvals);
\end{verbatim}
Get all values of a X-axis
......@@ -625,7 +625,7 @@ gridInqYbounds
\fi
}}
\begin{verbatim}
int gridInqYbounds(int gridID, double *ybounds);
size_t gridInqYbounds(int gridID, double *ybounds);
\end{verbatim}
Get the bounds of a Y-axis
......@@ -670,7 +670,7 @@ gridInqYsize
\fi
}}
\begin{verbatim}
int gridInqYsize(int gridID);
size_t gridInqYsize(int gridID);
\end{verbatim}
Get the number of values of a Y-axis
......@@ -700,7 +700,7 @@ gridInqYvals
\fi
}}
\begin{verbatim}
int gridInqYvals(int gridID, double *yvals);
size_t gridInqYvals(int gridID, double *yvals);
\end{verbatim}
Get all values of a Y-axis
......@@ -880,7 +880,7 @@ streamReadVar
\fi
}}
\begin{verbatim}
void streamReadVar(int streamID, int varID, double *data, int *nmiss);
void streamReadVar(int streamID, int varID, double *data, size_t *nmiss);
\end{verbatim}
Read a variable
......@@ -895,7 +895,7 @@ streamReadVarF
\fi
}}
\begin{verbatim}
void streamReadVar(int streamID, int varID, float *data, int *nmiss);
void streamReadVar(int streamID, int varID, float *data, size_t *nmiss);
\end{verbatim}
Read a variable
......@@ -911,7 +911,7 @@ streamReadVarSlice
}}
\begin{verbatim}
void streamReadVarSlice(int streamID, int varID, int levelID, double *data,
int *nmiss);
size_t *nmiss);
\end{verbatim}
Read a horizontal slice of a variable
......@@ -927,7 +927,7 @@ streamReadVarSliceF
}}
\begin{verbatim}
void streamReadVarSliceF(int streamID, int varID, int levelID, float *data,
int *nmiss);
size_t *nmiss);
\end{verbatim}
Read a horizontal slice of a variable
......@@ -942,7 +942,7 @@ streamWriteVar
\fi
}}
\begin{verbatim}
void streamWriteVar(int streamID, int varID, const double *data, int nmiss);
void streamWriteVar(int streamID, int varID, const double *data, size_t nmiss);
\end{verbatim}
Write a variable
......@@ -957,7 +957,7 @@ streamWriteVarF
\fi
}}
\begin{verbatim}
void streamWriteVarF(int streamID, int varID, const float *data, int nmiss);
void streamWriteVarF(int streamID, int varID, const float *data, size_t nmiss);
\end{verbatim}
Write a variable
......@@ -973,7 +973,7 @@ streamWriteVarSlice
}}
\begin{verbatim}
void streamWriteVarSlice(int streamID, int varID, int levelID, const double *data,
int nmiss);
size_t nmiss);
\end{verbatim}
Write a horizontal slice of a variable
......@@ -989,7 +989,7 @@ streamWriteVarSliceF
}}
\begin{verbatim}
void streamWriteVarSliceF(int streamID, int varID, int levelID, const float *data,
int nmiss);
size_t nmiss);
\end{verbatim}
Write a horizontal slice of a variable
......@@ -1259,7 +1259,7 @@ vlistDefVar
\fi
}}
\begin{verbatim}
int vlistDefVar(int vlistID, int gridID, int zaxisID, int tsteptype);
int vlistDefVar(int vlistID, int gridID, int zaxisID, int timetype);
\end{verbatim}
Define a Variable
......
......@@ -9,7 +9,7 @@ from an open dataset.
\subsubsection*{Usage}
\begin{verbatim}
void streamReadVar(int streamID, int varID, double *data, int *nmiss);
void streamReadVar(int streamID, int varID, double *data, size_t *nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -37,7 +37,7 @@ from an open dataset.
\subsubsection*{Usage}
\begin{verbatim}
void streamReadVar(int streamID, int varID, float *data, int *nmiss);
void streamReadVar(int streamID, int varID, float *data, size_t *nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -66,7 +66,7 @@ from an open dataset.
\begin{verbatim}
void streamReadVarSlice(int streamID, int varID, int levelID, double *data,
int *nmiss);
size_t *nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -97,7 +97,7 @@ from an open dataset.
\begin{verbatim}
void streamReadVarSliceF(int streamID, int varID, int levelID, float *data,
int *nmiss);
size_t *nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......
......@@ -9,7 +9,7 @@ The values are converted to the external data type of the variable, if necessary
\subsubsection*{Usage}
\begin{verbatim}
void streamWriteVar(int streamID, int varID, const double *data, int nmiss);
void streamWriteVar(int streamID, int varID, const double *data, size_t nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -36,7 +36,7 @@ The values are converted to the external data type of the variable, if necessary
\subsubsection*{Usage}
\begin{verbatim}
void streamWriteVarF(int streamID, int varID, const float *data, int nmiss);
void streamWriteVarF(int streamID, int varID, const float *data, size_t nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -64,7 +64,7 @@ The values are converted to the external data type of the variable, if necessary
\begin{verbatim}
void streamWriteVarSlice(int streamID, int varID, int levelID, const double *data,
int nmiss);
size_t nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -94,7 +94,7 @@ The values are converted to the external data type of the variable, if necessary
\begin{verbatim}
void streamWriteVarSliceF(int streamID, int varID, int levelID, const float *data,
int nmiss);
size_t nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......
......@@ -9,21 +9,20 @@ The function {\texttt{vlistDefVar}} adds a new variable to vlistID.
\subsubsection*{Usage}
\begin{verbatim}
int vlistDefVar(int vlistID, int gridID, int zaxisID, int tsteptype);
int vlistDefVar(int vlistID, int gridID, int zaxisID, int timetype);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{tsteptype}\ }
\begin{deflist}{\texttt{timetype}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}.
\item[\texttt{gridID}]
Grid ID, from a previous call to {\htmlref{\texttt{gridCreate}}{gridCreate}}.
\item[\texttt{zaxisID}]
Z-axis ID, from a previous call to {\htmlref{\texttt{zaxisCreate}}{zaxisCreate}}.
\item[\texttt{tsteptype}]
\item[\texttt{timetype}]
One of the set of predefined {\CDI} timestep types.
The valid {\CDI} timestep types are {\texttt{TSTEP\_CONSTANT}}, {\texttt{TSTEP\_INSTANT}},
{\texttt{TSTEP\_ACCUM}}, {\texttt{TSTEP\_AVG}}, {\texttt{TSTEP\_MAX}}, {\texttt{TSTEP\_MIN}} and {\texttt{TSTEP\_SD}}.
The valid {\CDI} timestep types are {\texttt{TIME\_CONSTANT}} and {\texttt{TIME\_VARYING}}.
\end{deflist}
\end{minipage}
......@@ -45,7 +44,7 @@ and add a variable with {\texttt{vlistDefVar}}.
int vlistID, varID;
...
vlistID = vlistCreate();
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_INSTANT);
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_VARYING);
...
streamDefVlist(streamID, vlistID);
...
......@@ -136,7 +135,7 @@ Variable identifier.
{\texttt{vlistInqVarTsteptype}} returns the timestep type of the Variable,
one of the set of predefined {\CDI} timestep types.
The valid {\CDI} timestep types are {\texttt{TSTEP\_CONSTANT}}, {\texttt{TSTEP\_INSTANT}},
The valid {\CDI} timestep types are {\texttt{TSTEP\_INSTANT}},
{\texttt{TSTEP\_ACCUM}}, {\texttt{TSTEP\_AVG}}, {\texttt{TSTEP\_MAX}}, {\texttt{TSTEP\_MIN}} and {\texttt{TSTEP\_SD}}.
......
......@@ -135,7 +135,7 @@
\end{picture}
\begin{flushright}
{\large\bfseries Climate Data Interface \\ Version 1.9.1 \\ October 2017}
{\large\bfseries Climate Data Interface \\ Version 1.9.2 \\ November 2017}
\end{flushright}
\vfill
......
......@@ -132,7 +132,7 @@
\end{picture}
\begin{flushright}
{\large\bfseries Climate Data Interface \\ Version 1.9.1 \\ October 2017}
{\large\bfseries Climate Data Interface \\ Version 1.9.2 \\ November 2017}
\end{flushright}
\vfill
......
......@@ -1269,7 +1269,7 @@ vlistDefVar
}}
\begin{verbatim}
INTEGER FUNCTION vlistDefVar(INTEGER vlistID, INTEGER gridID, INTEGER zaxisID,
INTEGER tsteptype)
INTEGER timetype)
\end{verbatim}
Define a Variable
......
......@@ -10,21 +10,20 @@ The function {\texttt{vlistDefVar}} adds a new variable to vlistID.
\begin{verbatim}
INTEGER FUNCTION vlistDefVar(INTEGER vlistID, INTEGER gridID, INTEGER zaxisID,
INTEGER tsteptype)
INTEGER timetype)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\texttt{tsteptype}\ }
\begin{deflist}{\texttt{timetype}\ }
\item[\texttt{vlistID}]
Variable list ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}.
\item[\texttt{gridID}]
Grid ID, from a previous call to {\htmlref{\texttt{gridCreate}}{gridCreate}}.
\item[\texttt{zaxisID}]
Z-axis ID, from a previous call to {\htmlref{\texttt{zaxisCreate}}{zaxisCreate}}.
\item[\texttt{tsteptype}]
\item[\texttt{timetype}]
One of the set of predefined {\CDI} timestep types.
The valid {\CDI} timestep types are {\texttt{TSTEP\_CONSTANT}}, {\texttt{TSTEP\_INSTANT}},
{\texttt{TSTEP\_ACCUM}}, {\texttt{TSTEP\_AVG}}, {\texttt{TSTEP\_MAX}}, {\texttt{TSTEP\_MIN}} and {\texttt{TSTEP\_SD}}.
The valid {\CDI} timestep types are {\texttt{TIME\_CONSTANT}} and {\texttt{TIME\_VARYING}}.
\end{deflist}
\end{minipage}
......@@ -46,7 +45,7 @@ and add a variable with {\texttt{vlistDefVar}}.
INTEGER vlistID, varID
...
vlistID = vlistCreate()
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_INSTANT)
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_VARYING)
...
streamDefVlist(streamID, vlistID)
...
......@@ -137,7 +136,7 @@ Variable identifier.
{\texttt{vlistInqVarTsteptype}} returns the timestep type of the Variable,
one of the set of predefined {\CDI} timestep types.
The valid {\CDI} timestep types are {\texttt{TSTEP\_CONSTANT}}, {\texttt{TSTEP\_INSTANT}},
The valid {\CDI} timestep types are {\texttt{TSTEP\_INSTANT}},
{\texttt{TSTEP\_ACCUM}}, {\texttt{TSTEP\_AVG}}, {\texttt{TSTEP\_MAX}}, {\texttt{TSTEP\_MIN}} and {\texttt{TSTEP\_SD}}.
......
......@@ -323,6 +323,7 @@ sub printproto {
# fortran proto
if ( "$ftype" eq "void" ) { $ftype = "SUBROUTINE"; }
if ( "$ftype" eq "int" ) { $ftype = "INTEGER FUNCTION"; }
if ( "$ftype" eq "size_t" ) { $ftype = "INTEGER FUNCTION"; }
if ( "$ftype" eq "double" ) { $ftype = "REAL*8 FUNCTION"; }
if ( "$ftype" eq "float" ) { $ftype = "REAL*4 FUNCTION"; }
$klen = 0;
......@@ -339,6 +340,8 @@ sub printproto {
$tag =~ s/char \*/CHARACTER*(*) /og;
$tag =~ s/int \*/INTEGER /og;
$tag =~ s/int /INTEGER /og;
$tag =~ s/size_t \*/INTEGER /og;
$tag =~ s/size_t /INTEGER /og;
$tag =~ s/double \*/REAL*8 /og;
$tag =~ s/double /REAL*8 /og;
$tag =~ s/float \*/REAL*4 /og;
......@@ -377,6 +380,7 @@ sub printfortran {
$line =~ s/const char \*/CHARACTER\*(\*) /og;
$line =~ s/char \*/CHARACTER\*(\*) /og;
$line =~ s/int /INTEGER /og;
$line =~ s/size_t /INTEGER /og;
$line =~ s/double /REAL*8 /og;
$line =~ s/float /REAL*4 /og;
$line =~ s/const //og;
......
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