IlsOwnsSet::Iterator

Category

Nested class

Description

Iterator is a class nested in the template IlsOwnsSet. Instances of Iterator are used to sequentially read a relation set.

Related Pattern

Iterator

Library

Header File

#include <ilserver/model.h>

Synopsis

class Iterator

{

public:

Iterator(IlsOwnsSet&);

Iterator(const Iterator&);

Iterator& operator>>(OwnedTypeP&);

void reset();

operator IlsBoolean();

};

Constructors

Iterator(IlsOwnsSet&);

This constructor creates an iterator for the set supplied as its argument.

Iterator(const Iterator&);

This copy constructor creates an iterator with the same characteristics as the one supplied as its argument. The iterator points to the same location in the set as the iterator supplied as its argument.

Member Functions

void reset();

This member function resets the iterator so that it can scan all the elements in the set again.

Operators

Iterator& operator>>(OwnedTypeP&);

This operator scans the elements in the set sequentially. When the iterator is used for the first time, it scans all the elements in the set. This operator returns the iterator, which converts to a Boolean type. Once the set has been entirely scanned, the iterator converts to IlsFalse. The scanning order may change completely as new objects are added to the set or removed from the set.

operator IlsBoolean();

This conversion operator indicates whether the iterator has reached the end of the set.
It returns IlsFalse if at least one extraction operation was unsuccessful.