IlsDictionary< ValueType >::Iterator Class Reference

IlsDictionary iterator. More...

#include <ilserver/model.h>

Public Member Functions
	Iterator (IlsDictionary &)
	Creates an iterator for the dictionary supplied as its argument.
	Iterator (Iterator &)
	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.
Iterator &	operator>> (ValueTypeP &)
void	reset ()

Detailed Description

template<class ValueType>
class IlsDictionary< ValueType >::Iterator

IlsDictionary iterator.

Library: server

See also

IlsDictionary

Constructor & Destructor Documentation

Iterator()

template<class ValueType >

IlsDictionary< ValueType >::Iterator::Iterator

(

Iterator &

)

\short 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 Function Documentation

operator>>()

template<class ValueType >

Iterator& IlsDictionary< ValueType >::Iterator::operator>>

(

ValueTypeP &

)

\short 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.

reset()

template<class ValueType >

void IlsDictionary< ValueType >::Iterator::reset

(

)

\short Resets the iterator so that it points again to

the first item of the dictionary.