Class: TIteratorOver

Declaration: IteratorOver.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

TDictionaryOfIterator TEmptyIteratorOver TPriorityQueueOfIterator TSequenceOfIterator TSetOfIterator

Purpose:

TIteratorOver is an abstract base class that you can use to iterate over the objects in a collection.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TIteratorOver.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TIteratorOver::~TIteratorOver

virtual ~ TIteratorOver ()

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: TIteratorOver::Next

virtual AType * Next ()

Interface Category:

API.

Purpose:

Retrieves the object after the current object.

Calling Context:

Call this function directly to retrieve the object after the current object.

Parameters:

Takes no parameters.

Return Value:

A pointer to the next object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TIteratorOver::First

virtual AType * First ()

Interface Category:

API.

Purpose:

Retrieves the first object in the collection.

Calling Context:

Call this function directly to retrieves the first object in the collection.

Parameters:

Takes no parameters.

Return Value:

A pointer to the first object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TIteratorOver::Remove

virtual void Remove ()

Interface Category:

API.

Purpose:

Removes the current object from the collection and keep this iterator in sync with the collection.

Calling Context:

Call this function directly to remove the current 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: TIteratorOver::TIteratorOver

TIteratorOver ()
TIteratorOver (const TIteratorOver < AType > &)
TIteratorOver (TCollectionInternal *)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Creates a TIteratorOver and sets the implementation object to the specified object.

Calling Context:

Protected member. Unused.
Call this function directly to copy an object. Protected member. Unused.
Call this function directly to create a TIteratorOver with specified implementation object.

Parameters:

Takes no parameters.
const TIteratorOver < AType > & -The object to be copied.
TCollectionInternal * -The object that implements the iterator operations.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TIteratorOver::operator=

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

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TIteratorOver < 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.