Documentation for vtkCharArray

vtkCharArray - dynamic, self-adjusting character array

Super Class: vtkDataArray

Description:

vtkCharArray is an array of character values. It provides methods for insertion and retrieval of characters, and will automatically resize itself to hold new data.

 

Methods:

void vtkCharArray (int )
void vtkCharArray ()
static vtkCharArray *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 *)
void Squeeze ()
float GetComponent (const int ,const int )
void SetComponent (const int ,const int ,const float )
void InsertComponent (const int ,const int ,const float )
char GetValue (const int )
void SetValue (const int ,const char )
void SetNumberOfValues (const int )
char *WritePointer (const int ,const int )
void InsertValue (const int ,const char )
int InsertNextValue (const char )
void *GetVoidPointer (const int )
char *GetPointer (const int )
void DeepCopy (vtkDataArray *)
void SetArray (char * ,int ,int )
void DeepCopy (vtkDataArray &)
char *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 tuples in the array. Note that this allocates space depending on the tuple dimension.

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

Return the data component at the ith tuple and jth component location. Note that i

void Squeeze ()
float GetComponent (const int ,const int )

Set the data component at the ith tuple and jth component location. Note that i

void SetComponent (const int ,const int ,const float )

Insert the data component at ith tuple and jth component location. Note that memory allocation is performed as necessary to hold the data.

void InsertComponent (const int ,const int ,const float )

Get the data at a particular index.

char GetValue (const int )

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 SetValue (const int ,const char )
void SetNumberOfValues (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.

char *WritePointer (const int ,const int )

Insert data at a specified position in the array.

void InsertValue (const int ,const char )

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

int InsertNextValue (const char )

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

void *GetVoidPointer (const int )

Deep copy of another char array.

char *GetPointer (const int )
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 (char * ,int ,int )