SelectionResults

class HPS.SelectionResults : HPS.Object

The SelectionResults class is a smart pointer to a database object. It is a handle to the results of a selection action and allows iteration over them. When there are no remaining handles to a given selection result, the memory associated with it is freed.

Public Functions

void Assign (HPS.SelectionResults in_that)

Share the underlying smart-pointer of the SelectionResults source.

Param in_that:The SelectionResults source of the assignment.

void Copy (HPS.SelectionResults in_that)

Copy the selection results from another SelectionResults object.

Param in_that:The SelectionResults source of the copy.

bool Difference (HPS.SelectionResults in_that)

Removes elements from this SelectionResults that also occur in the supplied SelectionResults. This will fail if the SelectionResults selections were performed at different levels (e.g. Entity vs Segment).

Param in_that:The SelectionResults to subtract from this object. Return:true if the operation succeeded, false otherwise.

override void Dispose ()

bool Equals (HPS.SelectionResults in_that)

Check if the source SelectionResults is equivalent to this SelectionResults.

Param in_that:The source SelectionResults to compare to this SelectionResults. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ulong GetCount ()

Gets the number of items selected when the associated selection action occurred.

Return:Number of items selected when the associated selection action occurred.

override int GetHashCode ()

HPS.SelectionResultsIterator GetIterator ()

Get an iterator that can be used to iterate through the selection results.

Return:An iterator that can be used to iterate through the selection results.

HPS.Selection.Level GetSelectionLevel ()

Gets the selection level used when the associated selection action occurred.

Return:The selection level used when the associated selection action occurred.

bool Intersect (HPS.SelectionResults in_that)

Perform a set intersection of elements in this SelectionResults object with the elements of the supplied SelectionResults. This will fail if the SelectionResults selections were performed at different levels (e.g. Entity vs Segment).

Param in_that:The SelectionResults to intersect with this object. Return:true if the operation succeeded, false otherwise.

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

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

override void Reset ()

Resets this object to its initial, uninitialized state.

SelectionResults ()

The default constructor creates an empty SelectionResults object which is not associated with any selection action.

SelectionResults (HPS.SelectionResults in_that)

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

Param in_that:The source SelectionResults to copy.

bool SymmetricDifference (HPS.SelectionResults in_that)

Perform a symmetric difference (similar to XOR) of elements in this SelectionResults object with the elements of the supplied SelectionResults. This will fail if the SelectionResults selections were performed at different levels (e.g. Entity vs Segment). The resulting SelectionResults will be unsorted, even if the sources were sorted.

Param in_that:The SelectionResults to take the symmetric difference of with this object. Return:true if the operation succeeded, false otherwise.

bool Union (HPS.SelectionResults in_that)

Perform a set union of elements in this SelectionResults object with the elements of the supplied SelectionResults. This will fail if the SelectionResults selections were performed at different levels (e.g. Entity vs Segment). The resulting SelectionResults will be unsorted, even if the sources were sorted.

Param in_that:The SelectionResults to union with this object. Return:true if the operation succeeded, false otherwise.

Public Static Functions

bool operator!= (HPS.SelectionResults a, HPS.SelectionResults b)

bool operator== (HPS.SelectionResults a, HPS.SelectionResults b)