<!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.9 --> <script type="text/javascript"> <!-- function changeDisplayState (e){ var num=this.id.replace(/[^[0-9]/g,''); var button=this.firstChild; var sectionDiv=document.getElementById('dynsection'+num); if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){ sectionDiv.style.display='block'; button.src='open.gif'; }else{ sectionDiv.style.display='none'; button.src='closed.gif'; } } function initDynSections(){ var divs=document.getElementsByTagName('div'); var sectionCounter=1; for(var i=0;i<divs.length-1;i++){ if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){ var header=divs[i]; var section=divs[i+1]; var button=header.firstChild; if (button!='IMG'){ divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild); button=document.createElement('img'); divs[i].insertBefore(button,divs[i].firstChild); } header.style.cursor='pointer'; header.onclick=changeDisplayState; header.id='dynheader'+sectionCounter; button.src='closed.gif'; section.id='dynsection'+sectionCounter; section.style.display='none'; section.style.marginLeft='14px'; sectionCounter++; } } } window.onload = initDynSections; --> </script> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</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="navpath"><a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> </div> </div> <div class="contents"> <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> <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 Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="475e11e82d8268d23b750c787531ab9a"></a><!-- doxytag: member="Xapian::PositionIterator::PositionIterator" ref="475e11e82d8268d23b750c787531ab9a" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PositionIterator.html#475e11e82d8268d23b750c787531ab9a">PositionIterator</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor - for declaring an uninitialised iterator. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a84f5de9867d1413c0dacb704d63c04"></a><!-- doxytag: member="Xapian::PositionIterator::~PositionIterator" ref="9a84f5de9867d1413c0dacb704d63c04" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PositionIterator.html#9a84f5de9867d1413c0dacb704d63c04">~PositionIterator</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <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#8b9d10db35fa9e2944012ea57a0b9d23">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="#8b9d10db35fa9e2944012ea57a0b9d23"></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#5cbc03e21296bb5347736977d0f27547">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="#5cbc03e21296bb5347736977d0f27547"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e673659cdc4225d2b2eb7922fac95449"></a><!-- doxytag: member="Xapian::PositionIterator::operator*" ref="e673659cdc4225d2b2eb7922fac95449" args="() const " --> <a class="el" href="namespaceXapian.html#e5a16f073d0c8ed54085a9de07248d45">Xapian::termpos</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PositionIterator.html#e673659cdc4225d2b2eb7922fac95449">operator*</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the term position at the current iterator position. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4a068fa03b75f797ab4cae83fc0810f"></a><!-- doxytag: member="Xapian::PositionIterator::operator++" ref="f4a068fa03b75f797ab4cae83fc0810f" args="()" --> <a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PositionIterator.html#f4a068fa03b75f797ab4cae83fc0810f">operator++</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="28688871c66063b2cf3b78766f988fd5"></a><!-- doxytag: member="Xapian::PositionIterator::operator++" ref="28688871c66063b2cf3b78766f988fd5" args="(int)" --> DerefWrapper_< <a class="el" href="namespaceXapian.html#e5a16f073d0c8ed54085a9de07248d45">termpos</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PositionIterator.html#28688871c66063b2cf3b78766f988fd5">operator++</a> (int)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the next position (postfix version). <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#5ecfb4a9c90777b64368c8f61b26e296">skip_to</a> (<a class="el" href="namespaceXapian.html#e5a16f073d0c8ed54085a9de07248d45">Xapian::termpos</a> pos)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the specified termpos. <a href="#5ecfb4a9c90777b64368c8f61b26e296"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae9e6e3e7481bd22f228de4c2deb03eb"></a><!-- doxytag: member="Xapian::PositionIterator::get_description" ref="ae9e6e3e7481bd22f228de4c2deb03eb" args="() const " --> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PositionIterator.html#ae9e6e3e7481bd22f228de4c2deb03eb">get_description</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br></td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="834fe2a9af5f7e592e1ceaba44ceb1a3"></a><!-- doxytag: member="Xapian::PositionIterator::operator==" ref="834fe2a9af5f7e592e1ceaba44ceb1a3" args="(const PositionIterator &a, const PositionIterator &b)" --> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1PositionIterator.html#834fe2a9af5f7e592e1ceaba44ceb1a3">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. <br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> An iterator pointing to items in a list of positions. <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="8b9d10db35fa9e2944012ea57a0b9d23"></a><!-- doxytag: member="Xapian::PositionIterator::PositionIterator" ref="8b9d10db35fa9e2944012ea57a0b9d23" 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></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="5cbc03e21296bb5347736977d0f27547"></a><!-- doxytag: member="Xapian::PositionIterator::operator=" ref="5cbc03e21296bb5347736977d0f27547" 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></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="5ecfb4a9c90777b64368c8f61b26e296"></a><!-- doxytag: member="Xapian::PositionIterator::skip_to" ref="5ecfb4a9c90777b64368c8f61b26e296" args="(Xapian::termpos pos)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Xapian::PositionIterator::skip_to </td> <td>(</td> <td class="paramtype"><a class="el" href="namespaceXapian.html#e5a16f073d0c8ed54085a9de07248d45">Xapian::termpos</a> </td> <td class="paramname"> <em>pos</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Advance the iterator to the specified termpos. <p> If the specified termpos isn't in the list, position ourselves on the first termpos after it (or at_end() if no greater term positions are present). </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> </div> <hr> <address><small> Documentation for Xapian (version 1.2.12).<br> Generated on 27 Jun 2012 by <a href="http://www.doxygen.org/">Doxygen 1.5.9</a>. </small></address> </body> </html>