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