SelectionResultsIterator
-
class
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
-
SelectionItem
GetItem() const Get the selection item this SelectionResultsIterator is currently pointing at. This will throw an exception if this iterator is not valid.
Returns: The selection item this SelectionResultsIterator is currently pointing at.
-
bool
IsValid() const Indicates whether this SearchResultsIterator is pointing to a valid selection item.
Returns: true if this SearchResultsIterator is pointing to a valid item, false otherwise.
-
void
Next() Advances the iterator to the next selection item.
-
inline virtual HPS::Type
ObjectType() const 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).
Returns: The declared type of the object in question, which may differ from the true, underlying type.
-
bool
operator!=(SelectionResultsIterator const &in_search_results_iterator) Comparison operator between iterators to compare inequality
Parameters: in_search_results_iterator – The iterator to compare to
-
SelectionItem
operator*() const Get the selection item this SelectionResultsIterator is currently pointing at. This will throw an exception if this iterator is not valid.
Returns: The selection item this SelectionResultsIterator is currently pointing at.
-
SelectionResultsIterator &
operator++() The prefix increment operator advances this iterator and returns it.
Returns: A reference to this SelectionResultsIterator.
-
SelectionResultsIterator
operator++(int in_val) The postfix increment operator advances this iterator and returns a copy of the it prior to advancement.
Returns: A copy of this SelectionResultsIterator prior to having advanced it.
-
SelectionResultsIterator &
operator=(SelectionResultsIterator &&in_that) The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionResultsIterator thereby avoiding a copy.
Parameters: in_that – An rvalue reference to a SelectionResultsIterator to take the impl from. Returns: A reference to this SelectionResultsIterator.
-
SelectionResultsIterator &
operator=(SelectionResultsIterator const &in_that) Copies the source SelectionResultsIterator into this SelectionResultsIterator.
Parameters: in_that – The source SelectionResultsIterator to copy. Returns: A reference to this SelectionResultsIterator.
-
bool
operator==(SelectionResultsIterator const &in_search_results_iterator) Comparison operator between iterators to compare equality
Parameters: in_search_results_iterator – The iterator to compare to
-
virtual 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(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.
Parameters: in_that – An rvalue reference to a SelectionResultsIterator to take the impl from.
-
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.
Parameters: in_that – The source SelectionResultsIterator object to copy.
-
void
Set(SelectionResultsIterator const &in_that) Copies the source SelectionResultsIterator into this SelectionResultsIterator.
Parameters: in_that – The source SelectionResultsIterator to copy.
-
~SelectionResultsIterator()
-
SelectionItem
