Server
API Reference Guide
Product Documentation:

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

Iterator class. More...

#include <ilserver/model.h>

Inherits IlsViewedRelIterator.

Public Types

typedef IlsSetRelationIterator< RelationSet > Myself
 Myself is the type of the instantiated template class.
 

Public Member Functions

 IlsSetRelationIterator (const Myself &rhs)
 Copy constructor. Creates an iterator with the same characteristics as the one supplied as its argument. The iterator points to the same location in the set as the iterator supplied as its argument.
 
 IlsSetRelationIterator (RelationSet &r)
 Creates an iterator for the set supplied as its argument.
 
 operator IlsBoolean () const
 This conversion operator indicates whether the iterator has reached the end of the set. It returns IlsFalse if at least one extraction operation was unsuccessful.
 
Myselfoperator>> (TargetTypeP &p)
 
void reset ()
 

Detailed Description

template<class RelationSet>
class IlsSetRelationIterator< RelationSet >

Iterator class.

Library: server

This class is aliased (typedef) to Iterator in set relations.

Related Pattern
Iterator
See also
IlsOwnsSet::Iterator, IlsUSesSet::Iterator.

Member Function Documentation

◆ operator>>()

template<class RelationSet >
Myself& IlsSetRelationIterator< RelationSet >::operator>> ( TargetTypeP &  p)
\short Scans the elements in the set sequentially.

When the iterator is used for the first time, it scans all the elements in the set. This operator returns the iterator, which converts to a Boolean type. Once the set has been entirely scanned, the iterator converts to IlsFalse.

The scanning order may change completely as new objects are added to the set or removed from the set.

◆ reset()

template<class RelationSet >
void IlsSetRelationIterator< RelationSet >::reset ( )
\short Resets the iterator so that it can scan

all the elements in the set again.