diff options
Diffstat (limited to 'doc/latex/classIsisEntryIterator.tex')
| -rw-r--r-- | doc/latex/classIsisEntryIterator.tex | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/latex/classIsisEntryIterator.tex b/doc/latex/classIsisEntryIterator.tex new file mode 100644 index 0000000..07f9418 --- /dev/null +++ b/doc/latex/classIsisEntryIterator.tex @@ -0,0 +1,68 @@ +\hypertarget{classIsisEntryIterator}{ +\section{IsisEntryIterator Class Reference} +\label{classIsisEntryIterator}\index{IsisEntryIterator@{IsisEntryIterator}} +} +\subsection*{Public Member Functions} +\begin{DoxyCompactItemize} +\item +\hyperlink{classIsisEntryIterator_a056fcc7d817523faf1fb033fa9f8ad6e}{\_\-\_\-construct} (\$class, \$entry=1) +\item +\hyperlink{classIsisEntryIterator_a985e88cdfb69b42e3389f24c08b2404a}{rewind} () +\item +\hyperlink{classIsisEntryIterator_a4a740dacedb86023ece4561092c33a65}{key} () +\item +\hyperlink{classIsisEntryIterator_ac482f43403fc4d2e1b620fb4e0f6797f}{current} () +\item +\hyperlink{classIsisEntryIterator_a2d1d0fe5d3c22d1720e93e03952b877d}{next} () +\item +\hyperlink{classIsisEntryIterator_aff9e54b112cc728b7cd6cf00c0359c49}{valid} () +\end{DoxyCompactItemize} + + +\subsection{Detailed Description} +Isis entry iterator. Iterates over all entries in the database. + +\subsection{Constructor \& Destructor Documentation} +\hypertarget{classIsisEntryIterator_a056fcc7d817523faf1fb033fa9f8ad6e}{ +\index{IsisEntryIterator@{IsisEntryIterator}!\_\-\_\-construct@{\_\-\_\-construct}} +\index{\_\-\_\-construct@{\_\-\_\-construct}!IsisEntryIterator@{IsisEntryIterator}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em entry} = {\ttfamily 1})}} +\label{classIsisEntryIterator_a056fcc7d817523faf1fb033fa9f8ad6e} +Constructor. + + +\begin{DoxyParams}{Parameters} +\item[{\em \$class}]Instance of \hyperlink{classIsisConnector}{IsisConnector} or child class.\item[{\em \$entry}]Start entry number to iterate from. \end{DoxyParams} + + +\subsection{Member Function Documentation} +\hypertarget{classIsisEntryIterator_ac482f43403fc4d2e1b620fb4e0f6797f}{ +\index{IsisEntryIterator@{IsisEntryIterator}!current@{current}} +\index{current@{current}!IsisEntryIterator@{IsisEntryIterator}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::current ()}} +\label{classIsisEntryIterator_ac482f43403fc4d2e1b620fb4e0f6797f} +Return the current element. \hypertarget{classIsisEntryIterator_a4a740dacedb86023ece4561092c33a65}{ +\index{IsisEntryIterator@{IsisEntryIterator}!key@{key}} +\index{key@{key}!IsisEntryIterator@{IsisEntryIterator}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::key ()}} +\label{classIsisEntryIterator_a4a740dacedb86023ece4561092c33a65} +Return the key of the current element. \hypertarget{classIsisEntryIterator_a2d1d0fe5d3c22d1720e93e03952b877d}{ +\index{IsisEntryIterator@{IsisEntryIterator}!next@{next}} +\index{next@{next}!IsisEntryIterator@{IsisEntryIterator}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::next ()}} +\label{classIsisEntryIterator_a2d1d0fe5d3c22d1720e93e03952b877d} +Move forward to next element. \hypertarget{classIsisEntryIterator_a985e88cdfb69b42e3389f24c08b2404a}{ +\index{IsisEntryIterator@{IsisEntryIterator}!rewind@{rewind}} +\index{rewind@{rewind}!IsisEntryIterator@{IsisEntryIterator}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::rewind ()}} +\label{classIsisEntryIterator_a985e88cdfb69b42e3389f24c08b2404a} +Rewind the Iterator to the first element. \hypertarget{classIsisEntryIterator_aff9e54b112cc728b7cd6cf00c0359c49}{ +\index{IsisEntryIterator@{IsisEntryIterator}!valid@{valid}} +\index{valid@{valid}!IsisEntryIterator@{IsisEntryIterator}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisEntryIterator::valid ()}} +\label{classIsisEntryIterator_aff9e54b112cc728b7cd6cf00c0359c49} +Check if there is a current element after calls to \hyperlink{classIsisEntryIterator_a985e88cdfb69b42e3389f24c08b2404a}{rewind()} or \hyperlink{classIsisEntryIterator_a2d1d0fe5d3c22d1720e93e03952b877d}{next()}. + +The documentation for this class was generated from the following file:\begin{DoxyCompactItemize} +\item +classes/iterators/IsisEntryIterator.php\end{DoxyCompactItemize} |