VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkUnsignedShortArray Class Reference

dynamic, self-adjusting array of unsigned short More...

#include <vtkUnsignedShortArray.h>

Inheritance diagram for vtkUnsignedShortArray:
Inheritance graph
[legend]
Collaboration diagram for vtkUnsignedShortArray:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkDataArrayTemplate
< unsigned short > 
Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkUnsignedShortArrayNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
int GetDataType ()
void GetTupleValue (vtkIdType i, unsigned short *tuple)
void SetTupleValue (vtkIdType i, const unsigned short *tuple)
void InsertTupleValue (vtkIdType i, const unsigned short *tuple)
vtkIdType InsertNextTupleValue (const unsigned short *tuple)
unsigned short GetValue (vtkIdType id)
void SetValue (vtkIdType id, unsigned short value)
void SetNumberOfValues (vtkIdType number)
void InsertValue (vtkIdType id, unsigned short f)
vtkIdType InsertNextValue (unsigned short f)
unsigned short * GetValueRange (int comp)
void GetValueRange (unsigned short range[2], int comp)
unsigned short * GetValueRange ()
void GetValueRange (unsigned short range[2])
unsigned short * WritePointer (vtkIdType id, vtkIdType number)
unsigned short * GetPointer (vtkIdType id)
void SetArray (unsigned short *array, vtkIdType size, int save)
void SetArray (unsigned short *array, vtkIdType size, int save, int deleteMethod)

Static Public Member Functions

static vtkUnsignedShortArrayNew ()
static int IsTypeOf (const char *type)
static vtkUnsignedShortArraySafeDownCast (vtkObjectBase *o)
static unsigned short GetDataTypeValueMin ()
static unsigned short GetDataTypeValueMax ()

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkUnsignedShortArray (vtkIdType numComp=1)
 ~vtkUnsignedShortArray ()

Detailed Description

dynamic, self-adjusting array of unsigned short

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

Tests:
vtkUnsignedShortArray (Tests)

Definition at line 40 of file vtkUnsignedShortArray.h.


Member Typedef Documentation

Reimplemented from vtkDataArray.

Definition at line 45 of file vtkUnsignedShortArray.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkObject.

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

Reimplemented from vtkDataArray.

virtual vtkObjectBase* vtkUnsignedShortArray::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkDataArray.

Reimplemented from vtkDataArray.

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

Get the data type.

Implements vtkAbstractArray.

Definition at line 50 of file vtkUnsignedShortArray.h.

void vtkUnsignedShortArray::GetTupleValue ( vtkIdType  i,
unsigned short *  tuple 
) [inline]

Copy the tuple value into a user-provided array.

Definition at line 56 of file vtkUnsignedShortArray.h.

void vtkUnsignedShortArray::SetTupleValue ( vtkIdType  i,
const unsigned short *  tuple 
) [inline]

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

Definition at line 62 of file vtkUnsignedShortArray.h.

void vtkUnsignedShortArray::InsertTupleValue ( vtkIdType  i,
const unsigned short *  tuple 
) [inline]

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

Definition at line 69 of file vtkUnsignedShortArray.h.

vtkIdType vtkUnsignedShortArray::InsertNextTupleValue ( const unsigned short *  tuple) [inline]

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

Definition at line 76 of file vtkUnsignedShortArray.h.

unsigned short vtkUnsignedShortArray::GetValue ( vtkIdType  id) [inline]

Get the data at a particular index.

Definition at line 82 of file vtkUnsignedShortArray.h.

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

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 97 of file vtkUnsignedShortArray.h.

void vtkUnsignedShortArray::InsertValue ( vtkIdType  id,
unsigned short  f 
) [inline]

Insert data at a specified position in the array.

Definition at line 103 of file vtkUnsignedShortArray.h.

vtkIdType vtkUnsignedShortArray::InsertNextValue ( unsigned short  f) [inline]

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

Definition at line 110 of file vtkUnsignedShortArray.h.

unsigned short* vtkUnsignedShortArray::GetValueRange ( int  comp) [inline]

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

Definition at line 117 of file vtkUnsignedShortArray.h.

void vtkUnsignedShortArray::GetValueRange ( unsigned short  range[2],
int  comp 
) [inline]

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

Definition at line 120 of file vtkUnsignedShortArray.h.

unsigned short* vtkUnsignedShortArray::GetValueRange ( ) [inline]

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

Definition at line 128 of file vtkUnsignedShortArray.h.

void vtkUnsignedShortArray::GetValueRange ( unsigned short  range[2]) [inline]

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

Definition at line 131 of file vtkUnsignedShortArray.h.

static unsigned short vtkUnsignedShortArray::GetDataTypeValueMin ( ) [inline, static]

Get the minimum data value in its native type.

Definition at line 137 of file vtkUnsignedShortArray.h.

static unsigned short vtkUnsignedShortArray::GetDataTypeValueMax ( ) [inline, static]

Get the maximum data value in its native type.

Definition at line 140 of file vtkUnsignedShortArray.h.

unsigned short* vtkUnsignedShortArray::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 146 of file vtkUnsignedShortArray.h.

unsigned short* vtkUnsignedShortArray::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 153 of file vtkUnsignedShortArray.h.

void vtkUnsignedShortArray::SetArray ( unsigned short *  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 164 of file vtkUnsignedShortArray.h.

void vtkUnsignedShortArray::SetArray ( unsigned short *  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 166 of file vtkUnsignedShortArray.h.


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