REFERENCE MANUAL
The SelectionResults class is a smart pointer to a database object. More...
Public Member Functions | |
void | Assign (HPS.SelectionResults in_that) |
Share the underlying smart-pointer of the SelectionResults source. More... | |
void | Copy (HPS.SelectionResults in_that) |
Copy the selection results from another SelectionResults object. More... | |
bool | Difference (HPS.SelectionResults in_that) |
Removes elements from this SelectionResults that also occur in the supplied SelectionResults. More... | |
override void | Dispose () |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.SelectionResults in_that) |
Check if the source SelectionResults is equivalent to this SelectionResults. More... | |
ulong | GetCount () |
Gets the number of items selected when the associated selection action occurred. More... | |
override int | GetHashCode () |
HPS.SelectionResultsIterator | GetIterator () |
Get an iterator that can be used to iterate through the selection results. More... | |
HPS.Selection.Level | GetSelectionLevel () |
Gets the selection level used when the associated selection action occurred. More... | |
bool | Intersect (HPS.SelectionResults in_that) |
Perform a set intersection of elements in this SelectionResults object with the elements of the supplied SelectionResults. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
override void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
SelectionResults () | |
The default constructor creates an empty SelectionResults object which is not associated with any selection action. More... | |
SelectionResults (HPS.SelectionResults in_that) | |
The copy constructor creates a SelectionResults object that shares the underlying smart-pointer of the source SelectionResults. More... | |
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. More... | |
bool | Union (HPS.SelectionResults in_that) |
Perform a set union of elements in this SelectionResults object with the elements of the supplied SelectionResults. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.SelectionResults a, HPS.SelectionResults b) |
static bool | operator== (HPS.SelectionResults a, HPS.SelectionResults b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
HPS.SelectionResults.SelectionResults | ( | ) |
The default constructor creates an empty SelectionResults object which is not associated with any selection action.
HPS.SelectionResults.SelectionResults | ( | HPS.SelectionResults | in_that | ) |
The copy constructor creates a SelectionResults object that shares the underlying smart-pointer of the source SelectionResults.
in_that | The source <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> to copy. |
void HPS.SelectionResults.Assign | ( | HPS.SelectionResults | in_that | ) |
Share the underlying smart-pointer of the SelectionResults source.
in_that | The <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> source of the assignment. |
void HPS.SelectionResults.Copy | ( | HPS.SelectionResults | in_that | ) |
Copy the selection results from another SelectionResults object.
in_that | The <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> source of the copy. |
bool HPS.SelectionResults.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).
in_that | The <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> to subtract from this object. |
bool HPS.SelectionResults.Equals | ( | HPS.SelectionResults | in_that | ) |
Check if the source SelectionResults is equivalent to this SelectionResults.
in_that | The source <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> to compare to this <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref>. |
ulong HPS.SelectionResults.GetCount | ( | ) |
Gets the number of items selected when the associated selection action occurred.
HPS.SelectionResultsIterator HPS.SelectionResults.GetIterator | ( | ) |
Get an iterator that can be used to iterate through the selection results.
HPS.Selection.Level HPS.SelectionResults.GetSelectionLevel | ( | ) |
Gets the selection level used when the associated selection action occurred.
bool HPS.SelectionResults.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).
in_that | The <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> to intersect with this object. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
virtual |
Resets this object to its initial, uninitialized state.
Reimplemented from HPS.Object.
bool HPS.SelectionResults.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.
in_that | The <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> to take the symmetric difference of with this object. |
bool HPS.SelectionResults.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.
in_that | The <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> to union with this object. |