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

vtkUnsignedCharArray Class Reference

dynamic, self-adjusting unsigned character array. More...

#include <vtkUnsignedCharArray.h>

Inheritance diagram for vtkUnsignedCharArray:

[legend]Collaboration diagram for vtkUnsignedCharArray:

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 ()
vtkDataArray *	MakeObject ()
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 ()
float	GetComponent (const int i, const int j)
void	SetComponent (const int i, const int j, const float c)
void	InsertComponent (const int i, const int j, const float c)
unsigned char	GetValue (const int id)
void	SetValue (const int id, const unsigned char value)
void	SetNumberOfValues (const int number)
void	InsertValue (const int id, const unsigned char c)
int	InsertNextValue (const unsigned char c)
unsigned char *	GetPointer (const int id)
void *	GetVoidPointer (const int id)
unsigned char *	WritePointer (const int id, const int number)
void	DeepCopy (vtkDataArray *da)
void	SetArray (unsigned char *array, int size, int save)
void	SetVoidArray (void *array, int size, int save)
void	DeepCopy (vtkDataArray &da)
Static Public Methods
vtkUnsignedCharArray *	New ()
int	IsTypeOf (const char *type)
vtkUnsignedCharArray *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkUnsignedCharArray (int numComp=1)
	~vtkUnsignedCharArray ()
	vtkUnsignedCharArray (const vtkUnsignedCharArray &)
void	operator= (const vtkUnsignedCharArray &)
unsigned char *	Resize (const int sz)
Protected Attributes
unsigned char *	Array
int	TupleSize
float *	Tuple
int	SaveUserArray

Detailed Description

dynamic, self-adjusting unsigned character array.

Date:: 2000/12/10 20:08:20

Revision:: 1.53

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

Examples:: vtkUnsignedCharArray (examples)

Definition at line 59 of file vtkUnsignedCharArray.h.

Constructor & Destructor Documentation

vtkUnsignedCharArray::vtkUnsignedCharArray ( int numComp = 1 ) [protected]

vtkUnsignedCharArray::~vtkUnsignedCharArray ( ) [protected]

vtkUnsignedCharArray::vtkUnsignedCharArray ( const vtkUnsignedCharArray & ) [inline, protected]

Definition at line 176 of file vtkUnsignedCharArray.h.

Member Function Documentation

vtkUnsignedCharArray* vtkUnsignedCharArray::New ( ) [static]

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

virtual const char* vtkUnsignedCharArray::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 vtkUnsignedCharArray::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 vtkUnsignedCharArray::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.

vtkUnsignedCharArray* vtkUnsignedCharArray::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 vtkUnsignedCharArray::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 vtkUnsignedCharArray::Allocate ( const int sz,

const int ext = 1000

) [virtual]

Allocate memory for this array. Delete old storage only if necessary.
Reimplemented from vtkDataArray.
Referenced by SetNumberOfValues().

void vtkUnsignedCharArray::Initialize ( ) [virtual]

Release storage and reset array to initial state.
Reimplemented from vtkDataArray.

vtkDataArray* vtkUnsignedCharArray::MakeObject ( ) [virtual]

Create the same type object as this (virtual constructor).
Reimplemented from vtkDataArray.

int vtkUnsignedCharArray::GetDataType ( ) [inline, virtual]

Get the data type.
Reimplemented from vtkDataArray.
Definition at line 77 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::SetNumberOfTuples ( const int number ) [virtual]

Set the number of n-tuples in the array.
Reimplemented from vtkDataArray.

float* vtkUnsignedCharArray::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).
Reimplemented from vtkDataArray.

void vtkUnsignedCharArray::GetTuple ( const int i,

float * tuple

) [virtual]

Copy the tuple value into a user-provided array.
Reimplemented from vtkDataArray.

void vtkUnsignedCharArray::GetTuple ( const int i,

double * tuple

) [virtual]

Reimplemented from vtkDataArray.

void vtkUnsignedCharArray::SetTuple ( const int i,

const float * tuple

) [virtual]

Set the tuple value at the ith location in the array.
Reimplemented from vtkDataArray.

