vtkVoidArray Class Reference

dynamic, self-adjusting array of void* pointers More...

#include <vtkVoidArray.h>

Inheritance diagram for vtkVoidArray:

Collaboration diagram for vtkVoidArray:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkVoidArray *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
int	Allocate (vtkIdType sz, vtkIdType ext=1000)
void	Initialize ()
int	GetDataType ()
int	GetDataTypeSize ()
void	InsertVoidPointer (vtkIdType i, void *ptr)
vtkIdType	InsertNextVoidPointer (void *tuple)
void **	GetPointer (vtkIdType id)
void **	WritePointer (vtkIdType id, vtkIdType number)
void	DeepCopy (vtkVoidArray *va)
void	SetNumberOfPointers (vtkIdType number)
vtkIdType	GetNumberOfPointers ()
void *	GetVoidPointer (vtkIdType id)
void	SetVoidPointer (vtkIdType id, void *ptr)
void	Reset ()
void	Squeeze ()
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 vtkVoidArray *	New ()
static int	IsTypeOf (const char *type)
static vtkVoidArray *	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 Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkVoidArray ()
	~vtkVoidArray ()
void **	ResizeAndExtend (vtkIdType sz)
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 &)

Protected Attributes
vtkIdType	NumberOfPointers
vtkIdType	Size
void **	Array
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

dynamic, self-adjusting array of void* pointers

vtkVoidArray is an array of pointers to void. It provides methods for insertion and retrieval of these pointers values, and will automatically resize itself to hold new data.

Definition at line 29 of file vtkVoidArray.h.

Member Typedef Documentation

typedef vtkObject vtkVoidArray::Superclass

Definition at line 35 of file vtkVoidArray.h.

Constructor & Destructor Documentation

vtkVoidArray::vtkVoidArray ( )

protected

vtkVoidArray::~vtkVoidArray ( )

protected

Member Function Documentation

static vtkVoidArray* vtkVoidArray::New ( )

static

Initialize with empty array.

static int vtkVoidArray::IsTypeOf ( const char *  type )

static

virtual int vtkVoidArray::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.

static vtkVoidArray* vtkVoidArray::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkVoidArray::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkVoidArray* vtkVoidArray::NewInstance

(

)

const

void vtkVoidArray::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.

int vtkVoidArray::Allocate	(	vtkIdType	sz,
		vtkIdType	ext = 1000
	)

Allocate memory for this array. Delete old storage only if necessary. Note that the parameter ext is no longer used.

void vtkVoidArray::Initialize

(

)

Release storage and reset array to initial state.

int vtkVoidArray::GetDataType ( )

inline

Return the type of data.

Definition at line 46 of file vtkVoidArray.h.

int vtkVoidArray::GetDataTypeSize ( )

inline

Return the size of the data contained in the array.

Definition at line 49 of file vtkVoidArray.h.

void vtkVoidArray::SetNumberOfPointers ( vtkIdType  number )

inline

Set the number of void* pointers held in the array.

Definition at line 53 of file vtkVoidArray.h.

vtkIdType vtkVoidArray::GetNumberOfPointers ( )

inline

Get the number of void* pointers held in the array.

Definition at line 59 of file vtkVoidArray.h.

void* vtkVoidArray::GetVoidPointer ( vtkIdType  id )

inline

Get the void* pointer at the ith location.

Definition at line 65 of file vtkVoidArray.h.

void vtkVoidArray::SetVoidPointer ( vtkIdType  id, void *  ptr  )

inline

Set the void* pointer value at the ith location in the array.

Definition at line 71 of file vtkVoidArray.h.

void vtkVoidArray::InsertVoidPointer	(	vtkIdType	i,
		void *	ptr
	)

Insert (memory allocation performed) the void* into the ith location in the array.

vtkIdType vtkVoidArray::InsertNextVoidPointer

(

void *

tuple

)

Insert (memory allocation performed) the void* pointer at the end of the array.

void vtkVoidArray::Reset ( )

inline

Reuse already allocated data; make the container look like it is empty.

Definition at line 86 of file vtkVoidArray.h.

void vtkVoidArray::Squeeze ( )

inline

Resize the array to just fit the inserted memory. Reclaims extra memory.

Definition at line 93 of file vtkVoidArray.h.

void** vtkVoidArray::GetPointer ( vtkIdType  id )

inline

Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.

Definition at line 99 of file vtkVoidArray.h.

void** vtkVoidArray::WritePointer	(	vtkIdType	id,
		vtkIdType	number
	)

Get the address of a particular data index. Make sure data is allocated for the number of items requested. Set NumberOfPointers according to the number of data values requested.

void vtkVoidArray::DeepCopy

(

vtkVoidArray *

va

)

Deep copy of another void array.

void** vtkVoidArray::ResizeAndExtend ( vtkIdType  sz )

protected

Member Data Documentation

vtkIdType vtkVoidArray::NumberOfPointers

protected

Definition at line 113 of file vtkVoidArray.h.

vtkIdType vtkVoidArray::Size

protected

Definition at line 114 of file vtkVoidArray.h.

void** vtkVoidArray::Array

protected

Definition at line 115 of file vtkVoidArray.h.

---

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

• dox/Common/Core/vtkVoidArray.h