Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

vtkVoidArray Class Reference

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

#include <vtkVoidArray.h>

Inheritance diagram for vtkVoidArray:

[legend]Collaboration diagram for vtkVoidArray:

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	Allocate (const int sz, const int ext=1000)
void	Initialize ()
vtkDataArray *	MakeObject ()
int	GetDataType ()
void	SetNumberOfTuples (const int number)
float *	GetTuple (const int i)
void	GetTuple (const int i, float *tuple)
void	GetTuple (const int i, double *tuple)
void	SetTuple (const int i, const float *tuple)
void	SetTuple (const int i, const double *tuple)
void	InsertTuple (const int i, const float *tuple)
void	InsertTuple (const int i, const double *tuple)
int	InsertNextTuple (const float *tuple)
int	InsertNextTuple (const double *tuple)
void	Squeeze ()
void *	GetValue (const int id)
void	SetNumberOfValues (const int number)
void	SetValue (const int id, void *value)
void	InsertValue (const int id, void *p)
int	InsertNextValue (void *v)
void **	GetPointer (const int id)
void *	GetVoidPointer (const int id)
void **	WritePointer (const int id, const int number)
void	DeepCopy (vtkDataArray *da)
void	DeepCopy (vtkDataArray &da)
Static Public Methods
vtkVoidArray *	New ()
int	IsTypeOf (const char *type)
vtkVoidArray *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkVoidArray ()
	~vtkVoidArray ()
	vtkVoidArray (const vtkVoidArray &)
void	operator= (const vtkVoidArray &)
void **	Resize (const int sz)
Protected Attributes
void **	Array
int	TupleSize
float *	Tuple

Detailed Description

dynamic, self-adjusting array of void* pointers.

Date:: 2000/12/10 20:08:21

Revision:: 1.40

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

Constructor & Destructor Documentation

vtkVoidArray::vtkVoidArray ( ) [protected]

vtkVoidArray::~vtkVoidArray ( ) [protected]

vtkVoidArray::vtkVoidArray ( const vtkVoidArray & ) [inline, protected]

Definition at line 145 of file vtkVoidArray.h.

Member Function Documentation

vtkVoidArray* vtkVoidArray::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
Referenced by MakeObject().

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataArray.

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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataArray.

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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataArray.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataArray.

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 vtkDataArray.

int vtkVoidArray::Allocate ( const int sz,

const int ext = 1000

) [virtual]

Allocate memory for this array. Delete old storage only if necessary.
Reimplemented from vtkDataArray.
Referenced by SetNumberOfValues().

void vtkVoidArray::Initialize ( ) [virtual]

Release storage and reset array to initial state.
Reimplemented from vtkDataArray.

vtkDataArray* vtkVoidArray::MakeObject ( ) [inline, virtual]

Create a similar type object
Reimplemented from vtkDataArray.
Definition at line 71 of file vtkVoidArray.h.

int vtkVoidArray::GetDataType ( ) [inline, virtual]

Get the data type.
Reimplemented from vtkDataArray.
Definition at line 74 of file vtkVoidArray.h.

void vtkVoidArray::SetNumberOfTuples ( const int number ) [virtual]

Set the number of n-tuples in the array.
Reimplemented from vtkDataArray.

float* vtkVoidArray::GetTuple ( const int i ) [virtual]

Get a pointer to a tuple at the ith location.
Reimplemented from vtkDataArray.

void vtkVoidArray::GetTuple ( const int i,

float * tuple

) [virtual]

Copy the tuple value into a user-provided array.
Reimplemented from vtkDataArray.

void vtkVoidArray::GetTuple ( const int i,

double * tuple

) [virtual]

Reimplemented from vtkDataArray.

void vtkVoidArray::SetTuple ( const int i,

const float * tuple

) [virtual]

Set the tuple value at the ith location in the array.
Reimplemented from vtkDataArray.

void vtkVoidArray::SetTuple ( const int i,

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

void vtkVoidArray::InsertTuple ( const int i,

const float * tuple

) [virtual]

Insert (memory allocation performed) the tuple into the ith location in the array.
Reimplemented from vtkDataArray.

void vtkVoidArray::InsertTuple ( const int i,

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

int vtkVoidArray::InsertNextTuple ( const float * tuple ) [virtual]

Insert (memory allocation performed) the tuple onto the end of the array.
Reimplemented from vtkDataArray.

int vtkVoidArray::InsertNextTuple ( const double * tuple ) [virtual]

Reimplemented from vtkDataArray.

void vtkVoidArray::Squeeze ( ) [inline, virtual]

Resize object to just fit data requirement. Reclaims extra memory.
Reimplemented from vtkDataArray.
Definition at line 101 of file vtkVoidArray.h.

void* vtkVoidArray::GetValue ( const int id ) [inline]

Get the data at a particular index.
Definition at line 104 of file vtkVoidArray.h.

void vtkVoidArray::SetNumberOfValues ( const int number ) [inline]

Specify the number of values for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for fast insertion.
Definition at line 156 of file vtkVoidArray.h.

void vtkVoidArray::SetValue ( const int id,

void * value

) [inline]

Set the data at a particular index. Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data.
Definition at line 162 of file vtkVoidArray.h.

void vtkVoidArray::InsertValue ( const int id,

void * p

) [inline]

Insert data at a specified position in the array.
Definition at line 181 of file vtkVoidArray.h.
Referenced by InsertNextValue().

int vtkVoidArray::InsertNextValue ( void * p ) [inline]

Insert data at the end of the array. Return its location in the array.
Definition at line 194 of file vtkVoidArray.h.

void** vtkVoidArray::GetPointer ( const int 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 124 of file vtkVoidArray.h.

void* vtkVoidArray::GetVoidPointer ( const int id ) [inline, virtual]

Return a void pointer. For image pipeline interface and other special pointer manipulation.
Reimplemented from vtkDataArray.
Definition at line 125 of file vtkVoidArray.h.

void ** vtkVoidArray::WritePointer ( const int id,

const int number

) [inline]

Get the address of a particular data index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of data values requested.
Definition at line 167 of file vtkVoidArray.h.

void vtkVoidArray::DeepCopy ( vtkDataArray * da ) [virtual]

Deep copy of another void array.
Reimplemented from vtkDataArray.

void vtkVoidArray::DeepCopy ( vtkDataArray & da ) [inline]

For legacy compatibility. Do not use.
Reimplemented from vtkDataArray.
Definition at line 137 of file vtkVoidArray.h.

void vtkVoidArray::operator= ( const vtkVoidArray & ) [inline, protected]

Definition at line 146 of file vtkVoidArray.h.

void** vtkVoidArray::Resize ( const int sz ) [protected]

Referenced by InsertValue(), and WritePointer().

Member Data Documentation

void** vtkVoidArray::Array [protected]

Definition at line 148 of file vtkVoidArray.h.

int vtkVoidArray::TupleSize [protected]

Definition at line 151 of file vtkVoidArray.h.

float* vtkVoidArray::Tuple [protected]

Definition at line 152 of file vtkVoidArray.h.

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

common/vtkVoidArray.h

Generated on Wed Nov 21 13:01:42 2001 for VTK by

vtkVoidArray Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation