vtkObjectBaseQueueIterator Class Reference

#include <vtkObjectBaseQueueIterator.h>

Inheritance diagram for vtkObjectBaseQueueIterator:

[legend]Collaboration diagram for vtkObjectBaseQueueIterator:

[legend]List of all members.

---

Detailed Description

An iterator for vtkObjectBaseQueue subclasses.

See also:

vtkObjectBaseQueue

Definition at line 31 of file vtkObjectBaseQueueIterator.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectBaseQueueIterator, 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
vtkObjectBaseQueueIterator *	New (void)
Protected Member Functions
	vtkObjectBaseQueueIterator (void)
	~vtkObjectBaseQueueIterator ()

---

Constructor & Destructor Documentation

vtkObjectBaseQueueIterator::vtkObjectBaseQueueIterator (  void   )  [protected]

vtkObjectBaseQueueIterator::~vtkObjectBaseQueueIterator (   )  [protected]

---

Member Function Documentation

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

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

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

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

Reimplemented from vtkExtensionsObject. Reimplemented in vtkExtensionsObjectQueueIterator, and vtkObjectQueueIterator.

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

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

vtkObjectBaseQueueIterator::vtkTypeRevisionMacro (  vtkObjectBaseQueueIterator  , vtkIterator  )

---

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

• vtkObjectBaseQueueIterator.h

---