Class: TPropertySetIterator

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

TPropertySetIterator (const TPropertySet & Set)
TPropertySetIterator (const TPropertySetIterator & copy)

Interface Category:

API.

Purpose:

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

Calling Context:

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

Parameters:

const TPropertySet & Set -The property set to construct an iterator for.
const TPropertySetIterator & copy -The iterator to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySetIterator::operator=

TPropertySetIterator & operator =(const TPropertySetIterator & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TPropertySetIterator & right -The iterator to be copied.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySetIterator::~TPropertySetIterator

virtual ~ TPropertySetIterator ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySetIterator::First

virtual TProperty First ()

Interface Category:

API.

Purpose:

Returns the first property in the set.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The first property in the set, or TPropertySetIterator::kEndOfIteration if the set is empty.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySetIterator::Next

virtual TProperty Next ()

Interface Category:

API.

Purpose:

Returns the next property in the iteration.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The next property in the iteration, or TPropertySetIterator::kEndOfIteration when it reaches the end of iteration.

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.