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

Xapian::ValueIterator Class Reference

An iterator pointing to values associated with a document. More...

#include <valueiterator.h>

Collaboration diagram for Xapian::ValueIterator:

Collaboration graph
[legend]
List of all members.

Public Types

typedef std::input_iterator_tag iterator_category
typedef std::string value_type
typedef Xapian::valueno_diff difference_type
typedef std::string * pointer
typedef std::string & reference

Public Methods

 ValueIterator ()
 Create an uninitialised iterator; this cannot be used, but is convenient syntactically. More...

 ~ValueIterator ()
 ValueIterator (const ValueIterator &other)
 Copying is allowed (and is cheap). More...

void operator= (const ValueIterator &other)
 Assignment is allowed (and is cheap). More...

ValueIterator & operator++ ()
 Advance the iterator. More...

void operator++ (int)
const std::string & operator * () const
 Get the value for the current position. More...

const std::string * operator-> () const
 Get the value for the current position. More...

Xapian::valueno get_valueno () const
 Get the number of the value at the current position. More...

std::string get_description () const
 Returns a string describing this object. More...


Friends

class Document
bool operator== (const ValueIterator &a, const ValueIterator &b)
bool operator!= (const ValueIterator &a, const ValueIterator &b)

Detailed Description

An iterator pointing to values associated with a document.


Constructor & Destructor Documentation

Xapian::ValueIterator::ValueIterator   [inline]
 

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

Xapian::ValueIterator::ValueIterator const ValueIterator &    other [inline]
 

Copying is allowed (and is cheap).


Member Function Documentation

std::string Xapian::ValueIterator::get_description   const
 

Returns a string describing this object.

Introspection method.

Xapian::valueno Xapian::ValueIterator::get_valueno   const
 

Get the number of the value at the current position.

const std::string& Xapian::ValueIterator::operator *   const
 

Get the value for the current position.

ValueIterator& Xapian::ValueIterator::operator++   [inline]
 

Advance the iterator.

const std::string* Xapian::ValueIterator::operator->   const
 

Get the value for the current position.

void Xapian::ValueIterator::operator= const ValueIterator &    other [inline]
 

Assignment is allowed (and is cheap).


The documentation for this class was generated from the following file:
Documentation for Xapian (version 0.7.0).
Generated on 8 Jul 2003 by Doxygen 1.2.15.