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

#include <hps.h>

Inheritance diagram for HPS::OptimizeMappingResults:
HPS::Object

Public Member Functions

void Assign (OptimizeMappingResults const &in_mappping)
 
bool FlushMerged ()
 
size_t GetCount () const
 
OptimizeMappingResultsIterator GetIterator () const
 
HPS::Type ObjectType () const
 
OptimizeMappingResultsoperator= (OptimizeMappingResults &&in_that)
 
OptimizeMappingResultsoperator= (OptimizeMappingResults const &in_mappping)
 
 OptimizeMappingResults ()
 The default constructor creates an empty OptimizeMappingResults object, not associated with any optimize.
 
 OptimizeMappingResults (OptimizeMappingResults const &in_mappping)
 
 OptimizeMappingResults (OptimizeMappingResults &&in_that)
 
virtual void Reset ()
 
 ~OptimizeMappingResults ()
 The destructor decrements the number of users of the 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::OptimizeMappingResults
 
- 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 OptimizeMappingResults class is a smart-pointer to a database object. It contains the results of an OptimizeWithMapping operation.

Constructor & Destructor Documentation

HPS::OptimizeMappingResults::OptimizeMappingResults ( OptimizeMappingResults const &  in_mappping)

The copy constructor creates a new OptimizeMappingResults object that shares the underlying smart-pointer of the source.

Parameters
in_mapppingThe source of the copy.
HPS::OptimizeMappingResults::OptimizeMappingResults ( OptimizeMappingResults &&  in_that)

The move constructor creates a OptimizeMappingResults by transferring the underlying impl of the rvalue reference to this OptimizeMappingResults thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to OptimizeMappingResults to take the impl from.

Member Function Documentation

void HPS::OptimizeMappingResults::Assign ( OptimizeMappingResults const &  in_mappping)

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.
bool HPS::OptimizeMappingResults::FlushMerged ( )

Flush original shells that were merged. GetCount will return 0 after this operations so information must be read before flushing.

Returns
True if any items were flushed.
size_t HPS::OptimizeMappingResults::GetCount ( ) const

Gets the number of items that were recorded in the associated optimize.

Returns
The number of unique items.
OptimizeMappingResultsIterator HPS::OptimizeMappingResults::GetIterator ( ) const

Returns a OptimizeMappingResultsIterator used to iterate through the optimize results.

Returns
An iterator pointing to the beginning of the optimize results list.
OptimizeMappingResults& HPS::OptimizeMappingResults::operator= ( OptimizeMappingResults &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this OptimizeMappingResults thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an OptimizeMappingResults to take the impl from.
Returns
A reference to this OptimizeMappingResults.
OptimizeMappingResults& HPS::OptimizeMappingResults::operator= ( OptimizeMappingResults const &  in_mappping)

Share the underlying smart-pointer of the OptimizeMappingResults source.

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