Class: TDequeOfIterator

Declaration: DequeIterator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSequenceOfIterator

Inherited By:

None.

Purpose:

TDequeOfIterator is a template class that you can use to iterate over the objects in a TDequeOf. TDequeOfIterator inherits several operators from TIteratorOver and TSequenceOfIterator for accessing objects in the collection.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TDequeOfIterator.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TDequeOfIterator::~TDequeOfIterator

virtual ~ TDequeOfIterator ()

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: TDequeOfIterator::TDequeOfIterator

TDequeOfIterator (const TDequeOf < AType

* dequeOf)

TDequeOfIterator ()
TDequeOfIterator (const TDequeOfIterator < AType > &)

Interface Category:

API.

Purpose:

Creates an iterator for the specified object.
Default constructor. Protected member. Unused.
Copy constructor. Protected member. Unused.

Calling Context:

Call this function directly to create an iterator for the specified object.
Call this function directly by the stream-in operators and anywhere the creation of a TDequeOfIterator is desired.
Call this function directly to copy an object.

Parameters:

const TDequeOf < AType > * dequeOf -The object to iterate over.
Takes no parameters.
const TDequeOfIterator < AType > & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDequeOfIterator::operator=

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

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Protected member. Unused.

Parameters:

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

Return Value:

Currently returns a reference to this 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.