REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
void | Assign (SelectionResults const &in_that) |
void | Copy (SelectionResults const &in_that) |
bool | Difference (SelectionResults const &in_that) |
bool | Equals (SelectionResults const &in_that) const |
size_t | GetCount () const |
SelectionResultsIterator | GetIterator () const |
Selection::Level | GetSelectionLevel () const |
bool | Intersect (SelectionResults const &in_that) |
Type | ObjectType () const |
bool | operator!= (SelectionResults const &in_that) const |
SelectionResults & | operator= (SelectionResults &&in_that) |
SelectionResults & | operator= (SelectionResults const &in_that) |
bool | operator== (SelectionResults const &in_that) const |
virtual void | Reset () |
SelectionResults () | |
SelectionResults (SelectionResults const &in_that) | |
SelectionResults (SelectionResults &&in_that) | |
bool | SymmetricDifference (SelectionResults const &in_that) |
bool | Union (SelectionResults const &in_that) |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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::SelectionResults | ( | ) |
The default constructor creates an empty SelectionResults object which is not associated with any selection action.
SelectionResults::SelectionResults | ( | SelectionResults const & | in_that | ) |
The copy constructor creates a SelectionResults object that shares the underlying smart-pointer of the source SelectionResults.
in_that | The source SelectionResults to copy. |
SelectionResults::SelectionResults | ( | SelectionResults && | in_that | ) |
The move constructor creates a SelectionResults by transferring the underlying impl of the rvalue reference to this SelectionResults thereby avoiding a copy and allocation.
in_that | An rvalue reference to a SelectionResults to take the impl from. |
void SelectionResults::Assign | ( | SelectionResults const & | in_that | ) |
Share the underlying smart-pointer of the SelectionResults source.
in_that | The SelectionResults source of the assignment. |
void SelectionResults::Copy | ( | SelectionResults const & | in_that | ) |
Copy the selection results from another SelectionResults object.
in_that | The SelectionResults source of the copy. |
bool SelectionResults::Difference | ( | SelectionResults const & | 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 SelectionResults to subtract from this object. |
bool SelectionResults::Equals | ( | SelectionResults const & | in_that | ) | const |
Check if the source SelectionResults is equivalent to this SelectionResults.
in_that | The source SelectionResults to compare to this SelectionResults. |
size_t SelectionResults::GetCount | ( | ) | const |
Gets the number of items selected when the associated selection action occurred.
SelectionResultsIterator SelectionResults::GetIterator | ( | ) | const |
Get an iterator that can be used to iterate through the selection results.
Selection::Level SelectionResults::GetSelectionLevel | ( | ) | const |
Gets the selection level used when the associated selection action occurred.
bool SelectionResults::Intersect | ( | SelectionResults const & | 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 SelectionResults to intersect with this object. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool SelectionResults::operator!= | ( | SelectionResults const & | in_that | ) | const |
Check if the source SelectionResults is not equivalent to this SelectionResults.
in_that | The source SelectionResults to compare to this SelectionResults. |
SelectionResults& SelectionResults::operator= | ( | SelectionResults && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionResults thereby avoiding a copy.
in_that | An rvalue reference to a SelectionResults to take the impl from. |
SelectionResults& SelectionResults::operator= | ( | SelectionResults const & | in_that | ) |
Share the underlying smart-pointer of the SelectionResults source.
in_that | The SelectionResults source of the assignment. |
bool SelectionResults::operator== | ( | SelectionResults const & | in_that | ) | const |
Check if the source SelectionResults is equivalent to this SelectionResults.
in_that | The source SelectionResults to compare to this SelectionResults. |
|
virtual |
Resets this object to its initial, uninitialized state.
Reimplemented from Object.
bool SelectionResults::SymmetricDifference | ( | SelectionResults const & | 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 SelectionResults to take the symmetric difference of with this object. |
bool SelectionResults::Union | ( | SelectionResults const & | 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 SelectionResults to union with this object. |