Xapian::ESetIterator Class Reference

Iterate through terms in the ESet. More...

#include <enquire.h>

Collaboration diagram for Xapian::ESetIterator:

Collaboration graph
[legend]
List of all members.

Public Types

typedef std::bidirectional_iterator_tag iterator_category
 Allow use as an STL iterator.
typedef std::string value_type
typedef Xapian::termcount_diff difference_type
typedef std::string * pointer
typedef std::string & reference

Public Member Functions

 ESetIterator ()
 Create an uninitialised iterator; this cannot be used, but is convenient syntactically.
 ESetIterator (const ESetIterator &other)
 Copying is allowed (and is cheap).
void operator= (const ESetIterator &other)
 Assignment is allowed (and is cheap).
ESetIteratoroperator++ ()
 Advance the iterator.
ESetIterator operator++ (int)
 Advance the iterator (postfix variant).
ESetIteratoroperator-- ()
 Decrement the iterator.
ESetIterator operator-- (int)
 Decrement the iterator (postfix variant).
const std::string & operator * () const
 Get the term for the current position.
Xapian::weight get_weight () const
 Get the weight of the term at the current position.
std::string get_description () const
 Returns a string describing this object.

Friends

class ESet
bool operator== (const ESetIterator &a, const ESetIterator &b)
bool operator!= (const ESetIterator &a, const ESetIterator &b)

Detailed Description

Iterate through terms in the ESet.


Member Typedef Documentation

typedef std::bidirectional_iterator_tag Xapian::ESetIterator::iterator_category
 

Allow use as an STL iterator.


Constructor & Destructor Documentation

Xapian::ESetIterator::ESetIterator  )  [inline]
 

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

Xapian::ESetIterator::ESetIterator const ESetIterator other  )  [inline]
 

Copying is allowed (and is cheap).


Member Function Documentation

std::string Xapian::ESetIterator::get_description  )  const
 

Returns a string describing this object.

Introspection method.

Xapian::weight Xapian::ESetIterator::get_weight  )  const
 

Get the weight of the term at the current position.

const std::string& Xapian::ESetIterator::operator *  )  const
 

Get the term for the current position.

ESetIterator Xapian::ESetIterator::operator++ int   )  [inline]
 

Advance the iterator (postfix variant).

ESetIterator& Xapian::ESetIterator::operator++  )  [inline]
 

Advance the iterator.

ESetIterator Xapian::ESetIterator::operator-- int   )  [inline]
 

Decrement the iterator (postfix variant).

ESetIterator& Xapian::ESetIterator::operator--  )  [inline]
 

Decrement the iterator.

void Xapian::ESetIterator::operator= const ESetIterator other  )  [inline]
 

Assignment is allowed (and is cheap).


The documentation for this class was generated from the following file:
Documentation for Xapian (version 0.9.6).
Generated on 15 May 2006 by Doxygen 1.4.6.