diff options
Diffstat (limited to 'doc/latex/classIsisSubfieldIterator.tex')
| -rw-r--r-- | doc/latex/classIsisSubfieldIterator.tex | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/latex/classIsisSubfieldIterator.tex b/doc/latex/classIsisSubfieldIterator.tex new file mode 100644 index 0000000..9f2f193 --- /dev/null +++ b/doc/latex/classIsisSubfieldIterator.tex @@ -0,0 +1,68 @@ +\hypertarget{classIsisSubfieldIterator}{ +\section{IsisSubfieldIterator Class Reference} +\label{classIsisSubfieldIterator}\index{IsisSubfieldIterator@{IsisSubfieldIterator}} +} +\subsection*{Public Member Functions} +\begin{DoxyCompactItemize} +\item +\hyperlink{classIsisSubfieldIterator_adc5472ca67d20defcab9eba45975dc29}{\_\-\_\-construct} (\$class, \$field, \$main=false) +\item +\hyperlink{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}{rewind} () +\item +\hyperlink{classIsisSubfieldIterator_a4ee62ad436a7c4ec1dac0c0c5d2a2c85}{key} () +\item +\hyperlink{classIsisSubfieldIterator_a7c31b7e8db31e1465d29fb58b2448bd8}{current} () +\item +\hyperlink{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}{next} () +\item +\hyperlink{classIsisSubfieldIterator_a1934438bfdfa1827e6bcc71d3c90f2db}{valid} () +\end{DoxyCompactItemize} + + +\subsection{Detailed Description} +Isis subfield iterator. Iterates over subfields for each result row. + +\subsection{Constructor \& Destructor Documentation} +\hypertarget{classIsisSubfieldIterator_adc5472ca67d20defcab9eba45975dc29}{ +\index{IsisSubfieldIterator@{IsisSubfieldIterator}!\_\-\_\-construct@{\_\-\_\-construct}} +\index{\_\-\_\-construct@{\_\-\_\-construct}!IsisSubfieldIterator@{IsisSubfieldIterator}} +\subsubsection[{\_\-\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::\_\-\_\-construct (\$ {\em class}, \/ \$ {\em field}, \/ \$ {\em main} = {\ttfamily false})}} +\label{classIsisSubfieldIterator_adc5472ca67d20defcab9eba45975dc29} +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 subfield the main field should be mapped to. By default no mapping is made. \end{DoxyParams} + + +\subsection{Member Function Documentation} +\hypertarget{classIsisSubfieldIterator_a7c31b7e8db31e1465d29fb58b2448bd8}{ +\index{IsisSubfieldIterator@{IsisSubfieldIterator}!current@{current}} +\index{current@{current}!IsisSubfieldIterator@{IsisSubfieldIterator}} +\subsubsection[{current}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::current ()}} +\label{classIsisSubfieldIterator_a7c31b7e8db31e1465d29fb58b2448bd8} +Return the current element. \hypertarget{classIsisSubfieldIterator_a4ee62ad436a7c4ec1dac0c0c5d2a2c85}{ +\index{IsisSubfieldIterator@{IsisSubfieldIterator}!key@{key}} +\index{key@{key}!IsisSubfieldIterator@{IsisSubfieldIterator}} +\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::key ()}} +\label{classIsisSubfieldIterator_a4ee62ad436a7c4ec1dac0c0c5d2a2c85} +Return the key of the current element. \hypertarget{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}{ +\index{IsisSubfieldIterator@{IsisSubfieldIterator}!next@{next}} +\index{next@{next}!IsisSubfieldIterator@{IsisSubfieldIterator}} +\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::next ()}} +\label{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371} +Move forward to next element. \hypertarget{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}{ +\index{IsisSubfieldIterator@{IsisSubfieldIterator}!rewind@{rewind}} +\index{rewind@{rewind}!IsisSubfieldIterator@{IsisSubfieldIterator}} +\subsubsection[{rewind}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::rewind ()}} +\label{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40} +Rewind the Iterator to the first element. \hypertarget{classIsisSubfieldIterator_a1934438bfdfa1827e6bcc71d3c90f2db}{ +\index{IsisSubfieldIterator@{IsisSubfieldIterator}!valid@{valid}} +\index{valid@{valid}!IsisSubfieldIterator@{IsisSubfieldIterator}} +\subsubsection[{valid}]{\setlength{\rightskip}{0pt plus 5cm}IsisSubfieldIterator::valid ()}} +\label{classIsisSubfieldIterator_a1934438bfdfa1827e6bcc71d3c90f2db} +Check if there is a current element after calls to \hyperlink{classIsisSubfieldIterator_a971b36317fab4fc07573f215a118fb40}{rewind()} or \hyperlink{classIsisSubfieldIterator_a74363e3dbfbde6d409b8ba3b70fc9371}{next()}. + +The documentation for this class was generated from the following file:\begin{DoxyCompactItemize} +\item +classes/iterators/IsisSubfieldIterator.php\end{DoxyCompactItemize} |