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

vtkUnsignedLongArray Class Reference

dynamic, self-adjusting unsigned long integer array. More...

#include <vtkUnsignedLongArray.h>

Inheritance diagram for vtkUnsignedLongArray:

[legend]Collaboration diagram for vtkUnsignedLongArray:

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

Detailed Description

dynamic, self-adjusting unsigned long integer array.

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

Revision:: 1.20

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

Examples:: vtkUnsignedLongArray (examples)

Definition at line 59 of file vtkUnsignedLongArray.h.

Constructor & Destructor Documentation

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

vtkUnsignedLongArray::~vtkUnsignedLongArray ( ) [protected]

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

Definition at line 160 of file vtkUnsignedLongArray.h.

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]

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 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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkDataArray.

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

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

vtkDataArray* vtkUnsignedLongArray::MakeObject ( ) [virtual]

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

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

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

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

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

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

float * tuple

) [virtual]

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

void vtkUnsignedLongArray::GetTuple ( const int i,

double * tuple

) [virtual]

Reimplemented from vtkDataArray.

void vtkUnsignedLongArray::SetTuple ( const int i,

const float * tuple

) [virtual]

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

void vtkUnsignedLongArray::SetTuple ( const int i,

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

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

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

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

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

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

Reimplemented from vtkDataArray.

unsigned long vtkUnsignedLongArray::GetValue ( const int id ) [inline]

Get the data at a particular index.
Definition at line 105 of file vtkUnsignedLongArray.h.

void vtkUnsignedLongArray::SetValue ( const int id,

const 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 109 of file vtkUnsignedLongArray.h.

void vtkUnsignedLongArray::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 172 of file vtkUnsignedLongArray.h.

void vtkUnsignedLongArray::InsertValue ( const int id,

const unsigned long i

) [inline]

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

int vtkUnsignedLongArray::InsertNextValue ( unsigned long i ) [inline]

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

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

void* vtkUnsignedLongArray::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 127 of file vtkUnsignedLongArray.h.

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

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

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

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

int size,

int save

) [inline]

Definition at line 144 of file vtkUnsignedLongArray.h.

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

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

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

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

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

Definition at line 161 of file vtkUnsignedLongArray.h.

unsigned long* vtkUnsignedLongArray::Resize ( const int sz ) [protected]

Referenced by InsertValue(), and WritePointer().

Member Data Documentation

unsigned long* vtkUnsignedLongArray::Array [protected]

Definition at line 163 of file vtkUnsignedLongArray.h.

int vtkUnsignedLongArray::TupleSize [protected]

Definition at line 166 of file vtkUnsignedLongArray.h.

float* vtkUnsignedLongArray::Tuple [protected]

Definition at line 167 of file vtkUnsignedLongArray.h.

int vtkUnsignedLongArray::SaveUserArray [protected]

Definition at line 169 of file vtkUnsignedLongArray.h.

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

common/vtkUnsignedLongArray.h

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

vtkUnsignedLongArray Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation