#include <hps.h>
Additional Inherited Members | |
Static Public Member Functions inherited from HPS::Object | |
| template<typename T > | |
| static intptr_t | ClassID () |
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 | ( | SelectionResultsIterator const & | 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 SelectionResultsIterator object to copy. |
| HPS::SelectionResultsIterator::SelectionResultsIterator | ( | SelectionResultsIterator && | in_that | ) |
The move constructor creates a SelectionResultsIterator by transferring the underlying impl of the rvalue reference to this SelectionResultsIterator thereby avoiding a copy and allocation.
| in_that | An rvalue reference to a SelectionResultsIterator to take the impl from. |
| SelectionItem HPS::SelectionResultsIterator::GetItem | ( | ) | const |
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 | ( | ) | const |
Indicates whether this SearchResultsIterator is pointing to a valid selection item.
| void HPS::SelectionResultsIterator::Next | ( | ) |
Advances the iterator to the next selection item.
|
inlinevirtual |
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.
| bool HPS::SelectionResultsIterator::operator!= | ( | SelectionResultsIterator const & | in_search_results_iterator | ) |
Comparison operator between iterators to compare inequality
| in_search_results_iterator | The iterator to compare to |
| SelectionItem HPS::SelectionResultsIterator::operator* | ( | ) | const |
Get the selection item this SelectionResultsIterator is currently pointing at. This will throw an exception if this iterator is not valid.
| SelectionResultsIterator& HPS::SelectionResultsIterator::operator++ | ( | ) |
The prefix increment operator advances this iterator and returns it.
| SelectionResultsIterator HPS::SelectionResultsIterator::operator++ | ( | int | in_val | ) |
The postfix increment operator advances this iterator and returns a copy of the it prior to advancement.
| SelectionResultsIterator& HPS::SelectionResultsIterator::operator= | ( | SelectionResultsIterator && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionResultsIterator thereby avoiding a copy.
| in_that | An rvalue reference to a SelectionResultsIterator to take the impl from. |
| SelectionResultsIterator& HPS::SelectionResultsIterator::operator= | ( | SelectionResultsIterator const & | in_that | ) |
Copies the source SelectionResultsIterator into this SelectionResultsIterator.
| in_that | The source SelectionResultsIterator to copy. |
| bool HPS::SelectionResultsIterator::operator== | ( | SelectionResultsIterator const & | in_search_results_iterator | ) |
Comparison operator between iterators to compare equality
| in_search_results_iterator | The iterator to compare to |
|
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 | ( | SelectionResultsIterator const & | in_that | ) |
Copies the source SelectionResultsIterator into this SelectionResultsIterator.
| in_that | The source SelectionResultsIterator to copy. |