IlsInvertedRelationList< TargetType, OriginType >::Iterator Class Reference

Non const iterator. More...

#include <ilserver/model.h>

Inherits IlsViewedRelIterator.

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

Detailed Description

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

Non const iterator.

Library: server

Related Pattern

Iterator

See also

IlsException, IlsInvertedRelationList, IlsInvertedRelationList::ConstIterator, IlsInvertedRelationList::Position.

Constructor & Destructor Documentation

Iterator()

template<class TargetType , class OriginType >

IlsInvertedRelationList< TargetType, OriginType >::Iterator::Iterator

(

const Iterator &

rhs

)

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

OriginType* IlsInvertedRelationList< TargetType, OriginType >::Iterator::operator*

(

)

const

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

remains at the same position.

operator+()

template<class TargetType , class OriginType >

Position IlsInvertedRelationList< TargetType, OriginType >::Iterator::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 >

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

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

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

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

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

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

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

(

OriginType *

p

)

\short Adds an item to the list and puts it after the

last item read by the iterator or at the beginning of the list if the iterator has not yet been used.

Warning

If several iterators have been declared for the same list, be careful when you use one of these iterators to add an item to the list. Let us suppose that iw is an iterator that performs write operations and ir is an iterator that performs read operations. If ir and iw point to the same item in the list and if iw is used to add an item to this list, ir may behave unexpectedly.

Exceptions

IlsMaxCardViolated

If attempting to add an item to the list when the maximum cardinality has been reached.

operator=()

template<class TargetType , class OriginType >

Iterator& IlsInvertedRelationList< TargetType, OriginType >::Iterator::operator=

(

const Iterator &

rhs

)

\short Moves the iterator to the same position as the

one supplied as its argument.

operator>>()

template<class TargetType , class OriginType >

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

(

OriginType *&

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 IlsBoolean()).

If an iterator is built for an empty list, the conversion operator of the iterator returns IlsFalse.

shrink()

template<class TargetType , class OriginType >

Iterator& IlsInvertedRelationList< TargetType, OriginType >::Iterator::shrink

(

)

\short Removes the item following the last
element read from the list, or, if the list has not been read yet,
it removes the first item in the list.

\warning If several iterators, or positions, have been declared
    for the same list, be careful when you use the shrink
         function with one of these iterators or positions.
         For example, suppose we have an iterator \c iw that
         performs write operations and an iterator \c ir that
         performs read operations. If \c ir and \c iw point to
         the same item in the list and if \c iw executes the
         function `shrink()`, \c ir may behave unexpectedly.
         Likewise, if \c iw points to a given item in the list
         and \c ir points to the next item, \c ir may behave
         unexpectedly if \c iw executes the function `shrink()`.

\throw IlsMinCardViolated If this function is called when the
         minimum cardinality of the list has been reached.

Exceptions

IlsEndOfList

If it is called when the iterator points to the last item of the list.

shrinkBefore()

template<class TargetType , class OriginType >

Iterator& IlsInvertedRelationList< TargetType, OriginType >::Iterator::shrinkBefore

(

)

\short Removes the last item read from the list.

Restrictions of the same kind as those mentioned for shrink() apply to shrinkBefore().

\throw IlsMinCardViolated If this function is called when the
       minimal cardinality of the list has been reached.
\throw IlsBeginningOfList If it is called when the iterator points
  to the first item of the list.