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

vtkCharArray Class Reference

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

#include <vtkCharArray.h>

Inheritance diagram for vtkCharArray:

[legend]Collaboration diagram for vtkCharArray:

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

Detailed Description

dynamic, self-adjusting character array.

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

Revision:: 1.31

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.

Examples:: vtkCharArray (examples)

Definition at line 59 of file vtkCharArray.h.

Constructor & Destructor Documentation

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

vtkCharArray::~vtkCharArray ( ) [protected]

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

Definition at line 175 of file vtkCharArray.h.

Member Function Documentation

vtkCharArray* vtkCharArray::New ( ) [static]

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

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

vtkCharArray* vtkCharArray::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 vtkCharArray::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 vtkCharArray::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 vtkCharArray::Initialize ( ) [virtual]

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

vtkDataArray* vtkCharArray::MakeObject ( ) [virtual]

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

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

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

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

Set the number of tuples in the array. Note that this allocates space depending on the tuple dimension.
Reimplemented from vtkDataArray.

float* vtkCharArray::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 vtkCharArray::GetTuple ( const int i,

float * tuple

) [virtual]

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

void vtkCharArray::GetTuple ( const int i,

double * tuple

) [virtual]

Reimplemented from vtkDataArray.

void vtkCharArray::SetTuple ( const int i,

const float * tuple

) [virtual]

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

void vtkCharArray::SetTuple ( const int i,

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

void vtkCharArray::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 vtkCharArray::InsertTuple ( const int i,

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

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

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

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

Reimplemented from vtkDataArray.

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

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

float vtkCharArray::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 than NumberOfTuples and j is less than NumberOfComponents.
Reimplemented from vtkDataArray.

void vtkCharArray::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 than NumberOfTuples and j is less than NumberOfComponents. Make sure enough memory has been allocated (use SetNumberOfTuples() and SetNumberOfComponents()).
Reimplemented from vtkDataArray.

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

char vtkCharArray::GetValue ( const int id ) [inline]

Get the data at a particular index.
Definition at line 125 of file vtkCharArray.h.

void vtkCharArray::SetValue ( const int id,

const 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 129 of file vtkCharArray.h.

void vtkCharArray::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 191 of file vtkCharArray.h.

char * vtkCharArray::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 201 of file vtkCharArray.h.

void vtkCharArray::InsertValue ( const int id,

const char c

) [inline]

Insert data at a specified position in the array.
Definition at line 215 of file vtkCharArray.h.
Referenced by InsertNextValue().

int vtkCharArray::InsertNextValue ( const char c ) [inline]

Insert data at the end of the array. Return its location in the array.
Definition at line 228 of file vtkCharArray.h.

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

Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.
Reimplemented from vtkDataArray.
Definition at line 150 of file vtkCharArray.h.

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

Definition at line 151 of file vtkCharArray.h.

void vtkCharArray::DeepCopy ( vtkDataArray * ia ) [virtual]

Deep copy of another char array.
Reimplemented from vtkDataArray.

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

int size,

int save

) [inline]

Definition at line 163 of file vtkCharArray.h.

void vtkCharArray::DeepCopy ( vtkDataArray & ia ) [inline]

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

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

Definition at line 176 of file vtkCharArray.h.

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

Referenced by InsertValue(), and WritePointer().

Member Data Documentation

char* vtkCharArray::Array [protected]

Definition at line 178 of file vtkCharArray.h.

int vtkCharArray::TupleSize [protected]

Definition at line 181 of file vtkCharArray.h.

float* vtkCharArray::Tuple [protected]

Definition at line 182 of file vtkCharArray.h.

int vtkCharArray::SaveUserArray [protected]

Definition at line 184 of file vtkCharArray.h.

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

common/vtkCharArray.h

Generated on Wed Nov 21 12:46:54 2001 for VTK by

vtkCharArray Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation