vtkObjectBaseMapIterator Class Reference

#include <vtkObjectBaseMapIterator.h>

Inheritance diagram for vtkObjectBaseMapIterator:

[legend]Collaboration diagram for vtkObjectBaseMapIterator:

[legend]List of all members.

---

Detailed Description

An iterator for vtkObjectBaseMap subclasses.

See also:

vtkObjectBaseMap

Definition at line 29 of file vtkObjectBaseMapIterator.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectBaseMapIterator, vtkAssociativeIterator)
void	PrintSelf (ostream &, vtkIndent)
Data Access Methods
vtkIdType	GetPosition (void) const
	Retrieve the item index position from the iterator.
const char *	GetKey (void) const
	Retrieve the key from the iterator.
vtkObjectBase *	GetItem (void) const
	Retrieve the data from the iterator.
int	SetItem (vtkObjectBase *object)
	Set the data at the iterator's position.
Traversal Methods
int	InitTraversal (void)
	Initialize traversal of the container.
int	InitTraversal (const char *key)
	Initialize traversal of the container starting at a key.
int	Increment (void)
	Increment the iterator to the next location.
int	Decrement (void)
	Decrement the iterator to the previous location.
Static Public Member Functions
vtkObjectBaseMapIterator *	New (void)
Protected Member Functions
	vtkObjectBaseMapIterator (void)
	~vtkObjectBaseMapIterator ()
Friends
class	vtkObjectBaseMap

---

Constructor & Destructor Documentation

vtkObjectBaseMapIterator::vtkObjectBaseMapIterator (  void   )  [protected]

vtkObjectBaseMapIterator::~vtkObjectBaseMapIterator (   )  [protected]

---

Member Function Documentation

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

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

const char* vtkObjectBaseMapIterator::GetKey (  void   )  const [virtual]

Retrieve the key from the iterator. For associative containers, the key is the string paired with the data. Returns: The key if retrieved correctly, otherwise null. Reimplemented from vtkIterator.

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

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

int vtkObjectBaseMapIterator::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 vtkObjectBaseMapIterator::InitTraversal (  const char *  key  )  [virtual]

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

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

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

Reimplemented from vtkObject. Reimplemented in vtkObjectMapIterator.

void vtkObjectBaseMapIterator::PrintSelf (  ostream &  , vtkIndent  )  [virtual]

Reimplemented from vtkAssociativeIterator. Reimplemented in vtkObjectMapIterator.

int vtkObjectBaseMapIterator::SetItem (  vtkObjectBase *  object  )  [virtual]

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

vtkObjectBaseMapIterator::vtkTypeRevisionMacro (  vtkObjectBaseMapIterator  , vtkAssociativeIterator  )

---

Friends And Related Function Documentation

friend class vtkObjectBaseMap [friend]

Definition at line 112 of file vtkObjectBaseMapIterator.h.

---

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

• vtkObjectBaseMapIterator.h

---