HPS.OptimizeMappingResults Class Reference
Inheritance diagram for HPS.OptimizeMappingResults:

Public Member Functions

void Assign (HPS.OptimizeMappingResults in_mappping)
override void Dispose ()
bool FlushMerged ()
ulong GetCount ()
HPS.OptimizeMappingResultsIterator GetIterator ()
override HPS.Type ObjectType ()
 OptimizeMappingResults (HPS.OptimizeMappingResults in_mappping)
override void Reset ()
- 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 OptimizeMappingResults class is a smart-pointer to a database object. It contains the results of an OptimizeWithMapping operation.

Constructor & Destructor Documentation

◆ OptimizeMappingResults()

HPS.OptimizeMappingResults.OptimizeMappingResults ( HPS.OptimizeMappingResults  in_mappping)

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

in_mapppingThe source of the copy.

Member Function Documentation

◆ Assign()

void HPS.OptimizeMappingResults.Assign ( HPS.OptimizeMappingResults  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.

◆ FlushMerged()

bool HPS.OptimizeMappingResults.FlushMerged ( )

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

True if any items were flushed.

◆ GetCount()

ulong HPS.OptimizeMappingResults.GetCount ( )

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

The number of unique items.

◆ GetIterator()

HPS.OptimizeMappingResultsIterator HPS.OptimizeMappingResults.GetIterator ( )

Returns a OptimizeMappingResultsIterator used to iterate through the optimize results.

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

◆ ObjectType()

override HPS.Type HPS.OptimizeMappingResults.ObjectType ( )

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

The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

◆ Reset()

override void HPS.OptimizeMappingResults.Reset ( )

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.OptimizeMappingResults.cs