vtkUnsignedIntArray Class Reference

#include <vtkUnsignedIntArray.h>

Inheritance diagram for vtkUnsignedIntArray:

[legend]

Collaboration diagram for vtkUnsignedIntArray:

[legend]

List of all members.

Detailed Description

dynamic, self-adjusting array of unsigned int

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

Tests:: vtkUnsignedIntArray (Tests)

Definition at line 39 of file vtkUnsignedIntArray.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 int *tuple)

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

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

vtkIdType	InsertNextTupleValue (const unsigned int *tuple)

unsigned int	GetValue (vtkIdType id)

void	SetValue (vtkIdType id, unsigned int value)

void	SetNumberOfValues (vtkIdType number)

void	InsertValue (vtkIdType id, unsigned int f)

vtkIdType	InsertNextValue (unsigned int f)

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

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

unsigned int *	WritePointer (vtkIdType id, vtkIdType number)

unsigned int *	GetPointer (vtkIdType id)

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

Member Typedef Documentation

typedef vtkDataArray vtkUnsignedIntArray::Superclass

Reimplemented from vtkDataArray.

Definition at line 44 of file vtkUnsignedIntArray.h.

Constructor & Destructor Documentation

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

vtkUnsignedIntArray::~vtkUnsignedIntArray ( ) [protected]

Member Function Documentation

static vtkUnsignedIntArray* vtkUnsignedIntArray::New ( ) [static]

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

Reimplemented from vtkObject.

virtual const char* vtkUnsignedIntArray::GetClassName ( ) [virtual]

Reimplemented from vtkDataArray.

static int vtkUnsignedIntArray::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 vtkUnsignedIntArray::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 vtkUnsignedIntArray* vtkUnsignedIntArray::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkDataArray.

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

Get the data type.

Implements vtkAbstractArray.

Definition at line 49 of file vtkUnsignedIntArray.h.

void vtkUnsignedIntArray::GetTupleValue	(	vtkIdType	i,
		unsigned int *	tuple
	)			`[inline]`

Copy the tuple value into a user-provided array.

Definition at line 55 of file vtkUnsignedIntArray.h.

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

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

Definition at line 61 of file vtkUnsignedIntArray.h.

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

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

Definition at line 68 of file vtkUnsignedIntArray.h.

vtkIdType vtkUnsignedIntArray::InsertNextTupleValue ( const unsigned int * tuple ) [inline]

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

Definition at line 75 of file vtkUnsignedIntArray.h.

unsigned int vtkUnsignedIntArray::GetValue ( vtkIdType id ) [inline]

Get the data at a particular index.

Definition at line 81 of file vtkUnsignedIntArray.h.

void vtkUnsignedIntArray::SetValue	(	vtkIdType	id,
		unsigned 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 88 of file vtkUnsignedIntArray.h.

void vtkUnsignedIntArray::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 96 of file vtkUnsignedIntArray.h.

void vtkUnsignedIntArray::InsertValue	(	vtkIdType	id,
		unsigned int	f
	)			`[inline]`

Insert data at a specified position in the array.

Definition at line 102 of file vtkUnsignedIntArray.h.

vtkIdType vtkUnsignedIntArray::InsertNextValue ( unsigned int f ) [inline]

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

Definition at line 109 of file vtkUnsignedIntArray.h.

unsigned int* vtkUnsignedIntArray::GetValueRange ( int comp ) [inline]

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

Definition at line 116 of file vtkUnsignedIntArray.h.

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

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

Definition at line 119 of file vtkUnsignedIntArray.h.

unsigned int* vtkUnsignedIntArray::GetValueRange ( ) [inline]

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

Definition at line 127 of file vtkUnsignedIntArray.h.

void vtkUnsignedIntArray::GetValueRange ( unsigned int range[2] ) [inline]

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

Definition at line 130 of file vtkUnsignedIntArray.h.

static unsigned int vtkUnsignedIntArray::GetDataTypeValueMin ( ) [inline, static]

Get the minimum data value in its native type.

Definition at line 136 of file vtkUnsignedIntArray.h.

static unsigned int vtkUnsignedIntArray::GetDataTypeValueMax ( ) [inline, static]

Get the maximum data value in its native type.

Definition at line 139 of file vtkUnsignedIntArray.h.

unsigned int* vtkUnsignedIntArray::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 145 of file vtkUnsignedIntArray.h.

unsigned int* vtkUnsignedIntArray::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 152 of file vtkUnsignedIntArray.h.

void vtkUnsignedIntArray::SetArray	(	unsigned int *	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 163 of file vtkUnsignedIntArray.h.

void vtkUnsignedIntArray::SetArray	(	unsigned int *	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 165 of file vtkUnsignedIntArray.h.

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

dox/Common/vtkUnsignedIntArray.h

vtkUnsignedIntArray 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