Inheritance diagram for HPS.SelectionResults:
HPS.Object

Public Member Functions

void Assign (HPS.SelectionResults in_that)
 
void Copy (HPS.SelectionResults in_that)
 
bool Difference (HPS.SelectionResults in_that)
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.SelectionResults in_that)
 
ulong GetCount ()
 
override int GetHashCode ()
 
HPS.SelectionResultsIterator GetIterator ()
 
HPS.Selection.Level GetSelectionLevel ()
 
bool Intersect (HPS.SelectionResults in_that)
 
override HPS.Type ObjectType ()
 
override void Reset ()
 
 SelectionResults ()
 
 SelectionResults (HPS.SelectionResults in_that)
 
bool SymmetricDifference (HPS.SelectionResults in_that)
 
bool Union (HPS.SelectionResults in_that)
 
- 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 ()
 

Static Public Member Functions

static bool operator!= (HPS.SelectionResults a, HPS.SelectionResults b)
 
static bool operator== (HPS.SelectionResults a, HPS.SelectionResults b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ SelectionResults() [1/2]

HPS.SelectionResults.SelectionResults ( )
inline

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

◆ SelectionResults() [2/2]

HPS.SelectionResults.SelectionResults ( HPS.SelectionResults  in_that)
inline

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

Parameters
in_thatThe source SelectionResults to copy.

Member Function Documentation

◆ Assign()

void HPS.SelectionResults.Assign ( HPS.SelectionResults  in_that)
inline

Share the underlying smart-pointer of the SelectionResults source.

Parameters
in_thatThe SelectionResults source of the assignment.

◆ Copy()

void HPS.SelectionResults.Copy ( HPS.SelectionResults  in_that)
inline

Copy the selection results from another SelectionResults object.

Parameters
in_thatThe SelectionResults source of the copy.

◆ Difference()

bool HPS.SelectionResults.Difference ( HPS.SelectionResults  in_that)
inline

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

Parameters
in_thatThe SelectionResults to subtract from this object.
Returns
true if the operation succeeded, false otherwise.

◆ Equals()

bool HPS.SelectionResults.Equals ( HPS.SelectionResults  in_that)
inline

Check if the source SelectionResults is equivalent to this SelectionResults.

Parameters
in_thatThe source SelectionResults to compare to this SelectionResults.
Returns
true if the objects are equivalent, false otherwise.

◆ GetCount()

ulong HPS.SelectionResults.GetCount ( )
inline

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

Returns
Number of items selected when the associated selection action occurred.

◆ GetIterator()

HPS.SelectionResultsIterator HPS.SelectionResults.GetIterator ( )
inline

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

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

◆ GetSelectionLevel()

HPS.Selection.Level HPS.SelectionResults.GetSelectionLevel ( )
inline

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

Returns
The selection level used when the associated selection action occurred.

◆ Intersect()

bool HPS.SelectionResults.Intersect ( HPS.SelectionResults  in_that)
inline

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

Parameters
in_thatThe SelectionResults to intersect with this object.
Returns
true if the operation succeeded, false otherwise.

◆ ObjectType()

override HPS.Type HPS.SelectionResults.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.SelectionResults.Reset ( )
inlinevirtual

Resets this object to its initial, uninitialized state.

Reimplemented from HPS.Object.

◆ SymmetricDifference()

bool HPS.SelectionResults.SymmetricDifference ( HPS.SelectionResults  in_that)
inline

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.

Parameters
in_thatThe SelectionResults to take the symmetric difference of with this object.
Returns
true if the operation succeeded, false otherwise.

◆ Union()

bool HPS.SelectionResults.Union ( HPS.SelectionResults  in_that)
inline

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.

Parameters
in_thatThe SelectionResults to union with this object.
Returns
true if the operation succeeded, false otherwise.

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