classxapian_1_1valueiterator.tex

xapian 是一个“Xapian 是一个开源概率论信息检索库

\hypertarget{classXapian_1_1ValueIterator}{
\section{Xapian::Value\-Iterator Class Reference}
\label{classXapian_1_1ValueIterator}\index{Xapian::ValueIterator@{Xapian::ValueIterator}}
}
An iterator pointing to values associated with a document.  


{\tt \#include $<$valueiterator.h$>$}

Collaboration diagram for Xapian::Value\-Iterator:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=119pt]{classXapian_1_1ValueIterator__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{Indent}{\bf }\par
\begin{CompactItemize}
\item 
typedef std::input\_\-iterator\_\-tag \hyperlink{classXapian_1_1ValueIterator_1da37a84f67fd8d7d3e08888832cf377}{iterator\_\-category}
\begin{CompactList}\small\item\em Allow use as an STL iterator. \item\end{CompactList}\item 
\hypertarget{classXapian_1_1ValueIterator_536aa2f1f0f23f92f6142657eee46a54}{
typedef std::string {\bf value\_\-type}}
\label{classXapian_1_1ValueIterator_536aa2f1f0f23f92f6142657eee46a54}

\item 
\hypertarget{classXapian_1_1ValueIterator_ca06d4f04c5baf3cf34d66b98551fa2b}{
typedef \hyperlink{types_8h_609c717d551f258db5cc883c3861b645}{Xapian::valueno\_\-diff} {\bf difference\_\-type}}
\label{classXapian_1_1ValueIterator_ca06d4f04c5baf3cf34d66b98551fa2b}

\item 
\hypertarget{classXapian_1_1ValueIterator_db40fe08d83bdc1d65fe519fe35fa1ab}{
typedef std::string $\ast$ {\bf pointer}}
\label{classXapian_1_1ValueIterator_db40fe08d83bdc1d65fe519fe35fa1ab}

\item 
\hypertarget{classXapian_1_1ValueIterator_90768af03030ce243f4b8a12b367e08c}{
typedef std::string \& {\bf reference}}
\label{classXapian_1_1ValueIterator_90768af03030ce243f4b8a12b367e08c}

\end{CompactItemize}
\end{Indent}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hyperlink{classXapian_1_1ValueIterator_4084631b78f8c9f95b3bc1f5546549dc}{Value\-Iterator} ()
\begin{CompactList}\small\item\em Create an uninitialised iterator; this cannot be used, but is convenient syntactically. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1ValueIterator_2dffeba1d3c0236a2bcd6b37875a0339}{Value\-Iterator} (const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \&other)
\begin{CompactList}\small\item\em Copying is allowed (and is cheap). \item\end{CompactList}\item 
void \hyperlink{classXapian_1_1ValueIterator_e5be5bbe3384c1d4b906fee3f20484c5}{operator=} (const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \&other)
\begin{CompactList}\small\item\em Assignment is allowed (and is cheap). \item\end{CompactList}\item 
\hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \& \hyperlink{classXapian_1_1ValueIterator_e76c157616ca36ce63409846649fc666}{operator++} ()
\begin{CompactList}\small\item\em Advance the iterator. \item\end{CompactList}\item 
\hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \hyperlink{classXapian_1_1ValueIterator_b50314e623f3daa0973b073518d68339}{operator++} (int)
\begin{CompactList}\small\item\em Advance the iterator (postfix variant). \item\end{CompactList}\item 
const std::string \& \hyperlink{classXapian_1_1ValueIterator_22b178bd6e378eda4ef960833b14e9ed}{operator $\ast$} () const 
\begin{CompactList}\small\item\em Get the value for the current position. \item\end{CompactList}\item 
const std::string $\ast$ \hyperlink{classXapian_1_1ValueIterator_79c83ae1aceb06efa87404ee15ff2013}{operator $\rightarrow$ } () const 
\begin{CompactList}\small\item\em Get the value for the current position. \item\end{CompactList}\item 
\hyperlink{types_8h_f24564a367ebbc8f80cf9a1dbd1e81fd}{Xapian::valueno} \hyperlink{classXapian_1_1ValueIterator_7ad3cc981f6563e8d2d2d875bcee78a5}{get\_\-valueno} () const 
\begin{CompactList}\small\item\em Get the number of the value at the current position. \item\end{CompactList}\item 
std::string \hyperlink{classXapian_1_1ValueIterator_74bed1979654824aa8186c3708cfd921}{get\_\-description} () const 
\begin{CompactList}\small\item\em Returns a string describing this object. \item\end{CompactList}\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
\hypertarget{classXapian_1_1ValueIterator_883538034e58fc5c0de7d4e4cab3cef7}{
class {\bf Document}}
\label{classXapian_1_1ValueIterator_883538034e58fc5c0de7d4e4cab3cef7}

