aboutsummaryrefslogtreecommitdiff
path: root/doc/latex/classIsisMainItemIterator.tex
blob: 938cd8a95aa81ced303cdfaace8ac6db0ecc8c1a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
\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 (
\begin{DoxyParamCaption}
\item[{\$}]{ class, }
\item[{\$}]{ field}
\end{DoxyParamCaption}
)}}
\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 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\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 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\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 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\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 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\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 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\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 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\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 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\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}