vtkObjectBaseHashMapIterator Class Reference

#include <vtkObjectBaseHashMapIterator.h>

Inheritance diagram for vtkObjectBaseHashMapIterator:

[legend]Collaboration diagram for vtkObjectBaseHashMapIterator:

[legend]List of all members.

---

Detailed Description

An iterator for vtkObjectBaseHashMap subclasses.

Author:

Sean McInerney

Version:

Revision

1.3

Date:

Date

2005/07/13 02:22:18

See also:

vtkObjectBaseHashMap

Definition at line 32 of file vtkObjectBaseHashMapIterator.h.

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

---

Constructor & Destructor Documentation

vtkObjectBaseHashMapIterator::vtkObjectBaseHashMapIterator (  void   )  [protected]

vtkObjectBaseHashMapIterator::~vtkObjectBaseHashMapIterator (   )  [protected]

---

Member Function Documentation

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

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

const char* vtkObjectBaseHashMapIterator::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 vtkObjectBaseHashMapIterator::GetPosition (  void   )  const [virtual]

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

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

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

Reimplemented from vtkObject. Reimplemented in vtkObjectHashMapIterator.

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

Reimplemented from vtkAssociativeIterator. Reimplemented in vtkObjectHashMapIterator.

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

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

vtkObjectBaseHashMapIterator::vtkTypeRevisionMacro (  vtkObjectBaseHashMapIterator  , vtkAssociativeIterator  )

---

Friends And Related Function Documentation

friend class vtkObjectBaseHashMap [friend]

Definition at line 116 of file vtkObjectBaseHashMapIterator.h.

---

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

• vtkObjectBaseHashMapIterator.h

---