vtkVoidArray Class Reference

#include <vtkVoidArray.h>

Inheritance diagram for vtkVoidArray:

[legend]Collaboration diagram for vtkVoidArray:

[legend]List of all members.

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.

Created by:

Schroeder, Will

CVS contributions (if > 5%):

Schroeder, Will (61%)
Martin, Ken (9%)
Henderson, Amy (6%)
Geveci, Berk (5%)
Miller, Jim (5%)

CVS logs (CVSweb):

.cxx (/Common/vtkVoidArray.cxx)
.h (/Common/vtkVoidArray.h)

Definition at line 42 of file vtkVoidArray.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

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 ()

Static Public Member Functions

vtkVoidArray * New ()

int IsTypeOf (const char *type)

vtkVoidArray * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkVoidArray ()

~vtkVoidArray ()

void ** ResizeAndExtend (vtkIdType sz)

Protected Attributes

vtkIdType NumberOfPointers

vtkIdType Size

void ** Array

Member Typedef Documentation

typedef vtkObject vtkVoidArray::Superclass

Reimplemented from vtkObject.
Definition at line 48 of file vtkVoidArray.h.

Constructor & Destructor Documentation

vtkVoidArray::vtkVoidArray ( ) [protected]

vtkVoidArray::~vtkVoidArray ( ) [protected]

Member Function Documentation

vtkVoidArray* vtkVoidArray::New ( ) [static]

Initialize with empty array.
Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

int vtkVoidArray::IsTypeOf ( const char * type ) [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 vtkObject.

virtual int vtkVoidArray::IsA ( const char * type ) [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 vtkObject.

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

Reimplemented from vtkObject.

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 59 of file vtkVoidArray.h.

int vtkVoidArray::GetDataTypeSize ( ) [inline]

Return the size of the data contained in the array.
Definition at line 62 of file vtkVoidArray.h.

void vtkVoidArray::SetNumberOfPointers ( vtkIdType number ) [inline]

Set the number of void* pointers held in the array.
Definition at line 66 of file vtkVoidArray.h.
References vtkIdType.

vtkIdType vtkVoidArray::GetNumberOfPointers ( ) [inline]

Get the number of void* pointers held in the array.
Definition at line 72 of file vtkVoidArray.h.
References vtkIdType.

void* vtkVoidArray::GetVoidPointer ( vtkIdType id ) [inline]

Get the void* pointer at the ith location.
Definition at line 78 of file vtkVoidArray.h.
References vtkIdType.

void vtkVoidArray::SetVoidPointer ( vtkIdType id,

void * ptr

) [inline]

Set the void* pointer value at the ith location in the array.
Definition at line 84 of file vtkVoidArray.h.
References vtkIdType.

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 99 of file vtkVoidArray.h.

void vtkVoidArray::Squeeze ( ) [inline]

Resize the array to just fit the inserted memory. Reclaims extra memory.
Definition at line 106 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 112 of file vtkVoidArray.h.
References vtkIdType.

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 126 of file vtkVoidArray.h.

vtkIdType vtkVoidArray::Size [protected]

Definition at line 127 of file vtkVoidArray.h.

void** vtkVoidArray::Array [protected]

Definition at line 128 of file vtkVoidArray.h.

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

dox/Common/vtkVoidArray.h


Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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 ()
Static Public Member Functions
vtkVoidArray *	New ()
int	IsTypeOf (const char *type)
vtkVoidArray *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkVoidArray ()
	~vtkVoidArray ()
void **	ResizeAndExtend (vtkIdType sz)
Protected Attributes
vtkIdType	NumberOfPointers
vtkIdType	Size
void **	Array