Documentation for vtkUnsignedLongArray

vtkUnsignedLongArray - dynamic, self-adjusting unsigned long integer array

Super Class: vtkDataArray

Description:

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

 

Methods:

void vtkUnsignedLongArray (int )
void vtkUnsignedLongArray ()
static vtkUnsignedLongArray *New ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
int Allocate (const int ,const int )
void Initialize ()
vtkDataArray *MakeObject ()
int GetDataType ()
void SetNumberOfTuples (const int )
float *GetTuple (const int )
void GetTuple (const int ,float *)
void SetTuple (const int ,const float *)
void InsertTuple (const int ,const float *)
int InsertNextTuple (const float *)
unsigned long GetValue (const int )
void SetValue (const int ,const unsigned long )
void SetNumberOfValues (const int )
void InsertValue (const int ,const unsigned long )
int InsertNextValue (const unsigned long )
unsigned long *GetPointer (const int )
void *GetVoidPointer (const int )
unsigned long *WritePointer (const int ,const int )
void DeepCopy (vtkDataArray *)
void SetArray (unsigned long * ,int ,int )
void Squeeze ()
void DeepCopy (vtkDataArray &)
unsigned long *Resize (const int )

 

Detailed Method Descriptions:

Allocate memory for this array. Delete old storage only if necessary.

int Allocate (const int ,const int )

Release storage and reset array to initial state.

void Initialize ()

Create a similar type object

vtkDataArray *MakeObject ()

Get the data type.

int GetDataType ()

Set the number of n-tuples in the array.

void SetNumberOfTuples (const int )

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

float *GetTuple (const int )

Copy the tuple value into a user-provided array.

void GetTuple (const int ,float *)

Set the tuple value at the ith location in the array.

void SetTuple (const int ,const float *)

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

void InsertTuple (const int ,const float *)

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

int InsertNextTuple (const float *)

Get the data at a particular index.

unsigned long GetValue (const int )

Set the data at a particular index. Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data.

void SetValue (const int ,const unsigned long )

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.

void SetNumberOfValues (const int )

Insert data at a specified position in the array.

void InsertValue (const int ,const unsigned long )

Insert data at the end of the array. Return its location in the array.

int InsertNextValue (const unsigned long )

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

unsigned long *GetPointer (const int )
void *GetVoidPointer (const int )

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.

unsigned long *WritePointer (const int ,const int )

Deep copy of another unsigned long array.

void DeepCopy (vtkDataArray *)

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 SetArray (unsigned long * ,int ,int )

Resize object to just fit data requirement. Reclaims extra memory.

void Squeeze ()