vtkObjectBaseVectorIterator Class Reference

#include <vtkObjectBaseVectorIterator.h>

Inheritance diagram for vtkObjectBaseVectorIterator:

[legend]Collaboration diagram for vtkObjectBaseVectorIterator:

[legend]List of all members.

---

Detailed Description

An iterator for vtkObjectBaseVector subclasses.

See also:

vtkObjectBaseVector

Definition at line 31 of file vtkObjectBaseVectorIterator.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectBaseVectorIterator, vtkAbstractSequenceIterator)
Data Access Methods
vtkIdType	GetPosition (void) const
	Retrieve the position from the iterator.
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	InitTraversal (int position)
	Initialize traversal of the container starting at a position.
int	Increment (void)
	Increment the iterator to the next location.
int	Decrement (void)
	Decrement the iterator to the previous location.
Static Public Member Functions
vtkObjectBaseVectorIterator *	New (void)
Protected Member Functions
	vtkObjectBaseVectorIterator (void)
	~vtkObjectBaseVectorIterator ()

---

Constructor & Destructor Documentation

vtkObjectBaseVectorIterator::vtkObjectBaseVectorIterator (  void   )  [protected]

vtkObjectBaseVectorIterator::~vtkObjectBaseVectorIterator (   )  [protected]

---

Member Function Documentation

int vtkObjectBaseVectorIterator::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* vtkObjectBaseVectorIterator::GetObject (  void   )  const [virtual]

Retrieve the data from the iterator. Returns: The object if retrieved correctly, otherwise null. Reimplemented from vtkIterator. Reimplemented in vtkExtensionsObjectVectorIterator, and vtkObjectVectorIterator.

vtkIdType vtkObjectBaseVectorIterator::GetPosition (  void   )  const [virtual]

Retrieve the position from the iterator. Returns: The position if retrieved correctly, otherwise -1. Reimplemented from vtkIterator.

int vtkObjectBaseVectorIterator::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 vtkObjectBaseVectorIterator::InitTraversal (  int  position  )  [virtual]

Initialize traversal of the container starting at a position. Returns: false if the container is empty, position is out of range, or this iterator has not been initialized to traverse any container, otherwise true. Implements vtkAbstractSequenceIterator.

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

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

Reimplemented from vtkExtensionsObject. Reimplemented in vtkExtensionsObjectVectorIterator, and vtkObjectVectorIterator.

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

Set the data at the iterator's position. Returns: true if the data were set correctly, otherwise false. Implements vtkIterator.

vtkObjectBaseVectorIterator::vtkTypeRevisionMacro (  vtkObjectBaseVectorIterator  , vtkAbstractSequenceIterator  )

---

The documentation for this class was generated from the following file:

• vtkObjectBaseVectorIterator.h

---