Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

OmTermIterator Class Reference

An iterator pointing to items in a list of terms. More...

#include <omtermlistiterator.h>

List of all members.

Public Types

typedef std::input_iterator_tag iterator_category
typedef om_termname value_type
typedef om_termcount_diff difference_type
typedef om_termname * pointer
typedef om_termname & reference

Public Methods

 OmTermIterator (Internal *internal_)
 OmTermIterator ()
 Default constructor - for declaring an uninitialised iterator. More...

 ~OmTermIterator ()
 Destructor. More...

 OmTermIterator (const OmTermIterator &other)
 Copying is allowed. More...

void operator= (const OmTermIterator &other)
 Assignment is allowed. More...

om_termname operator * () const
OmTermIterator & operator++ ()
void operator++ (int)
void skip_to (const om_termname &tname)
om_termcount get_wdf () const
om_doccount get_termfreq () const
OmPositionListIterator positionlist_begin ()
OmPositionListIterator positionlist_end ()
std::string get_description () const
 Returns a string describing this object. More...


Public Attributes

Internal * internal

Friends

class OmDatabase
class OmDocument
bool operator== (const OmTermIterator &a, const OmTermIterator &b)


Detailed Description

An iterator pointing to items in a list of terms.


Constructor & Destructor Documentation

OmTermIterator::OmTermIterator  
 

Default constructor - for declaring an uninitialised iterator.

OmTermIterator::~OmTermIterator  
 

Destructor.

OmTermIterator::OmTermIterator const OmTermIterator &    other
 

Copying is allowed.

The internals are reference counted, so copying is also cheap.


Member Function Documentation

std::string OmTermIterator::get_description   const
 

Returns a string describing this object.

Introspection method.

void OmTermIterator::operator= const OmTermIterator &    other
 

Assignment is allowed.

The internals are reference counted, so assignment is also cheap.


The documentation for this class was generated from the following file:
Documentation for Xapian (version 0.5.2).
Generated on 12 Oct 2002 by Doxygen 1.2.15.