strus  0.17
Public Member Functions | List of all members
strus::QueryResult Class Reference

Structure defining the result of a strus query. More...

#include <queryResult.hpp>

Public Member Functions

 QueryResult ()
 Default constructor. More...
 
 QueryResult (const QueryResult &o)
 Copy constructor. More...
 
 QueryResult (unsigned int evaluationPass_, unsigned int nofRanked_, unsigned int nofVisited_, const std::vector< ResultDocument > &ranks_)
 Constructor. More...
 
unsigned int evaluationPass () const
 Get the last query evaluation pass used (level of selection features used) More...
 
unsigned int nofRanked () const
 Get the total number of matches that were ranked (after applying all query restrictions) More...
 
unsigned int nofVisited () const
 Get the total number of matches that were visited (after applying ACL restrictions, but before applying other restrictions) More...
 
const std::vector
< ResultDocument > & 
ranks () const
 Get the list of result elements. More...
 

Detailed Description

Structure defining the result of a strus query.

Constructor & Destructor Documentation

strus::QueryResult::QueryResult ( )
inline

Default constructor.

strus::QueryResult::QueryResult ( const QueryResult o)
inline

Copy constructor.

strus::QueryResult::QueryResult ( unsigned int  evaluationPass_,
unsigned int  nofRanked_,
unsigned int  nofVisited_,
const std::vector< ResultDocument > &  ranks_ 
)
inline

Constructor.

Member Function Documentation

unsigned int strus::QueryResult::evaluationPass ( ) const
inline

Get the last query evaluation pass used (level of selection features used)

unsigned int strus::QueryResult::nofRanked ( ) const
inline

Get the total number of matches that were ranked (after applying all query restrictions)

unsigned int strus::QueryResult::nofVisited ( ) const
inline

Get the total number of matches that were visited (after applying ACL restrictions, but before applying other restrictions)

const std::vector<ResultDocument>& strus::QueryResult::ranks ( ) const
inline

Get the list of result elements.


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