vtkGenericCellIterator Class Reference

#include <vtkGenericCellIterator.h>

Inheritance diagram for vtkGenericCellIterator:

Inheritance graph
[legend]
Collaboration diagram for vtkGenericCellIterator:

Collaboration graph
[legend]

List of all members.


Detailed Description

iterator used to traverse cells

This class (and subclasses) are used to iterate over cells. Use it only in conjunction with vtkGenericDataSet (i.e., the adaptor framework).

Typical use is:

 vtkGenericDataSet *dataset;
 vtkGenericCellIterator *it = dataset->NewCellIterator(2);
 for (it->Begin(); !it->IsAtEnd(); it->Next());
   {
   spec=it->GetCell();
   }
 

Tests:
vtkGenericCellIterator (Tests)

Definition at line 42 of file vtkGenericCellIterator.h.

typedef vtkObject Superclass
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
static int IsTypeOf (const char *type)
static vtkGenericCellIteratorSafeDownCast (vtkObject *o)

Public Member Functions

virtual void Begin ()=0
virtual int IsAtEnd ()=0
virtual vtkGenericAdaptorCellNewCell ()=0
virtual void GetCell (vtkGenericAdaptorCell *c)=0
virtual vtkGenericAdaptorCellGetCell ()=0
virtual void Next ()=0

Protected Member Functions

 vtkGenericCellIterator ()
virtual ~vtkGenericCellIterator ()

Member Typedef Documentation


Constructor & Destructor Documentation

vtkGenericCellIterator::vtkGenericCellIterator (  )  [protected]

virtual vtkGenericCellIterator::~vtkGenericCellIterator (  )  [protected, virtual]


Member Function Documentation

virtual const char* vtkGenericCellIterator::GetClassName (  )  [virtual]

static int vtkGenericCellIterator::IsTypeOf ( const char *  type  )  [static]

virtual int vtkGenericCellIterator::IsA ( const char *  type  )  [virtual]

static vtkGenericCellIterator* vtkGenericCellIterator::SafeDownCast ( vtkObject o  )  [static]

void vtkGenericCellIterator::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

virtual void vtkGenericCellIterator::Begin (  )  [pure virtual]

virtual int vtkGenericCellIterator::IsAtEnd (  )  [pure virtual]

virtual vtkGenericAdaptorCell* vtkGenericCellIterator::NewCell (  )  [pure virtual]

Create an empty cell. The user is responsible for deleting it.

Postcondition:
result_exists: result!=0

Implemented in vtkBridgeCellIterator, and vtkBridgeCellIteratorStrategy.

virtual void vtkGenericCellIterator::GetCell ( vtkGenericAdaptorCell c  )  [pure virtual]

Get the cell at current position. The cell should be instantiated with the NewCell() method.

Precondition:
not_at_end: !IsAtEnd()

c_exists: c!=0 THREAD SAFE

Implemented in vtkBridgeCellIterator, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOnCellList, vtkBridgeCellIteratorOnDataSet, and vtkBridgeCellIteratorOne.

virtual vtkGenericAdaptorCell* vtkGenericCellIterator::GetCell (  )  [pure virtual]

Get the cell at the current traversal position. NOT THREAD SAFE

Precondition:
not_at_end: !IsAtEnd()
Postcondition:
result_exits: result!=0

Implemented in vtkBridgeCellIterator, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOnCellList, vtkBridgeCellIteratorOnDataSet, and vtkBridgeCellIteratorOne.

virtual void vtkGenericCellIterator::Next (  )  [pure virtual]

Move the iterator to the next position in the list.

Precondition:
not_at_end: !IsAtEnd()

Implemented in vtkBridgeCellIterator, vtkBridgeCellIteratorOnCellBoundaries, vtkBridgeCellIteratorOnCellList, vtkBridgeCellIteratorOnDataSet, and vtkBridgeCellIteratorOne.


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

Generated on Sat Dec 27 13:25:56 2008 for VTK by  doxygen 1.5.6