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. 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. This will fail if the SelectionResults selections were performed at different levels (e.g. Entity vs Segment). 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. This will fail if the SelectionResults selections were performed at different levels (e.g. Entity vs Segment). More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. 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. 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. More... | |
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. 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. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. 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 |
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
|
inline |
The default constructor creates an empty SelectionResults object which is not associated with any selection action.
|
inline |
The copy constructor creates a SelectionResults object that shares the underlying smart-pointer of the source SelectionResults.
- Parameters
-
in_that The source SelectionResults to copy.
Member Function Documentation
|
inline |
Share the underlying smart-pointer of the SelectionResults source.
- Parameters
-
in_that The SelectionResults source of the assignment.
|
inline |
Copy the selection results from another SelectionResults object.
- Parameters
-
in_that The SelectionResults source of the copy.
|
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_that The SelectionResults to subtract from this object.
- Returns
- true if the operation succeeded, false otherwise.
|
inline |
Check if the source SelectionResults is equivalent to this SelectionResults.
- Parameters
-
in_that The source SelectionResults to compare to this SelectionResults.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Gets the number of items selected when the associated selection action occurred.
- Returns
- Number of items selected when the associated selection action occurred.
|
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.
|
inline |
Gets the selection level used when the associated selection action occurred.
- Returns
- The selection level used when the associated selection action occurred.
|
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_that The SelectionResults to intersect with this object.
- Returns
- true if the operation succeeded, false otherwise.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
inlinevirtual |
Resets this object to its initial, uninitialized state.
Reimplemented from HPS.Object.
|
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_that The SelectionResults to take the symmetric difference of with this object.
- Returns
- true if the operation succeeded, false otherwise.
|
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_that The 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