Name 

Description 

 

close 

Closes the iterator and invalidates this object.  

 

createTuple 

Creates an ITuple that can be used to retrieve the current position, by using it as an argument of the getTuple method.  

 

getTuple 

Retrieves the current position into an ITuple, which you must create first by invoking the createTuple method.  

 

next 

Moves the current position to the next non-default value, if any.  

 

reset 

Re initializes the iterator: Moves the current position to before the beginning of the data; a subsequent next call will find the first non-default position. If the iterator was in an erroneous state, the reset method will also reset the state to normal.
 

 

tupleValid 

Verifies whether the given ITuple can be used with the getTuple method. More specifically, it tests whether the given ITuple is compatible with the domain sets of the associated IData object.  

 

Name 

Description 

 

this 

Returns the position on the specified dimension.  

 

Name 

Description 

 

Dimension 

The dimension of the IIterator.  

 

Double 

The value on the current position. Applies to double valued data only.  

 

Element 

The value on the current position. Applies to element valued data only.  

 

Int 

The value on the current position. Applies to integer valued data and element valued data of which the range is a subset of Integers.  

 

String 

The value on the current position. Applies to string valued data and element valued data of which the range is not a subset of Integers.  

 

Tuple 

The current position of the iterator. The returned ITuple is readonly.