IlsListRelationConstIterator< RelationList > Class Template Reference

Relation list const iterator. More...

#include <ilserver/model.h>

Public Types
typedef IlsListRelationConstIterator< RelationList >	Myself
	Myself is the type of the instantiated template class.

Public Member Functions
	IlsListRelationConstIterator (const Myself &rhs)
	Copy constructor. Creates an iterator with the same characteristics as the one supplied as its argument. This iterator points to the same item in the list as the iterator supplied as its argument.
	IlsListRelationConstIterator (const RelationList &r)
	Constructor. Creates an iterator for the list that is supplied as its argument.
IlsBoolean	eol () const
	Returns IlsTrue if the end of the list has been reached.
Myself &	gotoEnd ()
	Moves the iterator to the end of the list.
	operator IlsBoolean () const
IlsBoolean	operator!= (Myself &rhs) const
CTargetTypePR	operator* () const
Position	operator+ (int i) const
Myself &	operator++ ()
	This increment operator moves the iterator to the next item in the list. More...
Myself &	operator++ (int)
Myself &	operator+= (int i)
Position	operator- (int i) const
Myself &	operator-- ()
	Moves the iterator to the previous item in the list. More...
Myself &	operator-- (int)
	This operator is identical to operator--() except that it uses a prefix notation. More...
Myself &	operator-= (int i)
Myself &	operator= (const Myself &rhs)
Myself &	operator= (const Position &rhs)
	Moves the iterator to the specified position.
IlsBoolean	operator== (Myself &rhs) const
Myself &	operator>> (TargetTypeP &p)
CTargetTypePR	operator[] (int i) const
	Returns the i-th list item.
void	reset ()
Myself &	seekp (const Position &position)
	Moves the iterator to the specified position.
Position	tellp () const
	Returns the position of the iterator.

Detailed Description

template<class RelationList>
class IlsListRelationConstIterator< RelationList >

Relation list const iterator.

Library: server

This class is aliased (by typedef) as "ConstIterator" in list relations.

Related Pattern

Iterator

See also

IlsOwnsList::ConstIterator, IlsUsesList::ConstIterator.

Member Function Documentation

operator IlsBoolean()

template<class RelationList >

IlsListRelationConstIterator< RelationList >::operator IlsBoolean

(

)

const

\short This conversion operator indicates whether the iterator has
reached the end of the list.

It returns IlsFalse if the list is empty or if at least one unsuccessful extraction has been performed.

operator!=()

template<class RelationList >

IlsBoolean IlsListRelationConstIterator< RelationList >::operator!=

(

Myself &

rhs

)

const

\short Indicates whether the iterator is not at the same

position as the one supplied as its argument.

operator*()

template<class RelationList >

CTargetTypePR IlsListRelationConstIterator< RelationList >::operator*

(

)

const

\short Returns the next item to be read. The iterator

remains at the same position.

operator+()

template<class RelationList >

Position IlsListRelationConstIterator< RelationList >::operator+

(

int

i

)

const

\short Moves the iterator forward in the list according

to the value supplied as its argument.

Exceptions

IlsEndOfList

If the iterator is moved past the last list item.

operator++() [1/2]

template<class RelationList >

Myself& IlsListRelationConstIterator< RelationList >::operator++

(

)

This increment operator moves the iterator to the next item in the list.

Exceptions

IlsEndOfList

If the iterator is moved past the last list item.

operator++() [2/2]

template<class RelationList >

Myself& IlsListRelationConstIterator< RelationList >::operator++

(

int

)

\short This operator is identical to \c operator++() except that it

uses a prefix notation.

Exceptions

IlsEndOfList

If the iterator is moved past the last list item.

operator+=()

template<class RelationList >

Myself& IlsListRelationConstIterator< RelationList >::operator+=

(

int

i

)

\short Moves the iterator forward according to the value

supplied as its argument.

Exceptions

IlsEndOfList

If the value provided moves the iterator past the last list item.

operator-()

template<class RelationList >

Position IlsListRelationConstIterator< RelationList >::operator-

(

int

i

)

const

\short Moves the iterator backward in the list according

to the value supplied as its argument.

\throw IlsBeginningOfList If the iterator is moved past the first list
item.

operator--() [1/2]

template<class RelationList >

Myself& IlsListRelationConstIterator< RelationList >::operator--

(

)

Moves the iterator to the previous item in the list.

Exceptions

IlsBeginningOfList

If the iterator is moved past the first list item.

operator--() [2/2]

template<class RelationList >

Myself& IlsListRelationConstIterator< RelationList >::operator--

(

int

)

This operator is identical to operator--() except that it uses a prefix notation.

\throw IlsBeginningOfList If the iterator is moved past the first list
item.

operator-=()

template<class RelationList >

Myself& IlsListRelationConstIterator< RelationList >::operator-=

(

int

i

)

\short Moves the iterator backward in the list according

to the value supplied as its argument.

Exceptions

IlsBeginningOfList

If the value provided moves the iterator past the first list item.

operator=()

template<class RelationList >

Myself& IlsListRelationConstIterator< RelationList >::operator=

(

const Myself &

rhs

)

\short Moves the iterator to the same position as the

one supplied as its argument.

operator==()

template<class RelationList >

IlsBoolean IlsListRelationConstIterator< RelationList >::operator==

(

Myself &

rhs

)

const

\short Indicates whether the iterator occupies the same

position as the one supplied as its argument.

operator>>()

template<class RelationList >

Myself& IlsListRelationConstIterator< RelationList >::operator>>

(

TargetTypeP &

p

)

\short Sequentially reads the items in the list.

When the iterator is used for the first time, the item read is the one at the beginning of the list.

If the iterator has reached the last item in the list, and if the list 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 list, the conversion operator of the iterator returns IlsFalse.

reset()

template<class RelationList >

void IlsListRelationConstIterator< RelationList >::reset

(

)

\short Resets the iterator so that it points again

to the first item of the list.