HPS::SelectionResultsIterator Class Reference

#include <hps.h>

Inheritance diagram for HPS::SelectionResultsIterator:
HPS::Object

Public Member Functions

SelectionItem GetItem () const
 
bool IsValid () const
 
void Next ()
 
HPS::Type ObjectType () const
 
bool operator!= (SelectionResultsIterator const &in_search_results_iterator)
 
SelectionItem operator* () const
 
SelectionResultsIteratoroperator++ ()
 
SelectionResultsIterator operator++ (int in_val)
 
SelectionResultsIteratoroperator= (SelectionResultsIterator &&in_that)
 
SelectionResultsIteratoroperator= (SelectionResultsIterator const &in_that)
 
bool operator== (SelectionResultsIterator const &in_search_results_iterator)
 
void Reset ()
 
 SelectionResultsIterator ()
 
 SelectionResultsIterator (SelectionResultsIterator const &in_that)
 
 SelectionResultsIterator (SelectionResultsIterator &&in_that)
 
void Set (SelectionResultsIterator const &in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::SelectionResultsIterator
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The SelectionResultsIterator class is used to iterate over a SelectionResults object and access the SelectionItem objects contained within it.

Constructor & Destructor Documentation

◆ SelectionResultsIterator() [1/3]

HPS::SelectionResultsIterator::SelectionResultsIterator ( )

The default constructor creates a SelectionResultsIterator object which is not associated with a SelectionResults object.

◆ SelectionResultsIterator() [2/3]

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.

Parameters
in_thatThe source SelectionResultsIterator object to copy.

◆ SelectionResultsIterator() [3/3]

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.

Parameters
in_thatAn rvalue reference to a SelectionResultsIterator to take the impl from.

Member Function Documentation

◆ GetItem()

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.

Returns
The selection item this SelectionResultsIterator is currently pointing at.

◆ IsValid()

bool HPS::SelectionResultsIterator::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.

◆ Next()

void HPS::SelectionResultsIterator::Next ( )

Advances the iterator to the next selection item.

◆ ObjectType()

HPS::Type HPS::SelectionResultsIterator::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::Object.

◆ operator!=()

bool HPS::SelectionResultsIterator::operator!= ( SelectionResultsIterator const &  in_search_results_iterator)

Comparison operator between iterators to compare inequality

Parameters
in_search_results_iteratorThe iterator to compare to

◆ operator*()

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.

Returns
The selection item this SelectionResultsIterator is currently pointing at.

◆ operator++() [1/2]

SelectionResultsIterator& HPS::SelectionResultsIterator::operator++ ( )

The prefix increment operator advances this iterator and returns it.

Returns
A reference to this SelectionResultsIterator.

◆ operator++() [2/2]

SelectionResultsIterator HPS::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.

◆ operator=() [1/2]

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.

Parameters
in_thatAn rvalue reference to a SelectionResultsIterator to take the impl from.
Returns
A reference to this SelectionResultsIterator.

◆ operator=() [2/2]

SelectionResultsIterator& HPS::SelectionResultsIterator::operator= ( SelectionResultsIterator const &  in_that)

Copies the source SelectionResultsIterator into this SelectionResultsIterator.

Parameters
in_thatThe source SelectionResultsIterator to copy.
Returns
A reference to this SelectionResultsIterator.

◆ operator==()

bool HPS::SelectionResultsIterator::operator== ( SelectionResultsIterator const &  in_search_results_iterator)

Comparison operator between iterators to compare equality

Parameters
in_search_results_iteratorThe iterator to compare to

◆ Reset()

void HPS::SelectionResultsIterator::Reset ( )
virtual

Reset this SearchResultsIterator so it points to the first selection item in the associated SelectionResults object.

Reimplemented from HPS::Object.

◆ Set()

void HPS::SelectionResultsIterator::Set ( SelectionResultsIterator const &  in_that)

Copies the source SelectionResultsIterator into this SelectionResultsIterator.

Parameters
in_thatThe source SelectionResultsIterator to copy.

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