SelectionResultsIterator
- class HPS.SelectionResultsIterator : public HPS.Object
The SelectionResultsIterator class is used to iterate over a SelectionResults object and access the SelectionItem objects contained within it.
Public Functions
- override void Dispose ()
- HPS.SelectionItem GetItem ()
Get the selection item this SelectionResultsIterator is currently pointing at. This will throw an exception if this iterator is not valid.
- Return
The selection item this SelectionResultsIterator is currently pointing at.
- bool IsValid ()
Indicates whether this SearchResultsIterator is pointing to a valid selection item.
- Return
true if this SearchResultsIterator is pointing to a valid item, false otherwise.
- void Next ()
Advances the iterator to the next selection item.
- override HPS.Type ObjectType ()
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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- override void Reset ()
Reset this SearchResultsIterator so it points to the first selection item in the associated SelectionResults object.
- SelectionResultsIterator ()
The default constructor creates a SelectionResultsIterator object which is not associated with a SelectionResults object.
- 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.
- Param in_that
The source SelectionResultsIterator object to copy.
- void Set (HPS.SelectionResultsIterator in_that)
Copies the source SelectionResultsIterator into this SelectionResultsIterator.
- Param in_that
The source SelectionResultsIterator to copy.
