ISetIterator Class

An object that allows you to iterate over the data associated with an ISetData object.

Set iterators can be created using createIterator on an ISetData.

C++

class ISetIterator;

Remarks

As long as there are pending changes, an open ISetIterator iterates over the original set contents only. An open ISetIterator gets invalidated if changes on the corresponding set are sent to AIMMS. After a call to the reset method, the iterator will be valid again and will iterate over the set contents of the moment of calling reset.

More information on when modifications on sets are sent to AIMMS can be found in the topic on Optimizing performance.

Inheritance Hierarchy

Module

C++

Topics

Name	Description
ISetIterator Members	The following tables list the members exposed by ISetIterator.

Public Methods

	Name	Description
	close	Closes the iterator and invalidates the object.
	createElement	Creates an IElement to be used with the getElement method.
	element	Returns an IElement associated with the current iterator position.
	elementCompatible	Verifies whether the IElement is compatible with the rootset of the ISetData to which this iterator belongs.
	getElement	Gets the element associated with the current iterator position.
	next	Moves the current iterator position to the next iterator position, 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 element. If the iterator was in an erroneous state, the reset method will also reset the state to normal.