Documentation for vtkBitArray

vtkBitArray - dynamic, self-adjusting array of bits

Super Class: vtkDataArray

Description:

vtkBitArray is an array of bits (0/1 data value). The array is packed so that each byte stores eight bits. vtkBitArray provides methods for insertion and retrieval of bits, and will automatically resize itself to hold new data.

 

Methods:

void vtkBitArray (int )
void vtkBitArray ()
static vtkBitArray *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 ()
int GetValue (const int )
void SetNumberOfValues (const int )
void SetValue (const int ,const int )
void InsertValue (const int ,const int )
int InsertNextValue (const int )
unsigned char *GetPointer (const int )
unsigned char *WritePointer (const int ,const int )
void *GetVoidPointer (const int )
void DeepCopy (vtkDataArray *)
void SetArray (unsigned char * ,int ,int )
void DeepCopy (vtkBitArray &)
unsigned 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 ()

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

Free any uunrequired memory.

void Squeeze ()

Get the data at a particular index.

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

Insets values and checks to make sure there is enough memory

void InsertValue (const int ,const int )
int InsertNextValue (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 char *GetPointer (const int )
unsigned char *WritePointer (const int ,const int )
void *GetVoidPointer (const int )

Deep copy of another bit 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 char * ,int ,int )