<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::ESetIterator 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_1ESetIterator.html">ESetIterator</a></div>
<h1>Xapian::ESetIterator Class Reference</h1><!-- doxytag: class="Xapian::ESetIterator" -->Iterate through terms in the <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>.
<a href="#_details">More...</a>
<p>
<a href="classXapian_1_1ESetIterator-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::bidirectional_iterator_tag </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#57c315ac0fc056e91dbc92a82a57d028">iterator_category</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#57c315ac0fc056e91dbc92a82a57d028"></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_1ESetIterator.html#4bd78b14ec53402ecc0d81f7d91e1a8b">value_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#4bd78b14ec53402ecc0d81f7d91e1a8b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="namespaceXapian.html#d2d5022b715dc424202f74eef3bdefc5">Xapian::termcount_diff</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#88b554b7cee2ad0934b3c6d8fc510572">difference_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#88b554b7cee2ad0934b3c6d8fc510572"></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_1ESetIterator.html#1e44c1bb5026481b189d61edd3b26caf">pointer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#1e44c1bb5026481b189d61edd3b26caf"></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_1ESetIterator.html#68bccb771987f23cf3fd18af5f1a6d48">reference</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow use as an STL iterator. <a href="#68bccb771987f23cf3fd18af5f1a6d48"></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_1ESetIterator.html#835a56510580f41353b785821300339a">ESetIterator</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="#835a56510580f41353b785821300339a"></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_1ESetIterator.html#a47db737dc851c4738bed4ffcad463d8">ESetIterator</a> (const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed (and is cheap). <a href="#a47db737dc851c4738bed4ffcad463d8"></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_1ESetIterator.html#7768160cc847da269a2352f1e634fd99">operator=</a> (const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed (and is cheap). <a href="#7768160cc847da269a2352f1e634fd99"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#f712cd2c14b611bbf3c29aae1f748314">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator. <a href="#f712cd2c14b611bbf3c29aae1f748314"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#d53eca0121b51732297718d5e65aa55a">operator++</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator (postfix variant). <a href="#d53eca0121b51732297718d5e65aa55a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#b3045d7366a0b421a4e079ce1d6af912">operator--</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrement the iterator. <a href="#b3045d7366a0b421a4e079ce1d6af912"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#c50207c6af311fcc21aa598543ae6f0d">operator--</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrement the iterator (postfix variant). <a href="#c50207c6af311fcc21aa598543ae6f0d"></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_1ESetIterator.html#72de913ed2181f8dd0144d5566aa6ee5">operator *</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the term for the current position. <a href="#72de913ed2181f8dd0144d5566aa6ee5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ESetIterator.html#0913173106e13d44b7e95d92416ba9cb">get_weight</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the weight of the term at the current position. <a href="#0913173106e13d44b7e95d92416ba9cb"></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_1ESetIterator.html#78455a9213062ea540897861fecd44f2">get_description</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#78455a9213062ea540897861fecd44f2"></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_1ESetIterator.html#3571b9de3cbebd2fe83c4f697072a926">operator==</a> (const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &a, const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equality test for <a class="el" href="classXapian_1_1ESetIterator.html" title="Iterate through terms in the ESet.">ESetIterator</a> objects. <a href="#3571b9de3cbebd2fe83c4f697072a926"></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_1ESetIterator.html#7df943d8a1546c235b98c96c4a67175d">operator!=</a> (const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &a, const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inequality test for <a class="el" href="classXapian_1_1ESetIterator.html" title="Iterate through terms in the ESet.">ESetIterator</a> objects. <a href="#7df943d8a1546c235b98c96c4a67175d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Iterate through terms in the <a class="el" href="classXapian_1_1ESet.html" title="Class representing an ordered set of expand terms (an ESet).">ESet</a>.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="57c315ac0fc056e91dbc92a82a57d028"></a><!-- doxytag: member="Xapian::ESetIterator::iterator_category" ref="57c315ac0fc056e91dbc92a82a57d028" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::bidirectional_iterator_tag <a class="el" href="classXapian_1_1ESetIterator.html#57c315ac0fc056e91dbc92a82a57d028">Xapian::ESetIterator::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="4bd78b14ec53402ecc0d81f7d91e1a8b"></a><!-- doxytag: member="Xapian::ESetIterator::value_type" ref="4bd78b14ec53402ecc0d81f7d91e1a8b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::string <a class="el" href="classXapian_1_1ESetIterator.html#4bd78b14ec53402ecc0d81f7d91e1a8b">Xapian::ESetIterator::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="88b554b7cee2ad0934b3c6d8fc510572"></a><!-- doxytag: member="Xapian::ESetIterator::difference_type" ref="88b554b7cee2ad0934b3c6d8fc510572" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="namespaceXapian.html#d2d5022b715dc424202f74eef3bdefc5">Xapian::termcount_diff</a> <a class="el" href="classXapian_1_1ESetIterator.html#88b554b7cee2ad0934b3c6d8fc510572">Xapian::ESetIterator::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="1e44c1bb5026481b189d61edd3b26caf"></a><!-- doxytag: member="Xapian::ESetIterator::pointer" ref="1e44c1bb5026481b189d61edd3b26caf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::string* <a class="el" href="classXapian_1_1ESetIterator.html#1e44c1bb5026481b189d61edd3b26caf">Xapian::ESetIterator::pointer</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allow use as an STL iterator.
<p>
</div>
</div><p>
<a class="anchor" name="68bccb771987f23cf3fd18af5f1a6d48"></a><!-- doxytag: member="Xapian::ESetIterator::reference" ref="68bccb771987f23cf3fd18af5f1a6d48" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::string& <a class="el" href="classXapian_1_1ESetIterator.html#68bccb771987f23cf3fd18af5f1a6d48">Xapian::ESetIterator::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="835a56510580f41353b785821300339a"></a><!-- doxytag: member="Xapian::ESetIterator::ESetIterator" ref="835a56510580f41353b785821300339a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::ESetIterator::ESetIterator </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="a47db737dc851c4738bed4ffcad463d8"></a><!-- doxytag: member="Xapian::ESetIterator::ESetIterator" ref="a47db737dc851c4738bed4ffcad463d8" args="(const ESetIterator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::ESetIterator::ESetIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</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="7768160cc847da269a2352f1e634fd99"></a><!-- doxytag: member="Xapian::ESetIterator::operator=" ref="7768160cc847da269a2352f1e634fd99" args="(const ESetIterator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::ESetIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</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="f712cd2c14b611bbf3c29aae1f748314"></a><!-- doxytag: member="Xapian::ESetIterator::operator++" ref="f712cd2c14b611bbf3c29aae1f748314" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a>& Xapian::ESetIterator::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="d53eca0121b51732297718d5e65aa55a"></a><!-- doxytag: member="Xapian::ESetIterator::operator++" ref="d53eca0121b51732297718d5e65aa55a" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> Xapian::ESetIterator::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="b3045d7366a0b421a4e079ce1d6af912"></a><!-- doxytag: member="Xapian::ESetIterator::operator--" ref="b3045d7366a0b421a4e079ce1d6af912" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a>& Xapian::ESetIterator::operator-- </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decrement the iterator.
<p>
</div>
</div><p>
<a class="anchor" name="c50207c6af311fcc21aa598543ae6f0d"></a><!-- doxytag: member="Xapian::ESetIterator::operator--" ref="c50207c6af311fcc21aa598543ae6f0d" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ESetIterator.html">ESetIterator</a> Xapian::ESetIterator::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>
Decrement the iterator (postfix variant).
<p>
</div>
</div><p>
<a class="anchor" name="72de913ed2181f8dd0144d5566aa6ee5"></a><!-- doxytag: member="Xapian::ESetIterator::operator *" ref="72de913ed2181f8dd0144d5566aa6ee5" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& Xapian::ESetIterator::operator * </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the term for the current position.
<p>
</div>
</div><p>
<a class="anchor" name="0913173106e13d44b7e95d92416ba9cb"></a><!-- doxytag: member="Xapian::ESetIterator::get_weight" ref="0913173106e13d44b7e95d92416ba9cb" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#ee1bece7207c349621963d7f584dd98b">Xapian::weight</a> Xapian::ESetIterator::get_weight </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the weight of the term at the current position.
<p>
</div>
</div><p>
<a class="anchor" name="78455a9213062ea540897861fecd44f2"></a><!-- doxytag: member="Xapian::ESetIterator::get_description" ref="78455a9213062ea540897861fecd44f2" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::ESetIterator::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="3571b9de3cbebd2fe83c4f697072a926"></a><!-- doxytag: member="Xapian::ESetIterator::operator==" ref="3571b9de3cbebd2fe83c4f697072a926" args="(const ESetIterator &a, const ESetIterator &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_1ESetIterator.html">ESetIterator</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_1ESetIterator.html">ESetIterator</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_1ESetIterator.html" title="Iterate through terms in the ESet.">ESetIterator</a> objects.
<p>
</div>
</div><p>
<a class="anchor" name="7df943d8a1546c235b98c96c4a67175d"></a><!-- doxytag: member="Xapian::ESetIterator::operator!=" ref="7df943d8a1546c235b98c96c4a67175d" args="(const ESetIterator &a, const ESetIterator &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_1ESetIterator.html">ESetIterator</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_1ESetIterator.html">ESetIterator</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_1ESetIterator.html" title="Iterate through terms in the ESet.">ESetIterator</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="enquire_8h.html">enquire.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>
