Class: TAttributeGroupIterator

Declaration: AttributeGroup.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TAttributeGroupIterator provides for iteration over the elements in an attribute group. Separate constructors are provided for working directly on simple attribute groups or indirectly through surrogates using TAttributeGroupHandle.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This is a concrete class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TAttributeGroupIterator::TAttributeGroupIterator

TAttributeGroupIterator (const TSimpleAttributeGroup & simpleGroup)
TAttributeGroupIterator (const TAttributeGroupHandle & groupHandle)

Interface Category:

API.

Purpose:

Constructs an iterator for a simple attribute group.
Constructs an iterator for surrogate attribute groups.

Calling Context:

Called by the member function CreateIterator for objects of class TSimpleAttributeGroup.
Called by the member function CreateIterator for objects of class TAttributeGroupHandle.

Parameters:

TSimpleAttributeGroup & simpleGroup -The attribute group to be iterated over.
TAttributeGroupHandle & groupHandle -The attribute group to be iterated over.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAttributeGroupIterator::~TAttributeGroupIterator

virtual ~ TAttributeGroupIterator ()

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: TAttributeGroupIterator::First

TAttribute * First ()

Interface Category:

API.

Purpose:

Returns the first attribute in the group.

Calling Context:

Called directly to get the first attribute in the attribute group.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the first attribute in the group.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Attributes are immutable.

Member Function: TAttributeGroupIterator::Next

TAttribute * Next ()

Interface Category:

API.

Purpose:

Returns the next attribute in the group.

Calling Context:

Called directly to get the next attribute in the attribute group.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the next attribute in the group.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Attributes are immutable.

Member Function: TAttributeGroupIterator::Remove

void Remove ()

Interface Category:

API.

Purpose:

Removes the current attribute from the group. This member function does not delete the attribute being removed.

Calling Context:

Called directly to remove the current attribute from the attribute group.

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.