Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
None.
Purpose:
This is a class for creating an iterator. An iterator created from this class is used to iterate through the list of objects in a spin field.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Derive to create list iterators for specific spin list items. Derived class should override member functions: First(), Next(), Previous().
Concurrency:
Multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
TSpinListIterator ()
Interface Category:
API.
Purpose:
Default constructor.
Calling Context:
Called by the stream-in operators to create an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual ~ TSpinListIterator ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual TText * First ()
Interface Category:
API.
Purpose:
Returns a pointer to the first item in the list.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the pointer to the TText object that is the first item in the list.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual TText * Next ()
Interface Category:
API.
Purpose:
Returns the pointer to the next item in the list.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the pointer to the TText object that is the next item in the list.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual TText * Previous ()
Interface Category:
API.
Purpose:
Returns the pointer to the previous item in the list.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the pointer to the TText object that is the previous item in the list.
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.
Copyright©1995 Taligent,Inc. All rights reserved.