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

OmESet Class Reference

Class representing an ordered set of expand terms (an ESet). More...

#include <omenquire.h>

List of all members.

Public Methods

 OmESet ()
 Construct an empty OmESet. More...

 ~OmESet ()
 Destructor. More...

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

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

om_termcount get_ebound () const
 A lower bound on the number of terms which are in the full set of results of the expand. More...

om_termcount size () const
 The number of terms in this E-Set. More...

bool empty () const
 Test if this E-Set is empty. More...

OmESetIterator begin () const
 Iterator for the terms in this E-Set. More...

OmESetIterator end () const
 End iterator corresponding to begin(). More...

std::string get_description () const
 Introspection method. More...


Public Attributes

Internal * internal


Detailed Description

Class representing an ordered set of expand terms (an ESet).

This set represents the results of an expand operation, which is performed by OmEnquire::get_eset().


Constructor & Destructor Documentation

OmESet::OmESet  
 

Construct an empty OmESet.

OmESet::~OmESet  
 

Destructor.

OmESet::OmESet const OmESet &    other
 

Copying is allowed (and is cheap).


Member Function Documentation

OmESetIterator OmESet::begin   const
 

Iterator for the terms in this E-Set.

bool OmESet::empty   const
 

Test if this E-Set is empty.

OmESetIterator OmESet::end   const
 

End iterator corresponding to begin().

std::string OmESet::get_description   const
 

Introspection method.

Returns:
A string representing this OmESet.

om_termcount OmESet::get_ebound   const
 

A lower bound on the number of terms which are in the full set of results of the expand.

This will be greater than or equal to size()

void OmESet::operator= const OmESet &    other
 

Assignment is allowed (and is cheap).

om_termcount OmESet::size   const
 

The number of terms in this E-Set.


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