Xapian::ESetIterator Class Reference

Iterate through terms in the ESet. More...

#include <enquire.h>

Collaboration diagram for Xapian::ESetIterator:

[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
	Allow use as an STL iterator.
typedef Xapian::termcount_diff	difference_type
	Allow use as an STL iterator.
typedef std::string *	pointer
	Allow use as an STL iterator.
typedef std::string &	reference
	Allow use as an STL iterator.
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).
ESetIterator &	operator++ ()
	Advance the iterator.
ESetIterator	operator++ (int)
	Advance the iterator (postfix variant).
ESetIterator &	operator-- ()
	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
	Return a string describing this object.
Private Member Functions
	ESetIterator (Xapian::termcount index_, const ESet &eset_)
Private Attributes
Xapian::termcount	index
ESet	eset
Friends
class	ESet
bool	operator== (const ESetIterator &a, const ESetIterator &b)
	Equality test for ESetIterator objects.
bool	operator!= (const ESetIterator &a, const ESetIterator &b)
	Inequality test for ESetIterator objects.

---

Detailed Description

Iterate through terms in the ESet.

Definition at line 480 of file enquire.h.

---

Member Typedef Documentation

typedef Xapian::termcount_diff Xapian::ESetIterator::difference_type

Allow use as an STL iterator.

Definition at line 549 of file enquire.h.

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

Allow use as an STL iterator.

Definition at line 547 of file enquire.h.

typedef std::string* Xapian::ESetIterator::pointer

Allow use as an STL iterator.

Definition at line 550 of file enquire.h.

typedef std::string& Xapian::ESetIterator::reference

Allow use as an STL iterator.

Definition at line 551 of file enquire.h.

typedef std::string Xapian::ESetIterator::value_type

Allow use as an STL iterator.

Definition at line 548 of file enquire.h.

---

Constructor & Destructor Documentation

Xapian::ESetIterator::ESetIterator	(	Xapian::termcount	index_,
		const ESet &	eset_
	)			[inline, private]

Definition at line 486 of file enquire.h.

Xapian::ESetIterator::ESetIterator

(

)

[inline]

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

Definition at line 496 of file enquire.h.

Xapian::ESetIterator::ESetIterator

(

const ESetIterator &

other

)

[inline]

Copying is allowed (and is cheap).

Definition at line 499 of file enquire.h.

References eset, and index.

---

Member Function Documentation

string Xapian::ESetIterator::get_description

(

)

const

Return a string describing this object.

Definition at line 557 of file omenquire.cc.

References index, and Xapian::Internal::str().

Referenced by DEFINE_TESTCASE().

Xapian::weight Xapian::ESetIterator::get_weight

(

)

const

Get the weight of the term at the current position.

Definition at line 551 of file omenquire.cc.

References eset, index, and Xapian::ESet::internal.

Referenced by DEFINE_TESTCASE(), and main().

const string & Xapian::ESetIterator::operator*

(

)

const

Get the term for the current position.

Definition at line 545 of file omenquire.cc.

References eset, index, and Xapian::ESet::internal.

ESetIterator Xapian::ESetIterator::operator++

(

int

)

[inline]

Advance the iterator (postfix variant).

Definition at line 517 of file enquire.h.

ESetIterator& Xapian::ESetIterator::operator++

(

)

[inline]

Advance the iterator.

Definition at line 511 of file enquire.h.

ESetIterator Xapian::ESetIterator::operator--

(

int

)

[inline]

Decrement the iterator (postfix variant).

Definition at line 530 of file enquire.h.

ESetIterator& Xapian::ESetIterator::operator--

(

)

[inline]

Decrement the iterator.

Definition at line 524 of file enquire.h.

void Xapian::ESetIterator::operator=

(

const ESetIterator &

other

)

[inline]

Assignment is allowed (and is cheap).

Definition at line 505 of file enquire.h.

References eset, and index.

---

Friends And Related Function Documentation

friend class ESet [friend]

Definition at line 482 of file enquire.h.

bool operator!=	(	const ESetIterator &	a,
		const ESetIterator &	b
	)			[friend]

Inequality test for ESetIterator objects.

Definition at line 562 of file enquire.h.

bool operator==	(	const ESetIterator &	a,
		const ESetIterator &	b
	)			[friend]

Equality test for ESetIterator objects.

Definition at line 556 of file enquire.h.

---

Member Data Documentation

ESet Xapian::ESetIterator::eset [private]

Definition at line 490 of file enquire.h.

Referenced by ESetIterator(), get_weight(), operator*(), and operator=().

Xapian::termcount Xapian::ESetIterator::index [private]

Definition at line 489 of file enquire.h.

Referenced by ESetIterator(), get_description(), get_weight(), Xapian::operator!=(), operator*(), operator=(), and Xapian::operator==().

---

The documentation for this class was generated from the following files:

• include/xapian/enquire.h
• api/omenquire.cc