void vtkUnsignedCharArray::SetTuple ( const int i,

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

void vtkUnsignedCharArray::InsertTuple ( const int i,

const float * tuple

) [virtual]

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

void vtkUnsignedCharArray::InsertTuple ( const int i,

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

int vtkUnsignedCharArray::InsertNextTuple ( const float * tuple ) [virtual]

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

int vtkUnsignedCharArray::InsertNextTuple ( const double * tuple ) [virtual]

Reimplemented from vtkDataArray.

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

Resize object to just fit data requirement. Reclaims extra memory.
Reimplemented from vtkDataArray.
Definition at line 105 of file vtkUnsignedCharArray.h.

float vtkUnsignedCharArray::GetComponent ( const int i,

const int j

) [virtual]

Return the data component at the ith tuple and jth component location. Note that i is less then NumberOfTuples and j is less then NumberOfComponents.
Reimplemented from vtkDataArray.

void vtkUnsignedCharArray::SetComponent ( const int 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 vtkUnsignedCharArray::InsertComponent ( const int 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 vtkUnsignedCharArray::GetValue ( const int id ) [inline]

Get the data at a particular index.
Definition at line 124 of file vtkUnsignedCharArray.h.
Referenced by vtkGhostLevels::GetGhostLevel().

void vtkUnsignedCharArray::SetValue ( const int id,

const unsigned char 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 128 of file vtkUnsignedCharArray.h.
Referenced by vtkGhostLevels::SetGhostLevel().

void vtkUnsignedCharArray::SetNumberOfValues ( const int number ) [inline]

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 188 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::InsertValue ( const int id,

const unsigned char c

) [inline]

Insert data at a specified position in the array.
Definition at line 208 of file vtkUnsignedCharArray.h.
Referenced by vtkGhostLevels::InsertGhostLevel(), and InsertNextValue().

int vtkUnsignedCharArray::InsertNextValue ( const unsigned char c ) [inline]

Insert data at the end of the array. Return its location in the array.
Definition at line 221 of file vtkUnsignedCharArray.h.
Referenced by vtkGhostLevels::InsertNextGhostLevel().

unsigned char* vtkUnsignedCharArray::GetPointer ( const int id ) [inline]

Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.
Definition at line 145 of file vtkUnsignedCharArray.h.

void* vtkUnsignedCharArray::GetVoidPointer ( const int id ) [inline, virtual]

Return a void pointer. For image pipeline interface and other special pointer manipulation.
Reimplemented from vtkDataArray.
Definition at line 146 of file vtkUnsignedCharArray.h.

unsigned char * vtkUnsignedCharArray::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.
Definition at line 194 of file vtkUnsignedCharArray.h.
Referenced by vtkLookupTable::WritePointer().

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

Deep copy of another unsigned char array.
Reimplemented from vtkDataArray.

void vtkUnsignedCharArray::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 vtkUnsignedCharArray::SetVoidArray ( void * array,

int size,

int save

) [inline]

Definition at line 163 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::DeepCopy ( vtkDataArray & da ) [inline]

For legacy compatibility. Do not use.
Reimplemented from vtkDataArray.
Definition at line 168 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::operator= ( const vtkUnsignedCharArray & ) [inline, protected]

Definition at line 177 of file vtkUnsignedCharArray.h.

unsigned char* vtkUnsignedCharArray::Resize ( const int sz ) [protected]

Referenced by InsertValue(), and WritePointer().

Member Data Documentation

unsigned char* vtkUnsignedCharArray::Array [protected]

Definition at line 179 of file vtkUnsignedCharArray.h.

int vtkUnsignedCharArray::TupleSize [protected]

Definition at line 182 of file vtkUnsignedCharArray.h.

float* vtkUnsignedCharArray::Tuple [protected]

Definition at line 183 of file vtkUnsignedCharArray.h.

int vtkUnsignedCharArray::SaveUserArray [protected]

Definition at line 185 of file vtkUnsignedCharArray.h.

The documentation for this class was generated from the following file:

common/vtkUnsignedCharArray.h

Generated on Wed Nov 21 13:01:23 2001 for VTK by

vtkUnsignedCharArray Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation