< Home

< Table of Contents

REFERENCE MANUAL

SearchResults Class Reference

#include <hps.h>

Inheritance diagram for SearchResults:
Object

Public Member Functions

void Assign (SearchResults const &in_search_results)
 
size_t GetCount () const
 
SearchResultsIterator GetIterator () const
 
Type ObjectType () const
 
SearchResultsoperator= (SearchResults &&in_that)
 
SearchResultsoperator= (SearchResults const &in_search_results)
 
virtual void Reset ()
 
 SearchResults ()
 The default constructor creates an empty SearchResults object, not associated with any search.
 
 SearchResults (SearchResults const &in_search_results)
 
 SearchResults (SearchResults &&in_that)
 
 ~SearchResults ()
 The destructor decrements the number of users of the search results. If there are no remaining users, the results are released.
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
Type Type () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The SearchResults class is a smart-pointer to a database object. It contains the results of a Find operation.

Constructor & Destructor Documentation

SearchResults::SearchResults ( SearchResults const &  in_search_results)

The copy constructor creates a new SearchResults object that shares the underlying smart-pointer of the source.

Parameters
in_search_resultsThe source of the copy.
SearchResults::SearchResults ( SearchResults &&  in_that)

The move constructor creates SearchResults by transferring the underlying impl of the rvalue reference to this Key thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to SearchResults to take the impl from.

Member Function Documentation

void SearchResults::Assign ( SearchResults const &  in_search_results)

Share the underlying smart-pointer if the assignment source. This method is functionally equivalent to the overloaded assignment operator except for the return value.

Parameters
in_search_resultsThe source of the assignment.
size_t SearchResults::GetCount ( ) const

Gets the number of items that were found in the associated search.

Returns
The number of unique items found.
SearchResultsIterator SearchResults::GetIterator ( ) const

Returns a SearchResultsIterator used to iterate through the found search results.

Returns
An iterator pointing to the beginning of the search results list.
Type SearchResults::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from Object.

SearchResults& SearchResults::operator= ( SearchResults &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this SearchResults thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an SearchResults to take the impl from.
Returns
A reference to this SearchResults.
SearchResults& SearchResults::operator= ( SearchResults const &  in_search_results)

Share the underlying smart-pointer of the assignment source.

Parameters
in_search_resultsThe source of the assignment.
Returns
a reference to this object.
virtual void SearchResults::Reset ( )
virtual

Resets this object to its initial, uninitialized state.

Reimplemented from Object.


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