
Public Member Functions | |
override void | Dispose () |
HPS.SelectionItem | GetItem () |
Get the selection item this SelectionResultsIterator is currently pointing at. This will throw an exception if this iterator is not valid. 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 () |
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. Subsequent changes to either iterator will not affect the other. More... | |
void | Set (HPS.SelectionResultsIterator in_that) |
Copies the source SelectionResultsIterator into this SelectionResultsIterator. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
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
|
inline |
The default constructor creates a SelectionResultsIterator object which is not associated with a SelectionResults object.
|
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_that The source SelectionResultsIterator object to copy.
Member Function Documentation
|
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.
|
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.
|
inline |
Advances the iterator to the next selection item.
|
inlinevirtual |
Reset this SearchResultsIterator so it points to the first selection item in the associated SelectionResults object.
Reimplemented from HPS.Object.
|
inline |
Copies the source SelectionResultsIterator into this SelectionResultsIterator.
- Parameters
-
in_that The source SelectionResultsIterator to copy.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.SelectionResultsIterator.cs