Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File 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 vtkIdType sz, const vtkIdType ext=1000)
void Initialize ()
vtkDataArray * MakeObject ()
int GetDataType ()
void SetNumberOfTuples (const vtkIdType number)
float * GetTuple (const vtkIdType i)
void SetComponent (const vtkIdType i, const int j, const float c)
void Squeeze ()
virtual void Resize (vtkIdType numTuples)
int GetValue (const vtkIdType id)
void SetNumberOfValues (const vtkIdType number)
void SetValue (const vtkIdType id, const int value)
virtual void InsertComponent (const vtkIdType i, const int j, const float c)
unsigned char * GetPointer (const vtkIdType id)
void DeepCopy (vtkDataArray *da)
void GetTuple (const vtkIdType i, float *tuple)
void GetTuple (const vtkIdType i, double *tuple)
void SetTuple (const vtkIdType i, const float *tuple)
void SetTuple (const vtkIdType i, const double *tuple)
void InsertTuple (const vtkIdType i, const float *tuple)
void InsertTuple (const vtkIdType i, const double *tuple)
vtkIdType InsertNextTuple (const float *tuple)
vtkIdType InsertNextTuple (const double *tuple)
void InsertValue (const vtkIdType id, const int i)
vtkIdType InsertNextValue (const int i)
unsigned char * WritePointer (const vtkIdType id, const vtkIdType number)
void * GetVoidPointer (const vtkIdType id)
void SetArray (unsigned char *array, vtkIdType size, int save)
void SetVoidArray (void *array, vtkIdType size, int save)

Static Public Methods

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

Protected Methods

 vtkBitArray (vtkIdType numComp=1)
 ~vtkBitArray ()
unsigned char * ResizeAndExtend (const vtkIdType sz)

Protected Attributes

unsigned char * Array
int TupleSize
float * Tuple
int SaveUserArray

Detailed Description

dynamic, self-adjusting array of bits.

Date:
2001/11/16 13:01:59
Revision:
1.60

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.

Definition at line 57 of file vtkBitArray.h.

Constructor & Destructor Documentation

vtkBitArray::vtkBitArray (  vtkIdType    numComp = 1 )  [protected]
 

vtkBitArray::~vtkBitArray (    )  [protected]
 

Member Function Documentation

vtkBitArray* vtkBitArray::New (    )  [static]
 

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

Reimplemented from vtkObject.

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

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::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 vtkBitArray::Allocate (  const vtkIdType    sz,
const vtkIdType    ext = 1000
)  [virtual]
 

Allocate memory for this array. Delete old storage only if necessary. Note that ext is no longer used.

Reimplemented from vtkDataArray.

Referenced by SetNumberOfValues().

void vtkBitArray::Initialize (    )  [virtual]
 

Release storage and reset array to initial state.

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.

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.

Reimplemented from vtkDataArray.

Definition at line 73 of file vtkBitArray.h.

void vtkBitArray::SetNumberOfTuples (  const vtkIdType    number )  [virtual]
 

Set the number of n-tuples in the array.

Reimplemented from vtkDataArray.

float* vtkBitArray::GetTuple (  const vtkIdType    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 vtkBitArray::GetTuple (  const vtkIdType    i,
float *    tuple
)  [virtual]
 

Copy the tuple value into a user-provided array.

Reimplemented from vtkDataArray.

void vtkBitArray::GetTuple (  const vtkIdType    i,
double *    tuple
)  [virtual]
 

Copy the tuple value into a user-provided array.

Reimplemented from vtkDataArray.

void vtkBitArray::SetTuple (  const vtkIdType    i,
const float *    tuple
)  [virtual]
 

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

Reimplemented from vtkDataArray.

void vtkBitArray::SetTuple (  const vtkIdType    i,
const double *    tuple
)  [virtual]
 

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

Reimplemented from vtkDataArray.

void vtkBitArray::InsertTuple (  const vtkIdType    i,
const float *    tuple
)  [virtual]
 

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

Reimplemented from vtkDataArray.

void vtkBitArray::InsertTuple (  const vtkIdType    i,
const double *    tuple
)  [virtual]
 

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

Reimplemented from vtkDataArray.

vtkIdType vtkBitArray::InsertNextTuple (  const float *    tuple )  [virtual]
 

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

Reimplemented from vtkDataArray.

vtkIdType vtkBitArray::InsertNextTuple (  const double *    tuple )  [virtual]
 

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

Reimplemented from vtkDataArray.

void vtkBitArray::SetComponent (  const vtkIdType    i,
const int    j,
const float    c
)  [virtual]
 

Set the data component at the ith tuple and jth component location. Note that i is less then NumberOfTuples and j is less then NumberOfComponents. Make sure enough memory has been allocated (use SetNumberOfTuples() and SetNumberOfComponents()).

Reimplemented from vtkDataArray.

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

Free any unneeded memory.

Reimplemented from vtkDataArray.

Definition at line 253 of file vtkBitArray.h.

virtual void vtkBitArray::Resize (  vtkIdType    numTuples )  [virtual]
 

Resize the array while conserving the data.

Reimplemented from vtkDataArray.

int vtkBitArray::GetValue (  const vtkIdType    id ) 
 

Get the data at a particular index.

void vtkBitArray::SetNumberOfValues (  const vtkIdType    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.

Definition at line 210 of file vtkBitArray.h.

void vtkBitArray::SetValue (  const vtkIdType    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 216 of file vtkBitArray.h.

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

Insets values and checks to make sure there is enough memory

Definition at line 228 of file vtkBitArray.h.

Referenced by InsertNextValue().

vtkIdType vtkBitArray::InsertNextValue (  const int    i )  [inline]
 

Insets values and checks to make sure there is enough memory

Definition at line 248 of file vtkBitArray.h.

virtual void vtkBitArray::InsertComponent (  const vtkIdType    i,
const int    j,
const float    c
)  [virtual]
 

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

Reimplemented from vtkDataArray.

unsigned char* vtkBitArray::GetPointer (  const vtkIdType    id )  [inline]
 

Direct manipulation of the underlying data.

Definition at line 146 of file vtkBitArray.h.

unsigned char * vtkBitArray::WritePointer (  const vtkIdType    id,
const vtkIdType    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 195 of file vtkBitArray.h.

void* vtkBitArray::GetVoidPointer (  const vtkIdType    id )  [inline, virtual]
 

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.

Reimplemented from vtkDataArray.

Definition at line 153 of file vtkBitArray.h.

void vtkBitArray::DeepCopy (  vtkDataArray *    da )  [virtual]
 

Deep copy of another bit array.

Reimplemented from vtkDataArray.

void vtkBitArray::SetArray (  unsigned char *    array,
vtkIdType    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::SetVoidArray (  void *    array,
vtkIdType    size,
int    save
)  [inline]
 

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.

Definition at line 168 of file vtkBitArray.h.

unsigned char* vtkBitArray::ResizeAndExtend (  const vtkIdType    sz )  [protected]
 

Referenced by InsertValue(), Squeeze(), and WritePointer().

Member Data Documentation

unsigned char* vtkBitArray::Array [protected]
 

Definition at line 177 of file vtkBitArray.h.

int vtkBitArray::TupleSize [protected]
 

Definition at line 181 of file vtkBitArray.h.

float* vtkBitArray::Tuple [protected]
 

Definition at line 182 of file vtkBitArray.h.

int vtkBitArray::SaveUserArray [protected]
 

Definition at line 184 of file vtkBitArray.h.

The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:27:25 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001