Skip to content

GitLab

Commit 82f1823d authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent 7e58ea1a
Hide whitespace changes
Inline Side-by-side
doc/tex/c_grid.tex
View file @ 82f1823d
......@@ -262,7 +262,7 @@ The function {\tt gridDefXvals} defines all values of the X-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefXvals(int gridID, double *xvals);
void gridDefXvals(int gridID, const double *xvals);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -315,7 +315,7 @@ The function {\tt gridDefYvals} defines all values of the Y-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefYvals(int gridID, double *yvals);
void gridDefYvals(int gridID, const double *yvals);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -368,7 +368,7 @@ The function {\tt gridDefXbounds} defines all bounds of the X-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefXbounds(int gridID, double *xbounds);
void gridDefXbounds(int gridID, const double *xbounds);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -421,7 +421,7 @@ The function {\tt gridDefYbounds} defines all bounds of the Y-axis.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefYbounds(int gridID, double *ybounds);
void gridDefYbounds(int gridID, const double *ybounds);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......
doc/tex/c_ref.tex
View file @ 82f1823d
......@@ -12,7 +12,7 @@ Create a horizontal Grid
\section*{\tt \htmlref{gridDefXbounds}{gridDefXbounds}}
\begin{verbatim}
void gridDefXbounds(int gridID, double *xbounds);
void gridDefXbounds(int gridID, const double *xbounds);
\end{verbatim}
Define the bounds of a X-axis
......@@ -57,7 +57,7 @@ Define the units of a X-axis
\section*{\tt \htmlref{gridDefXvals}{gridDefXvals}}
\begin{verbatim}
void gridDefXvals(int gridID, double *xvals);
void gridDefXvals(int gridID, const double *xvals);
\end{verbatim}
Define the values of a X-axis
......@@ -66,7 +66,7 @@ Define the values of a X-axis
\section*{\tt \htmlref{gridDefYbounds}{gridDefYbounds}}
\begin{verbatim}
void gridDefYbounds(int gridID, double *ybounds);
void gridDefYbounds(int gridID, const double *ybounds);
\end{verbatim}
Define the bounds of a Y-axis
......@@ -111,7 +111,7 @@ Define the units of a Y-axis
\section*{\tt \htmlref{gridDefYvals}{gridDefYvals}}
\begin{verbatim}
void gridDefYvals(int gridID, double *yvals);
void gridDefYvals(int gridID, const double *yvals);
\end{verbatim}
Define the values of a Y-axis
......@@ -373,7 +373,7 @@ Read a horizontal slice of a variable
\section*{\tt \htmlref{streamWriteVar}{streamWriteVar}}
\begin{verbatim}
void streamWriteVar(int streamID, int varID, double *data, int nmiss);
void streamWriteVar(int streamID, int varID, const double *data, int nmiss);
\end{verbatim}
Write a variable
......@@ -382,7 +382,7 @@ Write a variable
\section*{\tt \htmlref{streamWriteVarSlice}{streamWriteVarSlice}}
\begin{verbatim}
void streamWriteVarSlice(int streamID, int varID, int levelID, double *data,
void streamWriteVarSlice(int streamID, int varID, int levelID, const double *data,
int nmiss);
\end{verbatim}
......@@ -743,7 +743,7 @@ Create a vertical Z-axis
\section*{\tt \htmlref{zaxisDefLevels}{zaxisDefLevels}}
\begin{verbatim}
void zaxisDefLevels(int zaxisID, double *levels);
void zaxisDefLevels(int zaxisID, const double *levels);
\end{verbatim}
Define the levels of a Z-axis
......
doc/tex/c_stream.tex
View file @ 82f1823d
......@@ -17,7 +17,7 @@ The function {\tt streamOpenWrite} creates a new datset.
The name of the new dataset
\item[{\tt filetype}]
The type of the file format, one of the set of predefined {\CDI} file format types.
The valid {\CDI} file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC},
The valid {\CDI} file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_GRB2}, {\tt FILETYPE\_NC},
{\tt FILETYPE\_NC2}, {\tt FILETYPE\_NC4}, {\tt FILETYPE\_SRV},
{\tt FILETYPE\_EXT} and {\tt FILETYPE\_IEG}.
......@@ -169,7 +169,7 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
{\tt streamInqFiletype} returns the type of the file format,
one of the set of predefined {\CDI} file format types.
The valid {\CDI} file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC}, {\tt FILETYPE\_NC2},
The valid {\CDI} file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_GRB2}, {\tt FILETYPE\_NC}, {\tt FILETYPE\_NC2},
{\tt FILETYPE\_NC4}, {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} and {\tt FILETYPE\_IEG}.
......@@ -341,7 +341,7 @@ to an open dataset.
\subsubsection*{Usage}
\begin{verbatim}
void streamWriteVar(int streamID, int varID, double *data, int nmiss);
void streamWriteVar(int streamID, int varID, const double *data, int nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -395,7 +395,7 @@ variable to an open dataset.
\subsubsection*{Usage}
\begin{verbatim}
void streamWriteVarSlice(int streamID, int varID, int levelID, double *data,
void streamWriteVarSlice(int streamID, int varID, int levelID, const double *data,
int nmiss);
\end{verbatim}
......
doc/tex/c_taxis.tex
View file @ 82f1823d
......@@ -40,7 +40,7 @@ with a standard calendar.
taxisID = taxisCreate(TAXIS_RELATIVE);
taxisDefCalendar(taxisID, CALENDAR_STANDARD);
taxisDefRdate(taxisID, 19870101);
taxisDefRtime(taxisID, 1200);
taxisDefRtime(taxisID, 120000);
...
\end{lstlisting}
......@@ -129,7 +129,7 @@ The function {\tt taxisDefVdate} defines the reference time of a Time axis.
\item[{\tt taxisID}]
Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt rtime}]
Reference time (hhmm)
Reference time (hhmmss)
\end{deflist}
\end{minipage}
......@@ -227,7 +227,7 @@ The function {\tt taxisDefVtime} defines the verification time of a Time axis.
\item[{\tt taxisID}]
Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt vtime}]
Verification time (hhmm)
Verification time (hhmmss)
\end{deflist}
\end{minipage}
......
doc/tex/c_zaxis.tex
View file @ 82f1823d
......@@ -132,7 +132,7 @@ The function {\tt zaxisDefLevels} defines the levels of a Z-axis.
\subsubsection*{Usage}
\begin{verbatim}
void zaxisDefLevels(int zaxisID, double *levels);
void zaxisDefLevels(int zaxisID, const double *levels);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......
doc/tex/cdi_cman.tex
View file @ 82f1823d
......@@ -124,7 +124,7 @@
\end{picture}
\begin{flushright}
\large\bf{Climate Data Interface \\ Version 1.3.0 \\ January 2009}
\large\bf{Climate Data Interface \\ Version 1.4.0 \\ September 2009}
\end{flushright}
\vfill
......
doc/tex/cdi_fman.tex
View file @ 82f1823d
......@@ -123,7 +123,7 @@
\end{picture}
\begin{flushright}
\large\bf{Climate Data Interface \\ Version 1.3.0 \\ January 2009}
\large\bf{Climate Data Interface \\ Version 1.4.0 \\ September 2009}
\end{flushright}
\vfill
......
doc/tex/f_grid.tex
View file @ 82f1823d
......@@ -262,7 +262,7 @@ The function {\tt gridDefXvals} defines all values of the X-axis.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE gridDefXvals(INTEGER gridID, REAL*8 xvals)
SUBROUTINE gridDefXvals(INTEGER gridID, const REAL*8 xvals)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -315,7 +315,7 @@ The function {\tt gridDefYvals} defines all values of the Y-axis.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE gridDefYvals(INTEGER gridID, REAL*8 yvals)
SUBROUTINE gridDefYvals(INTEGER gridID, const REAL*8 yvals)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -368,7 +368,7 @@ The function {\tt gridDefXbounds} defines all bounds of the X-axis.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE gridDefXbounds(INTEGER gridID, REAL*8 xbounds)
SUBROUTINE gridDefXbounds(INTEGER gridID, const REAL*8 xbounds)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......@@ -421,7 +421,7 @@ The function {\tt gridDefYbounds} defines all bounds of the Y-axis.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE gridDefYbounds(INTEGER gridID, REAL*8 ybounds)
SUBROUTINE gridDefYbounds(INTEGER gridID, const REAL*8 ybounds)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......
doc/tex/f_ref.tex
View file @ 82f1823d
......@@ -12,7 +12,7 @@ Create a horizontal Grid
\section*{\tt \htmlref{gridDefXbounds}{gridDefXbounds}}
\begin{verbatim}
SUBROUTINE gridDefXbounds(INTEGER gridID, REAL*8 xbounds)
SUBROUTINE gridDefXbounds(INTEGER gridID, const REAL*8 xbounds)
\end{verbatim}
Define the bounds of a X-axis
......@@ -57,7 +57,7 @@ Define the units of a X-axis
\section*{\tt \htmlref{gridDefXvals}{gridDefXvals}}
\begin{verbatim}
SUBROUTINE gridDefXvals(INTEGER gridID, REAL*8 xvals)
SUBROUTINE gridDefXvals(INTEGER gridID, const REAL*8 xvals)
\end{verbatim}
Define the values of a X-axis
......@@ -66,7 +66,7 @@ Define the values of a X-axis
\section*{\tt \htmlref{gridDefYbounds}{gridDefYbounds}}
\begin{verbatim}
SUBROUTINE gridDefYbounds(INTEGER gridID, REAL*8 ybounds)
SUBROUTINE gridDefYbounds(INTEGER gridID, const REAL*8 ybounds)
\end{verbatim}
Define the bounds of a Y-axis
......@@ -111,7 +111,7 @@ Define the units of a Y-axis
\section*{\tt \htmlref{gridDefYvals}{gridDefYvals}}
\begin{verbatim}
SUBROUTINE gridDefYvals(INTEGER gridID, REAL*8 yvals)
SUBROUTINE gridDefYvals(INTEGER gridID, const REAL*8 yvals)
\end{verbatim}
Define the values of a Y-axis
......@@ -374,7 +374,7 @@ Read a horizontal slice of a variable
\section*{\tt \htmlref{streamWriteVar}{streamWriteVar}}
\begin{verbatim}
SUBROUTINE streamWriteVar(INTEGER streamID, INTEGER varID, REAL*8 data,
SUBROUTINE streamWriteVar(INTEGER streamID, INTEGER varID, const REAL*8 data,
INTEGER nmiss)
\end{verbatim}
......@@ -385,7 +385,7 @@ Write a variable
\begin{verbatim}
SUBROUTINE streamWriteVarSlice(INTEGER streamID, INTEGER varID, INTEGER levelID,
REAL*8 data, INTEGER nmiss)
const REAL*8 data, INTEGER nmiss)
\end{verbatim}
Write a horizontal slice of a variable
......@@ -748,7 +748,7 @@ Create a vertical Z-axis
\section*{\tt \htmlref{zaxisDefLevels}{zaxisDefLevels}}
\begin{verbatim}
SUBROUTINE zaxisDefLevels(INTEGER zaxisID, REAL*8 levels)
SUBROUTINE zaxisDefLevels(INTEGER zaxisID, const REAL*8 levels)
\end{verbatim}
Define the levels of a Z-axis
......
doc/tex/f_stream.tex
View file @ 82f1823d
......@@ -17,7 +17,7 @@ The function {\tt streamOpenWrite} creates a new datset.
The name of the new dataset
\item[{\tt filetype}]
The type of the file format, one of the set of predefined {\CDI} file format types.
The valid {\CDI} file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC},
The valid {\CDI} file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_GRB2}, {\tt FILETYPE\_NC},
{\tt FILETYPE\_NC2}, {\tt FILETYPE\_NC4}, {\tt FILETYPE\_SRV},
{\tt FILETYPE\_EXT} and {\tt FILETYPE\_IEG}.
......@@ -169,7 +169,7 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
{\tt streamInqFiletype} returns the type of the file format,
one of the set of predefined {\CDI} file format types.
The valid {\CDI} file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC}, {\tt FILETYPE\_NC2},
The valid {\CDI} file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_GRB2}, {\tt FILETYPE\_NC}, {\tt FILETYPE\_NC2},
{\tt FILETYPE\_NC4}, {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} and {\tt FILETYPE\_IEG}.
......@@ -341,7 +341,7 @@ to an open dataset.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE streamWriteVar(INTEGER streamID, INTEGER varID, REAL*8 data,
SUBROUTINE streamWriteVar(INTEGER streamID, INTEGER varID, const REAL*8 data,
INTEGER nmiss)
\end{verbatim}
......@@ -398,7 +398,7 @@ variable to an open dataset.
\begin{verbatim}
SUBROUTINE streamWriteVarSlice(INTEGER streamID, INTEGER varID, INTEGER levelID,
REAL*8 data, INTEGER nmiss)
const REAL*8 data, INTEGER nmiss)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......
doc/tex/f_taxis.tex
View file @ 82f1823d
......@@ -40,7 +40,7 @@ with a standard calendar.
taxisID = taxisCreate(TAXIS_RELATIVE)
taxisDefCalendar(taxisID, CALENDAR_STANDARD)
taxisDefRdate(taxisID, 19870101)
taxisDefRtime(taxisID, 1200)
taxisDefRtime(taxisID, 120000)
...
\end{lstlisting}
......@@ -129,7 +129,7 @@ The function {\tt taxisDefVdate} defines the reference time of a Time axis.
\item[{\tt taxisID}]
Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt rtime}]
Reference time (hhmm)
Reference time (hhmmss)
\end{deflist}
\end{minipage}
......@@ -227,7 +227,7 @@ The function {\tt taxisDefVtime} defines the verification time of a Time axis.
\item[{\tt taxisID}]
Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt vtime}]
Verification time (hhmm)
Verification time (hhmmss)
\end{deflist}
\end{minipage}
......
doc/tex/f_zaxis.tex
View file @ 82f1823d
......@@ -132,7 +132,7 @@ The function {\tt zaxisDefLevels} defines the levels of a Z-axis.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE zaxisDefLevels(INTEGER zaxisID, REAL*8 levels)
SUBROUTINE zaxisDefLevels(INTEGER zaxisID, const REAL*8 levels)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
......
src/cdiFortran.c
View file @ 82f1823d
......@@ -217,12 +217,12 @@ FCALLSCSUB2 (gridDefXvals, GRIDDEFXVALS, griddefxvals, INT, PDOUBLE)
FCALLSCFUN2 (INT, gridInqXvals, GRIDINQXVALS, gridinqxvals, INT, PDOUBLE)
FCALLSCSUB2 (gridDefYvals, GRIDDEFYVALS, griddefyvals, INT, PDOUBLE)
FCALLSCFUN2 (INT, gridInqYvals, GRIDINQYVALS, gridinqyvals, INT, PDOUBLE)
FCALLSCSUB2 (gridDefXname, GRIDDEFXNAME, griddefxname, INT, PSTRING)
FCALLSCSUB2 (gridDefXlongname, GRIDDEFXLONGNAME, griddefxlongname, INT, PSTRING)
FCALLSCSUB2 (gridDefXunits, GRIDDEFXUNITS, griddefxunits, INT, PSTRING)
FCALLSCSUB2 (gridDefYname, GRIDDEFYNAME, griddefyname, INT, PSTRING)
FCALLSCSUB2 (gridDefYlongname, GRIDDEFYLONGNAME, griddefylongname, INT, PSTRING)
FCALLSCSUB2 (gridDefYunits, GRIDDEFYUNITS, griddefyunits, INT, PSTRING)
FCALLSCSUB2 (gridDefXname, GRIDDEFXNAME, griddefxname, INT, STRING)
FCALLSCSUB2 (gridDefXlongname, GRIDDEFXLONGNAME, griddefxlongname, INT, STRING)
FCALLSCSUB2 (gridDefXunits, GRIDDEFXUNITS, griddefxunits, INT, STRING)
FCALLSCSUB2 (gridDefYname, GRIDDEFYNAME, griddefyname, INT, STRING)
FCALLSCSUB2 (gridDefYlongname, GRIDDEFYLONGNAME, griddefylongname, INT, STRING)
FCALLSCSUB2 (gridDefYunits, GRIDDEFYUNITS, griddefyunits, INT, STRING)
FCALLSCSUB2 (gridInqXname, GRIDINQXNAME, gridinqxname, INT, PSTRING)
FCALLSCSUB2 (gridInqXlongname, GRIDINQXLONGNAME, gridinqxlongname, INT, PSTRING)
FCALLSCSUB2 (gridInqXstdname, GRIDINQXSTDNAME, gridinqxstdname, INT, PSTRING)
......
src/stream.c
View file @ 82f1823d
......@@ -1537,7 +1537,7 @@ void streamReadVar(int streamID, int varID, double *data, int *nmiss)
@Function streamWriteVar
@Title Write a variable
@Prototype void streamWriteVar(int streamID, int varID, double *data, int nmiss)
@Prototype void streamWriteVar(int streamID, int varID, const double *data, int nmiss)
@Parameter
@Item streamID Stream ID, from a previous call to @fref{streamOpenRead} or @fref{streamOpenWrite}
@Item varID Variable identifier
......@@ -1701,7 +1701,7 @@ void streamReadVarSlice(int streamID, int varID, int levelID, double *data, int
@Function streamWriteVarSlice
@Title Write a horizontal slice of a variable
@Prototype void streamWriteVarSlice(int streamID, int varID, int levelID, double *data, int nmiss)
@Prototype void streamWriteVarSlice(int streamID, int varID, int levelID, const double *data, int nmiss)
@Parameter
@Item streamID Stream ID, from a previous call to @fref{streamOpenRead} or @fref{streamOpenWrite}
@Item varID Variable identifier
......
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

Imprint | Privacy Policy