\item 
\hypertarget{classXapian_1_1ValueIterator_14e97982213500b544f69c4e86e6fbe3}{
bool {\bf operator==} (const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \&a, const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \&b)}
\label{classXapian_1_1ValueIterator_14e97982213500b544f69c4e86e6fbe3}

\item 
\hypertarget{classXapian_1_1ValueIterator_8c6a71ab54023ee8fd6d5dd1a47a5167}{
bool {\bf operator!=} (const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \&a, const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \&b)}
\label{classXapian_1_1ValueIterator_8c6a71ab54023ee8fd6d5dd1a47a5167}

\end{CompactItemize}


\subsection{Detailed Description}
An iterator pointing to values associated with a document. 



\subsection{Member Typedef Documentation}
\hypertarget{classXapian_1_1ValueIterator_1da37a84f67fd8d7d3e08888832cf377}{
\index{Xapian::ValueIterator@{Xapian::Value\-Iterator}!iterator_category@{iterator\_\-category}}
\index{iterator_category@{iterator\_\-category}!Xapian::ValueIterator@{Xapian::Value\-Iterator}}
\subsubsection[iterator\_\-category]{\setlength{\rightskip}{0pt plus 5cm}typedef std::input\_\-iterator\_\-tag \hyperlink{classXapian_1_1ValueIterator_1da37a84f67fd8d7d3e08888832cf377}{Xapian::Value\-Iterator::iterator\_\-category}}}
\label{classXapian_1_1ValueIterator_1da37a84f67fd8d7d3e08888832cf377}


Allow use as an STL iterator. 



