vtkIdTypeArray Class Reference

#include <vtkIdTypeArray.h>

Inheritance diagram for vtkIdTypeArray:

Inheritance graph
[legend]
Collaboration diagram for vtkIdTypeArray:

Collaboration graph
[legend]

List of all members.


Detailed Description

dynamic, self-adjusting array of vtkIdType

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

Examples:
vtkIdTypeArray (Examples)
Tests:
vtkIdTypeArray (Tests)

Definition at line 42 of file vtkIdTypeArray.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, vtkIdType *tuple)
void SetTupleValue (vtkIdType i, const vtkIdType *tuple)
void InsertTupleValue (vtkIdType i, const vtkIdType *tuple)
vtkIdType InsertNextTupleValue (const vtkIdType *tuple)
vtkIdType GetValue (vtkIdType id)
void SetValue (vtkIdType id, vtkIdType value)
void SetNumberOfValues (vtkIdType number)
void InsertValue (vtkIdType id, vtkIdType f)
vtkIdType InsertNextValue (vtkIdType f)
vtkIdTypeGetValueRange (int comp)
void GetValueRange (vtkIdType range[2], int comp)
vtkIdTypeGetValueRange ()
void GetValueRange (vtkIdType range[2])
vtkIdTypeWritePointer (vtkIdType id, vtkIdType number)
vtkIdTypeGetPointer (vtkIdType id)
void SetArray (vtkIdType *array, vtkIdType size, int save)
void SetArray (vtkIdType *array, vtkIdType size, int save, int deleteMethod)

Static Public Member Functions

static vtkIdTypeArrayNew ()
static int IsTypeOf (const char *type)
static vtkIdTypeArraySafeDownCast (vtkObject *o)
static vtkIdType GetDataTypeValueMin ()
static vtkIdType GetDataTypeValueMax ()

Protected Member Functions

 vtkIdTypeArray (vtkIdType numComp=1)
 ~vtkIdTypeArray ()

Member Typedef Documentation

Reimplemented from vtkDataArray.

Definition at line 47 of file vtkIdTypeArray.h.


Constructor & Destructor Documentation

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

vtkIdTypeArray::~vtkIdTypeArray (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkObject.

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

Reimplemented from vtkDataArray.

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

Reimplemented from vtkDataArray.

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

Get the data type.

Implements vtkAbstractArray.

Definition at line 52 of file vtkIdTypeArray.h.

void vtkIdTypeArray::GetTupleValue ( vtkIdType  i,
vtkIdType tuple 
) [inline]

Copy the tuple value into a user-provided array.

Definition at line 58 of file vtkIdTypeArray.h.

void vtkIdTypeArray::SetTupleValue ( vtkIdType  i,
const vtkIdType tuple 
) [inline]

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

Definition at line 64 of file vtkIdTypeArray.h.

void vtkIdTypeArray::InsertTupleValue ( vtkIdType  i,
const vtkIdType tuple 
) [inline]

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

Definition at line 71 of file vtkIdTypeArray.h.

vtkIdType vtkIdTypeArray::InsertNextTupleValue ( const vtkIdType tuple  )  [inline]

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

Definition at line 78 of file vtkIdTypeArray.h.

vtkIdType vtkIdTypeArray::GetValue ( vtkIdType  id  )  [inline]

Get the data at a particular index.

Definition at line 84 of file vtkIdTypeArray.h.

void vtkIdTypeArray::SetValue ( vtkIdType  id,
vtkIdType  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 vtkIdTypeArray.h.

void vtkIdTypeArray::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 vtkIdTypeArray.h.

void vtkIdTypeArray::InsertValue ( vtkIdType  id,
vtkIdType  f 
) [inline]

Insert data at a specified position in the array.

Definition at line 105 of file vtkIdTypeArray.h.

vtkIdType vtkIdTypeArray::InsertNextValue ( vtkIdType  f  )  [inline]

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

Definition at line 112 of file vtkIdTypeArray.h.

vtkIdType* vtkIdTypeArray::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 vtkIdTypeArray.h.

void vtkIdTypeArray::GetValueRange ( vtkIdType  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 vtkIdTypeArray.h.

vtkIdType* vtkIdTypeArray::GetValueRange (  )  [inline]

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

Definition at line 130 of file vtkIdTypeArray.h.

void vtkIdTypeArray::GetValueRange ( vtkIdType  range[2]  )  [inline]

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

Definition at line 133 of file vtkIdTypeArray.h.

static vtkIdType vtkIdTypeArray::GetDataTypeValueMin (  )  [inline, static]

Get the minimum data value in its native type.

Definition at line 139 of file vtkIdTypeArray.h.

static vtkIdType vtkIdTypeArray::GetDataTypeValueMax (  )  [inline, static]

Get the maximum data value in its native type.

Definition at line 142 of file vtkIdTypeArray.h.

vtkIdType* vtkIdTypeArray::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 vtkIdTypeArray.h.

vtkIdType* vtkIdTypeArray::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 vtkIdTypeArray.h.

void vtkIdTypeArray::SetArray ( vtkIdType 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 vtkIdTypeArray.h.

void vtkIdTypeArray::SetArray ( vtkIdType 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 vtkIdTypeArray.h.


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

Generated on Wed Aug 24 11:40:07 2011 for VTK by  doxygen 1.5.6