diff options
Diffstat (limited to 'doc/latex/classIsisItemIterator.tex')
| -rw-r--r-- | doc/latex/classIsisItemIterator.tex | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/latex/classIsisItemIterator.tex b/doc/latex/classIsisItemIterator.tex new file mode 100644 index 0000000..ba95027 --- /dev/null +++ b/doc/latex/classIsisItemIterator.tex @@ -0,0 +1,68 @@ +\hypertarget{classIsisItemIterator}{ +\section{IsisItemIterator Class Reference} +\label{classIsisItemIterator}\index{IsisItemIterator@{IsisItemIterator}} +} +\subsection*{Public Member Functions} +\begin{DoxyCompactItemize} +\item +\hyperlink{classIsisItemIterator_a6ee7fe126baaffa77ad2cf177fefc46a}{\_\-\_\-construct} (\$class, \$field, \$main=false) +\item +\hyperlink{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c}{rewind} () +\item +\hyperlink{classIsisItemIterator_ab51757f546b7d9efb9decd701a38b8b5}{key} () +\item +\hyperlink{classIsisItemIterator_a3f602399a600d7b95d23b87111d0e72b}{current} () +\item +\hyperlink{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23}{next} () +\item +\hyperlink{classIsisItemIterator_aacea6ed6fd269ef1549ce86820da8b3b}{valid} () +\end{DoxyCompactItemize} + + +\subsection{Detailed Description} +Isis field iterator. Iterates over a field for each result row. + +\subsection{Constructor \& Destructor Documentation} +\hypertarget{classIsisItemIterator_a6ee7fe126baaffa77ad2cf177fefc46a}{ +\index{IsisItemIterator@{IsisItemIterator}!\_\-\_\-construct@{\_\-\_\-construct}} +\index{\_\-\_\-construct@{\_\-\_\-construct}!IsisItemIterator@{IsisItemIterator}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field}, \/ \$ {\em main} = {\ttfamily false})}} +\label{classIsisItemIterator_a6ee7fe126baaffa77ad2cf177fefc46a} +Constructor. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$class}]Instance of \hyperlink{classIsisConnector}{IsisConnector} or child class.\item[{\em \$field}]Field to iterate over.\item[{\em \$main}]Control to which item the main field should be mapped to. By default no mapping is made. \end{DoxyParams} + + +\subsection{Member Function Documentation} +\hypertarget{classIsisItemIterator_a3f602399a600d7b95d23b87111d0e72b}{ +\index{IsisItemIterator@{IsisItemIterator}!current@{current}} +\index{current@{current}!IsisItemIterator@{IsisItemIterator}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::current ()}} +\label{classIsisItemIterator_a3f602399a600d7b95d23b87111d0e72b} +Return the current element. \hypertarget{classIsisItemIterator_ab51757f546b7d9efb9decd701a38b8b5}{ +\index{IsisItemIterator@{IsisItemIterator}!key@{key}} +\index{key@{key}!IsisItemIterator@{IsisItemIterator}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::key ()}} +\label{classIsisItemIterator_ab51757f546b7d9efb9decd701a38b8b5} +Return the key of the current element. \hypertarget{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23}{ +\index{IsisItemIterator@{IsisItemIterator}!next@{next}} +\index{next@{next}!IsisItemIterator@{IsisItemIterator}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::next ()}} +\label{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23} +Move forward to next element. \hypertarget{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c}{ +\index{IsisItemIterator@{IsisItemIterator}!rewind@{rewind}} +\index{rewind@{rewind}!IsisItemIterator@{IsisItemIterator}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::rewind ()}} +\label{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c} +Rewind the Iterator to the first element. \hypertarget{classIsisItemIterator_aacea6ed6fd269ef1549ce86820da8b3b}{ +\index{IsisItemIterator@{IsisItemIterator}!valid@{valid}} +\index{valid@{valid}!IsisItemIterator@{IsisItemIterator}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisItemIterator::valid ()}} +\label{classIsisItemIterator_aacea6ed6fd269ef1549ce86820da8b3b} +Check if there is a current element after calls to \hyperlink{classIsisItemIterator_ab87a4387a9fd745366ccf8e138a9f60c}{rewind()} or \hyperlink{classIsisItemIterator_a17c6a2e50a0ca67feb92f4ffc4cbec23}{next()}. + +The documentation for this class was generated from the following file:\begin{DoxyCompactItemize} +\item +classes/iterators/IsisItemIterator.php\end{DoxyCompactItemize} |