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

vtkObjectBaseSetIterator Class Reference

#include <vtkObjectBaseSetIterator.h>

Inheritance diagram for vtkObjectBaseSetIterator:

Inheritance graph
[legend]
Collaboration diagram for vtkObjectBaseSetIterator:

Collaboration graph
[legend]
List of all members.

Detailed Description

An iterator for vtkObjectBaseSet subclasses.

Author:
Sean McInerney
Version:
Revision
1.3
Date:
Date
2005/07/13 02:22:18
See also:
vtkObjectBaseSet

Definition at line 33 of file vtkObjectBaseSetIterator.h.

Public Member Functions

 vtkTypeRevisionMacro (vtkObjectBaseSetIterator, vtkIterator)
void PrintSelf (ostream &, vtkIndent)
Data Access Methods
vtkIdType GetPosition (void) const
 Retrieve the item index position from the iterator.

vtkObjectBaseGetItem (void) const
 Retrieve the data from the iterator.

int SetItem (vtkObjectBase *object)
 Cannot assign data at the iterator's position for sets.

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

vtkObjectBaseSetIteratorNew (void)

Protected Member Functions

 vtkObjectBaseSetIterator (void)
 ~vtkObjectBaseSetIterator ()

Friends

class vtkObjectBaseSet


Constructor & Destructor Documentation

vtkObjectBaseSetIterator::vtkObjectBaseSetIterator void   )  [protected]
 

vtkObjectBaseSetIterator::~vtkObjectBaseSetIterator  )  [protected]
 


Member Function Documentation

int vtkObjectBaseSetIterator::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* vtkObjectBaseSetIterator::GetItem void   )  const [virtual]
 

Retrieve the data from the iterator.

Returns:
The object if retrieved correctly, otherwise null.

Reimplemented from vtkIterator.

Reimplemented in vtkObjectSetIterator.

vtkIdType vtkObjectBaseSetIterator::GetPosition void   )  const [virtual]
 

Retrieve the item index position from the iterator.

Returns:
The position if retrieved correctly, otherwise -1.

Reimplemented from vtkIterator.

int vtkObjectBaseSetIterator::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 vtkObjectBaseSetIterator::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.

vtkObjectBaseSetIterator* vtkObjectBaseSetIterator::New void   )  [static]
 

Reimplemented from vtkObject.

Reimplemented in vtkObjectSetIterator.

void vtkObjectBaseSetIterator::PrintSelf ostream &  ,
vtkIndent 
[virtual]
 

Reimplemented from vtkIterator.

Reimplemented in vtkObjectSetIterator.

int vtkObjectBaseSetIterator::SetItem vtkObjectBase object  )  [virtual]
 

Cannot assign data at the iterator's position for sets.

Returns:
false since set elements are not assignable from iterators.

Implements vtkIterator.

vtkObjectBaseSetIterator::vtkTypeRevisionMacro vtkObjectBaseSetIterator  ,
vtkIterator 
 


Friends And Related Function Documentation

friend class vtkObjectBaseSet [friend]
 

Definition at line 98 of file vtkObjectBaseSetIterator.h.


The documentation for this class was generated from the following file:
Generated on Thu Jul 14 14:40:01 2005 for vtkContainers by doxygen 1.3.6