OptimizeMappingResults

class OptimizeMappingResults : public HPS::Object 

The OptimizeMappingResults class is a smart-pointer to a database object. It contains the results of an OptimizeWithMapping operation.

Public Functions

void 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_results – The source of the assignment.

bool 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 GetCount() const

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

Returns:	The number of unique items.

OptimizeMappingResultsIterator GetIterator() const

Returns a OptimizeMappingResultsIterator used to iterate through the optimize results.

Returns:	An iterator pointing to the beginning of the optimize results list.

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.

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_that – An rvalue reference to an OptimizeMappingResults to take the impl from.
Returns:	A reference to this OptimizeMappingResults.

OptimizeMappingResults &operator=(OptimizeMappingResults const &in_mappping)

Share the underlying smart-pointer of the OptimizeMappingResults source.

Parameters:	in_mappping – The OptimizeMappingResults source of the assignment.
Returns:	A reference to this HighlightSearchResults.

OptimizeMappingResults(): The default constructor creates an empty OptimizeMappingResults object, not associated with any optimize.

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_that – An rvalue reference to OptimizeMappingResults to take the impl from.

OptimizeMappingResults(OptimizeMappingResults const &in_mappping)

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

Parameters:	in_mappping – The source of the copy.

virtual void Reset(): Resets this object to its initial, uninitialized state.

~OptimizeMappingResults(): The destructor decrements the number of users of the results. If there are no remaining users, the results are released.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::OptimizeMappingResults