Inheritance diagram for HPS.SearchResults:
HPS.Object

Public Member Functions

void Assign (HPS.SearchResults in_search_results)
 
override void Dispose ()
 
ulong GetCount ()
 
HPS.SearchResultsIterator GetIterator ()
 
override HPS.Type ObjectType ()
 
override void Reset ()
 
 SearchResults (HPS.SearchResults in_search_results)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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()

HPS.SearchResults.SearchResults ( HPS.SearchResults  in_search_results)
inline

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.

Member Function Documentation

◆ Assign()

void HPS.SearchResults.Assign ( HPS.SearchResults  in_search_results)
inline

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.

◆ GetCount()

ulong HPS.SearchResults.GetCount ( )
inline

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

Returns
The number of unique items found.

◆ GetIterator()

HPS.SearchResultsIterator HPS.SearchResults.GetIterator ( )
inline

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

Returns
An iterator pointing to the beginning of the search results list.

◆ ObjectType()

override HPS.Type HPS.SearchResults.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.

◆ Reset()

override void HPS.SearchResults.Reset ( )
inlinevirtual

Resets this object to its initial, uninitialized state.

Reimplemented from HPS.Object.


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.SearchResults.cs