Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

vtkObjectBaseStackIterator Class Reference

#include <vtkObjectBaseStackIterator.h>

Inheritance diagram for vtkObjectBaseStackIterator:

Inheritance graph
[legend]
Collaboration diagram for vtkObjectBaseStackIterator:

Collaboration graph
[legend]
List of all members.

Detailed Description

An iterator for vtkObjectBaseStack subclasses.

See also:
vtkObjectBaseStack

Definition at line 31 of file vtkObjectBaseStackIterator.h.

Public Member Functions

 vtkTypeRevisionMacro (vtkObjectBaseStackIterator, vtkIterator)
Data Access Methods
vtkObjectBase * GetObject (void) const
 Retrieve the data from the iterator.

int SetObject (vtkObjectBase *object)
 Set the data at the iterator's position.

Traversal Methods
int InitTraversal (void)
 Initialize traversal of the container.

int Increment (void)
 Increment the iterator to the next location.

int Decrement (void)
 Decrement the iterator to the previous location.


Static Public Member Functions

vtkObjectBaseStackIterator * New (void)

Protected Member Functions

 vtkObjectBaseStackIterator (void)
 ~vtkObjectBaseStackIterator ()


Constructor & Destructor Documentation

vtkObjectBaseStackIterator::vtkObjectBaseStackIterator (  void   )  [protected]
 

vtkObjectBaseStackIterator::~vtkObjectBaseStackIterator (   )  [protected]
 


Member Function Documentation

int vtkObjectBaseStackIterator::Decrement (  void   )  [virtual]
 

Decrement the iterator to the previous location.

Returns:
false if the container is empty, the iterator is at the start of the container, or this iterator has not been initialized to traverse any container, otherwise true.

Implements vtkIterator.

vtkObjectBase* vtkObjectBaseStackIterator::GetObject (  void   )  const [virtual]
 

Retrieve the data from the iterator.

Returns:
The object if retrieved correctly, otherwise null.

Reimplemented from vtkIterator.

Reimplemented in vtkExtensionsObjectStackIterator, and vtkObjectStackIterator.

int vtkObjectBaseStackIterator::Increment (  void   )  [virtual]
 

Increment the iterator to the next location.

Returns:
false if the container is empty, the iterator is at the end of the container, or this iterator has not been initialized to traverse any container, otherwise true.

Implements vtkIterator.

int vtkObjectBaseStackIterator::InitTraversal (  void   )  [virtual]
 

Initialize traversal of the container.

Sets the iterator to the "beginning" of the container.

Returns:
false if the container is empty or this iterator has not been initialized to traverse any container, otherwise true.

Implements vtkIterator.

vtkObjectBaseStackIterator* vtkObjectBaseStackIterator::New (  void   )  [static]
 

Reimplemented from vtkExtensionsObject.

Reimplemented in vtkExtensionsObjectStackIterator, and vtkObjectStackIterator.

int vtkObjectBaseStackIterator::SetObject (  vtkObjectBase *  object  )  [virtual]
 

Set the data at the iterator's position.

Returns:
true if the data were set correctly, otherwise false.

Implements vtkIterator.

vtkObjectBaseStackIterator::vtkTypeRevisionMacro (  vtkObjectBaseStackIterator  ,
vtkIterator 
) 
 


The documentation for this class was generated from the following file:
Generated on Tue Aug 10 03:42:47 2004 for vtkExtensions by doxygen 1.3.7