vtkObjectBasePriorityQueueIterator Class Reference

#include <vtkObjectBasePriorityQueueIterator.h>

Inheritance diagram for vtkObjectBasePriorityQueueIterator:

[legend]Collaboration diagram for vtkObjectBasePriorityQueueIterator:

[legend]List of all members.

---

Detailed Description

An iterator for vtkObjectBasePriorityQueue subclasses.

See also:

vtkObjectBasePriorityQueue

Definition at line 31 of file vtkObjectBasePriorityQueueIterator.h.

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

---

Constructor & Destructor Documentation

vtkObjectBasePriorityQueueIterator::vtkObjectBasePriorityQueueIterator (  void   )  [protected]

vtkObjectBasePriorityQueueIterator::~vtkObjectBasePriorityQueueIterator (   )  [protected]

---

Member Function Documentation

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

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

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

Retrieve the priority of the current element from the iterator. Returns: The priority if retrieved correctly, otherwise 0. Warning: 0 is a valid priority value. Therefore, this method does NOT return any indication of an error. Reimplemented from vtkIterator.

int vtkObjectBasePriorityQueueIterator::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 vtkObjectBasePriorityQueueIterator::InitTraversal (  int  priority  )

Initialize traversal of the container starting at a priority value. Returns: false if the container is empty, priority is not associated with any element in the container, or this iterator has not been initialized to traverse any container, otherwise true.

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

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

Reimplemented from vtkExtensionsObject. Reimplemented in vtkExtensionsObjectPriorityQueueIterator, and vtkObjectPriorityQueueIterator.

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

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

vtkObjectBasePriorityQueueIterator::vtkTypeRevisionMacro (  vtkObjectBasePriorityQueueIterator  , vtkIterator  )

---

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

• vtkObjectBasePriorityQueueIterator.h

---