HPS.SelectionResultsIterator Class Reference
Inheritance diagram for HPS.SelectionResultsIterator:
HPS.Object

Public Member Functions

override void Dispose ()
 
HPS.SelectionItem GetItem ()
 
bool IsValid ()
 
void Next ()
 
override HPS.Type ObjectType ()
 
override void Reset ()
 
 SelectionResultsIterator ()
 
 SelectionResultsIterator (HPS.SelectionResultsIterator in_that)
 
void Set (HPS.SelectionResultsIterator in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual HPS.Type Type ()
 

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
 

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/2]

HPS.SelectionResultsIterator.SelectionResultsIterator ( )
inline

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

◆ SelectionResultsIterator() [2/2]

HPS.SelectionResultsIterator.SelectionResultsIterator ( HPS.SelectionResultsIterator  in_that)
inline

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.

Member Function Documentation

◆ GetItem()

HPS.SelectionItem HPS.SelectionResultsIterator.GetItem ( )
inline

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 ( )
inline

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 ( )
inline

Advances the iterator to the next selection item.

◆ ObjectType()

override HPS.Type HPS.SelectionResultsIterator.ObjectType ( )
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.

◆ Reset()

override void HPS.SelectionResultsIterator.Reset ( )
inlinevirtual

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

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:
  • internals/hps_core/source/cs/HPS.SelectionResultsIterator.cs