Class: TGrafBundleIterator

Declaration: Bundles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Allows TGrafBundle clients to iterate through the list of extended attributes in the TGrafBundle. You iterate by calling TGrafBundleIterator::Next until it returns NIL. The TGrafBundleIterator accesses only the extended attributes (those that are descended from TGrafAttribute), not the standard attributes (each of which is accessed by its own TGrafBundle member function). For each attribute, the iterator returns a constant TGrafAttribute pointer. However, the attributes are actually descendants of TGrafAttribute, and you might need to invoke members of the particular TGrafAttribute derived class. If so, (1) determine the attribute's class by invoking its GetName member function, and (2) type cast the pointer into a pointer to the correct class. A TGrafBundleIterator is created either by TGrafBundle::CreateGrafBundleIterator or by a constructor.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGrafBundleIterator::TGrafBundleIterator

TGrafBundleIterator (const TGrafBundle *)
TGrafBundleIterator ()

Interface Category:

API.

Purpose:

Creates a bundle iterator associated with the given bundle.
Default constructor, which is protected so it cannot be used except by derived classes.

Calling Context:

Called by TGrafBundle::CreateGrafBundleIterator.
Called by constructors of derived classes.

Parameters:

const TGrafBundle * -The bundle to iterate over.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrafBundleIterator::~TGrafBundleIterator

virtual ~ TGrafBundleIterator ()

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: TGrafBundleIterator::Reset

virtual void Reset ()

Interface Category:

API.

Purpose:

Resets the iterator to the beginning of the list, without returning the first extended attribute.

Calling Context:

Called by the Graphics system, or directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrafBundleIterator::First

virtual const TGrafAttribute * First ()

Interface Category:

API.

Purpose:

Resets the iterator to the beginning of the list, returning the first extended attribute.

Calling Context:

Called by the Graphics system, or directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to the first item in the list of extended attributes (NIL if the list is empty).

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrafBundleIterator::Next

virtual const TGrafAttribute * Next ()

Interface Category:

API.

Purpose:

Increments the iterator, returning the next item in the list of extended attributes.

Calling Context:

Called by the Graphics system, or directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to the next item in the list of extended attributes (NIL if at the end of the list).

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.