vtkUnsignedLongArray Class Reference

#include <vtkUnsignedLongArray.h>

Inheritance diagram for vtkUnsignedLongArray:

[legend]Collaboration diagram for vtkUnsignedLongArray:

[legend]List of all members.

Detailed Description

dynamic, self-adjusting array of unsigned long

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

Created by:

Schroeder, Will

CVS contributions (if > 5%):

Schroeder, Will (30%)
King, Brad (24%)
Martin, Ken (20%)
Henderson, Amy (6%)

CVS logs (CVSweb):

.h (/Common/vtkUnsignedLongArray.h)
.cxx (/Common/vtkUnsignedLongArray.cxx)

Tests:: vtkUnsignedLongArray (Tests)

Definition at line 52 of file vtkUnsignedLongArray.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 ()

unsigned long GetValue (vtkIdType id)

void SetValue (vtkIdType id, unsigned long value)

void SetNumberOfValues (vtkIdType number)

void InsertValue (vtkIdType id, unsigned long f)

vtkIdType InsertNextValue (unsigned long f)

unsigned long * WritePointer (vtkIdType id, vtkIdType number)

unsigned long * GetPointer (vtkIdType id)

void SetArray (unsigned long *array, vtkIdType size, int save)

Static Public Member Functions

vtkUnsignedLongArray * New ()

int IsTypeOf (const char *type)

vtkUnsignedLongArray * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkUnsignedLongArray (vtkIdType numComp=1)

~vtkUnsignedLongArray ()

Member Typedef Documentation

typedef vtkDataArray vtkUnsignedLongArray::Superclass

Reimplemented from vtkDataArray.
Definition at line 57 of file vtkUnsignedLongArray.h.

Constructor & Destructor Documentation

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

vtkUnsignedLongArray::~vtkUnsignedLongArray ( ) [protected]

Member Function Documentation

vtkUnsignedLongArray* vtkUnsignedLongArray::New ( ) [static]

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

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

Reimplemented from vtkDataArray.

int vtkUnsignedLongArray::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataArray.

virtual int vtkUnsignedLongArray::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataArray.

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

Reimplemented from vtkDataArray.

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

Get the data type.
Implements vtkDataArray.
Definition at line 62 of file vtkUnsignedLongArray.h.

unsigned long vtkUnsignedLongArray::GetValue ( vtkIdType id ) [inline]

Get the data at a particular index.
Definition at line 68 of file vtkUnsignedLongArray.h.
References vtkIdType.

void vtkUnsignedLongArray::SetValue ( vtkIdType id,

unsigned long 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 75 of file vtkUnsignedLongArray.h.
References vtkIdType.

void vtkUnsignedLongArray::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 83 of file vtkUnsignedLongArray.h.
References vtkIdType.

void vtkUnsignedLongArray::InsertValue ( vtkIdType id,

unsigned long f

) [inline]

Insert data at a specified position in the array.
Definition at line 89 of file vtkUnsignedLongArray.h.
References vtkIdType.

vtkIdType vtkUnsignedLongArray::InsertNextValue ( unsigned long f ) [inline]

Insert data at the end of the array. Return its location in the array.
Definition at line 96 of file vtkUnsignedLongArray.h.
References vtkIdType.

unsigned long* vtkUnsignedLongArray::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 104 of file vtkUnsignedLongArray.h.
References vtkIdType.

unsigned long* vtkUnsignedLongArray::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 111 of file vtkUnsignedLongArray.h.
References vtkIdType.

void vtkUnsignedLongArray::SetArray ( unsigned long * 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 122 of file vtkUnsignedLongArray.h.
References vtkIdType.

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

dox/Common/vtkUnsignedLongArray.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 ()

unsigned long	GetValue (vtkIdType id)

void	SetValue (vtkIdType id, unsigned long value)

void	SetNumberOfValues (vtkIdType number)

void	InsertValue (vtkIdType id, unsigned long f)

vtkIdType	InsertNextValue (unsigned long f)

unsigned long *	WritePointer (vtkIdType id, vtkIdType number)

unsigned long *	GetPointer (vtkIdType id)

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