\subsection{Constructor \& Destructor Documentation}
\hypertarget{classXapian_1_1ValueIterator_4084631b78f8c9f95b3bc1f5546549dc}{
\index{Xapian::ValueIterator@{Xapian::Value\-Iterator}!ValueIterator@{ValueIterator}}
\index{ValueIterator@{ValueIterator}!Xapian::ValueIterator@{Xapian::Value\-Iterator}}
\subsubsection[ValueIterator]{\setlength{\rightskip}{0pt plus 5cm}Xapian::Value\-Iterator::Value\-Iterator ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{classXapian_1_1ValueIterator_4084631b78f8c9f95b3bc1f5546549dc}


Create an uninitialised iterator; this cannot be used, but is convenient syntactically. 

\hypertarget{classXapian_1_1ValueIterator_2dffeba1d3c0236a2bcd6b37875a0339}{
\index{Xapian::ValueIterator@{Xapian::Value\-Iterator}!ValueIterator@{ValueIterator}}
\index{ValueIterator@{ValueIterator}!Xapian::ValueIterator@{Xapian::Value\-Iterator}}
\subsubsection[ValueIterator]{\setlength{\rightskip}{0pt plus 5cm}Xapian::Value\-Iterator::Value\-Iterator (const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \& {\em other})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{classXapian_1_1ValueIterator_2dffeba1d3c0236a2bcd6b37875a0339}


Copying is allowed (and is cheap). 



\subsection{Member Function Documentation}
\hypertarget{classXapian_1_1ValueIterator_74bed1979654824aa8186c3708cfd921}{
\index{Xapian::ValueIterator@{Xapian::Value\-Iterator}!get_description@{get\_\-description}}
\index{get_description@{get\_\-description}!Xapian::ValueIterator@{Xapian::Value\-Iterator}}
\subsubsection[get\_\-description]{\setlength{\rightskip}{0pt plus 5cm}std::string Xapian::Value\-Iterator::get\_\-description () const}}
\label{classXapian_1_1ValueIterator_74bed1979654824aa8186c3708cfd921}


Returns a string describing this object. 

Introspection method. \hypertarget{classXapian_1_1ValueIterator_7ad3cc981f6563e8d2d2d875bcee78a5}{
\index{Xapian::ValueIterator@{Xapian::Value\-Iterator}!get_valueno@{get\_\-valueno}}
\index{get_valueno@{get\_\-valueno}!Xapian::ValueIterator@{Xapian::Value\-Iterator}}
\subsubsection[get\_\-valueno]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{types_8h_f24564a367ebbc8f80cf9a1dbd1e81fd}{Xapian::valueno} Xapian::Value\-Iterator::get\_\-valueno () const}}
\label{classXapian_1_1ValueIterator_7ad3cc981f6563e8d2d2d875bcee78a5}


Get the number of the value at the current position. 

\hypertarget{classXapian_1_1ValueIterator_22b178bd6e378eda4ef960833b14e9ed}{
\index{Xapian::ValueIterator@{Xapian::Value\-Iterator}!operator *@{operator $\ast$}}
\index{operator *@{operator $\ast$}!Xapian::ValueIterator@{Xapian::Value\-Iterator}}
\subsubsection[operator $\ast$]{\setlength{\rightskip}{0pt plus 5cm}const std::string\& Xapian::Value\-Iterator::operator $\ast$ () const}}
\label{classXapian_1_1ValueIterator_22b178bd6e378eda4ef960833b14e9ed}


Get the value for the current position. 

\hypertarget{classXapian_1_1ValueIterator_b50314e623f3daa0973b073518d68339}{
\index{Xapian::ValueIterator@{Xapian::Value\-Iterator}!operator++@{operator++}}
\index{operator++@{operator++}!Xapian::ValueIterator@{Xapian::Value\-Iterator}}
\subsubsection[operator++]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} Xapian::Value\-Iterator::operator++ (int)\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{classXapian_1_1ValueIterator_b50314e623f3daa0973b073518d68339}


Advance the iterator (postfix variant). 

\hypertarget{classXapian_1_1ValueIterator_e76c157616ca36ce63409846649fc666}{
\index{Xapian::ValueIterator@{Xapian::Value\-Iterator}!operator++@{operator++}}
\index{operator++@{operator++}!Xapian::ValueIterator@{Xapian::Value\-Iterator}}
\subsubsection[operator++]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator}\& Xapian::Value\-Iterator::operator++ ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{classXapian_1_1ValueIterator_e76c157616ca36ce63409846649fc666}


Advance the iterator. 

\hypertarget{classXapian_1_1ValueIterator_79c83ae1aceb06efa87404ee15ff2013}{
\index{Xapian::ValueIterator@{Xapian::Value\-Iterator}!operator->@{operator-$>$}}
\index{operator->@{operator-$>$}!Xapian::ValueIterator@{Xapian::Value\-Iterator}}
\subsubsection[operator-$>$]{\setlength{\rightskip}{0pt plus 5cm}const std::string$\ast$ Xapian::Value\-Iterator::operator $\rightarrow$  () const}}
\label{classXapian_1_1ValueIterator_79c83ae1aceb06efa87404ee15ff2013}


Get the value for the current position. 

\hypertarget{classXapian_1_1ValueIterator_e5be5bbe3384c1d4b906fee3f20484c5}{
\index{Xapian::ValueIterator@{Xapian::Value\-Iterator}!operator=@{operator=}}
\index{operator=@{operator=}!Xapian::ValueIterator@{Xapian::Value\-Iterator}}
\subsubsection[operator=]{\setlength{\rightskip}{0pt plus 5cm}void Xapian::Value\-Iterator::operator= (const \hyperlink{classXapian_1_1ValueIterator}{Value\-Iterator} \& {\em other})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
\label{classXapian_1_1ValueIterator_e5be5bbe3384c1d4b906fee3f20484c5}


Assignment is allowed (and is cheap). 



The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
include/xapian/\hyperlink{valueiterator_8h}{valueiterator.h}\end{CompactItemize}