<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::ValueIterator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a></div>
<h1>Xapian::ValueIterator Class Reference</h1><!-- doxytag: class="Xapian::ValueIterator" -->An iterator pointing to values associated with a document.
<a href="#_details">More...</a>
<p>
<a href="classXapian_1_1ValueIterator-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::input_iterator_tag </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#19a42c35ff31b66b7550c614cf345d16">iterator_category</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#19a42c35ff31b66b7550c614cf345d16"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#f3a6af2176f10c5ff4ad599f2cc45de9">value_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#f3a6af2176f10c5ff4ad599f2cc45de9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="namespaceXapian.html#ce97def012215756c9ae59010245b399">Xapian::valueno_diff</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#75f6255b645bcb31fb6814fe20f55adb">difference_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#75f6255b645bcb31fb6814fe20f55adb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#1af2f08b6620386a6f5588204f5c3ae9">pointer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#1af2f08b6620386a6f5588204f5c3ae9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#2f4ab3d40b51b7a4fb5800b74f351fe3">reference</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#2f4ab3d40b51b7a4fb5800b74f351fe3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#61a3e661b2857bde43937b9aa86d0be2">ValueIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an uninitialised iterator; this cannot be used, but is convenient syntactically. <a href="#61a3e661b2857bde43937b9aa86d0be2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#c1c82d557944059e55b63f8f895c9025">ValueIterator</a> (const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed (and is cheap). <a href="#c1c82d557944059e55b63f8f895c9025"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#8b8fdfc375159ef0a4c6eaf7befbcae4">operator=</a> (const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed (and is cheap). <a href="#8b8fdfc375159ef0a4c6eaf7befbcae4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#ad7e1c2ccf459208abfe93d5f16d49d3">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator. <a href="#ad7e1c2ccf459208abfe93d5f16d49d3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#307ec9a8d6fe106dc183de6693872635">operator++</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator (postfix variant). <a href="#307ec9a8d6fe106dc183de6693872635"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#8a9c251dddefbbb6296255800a98eca1">operator *</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value for the current position. <a href="#8a9c251dddefbbb6296255800a98eca1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#55bb165b968500fe2505c613e2da80bc">operator-></a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value for the current position. <a href="#55bb165b968500fe2505c613e2da80bc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#e163c06958fa73cfac44a38c3eea5c10">Xapian::valueno</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#a148b217776eb509f3c07cf387458cbf">get_valueno</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of the value at the current position. <a href="#a148b217776eb509f3c07cf387458cbf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#89a03769b6e3d1eae5478507a75e03ff">get_description</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#89a03769b6e3d1eae5478507a75e03ff"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#b6f7a44a90643102402c118a75e47a44">operator==</a> (const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> &a, const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality test for <a class="el" href="classXapian_1_1ValueIterator.html" title="An iterator pointing to values associated with a document.">ValueIterator</a> objects. <a href="#b6f7a44a90643102402c118a75e47a44"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ValueIterator.html#a736ad26501c4f1b83993e308b13d74a">operator!=</a> (const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> &a, const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inequality test for <a class="el" href="classXapian_1_1ValueIterator.html" title="An iterator pointing to values associated with a document.">ValueIterator</a> objects. <a href="#a736ad26501c4f1b83993e308b13d74a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An iterator pointing to values associated with a document.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="19a42c35ff31b66b7550c614cf345d16"></a><!-- doxytag: member="Xapian::ValueIterator::iterator_category" ref="19a42c35ff31b66b7550c614cf345d16" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::input_iterator_tag <a class="el" href="classXapian_1_1ValueIterator.html#19a42c35ff31b66b7550c614cf345d16">Xapian::ValueIterator::iterator_category</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL iterator.
<p>
</div>
</div><p>
<a class="anchor" name="f3a6af2176f10c5ff4ad599f2cc45de9"></a><!-- doxytag: member="Xapian::ValueIterator::value_type" ref="f3a6af2176f10c5ff4ad599f2cc45de9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::string <a class="el" href="classXapian_1_1ValueIterator.html#f3a6af2176f10c5ff4ad599f2cc45de9">Xapian::ValueIterator::value_type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL iterator.
<p>
</div>
</div><p>
<a class="anchor" name="75f6255b645bcb31fb6814fe20f55adb"></a><!-- doxytag: member="Xapian::ValueIterator::difference_type" ref="75f6255b645bcb31fb6814fe20f55adb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="namespaceXapian.html#ce97def012215756c9ae59010245b399">Xapian::valueno_diff</a> <a class="el" href="classXapian_1_1ValueIterator.html#75f6255b645bcb31fb6814fe20f55adb">Xapian::ValueIterator::difference_type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL iterator.
<p>
</div>
</div><p>
<a class="anchor" name="1af2f08b6620386a6f5588204f5c3ae9"></a><!-- doxytag: member="Xapian::ValueIterator::pointer" ref="1af2f08b6620386a6f5588204f5c3ae9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::string* <a class="el" href="classXapian_1_1ValueIterator.html#1af2f08b6620386a6f5588204f5c3ae9">Xapian::ValueIterator::pointer</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL iterator.
<p>
</div>
</div><p>
<a class="anchor" name="2f4ab3d40b51b7a4fb5800b74f351fe3"></a><!-- doxytag: member="Xapian::ValueIterator::reference" ref="2f4ab3d40b51b7a4fb5800b74f351fe3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::string& <a class="el" href="classXapian_1_1ValueIterator.html#2f4ab3d40b51b7a4fb5800b74f351fe3">Xapian::ValueIterator::reference</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL iterator.
<p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="61a3e661b2857bde43937b9aa86d0be2"></a><!-- doxytag: member="Xapian::ValueIterator::ValueIterator" ref="61a3e661b2857bde43937b9aa86d0be2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::ValueIterator::ValueIterator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an uninitialised iterator; this cannot be used, but is convenient syntactically.
<p>
</div>
</div><p>
<a class="anchor" name="c1c82d557944059e55b63f8f895c9025"></a><!-- doxytag: member="Xapian::ValueIterator::ValueIterator" ref="c1c82d557944059e55b63f8f895c9025" args="(const ValueIterator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::ValueIterator::ValueIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copying is allowed (and is cheap).
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8b8fdfc375159ef0a4c6eaf7befbcae4"></a><!-- doxytag: member="Xapian::ValueIterator::operator=" ref="8b8fdfc375159ef0a4c6eaf7befbcae4" args="(const ValueIterator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::ValueIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment is allowed (and is cheap).
<p>
</div>
</div><p>
<a class="anchor" name="ad7e1c2ccf459208abfe93d5f16d49d3"></a><!-- doxytag: member="Xapian::ValueIterator::operator++" ref="ad7e1c2ccf459208abfe93d5f16d49d3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a>& Xapian::ValueIterator::operator++ </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Advance the iterator.
<p>
</div>
</div><p>
<a class="anchor" name="307ec9a8d6fe106dc183de6693872635"></a><!-- doxytag: member="Xapian::ValueIterator::operator++" ref="307ec9a8d6fe106dc183de6693872635" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> Xapian::ValueIterator::operator++ </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Advance the iterator (postfix variant).
<p>
</div>
</div><p>
<a class="anchor" name="8a9c251dddefbbb6296255800a98eca1"></a><!-- doxytag: member="Xapian::ValueIterator::operator *" ref="8a9c251dddefbbb6296255800a98eca1" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Xapian::ValueIterator::operator * </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value for the current position.
<p>
</div>
</div><p>
<a class="anchor" name="55bb165b968500fe2505c613e2da80bc"></a><!-- doxytag: member="Xapian::ValueIterator::operator->" ref="55bb165b968500fe2505c613e2da80bc" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string* Xapian::ValueIterator::operator-> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value for the current position.
<p>
</div>
</div><p>
<a class="anchor" name="a148b217776eb509f3c07cf387458cbf"></a><!-- doxytag: member="Xapian::ValueIterator::get_valueno" ref="a148b217776eb509f3c07cf387458cbf" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#e163c06958fa73cfac44a38c3eea5c10">Xapian::valueno</a> Xapian::ValueIterator::get_valueno </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of the value at the current position.
<p>
</div>
</div><p>
<a class="anchor" name="89a03769b6e3d1eae5478507a75e03ff"></a><!-- doxytag: member="Xapian::ValueIterator::get_description" ref="89a03769b6e3d1eae5478507a75e03ff" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::ValueIterator::get_description </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a string describing this object.
<p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="b6f7a44a90643102402c118a75e47a44"></a><!-- doxytag: member="Xapian::ValueIterator::operator==" ref="b6f7a44a90643102402c118a75e47a44" args="(const ValueIterator &a, const ValueIterator &b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> & </td>
<td class="paramname"> <em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> & </td>
<td class="paramname"> <em>b</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Equality test for <a class="el" href="classXapian_1_1ValueIterator.html" title="An iterator pointing to values associated with a document.">ValueIterator</a> objects.
<p>
</div>
</div><p>
<a class="anchor" name="a736ad26501c4f1b83993e308b13d74a"></a><!-- doxytag: member="Xapian::ValueIterator::operator!=" ref="a736ad26501c4f1b83993e308b13d74a" args="(const ValueIterator &a, const ValueIterator &b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> & </td>
<td class="paramname"> <em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> & </td>
<td class="paramname"> <em>b</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Inequality test for <a class="el" href="classXapian_1_1ValueIterator.html" title="An iterator pointing to values associated with a document.">ValueIterator</a> objects.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="valueiterator_8h.html">valueiterator.h</a></ul>
<hr>
<address><small>
Documentation for Xapian (version 1.0.21).<br>
Generated on 18 Jun 2010 by
<a href="http://www.doxygen.org/">Doxygen 1.5.2</a>.
</small></address>
</body>
</html>
