Implementation template for a array iterator. More...

#include <vtkArrayIteratorTemplate.h>

Inheritance diagram for vtkArrayIteratorTemplate< T >:

Collaboration diagram for vtkArrayIteratorTemplate< T >:

Public Types
typedef vtkArrayIterator	Superclass

Public Types inherited from vtkTypeTemplate< vtkArrayIteratorTemplate< T >, vtkArrayIterator >
typedef vtkArrayIterator	Superclass

Public Types inherited from vtkArrayIterator
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Initialize (vtkAbstractArray *array)

vtkAbstractArray *	GetArray ()

T *	GetTuple (vtkIdType id)

vtkIdType	GetNumberOfTuples ()

vtkIdType	GetNumberOfValues ()

int	GetNumberOfComponents ()

int	GetDataType ()

int	GetDataTypeSize ()


T &	GetValue (vtkIdType id)


void	SetValue (vtkIdType id, T value)

Public Member Functions inherited from vtkTypeTemplate< vtkArrayIteratorTemplate< T >, vtkArrayIterator >
vtkArrayIteratorTemplate< T > *	NewInstance () const

Public Member Functions inherited from vtkArrayIterator
vtkArrayIterator *	NewInstance () const

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkArrayIteratorTemplate< T > *	New ()

Static Public Member Functions inherited from vtkTypeTemplate< vtkArrayIteratorTemplate< T >, vtkArrayIterator >
static vtkArrayIteratorTemplate< T > *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkArrayIterator
static int	IsTypeOf (const char *type)

static vtkArrayIterator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Attributes
T *	Pointer

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef T	ValueType

	vtkArrayIteratorTemplate ()

	~vtkArrayIteratorTemplate ()

Additional Inherited Members
Protected Member Functions inherited from vtkTypeTemplate< vtkArrayIteratorTemplate< T >, vtkArrayIterator >
virtual vtkObjectBase *	NewInstanceInternal () const

virtual int	IsA (const char *type)

	vtkTypeTemplate ()

Protected Member Functions inherited from vtkArrayIterator
	vtkArrayIterator ()

	~vtkArrayIterator ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions inherited from vtkTypeTemplate< vtkArrayIteratorTemplate< T >, vtkArrayIterator >
static int	IsTypeOf (const char *type)

Detailed Description

template<class T>
class vtkArrayIteratorTemplate< T >

Implementation template for a array iterator.

This is implementation template for a array iterator. It only works with arrays that have a contiguous internal storage of values (as in vtkDataArray, vtkStringArray).

Tests:: vtkArrayIteratorTemplate (Tests)

Definition at line 36 of file vtkArrayIteratorTemplate.h.

Member Typedef Documentation

template<class T>

typedef vtkArrayIterator vtkArrayIteratorTemplate< T >::Superclass

Definition at line 41 of file vtkArrayIteratorTemplate.h.

template<class T>

typedef T vtkArrayIteratorTemplate< T >::ValueType

This is the data type for the value.

Definition at line 95 of file vtkArrayIteratorTemplate.h.

Constructor & Destructor Documentation

template<class T>

vtkArrayIteratorTemplate< T >::vtkArrayIteratorTemplate ( )

protected

This is the data type for the value.

template<class T>

vtkArrayIteratorTemplate< T >::~vtkArrayIteratorTemplate ( )

protected

This is the data type for the value.

Member Function Documentation

template<class T>

static vtkArrayIteratorTemplate<T>* vtkArrayIteratorTemplate< T >::New ( )

static

template<class T>

void vtkArrayIteratorTemplate< T >::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.

template<class T>

virtual void vtkArrayIteratorTemplate< T >::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.

template<class T>

vtkAbstractArray* vtkArrayIteratorTemplate< T >::GetArray ( )

inline

Get the array.

Definition at line 56 of file vtkArrayIteratorTemplate.h.

template<class T>

T* vtkArrayIteratorTemplate< T >::GetTuple ( vtkIdType id )

Must be called only after Initialize.

template<class T>

T& vtkArrayIteratorTemplate< T >::GetValue ( vtkIdType id )

inline

Must be called only after Initialize.

Definition at line 64 of file vtkArrayIteratorTemplate.h.

template<class T>

void vtkArrayIteratorTemplate< T >::SetValue	(	vtkIdType	id,
		T	value
	)

inline

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.

Definition at line 72 of file vtkArrayIteratorTemplate.h.

template<class T>

vtkIdType vtkArrayIteratorTemplate< T >::GetNumberOfTuples ( )

Must be called only after Initialize.

template<class T>

vtkIdType vtkArrayIteratorTemplate< T >::GetNumberOfValues ( )

Must be called only after Initialize.

template<class T>

int vtkArrayIteratorTemplate< T >::GetNumberOfComponents ( )

Must be called only after Initialize.

template<class T>

int vtkArrayIteratorTemplate< T >::GetDataType ( )

virtual

Get the data type from the underlying array.

Implements vtkArrayIterator.

template<class T>

int vtkArrayIteratorTemplate< T >::GetDataTypeSize ( )

Get the data type size from the underlying array.

Member Data Documentation

template<class T>

T* vtkArrayIteratorTemplate< T >::Pointer

protected

Definition at line 101 of file vtkArrayIteratorTemplate.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Core/vtkArrayIteratorTemplate.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class T> class vtkArrayIteratorTemplate< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class vtkArrayIteratorTemplate< T >