< Home

< Table of Contents

REFERENCE MANUAL

HPS.SelectionResultsIterator Class Reference

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

Inheritance diagram for HPS.SelectionResultsIterator:
HPS.Object

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...
 
- Public Member Functions inherited from HPS.Object
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 ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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

Constructor & Destructor Documentation

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.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_selection_results_iterator" kindref="compound">SelectionResultsIterator</ref> object to copy.

Member Function Documentation

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.

Returns
The selection item this SelectionResultsIterator is currently pointing at.
bool HPS.SelectionResultsIterator.IsValid ( )

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 HPS.SelectionResultsIterator.Next ( )

Advances the iterator to the next selection item.

override HPS.Type HPS.SelectionResultsIterator.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

override 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.

void HPS.SelectionResultsIterator.Set ( HPS.SelectionResultsIterator  in_that)

Copies the source SelectionResultsIterator into this SelectionResultsIterator.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_selection_results_iterator" kindref="compound">SelectionResultsIterator</ref> to copy.

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