iterator through a vtkCollection. More...
#include <vtkCollectionIterator.h>
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkCollectionIterator * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | InitTraversal () |
| void | GoToFirstItem () |
| void | GoToNextItem () |
| int | IsDoneWithTraversal () |
| vtkObject * | GetCurrentObject () |
| virtual void | SetCollection (vtkCollection *) |
| virtual vtkCollection * | GetCollection () |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkCollectionIterator * | SafeDownCast (vtkObjectBase *o) |
| static vtkCollectionIterator * | New () |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkCollectionIterator () | |
| ~vtkCollectionIterator () | |
| vtkObject * | GetObjectInternal () |
Protected Attributes | |
| vtkCollection * | Collection |
| vtkCollectionElement * | Element |
Detailed Description
iterator through a vtkCollection.
vtkCollectionIterator provides an alternative way to traverse through the objects in a vtkCollection. Unlike the collection's built in interface, this allows multiple iterators to simultaneously traverse the collection. If items are removed from the collection, only the iterators currently pointing to those items are invalidated. Other iterators will still continue to function normally.
Definition at line 36 of file vtkCollectionIterator.h.
Member Typedef Documentation
Reimplemented from vtkObject.
Reimplemented in vtkDataArrayCollectionIterator.
Definition at line 39 of file vtkCollectionIterator.h.
Constructor & Destructor Documentation
| vtkCollectionIterator::vtkCollectionIterator | ( | ) | [protected] |
| vtkCollectionIterator::~vtkCollectionIterator | ( | ) | [protected] |
Member Function Documentation
| static int vtkCollectionIterator::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkDataArrayCollectionIterator.
| virtual int vtkCollectionIterator::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkDataArrayCollectionIterator.
| static vtkCollectionIterator* vtkCollectionIterator::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkDataArrayCollectionIterator.
| virtual vtkObjectBase* vtkCollectionIterator::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkObject.
Reimplemented in vtkDataArrayCollectionIterator.
Reimplemented from vtkObject.
Reimplemented in vtkDataArrayCollectionIterator.
| void vtkCollectionIterator::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkObject.
Reimplemented in vtkDataArrayCollectionIterator.
| static vtkCollectionIterator* vtkCollectionIterator::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
Reimplemented in vtkDataArrayCollectionIterator.
| virtual void vtkCollectionIterator::SetCollection | ( | vtkCollection * | ) | [virtual] |
Set/Get the collection over which to iterate.
Reimplemented in vtkDataArrayCollectionIterator.
| virtual vtkCollection* vtkCollectionIterator::GetCollection | ( | ) | [virtual] |
Set/Get the collection over which to iterate.
| void vtkCollectionIterator::InitTraversal | ( | ) | [inline] |
Position the iterator at the first item in the collection.
Definition at line 50 of file vtkCollectionIterator.h.
| void vtkCollectionIterator::GoToFirstItem | ( | ) |
Position the iterator at the first item in the collection.
| void vtkCollectionIterator::GoToNextItem | ( | ) |
Move the iterator to the next item in the collection.
Test whether the iterator is currently positioned at a valid item. Returns 1 for yes, 0 for no.
Get the item at the current iterator position. Valid only when IsDoneWithTraversal() returns 1.
| vtkObject* vtkCollectionIterator::GetObjectInternal | ( | ) | [protected] |
Member Data Documentation
vtkCollection* vtkCollectionIterator::Collection [protected] |
Definition at line 71 of file vtkCollectionIterator.h.
vtkCollectionElement* vtkCollectionIterator::Element [protected] |
Definition at line 74 of file vtkCollectionIterator.h.
The documentation for this class was generated from the following file:
- /Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Common/Core/vtkCollectionIterator.h
