Commit 64ab01e3 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update.

parent 5f22d10b
......@@ -15,8 +15,8 @@ Function catalog:
streamInqByteorder Get the byte order
streamDefVlist Define the variable list
streamInqVlist Get the variable list
streamDefTimestep Define time step
streamInqTimestep Get time step
streamDefTimestep Define a timestep
streamInqTimestep Get timestep information
-------------------------------------------------------------
stream_write
-------------------------------------------------------------
......
......@@ -763,7 +763,7 @@ streamDefTimestep
int streamDefTimestep(int streamID, int tsID);
\end{verbatim}
Define time step
Define a timestep
\ifpdfoutput{}{(\ref{streamDefTimestep})}
......@@ -823,7 +823,7 @@ streamInqTimestep
int streamInqTimestep(int streamID, int tsID);
\end{verbatim}
Get time step
Get timestep information
\ifpdfoutput{}{(\ref{streamInqTimestep})}
......
......@@ -279,11 +279,14 @@ Stream ID, from a previous call to {\htmlref{\texttt{streamOpenRead}}{streamOpen
\subsection{Define time step: \texttt{streamDefTimestep}}
\subsection{Define a timestep: \texttt{streamDefTimestep}}
\index{streamDefTimestep}
\label{streamDefTimestep}
The function {\texttt{streamDefTimestep}} defines the time step of a stream.
The function {\texttt{streamDefTimestep}} defines a timestep of a stream by the identifier tsID.
The identifier tsID is the timestep index starting at 0 for the first timestep.
Before calling this function the functions {\texttt{taxisDefVdate}} and {\texttt{taxisDefVtime}} should be used
to define the timestamp for this timestep. All calls to write the data refer to this timestep.
\subsubsection*{Usage}
......@@ -303,15 +306,18 @@ Timestep identifier.
\subsubsection*{Result}
{\texttt{streamDefTimestep}} returns the number of records of the time step.
{\texttt{streamDefTimestep}} returns the number of expected records of the timestep.
\subsection{Get time step: \texttt{streamInqTimestep}}
\subsection{Get timestep information: \texttt{streamInqTimestep}}
\index{streamInqTimestep}
\label{streamInqTimestep}
The function {\texttt{streamInqTimestep}} returns the time step of a stream.
The function {\texttt{streamInqTimestep}} sets the next timestep to the identifier tsID.
The identifier tsID is the timestep index starting at 0 for the first timestep.
After a call to this function the functions {\texttt{taxisInqVdate}} and {\texttt{taxisInqVtime}} can be used
to read the timestamp for this timestep. All calls to read the data refer to this timestep.
\subsubsection*{Usage}
......@@ -331,5 +337,5 @@ Timestep identifier.
\subsubsection*{Result}
{\texttt{streamInqTimestep}} returns the number of records of the time step.
{\texttt{streamInqTimestep}} returns the number of records of the timestep or 0, if the end of the file is reached.
......@@ -768,7 +768,7 @@ streamDefTimestep
INTEGER FUNCTION streamDefTimestep(INTEGER streamID, INTEGER tsID)
\end{verbatim}
Define time step
Define a timestep
\ifpdfoutput{}{(\ref{streamDefTimestep})}
......@@ -828,7 +828,7 @@ streamInqTimestep
INTEGER FUNCTION streamInqTimestep(INTEGER streamID, INTEGER tsID)
\end{verbatim}
Get time step
Get timestep information
\ifpdfoutput{}{(\ref{streamInqTimestep})}
......
......@@ -279,11 +279,14 @@ Stream ID, from a previous call to {\htmlref{\texttt{streamOpenRead}}{streamOpen
\subsection{Define time step: \texttt{streamDefTimestep}}
\subsection{Define a timestep: \texttt{streamDefTimestep}}
\index{streamDefTimestep}
\label{streamDefTimestep}
The function {\texttt{streamDefTimestep}} defines the time step of a stream.
The function {\texttt{streamDefTimestep}} defines a timestep of a stream by the identifier tsID.
The identifier tsID is the timestep index starting at 0 for the first timestep.
Before calling this function the functions {\texttt{taxisDefVdate}} and {\texttt{taxisDefVtime}} should be used
to define the timestamp for this timestep. All calls to write the data refer to this timestep.
\subsubsection*{Usage}
......@@ -303,15 +306,18 @@ Timestep identifier.
\subsubsection*{Result}
{\texttt{streamDefTimestep}} returns the number of records of the time step.
{\texttt{streamDefTimestep}} returns the number of expected records of the timestep.
\subsection{Get time step: \texttt{streamInqTimestep}}
\subsection{Get timestep information: \texttt{streamInqTimestep}}
\index{streamInqTimestep}
\label{streamInqTimestep}
The function {\texttt{streamInqTimestep}} returns the time step of a stream.
The function {\texttt{streamInqTimestep}} sets the next timestep to the identifier tsID.
The identifier tsID is the timestep index starting at 0 for the first timestep.
After a call to this function the functions {\texttt{taxisInqVdate}} and {\texttt{taxisInqVtime}} can be used
to read the timestamp for this timestep. All calls to read the data refer to this timestep.
\subsubsection*{Usage}
......@@ -331,5 +337,5 @@ Timestep identifier.
\subsubsection*{Result}
{\texttt{streamInqTimestep}} returns the number of records of the time step.
{\texttt{streamInqTimestep}} returns the number of records of the timestep or 0, if the end of the file is reached.
......@@ -1214,7 +1214,7 @@ int cdiStreamDefTimestep_(stream_t *streamptr, int tsID)
/*
@Function streamDefTimestep
@Title Define time step
@Title Define a timestep
@Prototype int streamDefTimestep(int streamID, int tsID)
@Parameter
......@@ -1222,10 +1222,13 @@ int cdiStreamDefTimestep_(stream_t *streamptr, int tsID)
@Item tsID Timestep identifier.
@Description
The function @func{streamDefTimestep} defines the time step of a stream.
The function @func{streamDefTimestep} defines a timestep of a stream by the identifier tsID.
The identifier tsID is the timestep index starting at 0 for the first timestep.
Before calling this function the functions @func{taxisDefVdate} and @func{taxisDefVtime} should be used
to define the timestamp for this timestep. All calls to write the data refer to this timestep.
@Result
@func{streamDefTimestep} returns the number of records of the time step.
@func{streamDefTimestep} returns the number of expected records of the timestep.
@EndFunction
*/
......@@ -1247,7 +1250,7 @@ int streamInqCurTimestepID(int streamID)
/*
@Function streamInqTimestep
@Title Get time step
@Title Get timestep information
@Prototype int streamInqTimestep(int streamID, int tsID)
@Parameter
......@@ -1255,10 +1258,13 @@ int streamInqCurTimestepID(int streamID)
@Item tsID Timestep identifier.
@Description
The function @func{streamInqTimestep} returns the time step of a stream.
The function @func{streamInqTimestep} sets the next timestep to the identifier tsID.
The identifier tsID is the timestep index starting at 0 for the first timestep.
After a call to this function the functions @func{taxisInqVdate} and @func{taxisInqVtime} can be used
to read the timestamp for this timestep. All calls to read the data refer to this timestep.
@Result
@func{streamInqTimestep} returns the number of records of the time step.
@func{streamInqTimestep} returns the number of records of the timestep or 0, if the end of the file is reached.
@EndFunction
*/
......
Supports Markdown
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