Class: TGrafBundleIterator3D

Declaration: Bundles3D.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Allows TGrafBundle3D clients to iterate through the list of extended attributes in the TGrafBundle3D. You iterate by calling TGrafBundleIterate3D::Next until it returns NIL. The TGrafBundleIterator3D accesses only the extended attributes (those that are descended from TGrafAttribute), not the standard attributes (each of which is accessed by its own TGrafBundle3D 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 TGrafBundleIterator3D is created either by TGrafBundle3D::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: TGrafBundleIterator3D::TGrafBundleIterator3D

TGrafBundleIterator3D (const TGrafBundle3D *)
TGrafBundleIterator3D ()

Interface Category:

API.

Purpose:

Constructor used to create the iterator for a particular TGrafBundle3D.
Default constructor.

Calling Context:

Call this function directly.
Called by the stream-in operators. This is a protected member function and cannot be called directly.

Parameters:

const TGrafBundle3D * -The TGrafBundle3D 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: TGrafBundleIterator3D::~TGrafBundleIterator3D

virtual ~ TGrafBundleIterator3D ()

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

virtual void Reset ()

Interface Category:

API.

Purpose:

Resets the iterator to point to the first item in the list of extended attributes. This function does not return any items yet.

Calling Context:

Call this function 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: TGrafBundleIterator3D::First

virtual const TGrafAttribute * First ()

Interface Category:

API.

Purpose:

Returns the first extended attribute in the bundle's list.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A constant pointer TGrafAttribute that is the first item in the list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGrafBundleIterator3D::Next

virtual const TGrafAttribute * Next ()

Interface Category:

API.

Purpose:

Returns the next extended attribute in the bundle's list. Returns NIL if the last item in the list has been reached.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A constant pointer TGrafAttribute that is the next item in 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.