vtkObjectBaseDequeIterator Class Reference

#include <vtkObjectBaseDequeIterator.h>

Inheritance diagram for vtkObjectBaseDequeIterator:

[legend]Collaboration diagram for vtkObjectBaseDequeIterator:

[legend]List of all members.

---

Detailed Description

An iterator for vtkObjectBaseDeque subclasses.

Author:

Sean McInerney

Version:

Revision

1.3

Date:

Date

2005/07/13 00:21:58

See also:

vtkObjectBaseDeque

Definition at line 33 of file vtkObjectBaseDequeIterator.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectBaseDequeIterator, vtkSequenceIterator)
void	PrintSelf (ostream &, vtkIndent)
Data Access Methods
vtkIdType	GetPosition (void) const
	Retrieve the item index position 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 (vtkIdType i)
	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
vtkObjectBaseDequeIterator *	New (void)
Protected Member Functions
	vtkObjectBaseDequeIterator (void)
	~vtkObjectBaseDequeIterator ()
Friends
class	vtkObjectBaseDeque

---

Constructor & Destructor Documentation

vtkObjectBaseDequeIterator::vtkObjectBaseDequeIterator (  void   )  [protected]

vtkObjectBaseDequeIterator::~vtkObjectBaseDequeIterator (   )  [protected]

---

Member Function Documentation

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

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

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

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

int vtkObjectBaseDequeIterator::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 vtkObjectBaseDequeIterator::InitTraversal (  vtkIdType  i  )  [virtual]

Initialize traversal of the container. Sets the iterator to the i'th position of the container. Returns: false if the container is empty, this iterator has not been initialized to traverse any container, or the position is out of range, otherwise true. Implements vtkSequenceIterator.

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

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

Reimplemented from vtkObject. Reimplemented in vtkObjectDequeIterator.

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

Reimplemented from vtkSequenceIterator. Reimplemented in vtkObjectDequeIterator.

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

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

vtkObjectBaseDequeIterator::vtkTypeRevisionMacro (  vtkObjectBaseDequeIterator  , vtkSequenceIterator  )

---

Friends And Related Function Documentation

friend class vtkObjectBaseDeque [friend]

Definition at line 109 of file vtkObjectBaseDequeIterator.h.

---

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

• vtkObjectBaseDequeIterator.h

---