Class: TPropertyIDSetIterator

Declaration: Property.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Provides an iterator class over the contents of a property identifier set.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is not intended to be derived from.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPropertyIDSetIterator::TPropertyIDSetIterator

TPropertyIDSetIterator (const TPropertyIDSet & set)
TPropertyIDSetIterator (const TPropertyIDSetIterator & copy)

Interface Category:

API.

Purpose:

Constructs an iterator over the contents of the specified property identifier set.
Copy constructor.

Calling Context:

Called to construct an iterator from a set.
Called to copy an object.

Parameters:

const TPropertyIDSet & set -The property identifier set to construct an iterator for.
const TPropertyIDSetIterator & copy -The iterator to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSetIterator::operator=

TPropertyIDSetIterator & operator =(const TPropertyIDSetIterator & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TPropertyIDSetIterator & right -The iterator to assign to this object.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSetIterator::~TPropertyIDSetIterator

virtual ~ TPropertyIDSetIterator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSetIterator::First

virtual TPropertyID First ()

Interface Category:

API.

Purpose:

Returns the first identifier in the set.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the first identifier in the set, or TPropertyIDSetIterator::kEndOfIteration if the set is empty.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSetIterator::Next

virtual TPropertyID Next ()

Interface Category:

API.

Purpose:

Returns the next identifier in the set.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the next identifier in the set, or TPropertyIDSetIterator::kEndOfIteration if the end of this iteration has been reached.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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