Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.SelectionResults Class Reference

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

Inheritance diagram for HPS.SelectionResults:
HPS.Object

Public Member Functions

override void Dispose ()
 
 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...
 
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...
 
void Assign (HPS.SelectionResults in_that)
 Share the underlying smart-pointer of the SelectionResults source. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.SelectionResults in_that)
 Check if the source SelectionResults is equivalent to this SelectionResults. More...
 
override void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Selection.Level GetSelectionLevel ()
 Gets the selection level used when the associated selection action occurred. More...
 
ulong GetCount ()
 Gets the number of items selected when the associated selection action occurred. More...
 
HPS.SelectionResultsIterator GetIterator ()
 Get an iterator that can be used to iterate through the selection results. 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...
 
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...
 
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 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...
 
void Copy (HPS.SelectionResults in_that)
 Copy the selection results from another SelectionResults object. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 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...
 
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
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...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

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

HPS.SelectionResults.SelectionResults ( )
inline

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

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

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

override void HPS.SelectionResults.Reset ( )
inlinevirtual

Resets this object to its initial, uninitialized state.

Reimplemented from HPS.Object.

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