|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ 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]
◆ Assign()
◆ Copy()
◆ Difference()
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
-
- Returns
- true if the operation succeeded, false otherwise.
◆ Equals()
◆ 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()
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()
Gets the selection level used when the associated selection action occurred.
- Returns
- The selection level used when the associated selection action occurred.
◆ Intersect()
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
-
- 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()
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.
◆ Union()
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
-
- 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