vtkUnsignedCharArray Class Reference

#include <vtkUnsignedCharArray.h>

Inheritance diagram for vtkUnsignedCharArray:

[legend]

Collaboration diagram for vtkUnsignedCharArray:

[legend]

List of all members.

Detailed Description

dynamic, self-adjusting array of unsigned char

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

Examples:: vtkUnsignedCharArray (Examples)

Tests:: vtkUnsignedCharArray (Tests)

Definition at line 42 of file vtkUnsignedCharArray.h.


Public Types
typedef vtkDataArray	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)

int	GetDataType ()

void	GetTupleValue (vtkIdType i, unsigned char *tuple)

void	SetTupleValue (vtkIdType i, const unsigned char *tuple)

void	InsertTupleValue (vtkIdType i, const unsigned char *tuple)

vtkIdType	InsertNextTupleValue (const unsigned char *tuple)

unsigned char	GetValue (vtkIdType id)

void	SetValue (vtkIdType id, unsigned char value)

void	SetNumberOfValues (vtkIdType number)

void	InsertValue (vtkIdType id, unsigned char f)

vtkIdType	InsertNextValue (unsigned char f)

unsigned char *	GetValueRange (int comp)
void	GetValueRange (unsigned char range[2], int comp)

unsigned char *	GetValueRange ()
void	GetValueRange (unsigned char range[2])

unsigned char *	WritePointer (vtkIdType id, vtkIdType number)

unsigned char *	GetPointer (vtkIdType id)

void	SetArray (unsigned char *array, vtkIdType size, int save)
void	SetArray (unsigned char *array, vtkIdType size, int save, int deleteMethod)
Static Public Member Functions
static vtkUnsignedCharArray *	New ()
static int	IsTypeOf (const char *type)
static vtkUnsignedCharArray *	SafeDownCast (vtkObject *o)
static unsigned char	GetDataTypeValueMin ()
static unsigned char	GetDataTypeValueMax ()
Protected Member Functions
	vtkUnsignedCharArray (vtkIdType numComp=1)
	~vtkUnsignedCharArray ()

Member Typedef Documentation

typedef vtkDataArray vtkUnsignedCharArray::Superclass

Reimplemented from vtkDataArray.

Definition at line 47 of file vtkUnsignedCharArray.h.

Constructor & Destructor Documentation

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

vtkUnsignedCharArray::~vtkUnsignedCharArray ( ) [protected]

Member Function Documentation

static 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]

Reimplemented from vtkDataArray.

static int vtkUnsignedCharArray::IsTypeOf ( const char * name ) [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 * name ) [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.

static vtkUnsignedCharArray* vtkUnsignedCharArray::SafeDownCast ( vtkObject * o ) [static]

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::GetDataType ( ) [inline, virtual]

Get the data type.

Implements vtkAbstractArray.

Definition at line 52 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::GetTupleValue	(	vtkIdType	i,
		unsigned char *	tuple
	)			`[inline]`

Copy the tuple value into a user-provided array.

Definition at line 58 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::SetTupleValue	(	vtkIdType	i,
		const unsigned char *	tuple
	)			`[inline]`

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

Definition at line 64 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::InsertTupleValue	(	vtkIdType	i,
		const unsigned char *	tuple
	)			`[inline]`

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

Definition at line 71 of file vtkUnsignedCharArray.h.

vtkIdType vtkUnsignedCharArray::InsertNextTupleValue ( const unsigned char * tuple ) [inline]

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

Definition at line 78 of file vtkUnsignedCharArray.h.

unsigned char vtkUnsignedCharArray::GetValue ( vtkIdType id ) [inline]

Get the data at a particular index.

Definition at line 84 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::SetValue	(	vtkIdType	id,
		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 91 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::SetNumberOfValues ( vtkIdType 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 99 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::InsertValue	(	vtkIdType	id,
		unsigned char	f
	)			`[inline]`

Insert data at a specified position in the array.

Definition at line 105 of file vtkUnsignedCharArray.h.

vtkIdType vtkUnsignedCharArray::InsertNextValue ( unsigned char f ) [inline]

Insert data at the end of the array. Return its location in the array.

Definition at line 112 of file vtkUnsignedCharArray.h.

unsigned char* vtkUnsignedCharArray::GetValueRange ( int comp ) [inline]

Get the range of array values for the given component in the native data type.

Definition at line 119 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::GetValueRange	(	unsigned char	range[2],
		int	comp
	)			`[inline]`

Get the range of array values for the given component in the native data type.

Definition at line 122 of file vtkUnsignedCharArray.h.

unsigned char* vtkUnsignedCharArray::GetValueRange ( ) [inline]

Get the range of array values for the 0th component in the native data type.

Definition at line 130 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::GetValueRange ( unsigned char range[2] ) [inline]

Get the range of array values for the 0th component in the native data type.

Definition at line 133 of file vtkUnsignedCharArray.h.

static unsigned char vtkUnsignedCharArray::GetDataTypeValueMin ( ) [inline, static]

Get the minimum data value in its native type.

Definition at line 139 of file vtkUnsignedCharArray.h.

static unsigned char vtkUnsignedCharArray::GetDataTypeValueMax ( ) [inline, static]

Get the maximum data value in its native type.

Definition at line 142 of file vtkUnsignedCharArray.h.

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

unsigned char* vtkUnsignedCharArray::GetPointer ( vtkIdType 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 155 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::SetArray	(	unsigned char *	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 166 of file vtkUnsignedCharArray.h.

void vtkUnsignedCharArray::SetArray	(	unsigned char *	array,
		vtkIdType	size,
		int	save,
		int	deleteMethod
	)			`[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 vtkUnsignedCharArray.h.

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

dox/Common/vtkUnsignedCharArray.h

vtkUnsignedCharArray Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation