<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::PositionIterator 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_1PositionIterator.html">PositionIterator</a></div>
<h1>Xapian::PositionIterator Class Reference</h1><!-- doxytag: class="Xapian::PositionIterator" -->An iterator pointing to items in a list of positions.
<a href="#_details">More...</a>
<p>
<a href="classXapian_1_1PositionIterator-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 class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44cf0c3149036775a558af1ee7ebb613"></a><!-- doxytag: member="Xapian::PositionIterator::iterator_category" ref="44cf0c3149036775a558af1ee7ebb613" args="" -->
typedef std::input_iterator_tag </td><td class="memItemRight" valign="bottom"><b>iterator_category</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ece387cc55e8aa156f1f5d9dd0ff14e7"></a><!-- doxytag: member="Xapian::PositionIterator::value_type" ref="ece387cc55e8aa156f1f5d9dd0ff14e7" args="" -->
typedef <a class="el" href="namespaceXapian.html#2de139bd007f8cbe058d526cb311ebe4">Xapian::termpos</a> </td><td class="memItemRight" valign="bottom"><b>value_type</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e2a6b0056dd16b628ac1583893d45aa4"></a><!-- doxytag: member="Xapian::PositionIterator::difference_type" ref="e2a6b0056dd16b628ac1583893d45aa4" args="" -->
typedef <a class="el" href="namespaceXapian.html#e6567acc35e76f2abb70e4dc7a615eed">Xapian::termpos_diff</a> </td><td class="memItemRight" valign="bottom"><b>difference_type</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc3ee9c3c21e1d218fb8720fd8d5d036"></a><!-- doxytag: member="Xapian::PositionIterator::pointer" ref="cc3ee9c3c21e1d218fb8720fd8d5d036" args="" -->
typedef <a class="el" href="namespaceXapian.html#2de139bd007f8cbe058d526cb311ebe4">Xapian::termpos</a> * </td><td class="memItemRight" valign="bottom"><b>pointer</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3f2c15f86fcdf99ae63a4d5e12185f5f"></a><!-- doxytag: member="Xapian::PositionIterator::reference" ref="3f2c15f86fcdf99ae63a4d5e12185f5f" args="" -->
typedef <a class="el" href="namespaceXapian.html#2de139bd007f8cbe058d526cb311ebe4">Xapian::termpos</a> & </td><td class="memItemRight" valign="bottom"><b>reference</b></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="06219abd81dd290cf2363a3bf0cc3234"></a><!-- doxytag: member="Xapian::PositionIterator::PositionIterator" ref="06219abd81dd290cf2363a3bf0cc3234" args="(Internal *internal_)" -->
</td><td class="memItemRight" valign="bottom"><b>PositionIterator</b> (Internal *internal_)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PositionIterator.html#46b89ea50d82351aceeb72dbb7ddfd96">PositionIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor - for declaring an uninitialised iterator. <a href="#46b89ea50d82351aceeb72dbb7ddfd96"></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_1PositionIterator.html#066d9636ccd7b1565a62b68b7699308f">~PositionIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#066d9636ccd7b1565a62b68b7699308f"></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_1PositionIterator.html#23c25af6697786aa8317a61c54cf278d">PositionIterator</a> (const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed. <a href="#23c25af6697786aa8317a61c54cf278d"></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_1PositionIterator.html#d31e3a86d143beda271614a4ea1b4da4">operator=</a> (const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed. <a href="#d31e3a86d143beda271614a4ea1b4da4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47218769eb390b429304925d23c21e1"></a><!-- doxytag: member="Xapian::PositionIterator::operator *" ref="e47218769eb390b429304925d23c21e1" args="() const" -->
<a class="el" href="namespaceXapian.html#2de139bd007f8cbe058d526cb311ebe4">Xapian::termpos</a> </td><td class="memItemRight" valign="bottom"><b>operator *</b> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c7019ad714017785f577f4c9ae9351de"></a><!-- doxytag: member="Xapian::PositionIterator::operator++" ref="c7019ad714017785f577f4c9ae9351de" args="()" -->
<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> & </td><td class="memItemRight" valign="bottom"><b>operator++</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5dfc88c522bced8dac52dc6f73a2779"></a><!-- doxytag: member="Xapian::PositionIterator::operator++" ref="c5dfc88c522bced8dac52dc6f73a2779" args="(int)" -->
TermPosWrapper </td><td class="memItemRight" valign="bottom"><b>operator++</b> (int)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a55f3fb531a58ae82337aee3f6caa703"></a><!-- doxytag: member="Xapian::PositionIterator::skip_to" ref="a55f3fb531a58ae82337aee3f6caa703" args="(Xapian::termpos pos)" -->
void </td><td class="memItemRight" valign="bottom"><b>skip_to</b> (<a class="el" href="namespaceXapian.html#2de139bd007f8cbe058d526cb311ebe4">Xapian::termpos</a> pos)</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_1PositionIterator.html#9472a9ecf8208cc6b91beafb219e1585">get_description</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <a href="#9472a9ecf8208cc6b91beafb219e1585"></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_1PositionIterator.html#037c24b84542ece1703b0ef4cc1da7bc">operator==</a> (const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &a, const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test equality of two PositionIterators. <a href="#037c24b84542ece1703b0ef4cc1da7bc"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An iterator pointing to items in a list of positions.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="46b89ea50d82351aceeb72dbb7ddfd96"></a><!-- doxytag: member="Xapian::PositionIterator::PositionIterator" ref="46b89ea50d82351aceeb72dbb7ddfd96" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::PositionIterator::PositionIterator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor - for declaring an uninitialised iterator.
<p>
</div>
</div><p>
<a class="anchor" name="066d9636ccd7b1565a62b68b7699308f"></a><!-- doxytag: member="Xapian::PositionIterator::~PositionIterator" ref="066d9636ccd7b1565a62b68b7699308f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::PositionIterator::~PositionIterator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<a class="anchor" name="23c25af6697786aa8317a61c54cf278d"></a><!-- doxytag: member="Xapian::PositionIterator::PositionIterator" ref="23c25af6697786aa8317a61c54cf278d" args="(const PositionIterator &o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::PositionIterator::PositionIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> & </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copying is allowed.
<p>
The internals are reference counted, so copying is also cheap.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d31e3a86d143beda271614a4ea1b4da4"></a><!-- doxytag: member="Xapian::PositionIterator::operator=" ref="d31e3a86d143beda271614a4ea1b4da4" args="(const PositionIterator &o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::PositionIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> & </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment is allowed.
<p>
The internals are reference counted, so assignment is also cheap.
</div>
</div><p>
<a class="anchor" name="9472a9ecf8208cc6b91beafb219e1585"></a><!-- doxytag: member="Xapian::PositionIterator::get_description" ref="9472a9ecf8208cc6b91beafb219e1585" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::PositionIterator::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="037c24b84542ece1703b0ef4cc1da7bc"></a><!-- doxytag: member="Xapian::PositionIterator::operator==" ref="037c24b84542ece1703b0ef4cc1da7bc" args="(const PositionIterator &a, const PositionIterator &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_1PositionIterator.html">PositionIterator</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_1PositionIterator.html">PositionIterator</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>
Test equality of two PositionIterators.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="positioniterator_8h.html">positioniterator.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>
