# CIndexSet::Iterator Class Reference

A class for iterating over CDataArray objects during an evaluation. Iterator objects must always be created with CIndexSet::Begin(). More...

`#include <xsi_indexset.h>`

List of all members.

## Public Member Functions
SICPPSDK_INLINE void | Remove ()
SICPPSDK_INLINE bool | HasNext () const
SICPPSDK_INLINE ULONG | GetIndex () const
SICPPSDK_INLINE ULONG | GetAbsoluteIndex () const
SICPPSDK_INLINE void | Next ()
SICPPSDK_INLINE | operator ULONG () const

## Detailed Description

A class for iterating over CDataArray objects during an evaluation. Iterator objects must always be created with CIndexSet::Begin().

Since:
  7.0

See also:
  CIndexSet, CDataArray, CDataArray2D

## Member Function Documentation

SICPPSDK_INLINE void Remove | ( |  | ) |

Removes the current index from the CIndexSet.

Note:
  Removing an index will set CIndexSet with the next available index in the set. Make sure you don't call Iterator::Next again after Remove to avoid unexpected results while iterating.

SICPPSDK_INLINE bool HasNext | ( |  | ) | const

Use this method to know if there are more items in the set.

Returns:
  True if there are more items.

SICPPSDK_INLINE ULONG GetIndex | ( |  | ) | const

Returns the current index in the set.

Returns:
  Current index.

SICPPSDK_INLINE ULONG GetAbsoluteIndex | ( |  | ) | const

Returns the absolute index based on the global index set of the evaluation.

Returns:
  Absolute index.

SICPPSDK_INLINE void Next | ( |  | ) |

Moves to the next index in the set.

SICPPSDK_INLINE operator ULONG | ( |  | ) | const

Cast-operator which returns the current index in the set.

Returns:
  Current index.

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

- xsi_indexset.h