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

vtkBitArray Class Reference

dynamic, self-adjusting array of bits. More...

#include <vtkBitArray.h>

Inheritance diagram for vtkBitArray:

Inheritance graph
[legend]
Collaboration diagram for vtkBitArray:

Collaboration graph
[legend]
List of all members.

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 ()
vtkDataArrayMakeObject ()
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 ()
int GetValue (const int id)
void SetNumberOfValues (const int number)
void SetValue (const int id, const int value)
void InsertValue (const int id, const int i)
int InsertNextValue (const int i)
unsigned char * GetPointer (const int id)
unsigned char * WritePointer (const int id, const int number)
void * GetVoidPointer (const int id)
void DeepCopy (vtkDataArray *da)
void SetArray (unsigned char *array, int size, int save)
void SetVoidArray (void *array, int size, int save)
void DeepCopy (vtkBitArray &da)

Static Public Methods

vtkBitArray * New ()
int IsTypeOf (const char *type)
vtkBitArray * SafeDownCast (vtkObject *o)

Protected Methods

 vtkBitArray (int numComp=1)
 ~vtkBitArray ()
 vtkBitArray (const vtkBitArray &)
void operator= (const vtkBitArray &)
unsigned char * Resize (const int sz)

Protected Attributes

unsigned char * Array
int TupleSize
float * Tuple
int SaveUserArray

Detailed Description

dynamic, self-adjusting array of bits.

Date:
2000/12/10 20:08:06
Revision:
1.50

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.


Member Function Documentation

int vtkBitArray::Allocate const int    sz,
const int    ext = 1000
[virtual]
 

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

Implements vtkDataArray.

void vtkBitArray::DeepCopy vtkBitArray &    da [inline]
 

For legacy compatibility. Do not use.

void vtkBitArray::DeepCopy vtkDataArray   da [virtual]
 

Deep copy of another bit array.

Reimplemented from vtkDataArray.

virtual const char* vtkBitArray::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 vtkBitArray::GetDataType   [inline, virtual]
 

Return the underlying data type. An integer indicating data type is returned as specified in vtkSetGet.h.

Implements vtkDataArray.

unsigned char* vtkBitArray::GetPointer const int    id [inline]
 

Direct manipulation of the underlying data.

void vtkBitArray::GetTuple const int    i,
float *    tuple
[virtual]
 

Copy the tuple value into a user-provided array.

Implements vtkDataArray.

float* vtkBitArray::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).

Implements vtkDataArray.

int vtkBitArray::GetValue const int    id
 

Get the data at a particular index.

void* vtkBitArray::GetVoidPointer const int    id [inline, virtual]
 

Return a void pointer. For image pipeline interface and other special pointer manipulation.

Implements vtkDataArray.

void vtkBitArray::Initialize   [virtual]
 

Release storage and reset array to initial state.

Implements vtkDataArray.

int vtkBitArray::InsertNextTuple const float *    tuple [virtual]
 

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

Implements vtkDataArray.

void vtkBitArray::InsertTuple const int    i,
const float *    tuple
[virtual]
 

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

Implements vtkDataArray.

void vtkBitArray::InsertValue const int    id,
const int    i
[inline]
 

Insets values and checks to make sure there is enough memory

virtual int vtkBitArray::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.

int vtkBitArray::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.

vtkDataArray* vtkBitArray::MakeObject   [virtual]
 

Virtual constructor creates an object of the same type as this one. The created object also has the same number of components. You are responsible for freeing the object.

Implements vtkDataArray.

vtkBitArray* vtkBitArray::New   [static]
 

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

Reimplemented from vtkObject.

void vtkBitArray::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.

vtkBitArray* vtkBitArray::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 vtkBitArray::SetArray unsigned char *    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 vtkBitArray::SetNumberOfTuples const int    number [virtual]
 

Set the number of n-tuples in the array.

Implements vtkDataArray.

void vtkBitArray::SetNumberOfValues const int    number [inline]
 

Fast method based setting of values without memory checks. First use SetNumberOfValues then use SetValue to actually set them. 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 vtkBitArray::SetTuple const int    i,
const float *    tuple
[virtual]
 

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

Implements vtkDataArray.

void vtkBitArray::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.

void vtkBitArray::Squeeze   [inline, virtual]
 

Free any unneeded memory.

Implements vtkDataArray.

unsigned char * vtkBitArray::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.


The documentation for this class was generated from the following file:
Generated on Tue Mar 19 13:23:48 2002 for VTK by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002