REFERENCE MANUAL
The SelectionResultsIterator class is used to iterate over a SelectionResults object and access the SelectionItem objects contained within it. More...
Public Member Functions | |
override void | Dispose () |
HPS.SelectionItem | GetItem () |
Get the selection item this SelectionResultsIterator is currently pointing at. More... | |
bool | IsValid () |
Indicates whether this SearchResultsIterator is pointing to a valid selection item. More... | |
void | Next () |
Advances the iterator to the next selection item. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
override void | Reset () |
Reset this SearchResultsIterator so it points to the first selection item in the associated SelectionResults object. More... | |
SelectionResultsIterator () | |
The default constructor creates a SelectionResultsIterator object which is not associated with a SelectionResults object. More... | |
SelectionResultsIterator (HPS.SelectionResultsIterator in_that) | |
The copy constructor creates a SelectionResultsIterator object associated with the same SelectionResults object as the source SelectionResultsIterator and at the same location in the results. More... | |
void | Set (HPS.SelectionResultsIterator in_that) |
Copies the source SelectionResultsIterator into this SelectionResultsIterator. 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. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The SelectionResultsIterator class is used to iterate over a SelectionResults object and access the SelectionItem objects contained within it.
HPS.SelectionResultsIterator.SelectionResultsIterator | ( | ) |
The default constructor creates a SelectionResultsIterator object which is not associated with a SelectionResults object.
HPS.SelectionResultsIterator.SelectionResultsIterator | ( | HPS.SelectionResultsIterator | in_that | ) |
The copy constructor creates a SelectionResultsIterator object associated with the same SelectionResults object as the source SelectionResultsIterator and at the same location in the results.
Subsequent changes to either iterator will not affect the other.
in_that | The source <ref refid="class_h_p_s_1_1_selection_results_iterator" kindref="compound">SelectionResultsIterator</ref> object to copy. |
HPS.SelectionItem HPS.SelectionResultsIterator.GetItem | ( | ) |
Get the selection item this SelectionResultsIterator is currently pointing at.
This will throw an exception if this iterator is not valid.
bool HPS.SelectionResultsIterator.IsValid | ( | ) |
Indicates whether this SearchResultsIterator is pointing to a valid selection item.
void HPS.SelectionResultsIterator.Next | ( | ) |
Advances the iterator to the next selection item.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
virtual |
Reset this SearchResultsIterator so it points to the first selection item in the associated SelectionResults object.
Reimplemented from HPS.Object.
void HPS.SelectionResultsIterator.Set | ( | HPS.SelectionResultsIterator | in_that | ) |
Copies the source SelectionResultsIterator into this SelectionResultsIterator.
in_that | The source <ref refid="class_h_p_s_1_1_selection_results_iterator" kindref="compound">SelectionResultsIterator</ref> to copy. |