Class: TSortedSequenceOfIterator

Declaration: SortedSequenceIterator.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSequenceOfIterator

Inherited By:

None.

Purpose:

TSortedSequenceOfIterator is a class that you can use to iterate over the objects in a sorted sequence. TSortedSequenceOfIterator inherits operators for retrieving the first and next objects in the sequence.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

You should not derive any classes from TSortedSequenceOfIterator. TSortedSequenceOfIterator is derived from TSequenceOfIterator.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSortedSequenceOfIterator::~TSortedSequenceOfIterator

virtual ~ TSortedSequenceOfIterator ()

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

TSortedSequenceOfIterator (const TSortedSequenceOf < AType > * sortedSequenceOf)
TSortedSequenceOfIterator ()
TSortedSequenceOfIterator (const TSortedSequenceOfIterator < AType > &)

Interface Category:

API.

Purpose:

Creates an iterator associated with the supplied sorted sequence.
Default constructor.
Copy constructor.

Calling Context:

Call this function directly to create an iterator for the supplied sorted sequence.
Protect member. Unused constructor.
Protect member. Unused constructor.

Parameters:

const TSortedSequenceOf < AType > * sortedSequenceOf -The object to be copied.
Takes no parameters.
const TSortedSequenceOfIterator < AType > & -The sorted sequence iterator to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSortedSequenceOfIterator::StartHere

AType * StartHere (const AType & obj)

Interface Category:

API.

Purpose:

Sets the current position in the sequence to the object that is equal to the object supplied.

Calling Context:

Call this function directly to set the current position to the object in the sequence that is equal to the supplied object. The member function Next will return the object after the supplied object.

Parameters:

const AType & obj -The object to match.

Return Value:

A reference to the object in the sequence that matches the object passed.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSortedSequenceOfIterator::operator=

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

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Protected member. Unused.

Parameters:

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