vtkUnsignedLongArray Class Reference

#include <vtkUnsignedLongArray.h>

Inheritance diagram for vtkUnsignedLongArray:

Inheritance graph
[legend]
Collaboration diagram for vtkUnsignedLongArray:

Collaboration graph
[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.

Tests:
vtkUnsignedLongArray (Tests)

Definition at line 39 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 ()
void GetTupleValue (vtkIdType i, unsigned long *tuple)
void SetTupleValue (vtkIdType i, const unsigned long *tuple)
void InsertTupleValue (vtkIdType i, const unsigned long *tuple)
vtkIdType InsertNextTupleValue (const unsigned long *tuple)
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 * GetValueRange (int comp)
void GetValueRange (unsigned long range[2], int comp)
unsigned long * GetValueRange ()
void GetValueRange (unsigned long range[2])
unsigned long * WritePointer (vtkIdType id, vtkIdType number)
unsigned long * GetPointer (vtkIdType id)
void SetArray (unsigned long *array, vtkIdType size, int save)
void SetArray (unsigned long *array, vtkIdType size, int save, int deleteMethod)

Static Public Member Functions

static vtkUnsignedLongArrayNew ()
static int IsTypeOf (const char *type)
static vtkUnsignedLongArraySafeDownCast (vtkObject *o)
static unsigned long GetDataTypeValueMin ()
static unsigned long GetDataTypeValueMax ()

Protected Member Functions

 vtkUnsignedLongArray (vtkIdType numComp=1)
 ~vtkUnsignedLongArray ()

Member Typedef Documentation

Reimplemented from vtkDataArray.

Definition at line 44 of file vtkUnsignedLongArray.h.


Constructor & Destructor Documentation

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

vtkUnsignedLongArray::~vtkUnsignedLongArray (  )  [protected]


Member Function Documentation

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

static int vtkUnsignedLongArray::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 vtkUnsignedLongArray::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 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 vtkAbstractArray.

Definition at line 49 of file vtkUnsignedLongArray.h.

void vtkUnsignedLongArray::GetTupleValue ( vtkIdType  i,
unsigned long *  tuple 
) [inline]

Copy the tuple value into a user-provided array.

Definition at line 55 of file vtkUnsignedLongArray.h.

void vtkUnsignedLongArray::SetTupleValue ( vtkIdType  i,
const unsigned long *  tuple 
) [inline]

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

Definition at line 61 of file vtkUnsignedLongArray.h.

void vtkUnsignedLongArray::InsertTupleValue ( vtkIdType  i,
const unsigned long *  tuple 
) [inline]

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

Definition at line 68 of file vtkUnsignedLongArray.h.

vtkIdType vtkUnsignedLongArray::InsertNextTupleValue ( const unsigned long *  tuple  )  [inline]

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

Definition at line 75 of file vtkUnsignedLongArray.h.

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

Get the data at a particular index.

Definition at line 81 of file vtkUnsignedLongArray.h.

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

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

void vtkUnsignedLongArray::InsertValue ( vtkIdType  id,
unsigned long  f 
) [inline]

Insert data at a specified position in the array.

Definition at line 102 of file vtkUnsignedLongArray.h.

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

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

Definition at line 109 of file vtkUnsignedLongArray.h.

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

void vtkUnsignedLongArray::GetValueRange ( unsigned long  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 vtkUnsignedLongArray.h.

unsigned long* vtkUnsignedLongArray::GetValueRange (  )  [inline]

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

Definition at line 127 of file vtkUnsignedLongArray.h.

void vtkUnsignedLongArray::GetValueRange ( unsigned long  range[2]  )  [inline]

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

Definition at line 130 of file vtkUnsignedLongArray.h.

static unsigned long vtkUnsignedLongArray::GetDataTypeValueMin (  )  [inline, static]

Get the minimum data value in its native type.

Definition at line 136 of file vtkUnsignedLongArray.h.

static unsigned long vtkUnsignedLongArray::GetDataTypeValueMax (  )  [inline, static]

Get the maximum data value in its native type.

Definition at line 139 of file vtkUnsignedLongArray.h.

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

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

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

void vtkUnsignedLongArray::SetArray ( unsigned long *  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 vtkUnsignedLongArray.h.


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

Generated on Wed Aug 24 12:15:51 2011 for VTK by  doxygen 1.5.6