vtkUnsignedShortArray Class Reference

#include <vtkUnsignedShortArray.h>

Inheritance diagram for vtkUnsignedShortArray:

[legend]Collaboration diagram for vtkUnsignedShortArray:

[legend]List of all members.

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.

Created by:

Law, Charles

CVS contributions (if > 5%):

Law, Charles (21%)
King, Brad (20%)
Schroeder, Will (19%)
Martin, Ken (15%)
Henderson, Amy (5%)
Geveci, Berk (5%)
Miller, Jim (5%)

CVS logs (CVSweb):

.h (/Common/vtkUnsignedShortArray.h)
.cxx (/Common/vtkUnsignedShortArray.cxx)

Tests:: vtkUnsignedShortArray (Tests)

Definition at line 55 of file vtkUnsignedShortArray.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 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 * WritePointer (vtkIdType id, vtkIdType number)

unsigned short * GetPointer (vtkIdType id)

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

Static Public Member Functions

vtkUnsignedShortArray * New ()

int IsTypeOf (const char *type)

vtkUnsignedShortArray * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkUnsignedShortArray (vtkIdType numComp=1)

~vtkUnsignedShortArray ()

Member Typedef Documentation

typedef vtkDataArray vtkUnsignedShortArray::Superclass

Reimplemented from vtkDataArray.
Definition at line 60 of file vtkUnsignedShortArray.h.

Constructor & Destructor Documentation

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

vtkUnsignedShortArray::~vtkUnsignedShortArray ( ) [protected]

Member Function Documentation

vtkUnsignedShortArray* vtkUnsignedShortArray::New ( ) [static]

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

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

Reimplemented from vtkDataArray.

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

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

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 vtkDataArray.
Definition at line 65 of file vtkUnsignedShortArray.h.

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

Get the data at a particular index.
Definition at line 71 of file vtkUnsignedShortArray.h.
References vtkIdType.

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 78 of file vtkUnsignedShortArray.h.
References vtkIdType.

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

void vtkUnsignedShortArray::InsertValue ( vtkIdType id,

unsigned short f

) [inline]

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

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

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

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 107 of file vtkUnsignedShortArray.h.
References vtkIdType.

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 114 of file vtkUnsignedShortArray.h.
References vtkIdType.

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 125 of file vtkUnsignedShortArray.h.
References vtkIdType.

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

dox/Common/vtkUnsignedShortArray.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 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 *	WritePointer (vtkIdType id, vtkIdType number)

unsigned short *	GetPointer (vtkIdType id)

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