Class: TSetOfIterator

Declaration: SetIterator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TIteratorOver

Inherited By:

None.

Purpose:

TSetOfIterator allows you to iterate over the objects in a set. TSetOfIterator inherits operators for retrieving the first and next object in the set as well as operators for removing objects.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TSetOfIterator.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSetOfIterator::~TSetOfIterator

virtual ~ TSetOfIterator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSetOfIterator::TSetOfIterator

TSetOfIterator (const TSetOf < AType > * setOf)
TSetOfIterator ()
TSetOfIterator (const TSetOfIterator < AType > &)

Interface Category:

API.

Purpose:

Creates iterator over the supplied TSetOf.
Protected member. Unused.
Protected member. Unused.

Calling Context:

Call this function directly to create an iterator.
Protected member. Unused.
Protected member. Unused.

Parameters:

const TSetOf < AType > * setOf -The object to be copied.
Takes no parameters.
const TSetOfIterator < AType > & -The iterator object to use.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

It is best to create an iterator by calling TSetOf's member function CreateIterator.

Member Function: TSetOfIterator::operator=

const TSetOfIterator < AType > & operator =(const TSetOfIterator < AType > &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly when an object is assigned to a compatible object. Protected member. Unused.

Parameters:

const TSetOfIterator < AType > & -The object to be copied.

Return Value:

A reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.