#include <hps.h>

Public Member Functions | |
void | Assign (SearchResults const &in_search_results) |
size_t | GetCount () const |
SearchResultsIterator | GetIterator () const |
HPS::Type | ObjectType () const |
SearchResults & | operator= (SearchResults &&in_that) |
SearchResults & | operator= (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. | |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::SearchResults |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
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() [1/2]
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.
- Parameters
-
in_search_results The source of the copy.
◆ SearchResults() [2/2]
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.
- Parameters
-
in_that An rvalue reference to SearchResults to take the impl from.
Member Function Documentation
◆ Assign()
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.
- Parameters
-
in_search_results The source of the assignment.
◆ GetCount()
size_t HPS::SearchResults::GetCount | ( | ) | const |
Gets the number of items that were found in the associated search.
- Returns
- The number of unique items found.
◆ GetIterator()
SearchResultsIterator HPS::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.
◆ ObjectType()
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
◆ operator=() [1/2]
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.
- Parameters
-
in_that An rvalue reference to an SearchResults to take the impl from.
- Returns
- A reference to this SearchResults.
◆ operator=() [2/2]
SearchResults& HPS::SearchResults::operator= | ( | SearchResults const & | in_search_results | ) |
Share the underlying smart-pointer of the SearchResults source.
- Parameters
-
in_that The SearchResults source of the assignment.
- Returns
- A reference to this SearchResults.
◆ Reset()
|
virtual |
Resets this object to its initial, uninitialized state.
Reimplemented from HPS::Object.
The documentation for this class was generated from the following file:
- include/hps.h