xapian-core  1.5.0
Public Member Functions | List of all members
Xapian::DocumentSet Class Reference

Class representing a set of documents in a cluster. More...

Public Member Functions

 DocumentSet (const DocumentSet &other)
 Copying is allowed. More...
 
DocumentSetoperator= (const DocumentSet &other)
 Assignment is allowed. More...
 
 DocumentSet (DocumentSet &&other)
 Move constructor. More...
 
DocumentSetoperator= (DocumentSet &&other)
 Move assignment operator. More...
 
 DocumentSet ()
 Default constructor.
 
 ~DocumentSet ()
 Destructor.
 
Xapian::doccount size () const
 Return the size of the DocumentSet.
 
Xapian::Documentoperator[] (Xapian::doccount i)
 Return the Document in the DocumentSet at index i.
 
const Xapian::Documentoperator[] (Xapian::doccount i) const
 Return the Document in the DocumentSet at index i.
 
void add_document (const Document &document)
 Add a new Document to the DocumentSet. More...
 

Detailed Description

Class representing a set of documents in a cluster.

Constructor & Destructor Documentation

◆ DocumentSet() [1/2]

Xapian::DocumentSet::DocumentSet ( const DocumentSet other)

Copying is allowed.

The internals are reference counted, so copying is cheap.

Parameters
otherThe object to copy.

◆ DocumentSet() [2/2]

Xapian::DocumentSet::DocumentSet ( DocumentSet &&  other)

Move constructor.

Parameters
otherThe object to move.

Member Function Documentation

◆ add_document()

void Xapian::DocumentSet::add_document ( const Document document)

Add a new Document to the DocumentSet.

Parameters
documentDocument object that is to be added to the DocumentSet

◆ operator=() [1/2]

DocumentSet& Xapian::DocumentSet::operator= ( const DocumentSet other)

Assignment is allowed.

The internals are reference counted, so assignment is cheap.

Parameters
otherThe object to copy.

◆ operator=() [2/2]

DocumentSet& Xapian::DocumentSet::operator= ( DocumentSet &&  other)

Move assignment operator.

Parameters
otherThe object to move.

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