Class: TSequenceOfIterator

Declaration: SequenceIterator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TIteratorOver

Inherited By:

TArrayOfIterator TDequeOfIterator TEmptySequenceIterator TSortedSequenceOfIterator

Purpose:

TSequenceOfIterator allows you to iterate over the objects in a sequence collection. TSequenceOfIterator inherits operators for retrieving the first and next objects in the sequence. TSequenceOfIterator adds operators for retrieving the previous and last objects it the sequence.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TSequenceOfIterator.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSequenceOfIterator::Previous

AType * Previous ()

Interface Category:

API.

Purpose:

Returns the object in the sequence before the current object.

Calling Context:

Call this function directly to return the previous object.

Parameters:

Takes no parameters.

Return Value:

A pointer to the object retrieved. A NIL pointer is returned if the current object is the first in the sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSequenceOfIterator::Last

AType * Last ()

Interface Category:

API.

Purpose:

Returns the last object in the sequence.

Calling Context:

Call this function directly to return the last object.

Parameters:

Takes no parameters.

Return Value:

A pointer to the object retrieved. A NIL pointer is returned if there are no objects in the sequence.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSequenceOfIterator::operator=

const TSequenceOfIterator < AType > & operator =(const TSequenceOfIterator < 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 TSequenceOfIterator < 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.

Member Function: TSequenceOfIterator::TSequenceOfIterator

TSequenceOfIterator (TSequenceInternal *)
TSequenceOfIterator ()
TSequenceOfIterator (const TSequenceOfIterator < AType > &)

Interface Category:

API.

Purpose:

Create iterator over the given internal collection. Protected member. Unused.
Default constructor. Protected member. Unused.
Copy constructor. Protected member. Unused.

Calling Context:

Protected member. Unused.
Protected member. Unused.
Protected member. Unused.

Parameters:

TSequenceInternal * -The object to be copied.
Takes no parameters.
const TSequenceOfIterator < AType > & -The iterator to use.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSequenceOfIterator::~TSequenceOfIterator

virtual ~ TSequenceOfIterator ()

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.

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