diff options
Diffstat (limited to 'doc/latex/classIsisMainItemIterator.tex')
| -rw-r--r-- | doc/latex/classIsisMainItemIterator.tex | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/doc/latex/classIsisMainItemIterator.tex b/doc/latex/classIsisMainItemIterator.tex new file mode 100644 index 0000000..e89dc99 --- /dev/null +++ b/doc/latex/classIsisMainItemIterator.tex @@ -0,0 +1,82 @@ +\hypertarget{classIsisMainItemIterator}{ +\section{IsisMainItemIterator Class Reference} +\label{classIsisMainItemIterator}\index{IsisMainItemIterator@{IsisMainItemIterator}} +} +\subsection*{Public Member Functions} +\begin{DoxyCompactItemize} +\item +\hyperlink{classIsisMainItemIterator_a486e2d00fe13ed908b7384d64fd5f6f0}{\_\-\_\-construct} (\$class, \$field) +\item +\hyperlink{classIsisMainItemIterator_a37bf1484646334c5c41d3f7f50558b07}{rewind} () +\item +\hyperlink{classIsisMainItemIterator_a3676fc993eb38641c65363f2e05873f3}{key} () +\item +\hyperlink{classIsisMainItemIterator_adab612db1a4e1f16c6bc5848c3d4ee21}{current} () +\item +\hyperlink{classIsisMainItemIterator_af63043a1ab350854c0a30561ccb42dae}{next} () +\item +\hyperlink{classIsisMainItemIterator_a6c406f34a89316ff7e7fa15a80806b39}{has\_\-more\_\-rows} () +\item +\hyperlink{classIsisMainItemIterator_ad0f3d297912d5101d5227139f8414c80}{current\_\-null} () +\item +\hyperlink{classIsisMainItemIterator_a376387f6168a95890fc9f3a441967135}{valid} () +\end{DoxyCompactItemize} + + +\subsection{Detailed Description} +Isis field iterator. Iterates over all field main values for each result row. + +\subsection{Constructor \& Destructor Documentation} +\hypertarget{classIsisMainItemIterator_a486e2d00fe13ed908b7384d64fd5f6f0}{ +\index{IsisMainItemIterator@{IsisMainItemIterator}!\_\-\_\-construct@{\_\-\_\-construct}} +\index{\_\-\_\-construct@{\_\-\_\-construct}!IsisMainItemIterator@{IsisMainItemIterator}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field})}} +\label{classIsisMainItemIterator_a486e2d00fe13ed908b7384d64fd5f6f0} +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{classIsisMainItemIterator_adab612db1a4e1f16c6bc5848c3d4ee21}{ +\index{IsisMainItemIterator@{IsisMainItemIterator}!current@{current}} +\index{current@{current}!IsisMainItemIterator@{IsisMainItemIterator}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::current ()}} +\label{classIsisMainItemIterator_adab612db1a4e1f16c6bc5848c3d4ee21} +Return the current element. \hypertarget{classIsisMainItemIterator_ad0f3d297912d5101d5227139f8414c80}{ +\index{IsisMainItemIterator@{IsisMainItemIterator}!current\_\-null@{current\_\-null}} +\index{current\_\-null@{current\_\-null}!IsisMainItemIterator@{IsisMainItemIterator}} +\subsubsection[{current\_\-null}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::current\_\-null ()}} +\label{classIsisMainItemIterator_ad0f3d297912d5101d5227139f8414c80} +Check if the current value is null. \hypertarget{classIsisMainItemIterator_a6c406f34a89316ff7e7fa15a80806b39}{ +\index{IsisMainItemIterator@{IsisMainItemIterator}!has\_\-more\_\-rows@{has\_\-more\_\-rows}} +\index{has\_\-more\_\-rows@{has\_\-more\_\-rows}!IsisMainItemIterator@{IsisMainItemIterator}} +\subsubsection[{has\_\-more\_\-rows}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::has\_\-more\_\-rows ()}} +\label{classIsisMainItemIterator_a6c406f34a89316ff7e7fa15a80806b39} +Check if there are more rows. \hypertarget{classIsisMainItemIterator_a3676fc993eb38641c65363f2e05873f3}{ +\index{IsisMainItemIterator@{IsisMainItemIterator}!key@{key}} +\index{key@{key}!IsisMainItemIterator@{IsisMainItemIterator}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::key ()}} +\label{classIsisMainItemIterator_a3676fc993eb38641c65363f2e05873f3} +Return the key of the current element. \hypertarget{classIsisMainItemIterator_af63043a1ab350854c0a30561ccb42dae}{ +\index{IsisMainItemIterator@{IsisMainItemIterator}!next@{next}} +\index{next@{next}!IsisMainItemIterator@{IsisMainItemIterator}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::next ()}} +\label{classIsisMainItemIterator_af63043a1ab350854c0a30561ccb42dae} +Move forward to next element. \hypertarget{classIsisMainItemIterator_a37bf1484646334c5c41d3f7f50558b07}{ +\index{IsisMainItemIterator@{IsisMainItemIterator}!rewind@{rewind}} +\index{rewind@{rewind}!IsisMainItemIterator@{IsisMainItemIterator}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::rewind ()}} +\label{classIsisMainItemIterator_a37bf1484646334c5c41d3f7f50558b07} +Rewind the Iterator to the first element. \hypertarget{classIsisMainItemIterator_a376387f6168a95890fc9f3a441967135}{ +\index{IsisMainItemIterator@{IsisMainItemIterator}!valid@{valid}} +\index{valid@{valid}!IsisMainItemIterator@{IsisMainItemIterator}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisMainItemIterator::valid ()}} +\label{classIsisMainItemIterator_a376387f6168a95890fc9f3a441967135} +Check if there is a current element after calls to \hyperlink{classIsisMainItemIterator_a37bf1484646334c5c41d3f7f50558b07}{rewind()} or \hyperlink{classIsisMainItemIterator_af63043a1ab350854c0a30561ccb42dae}{next()}. + +The documentation for this class was generated from the following file:\begin{DoxyCompactItemize} +\item +classes/iterators/IsisMainItemIterator.php\end{DoxyCompactItemize} |