API Search || Global Search
HPS::HighlightSearchResults Class Reference

#include <hps.h>

Inheritance diagram for HPS::HighlightSearchResults:
HPS::Object

Public Member Functions

void Assign (HighlightSearchResults const &in_search_results)
 
size_t GetCount () const
 
HighlightSearchResultsIterator GetIterator () const
 
 HighlightSearchResults ()
 The default constructor creates an empty HighlightSearchResults object, not associated with any search.
 
 HighlightSearchResults (HighlightSearchResults const &in_search_results)
 
 HighlightSearchResults (HighlightSearchResults &&in_that)
 
HPS::Type ObjectType () const
 
HighlightSearchResultsoperator= (HighlightSearchResults &&in_that)
 
HighlightSearchResultsoperator= (HighlightSearchResults const &in_search_results)
 
virtual void Reset ()
 
 ~HighlightSearchResults ()
 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 HPS::Object
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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::HighlightSearchResults
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

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

Detailed Description

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

Constructor & Destructor Documentation

HPS::HighlightSearchResults::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_resultsThe source of the copy.
HPS::HighlightSearchResults::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_thatAn rvalue reference to HighlightSearchResults to take the impl from.

Member Function Documentation

void HPS::HighlightSearchResults::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_resultsThe source of the assignment.
size_t HPS::HighlightSearchResults::GetCount ( ) const

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

Returns
The number of unique items found.
HighlightSearchResultsIterator HPS::HighlightSearchResults::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& HPS::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_thatAn rvalue reference to an HighlightSearchResults to take the impl from.
Returns
A reference to this HighlightSearchResults.
HighlightSearchResults& HPS::HighlightSearchResults::operator= ( HighlightSearchResults const &  in_search_results)

Share the underlying smart-pointer of the HighlightSearchResults source.

Parameters
in_thatThe HighlightSearchResults source of the assignment.
Returns
A reference to this HighlightSearchResults.
virtual void HPS::HighlightSearchResults::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: