HighlightSearchResults
-
class HPS::HighlightSearchResults : public HPS::Object
The HighlightSearchResults class is a smart-pointer to a database object. It contains the results of a FindHighlights operation.
Public Functions
-
void Assign(HighlightSearchResults 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.
-
size_t GetCount() const
Gets the number of items that were found in the associated search.
- Returns
The number of unique items found.
-
HighlightSearchResultsIterator GetIterator() const
Returns a HighlightSearchResultsIterator used to iterate through the found search results.
- Returns
An iterator pointing to the beginning of the search results list.
-
HighlightSearchResults()
The default constructor creates an empty HighlightSearchResults object, not associated with any search.
-
HighlightSearchResults(HighlightSearchResults &&in_that)
The move constructor creates a HighlightSearchResults by transferring the underlying impl of the rvalue reference to this HighlightSearchResults thereby avoiding a copy and allocation.
- Parameters
in_that – An rvalue reference to HighlightSearchResults to take the impl from.
-
HighlightSearchResults(HighlightSearchResults const &in_search_results)
The copy constructor creates a new HighlightSearchResults object that shares the underlying smart-pointer of the source.
- Parameters
in_search_results – The source of the copy.
-
inline virtual HPS::Type ObjectType() const
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.
-
HighlightSearchResults &operator=(HighlightSearchResults &&in_that)
The move assignment operator transfers the underlying impl of the rvalue reference to this HighlightSearchResults thereby avoiding a copy.
- Parameters
in_that – An rvalue reference to an HighlightSearchResults to take the impl from.
- Returns
A reference to this HighlightSearchResults.
-
HighlightSearchResults &operator=(HighlightSearchResults const &in_search_results)
Share the underlying smart-pointer of the HighlightSearchResults source.
- Parameters
in_that – The HighlightSearchResults source of the assignment.
- Returns
A reference to this HighlightSearchResults.
-
virtual void Reset()
Resets this object to its initial, uninitialized state.
-
~HighlightSearchResults()
The destructor decrements the number of users of the search results. If there are no remaining users, the results are released.
Public Static Attributes
-
static const HPS::Type staticType = HPS::Type::HighlightSearchResults
-
void Assign(HighlightSearchResults const &in_search_results)
