vtkBitArrayIterator Class Reference

#include <vtkBitArrayIterator.h>

Inheritance diagram for vtkBitArrayIterator:

Inheritance graph
[legend]
Collaboration diagram for vtkBitArrayIterator:

Collaboration graph
[legend]

List of all members.


Detailed Description

Iterator for vtkBitArray. This iterator iterates over a vtkBitArray. It uses the double interface to get/set bit values.

Definition at line 27 of file vtkBitArrayIterator.h.


Public Types

typedef vtkArrayIterator Superclass
typedef int ValueType

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Initialize (vtkAbstractArray *array)
vtkAbstractArrayGetArray ()
int * GetTuple (vtkIdType id)
int GetValue (vtkIdType id)
vtkIdType GetNumberOfTuples ()
vtkIdType GetNumberOfValues ()
int GetNumberOfComponents ()
int GetDataType ()
int GetDataTypeSize ()
void SetValue (vtkIdType id, int value)

Static Public Member Functions

static vtkBitArrayIteratorNew ()
static int IsTypeOf (const char *type)
static vtkBitArrayIteratorSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkBitArrayIterator ()
 ~vtkBitArrayIterator ()
void SetArray (vtkBitArray *b)

Protected Attributes

int * Tuple
int TupleSize
vtkBitArrayArray

Member Typedef Documentation

Reimplemented from vtkArrayIterator.

Definition at line 31 of file vtkBitArrayIterator.h.

Data type of a value.

Definition at line 72 of file vtkBitArrayIterator.h.


Constructor & Destructor Documentation

vtkBitArrayIterator::vtkBitArrayIterator (  )  [protected]

vtkBitArrayIterator::~vtkBitArrayIterator (  )  [protected]


Member Function Documentation

static vtkBitArrayIterator* vtkBitArrayIterator::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

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

Reimplemented from vtkArrayIterator.

static int vtkBitArrayIterator::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkArrayIterator.

virtual int vtkBitArrayIterator::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkArrayIterator.

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

Reimplemented from vtkArrayIterator.

void vtkBitArrayIterator::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 vtkArrayIterator.

virtual void vtkBitArrayIterator::Initialize ( vtkAbstractArray array  )  [virtual]

Set the array this iterator will iterate over. After Initialize() has been called, the iterator is valid so long as the Array has not been modified (except using the iterator itself). If the array is modified, the iterator must be re-intialized.

Implements vtkArrayIterator.

vtkAbstractArray* vtkBitArrayIterator::GetArray (  ) 

Get the array.

int* vtkBitArrayIterator::GetTuple ( vtkIdType  id  ) 

Must be called only after Initialize.

int vtkBitArrayIterator::GetValue ( vtkIdType  id  ) 

Must be called only after Initialize.

vtkIdType vtkBitArrayIterator::GetNumberOfTuples (  ) 

Must be called only after Initialize.

vtkIdType vtkBitArrayIterator::GetNumberOfValues (  ) 

Must be called only after Initialize.

int vtkBitArrayIterator::GetNumberOfComponents (  ) 

Must be called only after Initialize.

int vtkBitArrayIterator::GetDataType (  )  [virtual]

Get the data type from the underlying array.

Implements vtkArrayIterator.

int vtkBitArrayIterator::GetDataTypeSize (  ) 

Get the data type size from the underlying array.

void vtkBitArrayIterator::SetValue ( vtkIdType  id,
int  value 
)

Sets the value at the index. This does not verify if the index is valid. The caller must ensure that id is less than the maximum number of values.

void vtkBitArrayIterator::SetArray ( vtkBitArray b  )  [protected]


Member Data Documentation

int* vtkBitArrayIterator::Tuple [protected]

Definition at line 79 of file vtkBitArrayIterator.h.

Definition at line 80 of file vtkBitArrayIterator.h.

Definition at line 82 of file vtkBitArrayIterator.h.


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

Generated on Sat Dec 27 13:17:40 2008 for VTK by  doxygen 1.5.6