IlsInvertedRelationList< TargetType, OriginType >::ConstIterator Class Reference

Const iterator. More...

#include <ilserver/model.h>

Public Member Functions
	ConstIterator (const Outer &r)
	Creates an iterator for the list supplied as its argument.
	ConstIterator (const ConstIterator &rhs)
	Copy constructor. Creates an iterator with the same characteristics as the one supplied as its argument. More...
IlsBoolean	eol () const
	Returns IlsTrue if the end of the list has been reached.
ConstIterator &	gotoEnd ()
	Moves the iterator to the end of the list.
	operator IlsBoolean () const
	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 extraction has failed.
IlsBoolean	operator!= (const ConstIterator &rhs) const
OriginType *	operator* () const
	Returns the next item to be read. The iterator remains at the same position.
Position	operator+ (int i) const
	Moves the iterator forward in the list according to the value supplied as its argument. More...
ConstIterator &	operator++ ()
	This increment operator moves the iterator to the next item in the list. More...
ConstIterator &	operator++ (int)
	This operator is identical to operator++() except that it uses a prefix notation. More...
ConstIterator &	operator+= (int i)
	Moves the iterator forward according to the value supplied as its argument. More...
Position	operator- (int i) const
	Moves the iterator backward in the list according to the value supplied as its argument. More...
ConstIterator &	operator-- ()
	Moves the iterator to the previous item in the list. More...
ConstIterator &	operator-- (int)
	This operator is identical to operator--() except that it uses a prefix notation. More...
ConstIterator &	operator-= (int i)
	Moves the iterator backward according to the value supplied as its argument. More...
ConstIterator &	operator= (const Position &rhs)
	Assigns the position provided as its argument to another position and returns the position supplied.
ConstIterator &	operator= (const ConstIterator &rhs)
	Moves the iterator to the same position as the one supplied as its argument.
IlsBoolean	operator== (const ConstIterator &rhs) const
	Indicates whether the iterator is at the same position as the one supplied as its argument.
ConstIterator &	operator>> (OriginType *&p)
	Sequentially reads the items in the list. More...
OriginType *	operator[] (int i) const
	Returns the i-th list element.
ConstIterator &	reset ()
	Resets the iterator so that it points again to the first item of the list.
ConstIterator &	seekp (const Position &position)
	Moves the iterator to the specified position.
Position	tellp () const
	Returns the position of the iterator.

Detailed Description

template<class TargetType, class OriginType>
class IlsInvertedRelationList< TargetType, OriginType >::ConstIterator

Const iterator.

Library: server

Related Pattern

Iterator

See also

IlsException, IlsInvertedRelationList, IlsInvertedRelationList::Iterator, IlsInvertedRelationList::Position.

Constructor & Destructor Documentation

ConstIterator()

template<class TargetType, class OriginType>

IlsInvertedRelationList< TargetType, OriginType >::ConstIterator::ConstIterator

(

const ConstIterator &

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.

Member Function Documentation

operator!=()

template<class TargetType, class OriginType>

IlsBoolean IlsInvertedRelationList< TargetType, OriginType >::ConstIterator::operator!=

(

const ConstIterator &

rhs

)

const

This operator indicates whether the iterator is not at the same position as the one supplied as its argument.

operator+()

template<class TargetType, class OriginType>

Position IlsInvertedRelationList< TargetType, OriginType >::ConstIterator::operator+

(

int

i

)

const

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 TargetType, class OriginType>

ConstIterator& IlsInvertedRelationList< TargetType, OriginType >::ConstIterator::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 TargetType, class OriginType>

ConstIterator& IlsInvertedRelationList< TargetType, OriginType >::ConstIterator::operator++

(

int

)

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

Exceptions

IlsEndOfList

If the iterator is moved past the last list item.

operator+=()

template<class TargetType, class OriginType>

ConstIterator& IlsInvertedRelationList< TargetType, OriginType >::ConstIterator::operator+=

(

int

i

)

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 TargetType, class OriginType>

Position IlsInvertedRelationList< TargetType, OriginType >::ConstIterator::operator-

(

int

i

)

const

Moves the iterator backward in the list according to the value supplied as its argument.

Exceptions

IlsBeginningOfList

If the iterator is moved past the first list item.

operator--() [1/2]

template<class TargetType, class OriginType>

ConstIterator& IlsInvertedRelationList< TargetType, OriginType >::ConstIterator::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 TargetType, class OriginType>

ConstIterator& IlsInvertedRelationList< TargetType, OriginType >::ConstIterator::operator--

(

int

)

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

Exceptions

IlsBeginningOfList

If the iterator is moved past the first list item.

operator-=()

template<class TargetType, class OriginType>

ConstIterator& IlsInvertedRelationList< TargetType, OriginType >::ConstIterator::operator-=

(

int

i

)

Moves the iterator backward 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 TargetType, class OriginType>

ConstIterator& IlsInvertedRelationList< TargetType, OriginType >::ConstIterator::operator>>

(

OriginType *&

p

)

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.