#include <hps.h>
Public Member Functions | |
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 & | operator= (SearchResults &&in_that) |
virtual void | Reset () |
~SearchResults () | |
The destructor decrements the number of users of the search results. If there are no remaining users, the results are released. | |
HPS::Type | ObjectType () const |
void | Assign (SearchResults const &in_search_results) |
SearchResults & | operator= (SearchResults const &in_search_results) |
size_t | GetCount () const |
SearchResultsIterator | GetIterator () const |
![]() | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual bool | Empty () const |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The SearchResults class is a smart-pointer to a database object. It contains the results of a Find operation.
HPS::SearchResults::SearchResults | ( | SearchResults const & | in_search_results | ) |
The copy constructor creates a new SearchResults object that shares the underlying smart-pointer of the source.
in_search_results | The source of the copy. |
HPS::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.
in_that | An rvalue reference to SearchResults to take the impl from. |
void HPS::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.
in_search_results | The source of the assignment. |
size_t HPS::SearchResults::GetCount | ( | ) | const |
Gets the number of items that were found in the associated search.
SearchResultsIterator HPS::SearchResults::GetIterator | ( | ) | const |
Returns a SearchResultsIterator used to iterate through the found search results.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
SearchResults& HPS::SearchResults::operator= | ( | SearchResults && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SearchResults thereby avoiding a copy.
in_that | An rvalue reference to an SearchResults to take the impl from. |
SearchResults& HPS::SearchResults::operator= | ( | SearchResults const & | in_search_results | ) |
Share the underlying smart-pointer of the assignment source.
in_search_results | The source of the assignment. |
|
virtual |
Resets this object to its initial, uninitialized state.
Reimplemented from HPS::Object.