Server
API Reference Guide
Product Documentation:

Visualization Server
Documentation Home
List of all members | Public Types | Public Member Functions
IlsListRelationPosition< RelationList > Class Template Reference

This class sets an iterator to a given position. More...

#include <ilserver/model.h>

Public Types

typedef IlsListRelationPosition< RelationList > Myself
 Myself is the type of the instantiated template class.
 

Public Member Functions

 IlsListRelationPosition (const Myself &rhs)
 
IlsBoolean operator!= (const Myself &rhs) const
 Evaluates whether two positions are not equal.
 
CTargetTypePR operator* () const
 Converts the position to the item to which the position points.
 
Myself operator+ (int i) const
 
Myselfoperator++ ()
 This increment operator moves the iterator to the next item in the list. More...
 
Myselfoperator++ (int i)
 This operator is identical to operator++() except that it uses a prefix notation. More...
 
Myselfoperator+= (int i)
 
Myself operator- (int i) const
 
Myselfoperator-- ()
 This decrement operator moves the iterator to the previous item in the list. More...
 
Myselfoperator-- (int i)
 This operator is identical to operator--() except that it uses a prefix notation. More...
 
Myselfoperator-= (int i)
 
Myselfoperator= (const Myself &rhs)
 
IlsBoolean operator== (const Myself &rhs) const
 Evaluates whether two positions are equal.
 

Detailed Description

template<class RelationList>
class IlsListRelationPosition< RelationList >

This class sets an iterator to a given position.

Library: server

This class is aliased (typedef) as Position in list relations.

Related Pattern

Memento

See also
IlsOwnsList::Position, IlsOwnsList::Iterator.

Constructor & Destructor Documentation

◆ IlsListRelationPosition()

template<class RelationList >
IlsListRelationPosition< RelationList >::IlsListRelationPosition ( const Myself rhs)
\short Copy constructor. Creates a position that points to the same

location as the one supplied as its argument.

Member Function Documentation

◆ operator+()

template<class RelationList >
Myself IlsListRelationPosition< RelationList >::operator+ ( int  i) const
\short Moves the iterator forward in the list according

to the value supplied as its argument.

Exceptions
IlsEndOfListIf the iterator is moved past the last list item.

◆ operator++() [1/2]

template<class RelationList >
Myself& IlsListRelationPosition< RelationList >::operator++ ( )

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

Exceptions
IlsEndOfListIf the iterator is moved past the last list item.

◆ operator++() [2/2]

template<class RelationList >
Myself& IlsListRelationPosition< RelationList >::operator++ ( int  i)

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

Exceptions
IlsEndOfListIf the iterator is moved past the last list item.

◆ operator+=()

template<class RelationList >
Myself& IlsListRelationPosition< RelationList >::operator+= ( int  i)
\short Moves the iterator forward according to the value

supplied as its argument.

Exceptions
IlsEndOfListIf the value provided moves the iterator past the last list item.

◆ operator-()

template<class RelationList >
Myself IlsListRelationPosition< RelationList >::operator- ( int  i) const
\short Moves the iterator backward in the list according

to the value supplied as its argument.

Exceptions
IlsBeginningOfListIf the iterator is moved past the first list item.

◆ operator--() [1/2]

template<class RelationList >
Myself& IlsListRelationPosition< RelationList >::operator-- ( )

This decrement operator moves the iterator to the previous item in the list.

Exceptions
IlsBeginningOfListIf the iterator is moved past the first list item.

◆ operator--() [2/2]

template<class RelationList >
Myself& IlsListRelationPosition< RelationList >::operator-- ( int  i)

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

Exceptions
IlsBeginningOfListIf the iterator is moved past the first list item.

◆ operator-=()

template<class RelationList >
Myself& IlsListRelationPosition< RelationList >::operator-= ( int  i)
\short Moves the iterator backward in the list according

to the value supplied as its argument.

Exceptions
IlsBeginningOfListIf the value provided moves the iterator past the first list item.

◆ operator=()

template<class RelationList >
Myself& IlsListRelationPosition< RelationList >::operator= ( const Myself rhs)
\short Assigns the position provided as its argument to

another position and returns the position supplied.