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

OmValueIterator Class Reference

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

#include <omvalueiterator.h>

List of all members.

Public Types

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

Public Methods

 OmValueIterator ()
 Default constructor - for declaring an uninitialised iterator. More...

 ~OmValueIterator ()
 Destructor. More...

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

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

OmValueIterator & operator++ ()
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...

om_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...


Public Attributes

Internal * internal

Friends

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


Detailed Description

An iterator pointing to values associated with a document.


Constructor & Destructor Documentation

OmValueIterator::OmValueIterator  
 

Default constructor - for declaring an uninitialised iterator.

OmValueIterator::~OmValueIterator  
 

Destructor.

OmValueIterator::OmValueIterator const OmValueIterator &    other
 

Copying is allowed (and is cheap).


Member Function Documentation

std::string OmValueIterator::get_description   const
 

Returns a string describing this object.

Introspection method.

om_valueno OmValueIterator::get_valueno   const
 

Get the number of the value at the current position.

const std::string& OmValueIterator::operator *   const
 

Get the value for the current position.

const std::string* OmValueIterator::operator->   const
 

Get the value for the current position.

void OmValueIterator::operator= const OmValueIterator &    other
 

Assignment is allowed (and is cheap).


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