< Home

< Table of Contents

REFERENCE MANUAL

HPS.SelectionResults Class Reference

The SelectionResults class is a smart pointer to a database object. More...

Inheritance diagram for HPS.SelectionResults:
HPS.Object

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...
 
- Public Member Functions inherited from HPS.Object
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 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
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

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.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> to copy.

Member Function Documentation

void HPS.SelectionResults.Assign ( HPS.SelectionResults  in_that)

Share the underlying smart-pointer of the SelectionResults source.

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

Parameters
in_thatThe <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).

Parameters
in_thatThe <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> to subtract from this object.
Returns
true if the operation succeeded, false otherwise.
bool HPS.SelectionResults.Equals ( HPS.SelectionResults  in_that)

Check if the source SelectionResults is equivalent to this SelectionResults.

Parameters
in_thatThe 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>.
Returns
true if the objects are equivalent, false otherwise.
ulong HPS.SelectionResults.GetCount ( )

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 ( )

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 ( )

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)

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 <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> to intersect with this object.
Returns
true if the operation succeeded, false otherwise.
override HPS.Type HPS.SelectionResults.ObjectType ( )
virtual

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

Parameters
in_thatThe <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> 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)

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 <ref refid="class_h_p_s_1_1_selection_results" kindref="compound">SelectionResults</ref> to union with this object.
Returns
true if the operation succeeded, false otherwise.

The documentation for this class was generated from the following file: