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

vtkIntArray Class Reference

dynamic, self-adjusting integer array. More...

#include <vtkIntArray.h>

Inheritance diagram for vtkIntArray:

[legend]Collaboration diagram for vtkIntArray:

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	Squeeze ()
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)
int	GetValue (const int id)
void	SetValue (const int id, const int value)
void	SetNumberOfValues (const int number)
void	InsertValue (const int id, const int i)
int	InsertNextValue (const int i)
int *	GetPointer (const int id)
void *	GetVoidPointer (const int id)
int *	WritePointer (const int id, const int number)
void	DeepCopy (vtkDataArray *ia)
void	SetArray (int *array, int size, int save)
void	SetVoidArray (void *array, int size, int save)
void	DeepCopy (vtkDataArray &ia)
Static Public Methods
vtkIntArray *	New ()
int	IsTypeOf (const char *type)
vtkIntArray *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkIntArray (int numComp=1)
	~vtkIntArray ()
	vtkIntArray (const vtkIntArray &)
void	operator= (const vtkIntArray &)
int *	Resize (const int sz)
Protected Attributes
int *	Array
int	TupleSize
float *	Tuple
int	SaveUserArray

Detailed Description

dynamic, self-adjusting integer array.

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

Revision:: 1.57

vtkIntArray is an array of integer numbers. It provides methods for insertion and retrieval of integer values, and will automatically resize itself to hold new data.

Examples:: vtkIntArray (examples)

Definition at line 59 of file vtkIntArray.h.

Constructor & Destructor Documentation

vtkIntArray::vtkIntArray ( int numComp = 1 ) [protected]

vtkIntArray::~vtkIntArray ( ) [protected]

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

Definition at line 164 of file vtkIntArray.h.

Member Function Documentation

vtkIntArray* vtkIntArray::New ( ) [static]

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

virtual const char* vtkIntArray::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 vtkIntArray::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 vtkIntArray::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.

vtkIntArray* vtkIntArray::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 vtkIntArray::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 vtkIntArray::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 vtkIntArray::Initialize ( ) [virtual]

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

vtkDataArray* vtkIntArray::MakeObject ( ) [virtual]

Create the same type object as this (virtual constructor).
Reimplemented from vtkDataArray.

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

Get the data type.
Reimplemented from vtkDataArray.
Definition at line 77 of file vtkIntArray.h.

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

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

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

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

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

Get a pointer to a tuple at the ith location. This is a dangerous method (it is not thread safe since a pointer is returned).
Reimplemented from vtkDataArray.

void vtkIntArray::GetTuple ( const int i,

float * tuple

) [virtual]

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

void vtkIntArray::GetTuple ( const int i,

double * tuple

) [virtual]

Reimplemented from vtkDataArray.

void vtkIntArray::SetTuple ( const int i,

const float * tuple

) [virtual]

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

void vtkIntArray::SetTuple ( const int i,

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

void vtkIntArray::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 vtkIntArray::InsertTuple ( const int i,

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

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

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

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

Reimplemented from vtkDataArray.

int vtkIntArray::GetValue ( const int id ) [inline]

Get the data at a particular index.
Definition at line 110 of file vtkIntArray.h.
Referenced by vtkPriorityQueue::DeleteId(), vtkCellArray::GetCell(), vtkCellArray::GetNextCell(), vtkPriorityQueue::GetPriority(), and vtkCellArray::ReverseCell().

void vtkIntArray::SetValue ( const int id,

const int 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 115 of file vtkIntArray.h.
Referenced by vtkCellArray::UpdateCellCount().

void vtkIntArray::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 177 of file vtkIntArray.h.

void vtkIntArray::InsertValue ( const int id,

const int i

) [inline]

Insert data at a specified position in the array.
Definition at line 197 of file vtkIntArray.h.
Referenced by vtkCellArray::InsertCellPoint(), and InsertNextValue().

int vtkIntArray::InsertNextValue ( const int i ) [inline]

Insert data at the end of the array. Return its location in the array.
Definition at line 210 of file vtkIntArray.h.
Referenced by vtkCellArray::InsertNextCell().

int* vtkIntArray::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 132 of file vtkIntArray.h.
Referenced by vtkCellArray::GetCell(), vtkCellArray::GetNextCell(), vtkCellArray::ReplaceCell(), and vtkCellArray::ReverseCell().

void* vtkIntArray::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 134 of file vtkIntArray.h.

int * vtkIntArray::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 183 of file vtkIntArray.h.
Referenced by vtkCellArray::InsertNextCell(), and vtkCellArray::WritePointer().

void vtkIntArray::DeepCopy ( vtkDataArray * ia ) [virtual]

Deep copy of another integer array.
Reimplemented from vtkDataArray.

void vtkIntArray::SetArray ( int * array,

int size,

int save

)

This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled array.

void vtkIntArray::SetVoidArray ( void * array,

int size,

int save

) [inline]

Definition at line 152 of file vtkIntArray.h.

void vtkIntArray::DeepCopy ( vtkDataArray & ia ) [inline]

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

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

Definition at line 165 of file vtkIntArray.h.

int* vtkIntArray::Resize ( const int sz ) [protected]

Referenced by InsertValue(), and WritePointer().

Member Data Documentation

int* vtkIntArray::Array [protected]

Definition at line 167 of file vtkIntArray.h.

int vtkIntArray::TupleSize [protected]

Definition at line 170 of file vtkIntArray.h.

float* vtkIntArray::Tuple [protected]

Definition at line 171 of file vtkIntArray.h.

int vtkIntArray::SaveUserArray [protected]

Definition at line 173 of file vtkIntArray.h.

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

common/vtkIntArray.h

Generated on Wed Nov 21 12:49:25 2001 for VTK by

vtkIntArray Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation