Skip to content

GitLab

Commit 9be178d3 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

docu update

parent 30c9bac5
Hide whitespace changes
Inline Side-by-side
doc/tex/FUNCTIONS
View file @ 9be178d3
......@@ -17,12 +17,15 @@ Function catalog:
streamInqVlist Get the variable list
streamDefTimestep Define time step
streamInqTimestep Get time step
streamReadVar Read a variable
streamReadVarSlice Read a horizontal slice of a variable
-------------------------------------------------------------
stream_write
-------------------------------------------------------------
streamWriteVar Write a variable
streamWriteVarF Write a variable
streamReadVar Read a variable
streamWriteVarSlice Write a horizontal slice of a variable
streamWriteVarSliceF Write a horizontal slice of a variable
streamReadVarSlice Read a horizontal slice of a variable
-------------------------------------------------------------
stream_record
-------------------------------------------------------------
......
doc/tex/Modules
View file @ 9be178d3
......@@ -8,12 +8,12 @@ streamDefVlist stream
streamInqVlist stream
streamDefTimestep stream
streamInqTimestep stream
streamWriteVar stream
streamWriteVarF stream
streamReadVar stream
streamWriteVarSlice stream
streamWriteVarSliceF stream
streamReadVarSlice stream
streamWriteVar stream_write
streamWriteVarF stream_write
streamWriteVarSlice stream_write
streamWriteVarSliceF stream_write
streamDefRecord stream_record
streamInqRecord stream_record
streamWriteRecord stream_record
......
doc/tex/c_stream.tex
View file @ 9be178d3
......@@ -331,61 +331,6 @@ Timestep identifier.
\subsection{Write a variable: {\tt streamWriteVar}}
\index{streamWriteVar}
\label{streamWriteVar}
The function streamWriteVar writes the values of one time step of a variable to an open dataset.
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);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt streamID\ }
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}.
\item[{\tt varID}]
Variable identifier.
\item[{\tt data}]
Pointer to a block of double precision floating point data values to be written.
\item[{\tt nmiss}]
Number of missing values.
\end{deflist}
\end{minipage}
\subsection{Write a variable: {\tt streamWriteVarF}}
\index{streamWriteVarF}
\label{streamWriteVarF}
The function streamWriteVarF writes the values of one time step of a variable to an open dataset.
The values are converted to the external data type of the variable, if necessary.
Only support for netCDF was implemented in this function.
\subsubsection*{Usage}
\begin{verbatim}
void streamWriteVarF(int streamID, int varID, const float *data, int nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt streamID\ }
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}.
\item[{\tt varID}]
Variable identifier.
\item[{\tt data}]
Pointer to a block of single precision floating point data values to be written.
\item[{\tt nmiss}]
Number of missing values.
\end{deflist}
\end{minipage}
\subsection{Read a variable: {\tt streamReadVar}}
\index{streamReadVar}
\label{streamReadVar}
......@@ -414,67 +359,6 @@ Number of missing values.
\end{minipage}
\subsection{Write a horizontal slice of a variable: {\tt streamWriteVarSlice}}
\index{streamWriteVarSlice}
\label{streamWriteVarSlice}
The function streamWriteVarSlice writes the values of a horizontal slice of a variable to an open dataset.
The values are converted to the external data type of the variable, if necessary.
\subsubsection*{Usage}
\begin{verbatim}
void streamWriteVarSlice(int streamID, int varID, int levelID, const double *data,
int nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt streamID\ }
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}.
\item[{\tt varID}]
Variable identifier.
\item[{\tt levelID}]
Level identifier.
\item[{\tt data}]
Pointer to a block of double precision floating point data values to be written.
\item[{\tt nmiss}]
Number of missing values.
\end{deflist}
\end{minipage}
\subsection{Write a horizontal slice of a variable: {\tt streamWriteVarSliceF}}
\index{streamWriteVarSliceF}
\label{streamWriteVarSliceF}
The function streamWriteVarSliceF writes the values of a horizontal slice of a variable to an open dataset.
The values are converted to the external data type of the variable, if necessary.
Only support for netCDF was implemented in this function.
\subsubsection*{Usage}
\begin{verbatim}
void streamWriteVarSliceF(int streamID, int varID, int levelID, const float *data,
int nmiss);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt streamID\ }
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}.
\item[{\tt varID}]
Variable identifier.
\item[{\tt levelID}]
Level identifier.
\item[{\tt data}]
Pointer to a block of single precision floating point data values to be written.
\item[{\tt nmiss}]
Number of missing values.
\end{deflist}
\end{minipage}
\subsection{Read a horizontal slice of a variable: {\tt streamReadVarSlice}}
\index{streamReadVarSlice}
\label{streamReadVarSlice}
......
doc/tex/cdi_cman.tex
View file @ 9be178d3
......@@ -174,6 +174,7 @@
\section{Dataset functions}
\input{dataset}
\input{c_stream}
\input{c_stream_write}
\newpage
......
doc/tex/cdi_fman.tex
View file @ 9be178d3
......@@ -171,6 +171,7 @@
\section{Dataset functions}
\input{dataset}
\input{f_stream}
\input{f_stream_write}
\newpage
......
doc/tex/f_stream.tex
View file @ 9be178d3
......@@ -331,63 +331,6 @@ Timestep identifier.
\subsection{Write a variable: {\tt streamWriteVar}}
\index{streamWriteVar}
\label{streamWriteVar}
The function streamWriteVar writes the values of one time step of a variable to an open dataset.
The values are converted to the external data type of the variable, if necessary.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE streamWriteVar(INTEGER streamID, INTEGER varID, REAL*8 data,
INTEGER nmiss)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt streamID\ }
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}.
\item[{\tt varID}]
Variable identifier.
\item[{\tt data}]
Pointer to a block of double precision floating point data values to be written.
\item[{\tt nmiss}]
Number of missing values.
\end{deflist}
\end{minipage}
\subsection{Write a variable: {\tt streamWriteVarF}}
\index{streamWriteVarF}
\label{streamWriteVarF}
The function streamWriteVarF writes the values of one time step of a variable to an open dataset.
The values are converted to the external data type of the variable, if necessary.
Only support for netCDF was implemented in this function.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE streamWriteVarF(INTEGER streamID, INTEGER varID, REAL*4 data,
INTEGER nmiss)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt streamID\ }
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}.
\item[{\tt varID}]
Variable identifier.
\item[{\tt data}]
Pointer to a block of single precision floating point data values to be written.
\item[{\tt nmiss}]
Number of missing values.
\end{deflist}
\end{minipage}
\subsection{Read a variable: {\tt streamReadVar}}
\index{streamReadVar}
\label{streamReadVar}
......@@ -417,67 +360,6 @@ Number of missing values.
\end{minipage}
\subsection{Write a horizontal slice of a variable: {\tt streamWriteVarSlice}}
\index{streamWriteVarSlice}
\label{streamWriteVarSlice}
The function streamWriteVarSlice writes the values of a horizontal slice of a variable to an open dataset.
The values are converted to the external data type of the variable, if necessary.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE streamWriteVarSlice(INTEGER streamID, INTEGER varID, INTEGER levelID,
REAL*8 data, INTEGER nmiss)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt streamID\ }
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}.
\item[{\tt varID}]
Variable identifier.
\item[{\tt levelID}]
Level identifier.
\item[{\tt data}]
Pointer to a block of double precision floating point data values to be written.
\item[{\tt nmiss}]
Number of missing values.
\end{deflist}
\end{minipage}
\subsection{Write a horizontal slice of a variable: {\tt streamWriteVarSliceF}}
\index{streamWriteVarSliceF}
\label{streamWriteVarSliceF}
The function streamWriteVarSliceF writes the values of a horizontal slice of a variable to an open dataset.
The values are converted to the external data type of the variable, if necessary.
Only support for netCDF was implemented in this function.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE streamWriteVarSliceF(INTEGER streamID, INTEGER varID, INTEGER levelID,
REAL*4 data, INTEGER nmiss)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt streamID\ }
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}.
\item[{\tt varID}]
Variable identifier.
\item[{\tt levelID}]
Level identifier.
\item[{\tt data}]
Pointer to a block of single precision floating point data values to be written.
\item[{\tt nmiss}]
Number of missing values.
\end{deflist}
\end{minipage}
\subsection{Read a horizontal slice of a variable: {\tt streamReadVarSlice}}
\index{streamReadVarSlice}
\label{streamReadVarSlice}
......
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