diff options
Diffstat (limited to 'doc/latex/classIsisRowIterator.tex')
| -rw-r--r-- | doc/latex/classIsisRowIterator.tex | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/latex/classIsisRowIterator.tex b/doc/latex/classIsisRowIterator.tex new file mode 100644 index 0000000..ead6d26 --- /dev/null +++ b/doc/latex/classIsisRowIterator.tex @@ -0,0 +1,68 @@ +\hypertarget{classIsisRowIterator}{ +\section{IsisRowIterator Class Reference} +\label{classIsisRowIterator}\index{IsisRowIterator@{IsisRowIterator}} +} +\subsection*{Public Member Functions} +\begin{DoxyCompactItemize} +\item +\hyperlink{classIsisRowIterator_acaab99d2bf18f6f958ddf07db55cb15d}{\_\-\_\-construct} (\$class, \$field) +\item +\hyperlink{classIsisRowIterator_a5ef72f942cc738bf24cf251018c28edf}{rewind} () +\item +\hyperlink{classIsisRowIterator_a96f65bca7f2e048a449e6f316d802e6f}{key} () +\item +\hyperlink{classIsisRowIterator_abe18cfd484f70348fb5832444186b10d}{current} () +\item +\hyperlink{classIsisRowIterator_ad084ce947a265969f738e7d7dc8a1853}{next} () +\item +\hyperlink{classIsisRowIterator_a69cb2b1c6e8feaffcfe65363a9178b72}{valid} () +\end{DoxyCompactItemize} + + +\subsection{Detailed Description} +Iterates over all rows from a field result. + +\subsection{Constructor \& Destructor Documentation} +\hypertarget{classIsisRowIterator_acaab99d2bf18f6f958ddf07db55cb15d}{ +\index{IsisRowIterator@{IsisRowIterator}!\_\-\_\-construct@{\_\-\_\-construct}} +\index{\_\-\_\-construct@{\_\-\_\-construct}!IsisRowIterator@{IsisRowIterator}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field})}} +\label{classIsisRowIterator_acaab99d2bf18f6f958ddf07db55cb15d} +Constructor. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$class}]Instance of \hyperlink{classIsisConnector}{IsisConnector} or child class.\item[{\em \$field}]Field to iterate over. \end{DoxyParams} + + +\subsection{Member Function Documentation} +\hypertarget{classIsisRowIterator_abe18cfd484f70348fb5832444186b10d}{ +\index{IsisRowIterator@{IsisRowIterator}!current@{current}} +\index{current@{current}!IsisRowIterator@{IsisRowIterator}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::current ()}} +\label{classIsisRowIterator_abe18cfd484f70348fb5832444186b10d} +Return the current element. \hypertarget{classIsisRowIterator_a96f65bca7f2e048a449e6f316d802e6f}{ +\index{IsisRowIterator@{IsisRowIterator}!key@{key}} +\index{key@{key}!IsisRowIterator@{IsisRowIterator}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::key ()}} +\label{classIsisRowIterator_a96f65bca7f2e048a449e6f316d802e6f} +Return the key of the current element. \hypertarget{classIsisRowIterator_ad084ce947a265969f738e7d7dc8a1853}{ +\index{IsisRowIterator@{IsisRowIterator}!next@{next}} +\index{next@{next}!IsisRowIterator@{IsisRowIterator}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::next ()}} +\label{classIsisRowIterator_ad084ce947a265969f738e7d7dc8a1853} +Move forward to next element. \hypertarget{classIsisRowIterator_a5ef72f942cc738bf24cf251018c28edf}{ +\index{IsisRowIterator@{IsisRowIterator}!rewind@{rewind}} +\index{rewind@{rewind}!IsisRowIterator@{IsisRowIterator}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::rewind ()}} +\label{classIsisRowIterator_a5ef72f942cc738bf24cf251018c28edf} +Rewind the Iterator to the first element. \hypertarget{classIsisRowIterator_a69cb2b1c6e8feaffcfe65363a9178b72}{ +\index{IsisRowIterator@{IsisRowIterator}!valid@{valid}} +\index{valid@{valid}!IsisRowIterator@{IsisRowIterator}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisRowIterator::valid ()}} +\label{classIsisRowIterator_a69cb2b1c6e8feaffcfe65363a9178b72} +Check if there is a current element after calls to \hyperlink{classIsisRowIterator_a5ef72f942cc738bf24cf251018c28edf}{rewind()} or \hyperlink{classIsisRowIterator_ad084ce947a265969f738e7d7dc8a1853}{next()}. + +The documentation for this class was generated from the following file:\begin{DoxyCompactItemize} +\item +classes/iterators/IsisRowIterator.php\end{DoxyCompactItemize} |