IlsDictionary::Iterator

Category

Nested class

Related Pattern

Iterator

Description

Iterator is a class nested in the template IlsDictionary. It is used to sequentially read a dictionary.

Library

Header File

#include <ilserver/model.h>

Synopsis

class Iterator

{

public:

Iterator(IlsDictionary&);

Iterator(Iterator&);

Iterator& operator>>(ValueTypeP&);

void reset();

operator IlsBoolean();

};

Constructors

Iterator(IlsDictionary&);

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

Iterator(Iterator&);

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

Member Functions

void reset();

This function resets the iterator so that it points again to the first item of the dictionary.

Operators

Iterator& operator>>(ValueTypeP&);

This operator sequentially reads the items in the dictionary. When the iterator is used for the first time, the item read is the one at the beginning of the dictionary. If the iterator has reached the last item in the dictionary and if the dictionary is not empty, no value is assigned to the argument of the operator during the next read operation. The conversion operator to IlsBoolean returns IlsFalse. (See operator IlsBoolean below.) If an iterator is built for an empty dictionary, the conversion operator returns IlsFalse.

operator IlsBoolean();

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