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

vtkUnsignedShortArray Class Reference

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

#include <vtkUnsignedShortArray.h>

Inheritance diagram for vtkUnsignedShortArray:

Inheritance graph
[legend]
Collaboration diagram for vtkUnsignedShortArray:

Collaboration graph
[legend]
List of all members.

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 ()
vtkDataArrayMakeObject ()
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)
float GetComponent (const int i, const int j)
void SetComponent (const int i, const int j, const float c)
void InsertComponent (const int i, const int j, const float c)
unsigned short GetValue (const int id)
void SetValue (const int id, const unsigned short value)
void SetNumberOfValues (const int number)
void InsertValue (const int id, const unsigned short i)
int InsertNextValue (const unsigned short)
unsigned short * GetPointer (const int id)
void * GetVoidPointer (const int id)
unsigned short * WritePointer (const int id, const int number)
void DeepCopy (vtkDataArray *ia)
void SetArray (unsigned short *array, int size, int save)
void SetVoidArray (void *array, int size, int save)
void Squeeze ()
void DeepCopy (vtkDataArray &ia)

Static Public Methods

vtkUnsignedShortArray * New ()
int IsTypeOf (const char *type)
vtkUnsignedShortArray * SafeDownCast (vtkObject *o)

Protected Methods

 vtkUnsignedShortArray (int numComp=1)
 ~vtkUnsignedShortArray ()
 vtkUnsignedShortArray (const vtkUnsignedShortArray &)
void operator= (const vtkUnsignedShortArray &)
unsigned short * Resize (const int sz)

Protected Attributes

unsigned short * Array
int TupleSize
float * Tuple
int SaveUserArray

Detailed Description

dynamic, self-adjusting unsigned short integer array.

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

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

Examples:
vtkUnsignedShortArray (examples)


Member Function Documentation

int vtkUnsignedShortArray::Allocate const int    sz,
const int    ext = 1000
[virtual]
 

Allocate memory for this array. Delete old storage only if necessary.

Implements vtkDataArray.

void vtkUnsignedShortArray::DeepCopy vtkDataArray   ia [inline]
 

For legacy compatibility. Do not use.

Reimplemented from vtkDataArray.

void vtkUnsignedShortArray::DeepCopy vtkDataArray   ia [virtual]
 

Deep copy of another unsigned short array.

Reimplemented from vtkDataArray.

virtual const char* vtkUnsignedShortArray::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.

float vtkUnsignedShortArray::GetComponent const int    i,
const int    j
[virtual]
 

Return the data component at the ith tuple and jth component location. Note that i is less than NumberOfTuples and j is less than NumberOfComponents.

Reimplemented from vtkDataArray.

int vtkUnsignedShortArray::GetDataType   [inline, virtual]
 

Get the data type.

Implements vtkDataArray.

unsigned short* vtkUnsignedShortArray::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.

void vtkUnsignedShortArray::GetTuple const int    i,
float *    tuple
[virtual]
 

Copy the tuple value into a user-provided array.

Implements vtkDataArray.

float* vtkUnsignedShortArray::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).

Implements vtkDataArray.

unsigned short vtkUnsignedShortArray::GetValue const int    id [inline]
 

Get the data at a particular index.

void* vtkUnsignedShortArray::GetVoidPointer const int    id [inline, virtual]
 

Return a void pointer. For image pipeline interface and other special pointer manipulation.

Implements vtkDataArray.

void vtkUnsignedShortArray::Initialize   [virtual]
 

Release storage and reset array to initial state.

Implements vtkDataArray.

void vtkUnsignedShortArray::InsertComponent const int    i,
const int    j,
const float    c
[virtual]
 

Insert the data component at ith tuple and jth component location. Note that memory allocation is performed as necessary to hold the data.

Reimplemented from vtkDataArray.

int vtkUnsignedShortArray::InsertNextTuple const float *    tuple [virtual]
 

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

Implements vtkDataArray.

int vtkUnsignedShortArray::InsertNextValue const unsigned    short [inline]
 

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

void vtkUnsignedShortArray::InsertTuple const int    i,
const float *    tuple
[virtual]
 

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

Implements vtkDataArray.

void vtkUnsignedShortArray::InsertValue const int    id,
const unsigned short    i
[inline]
 

Insert data at a specified position in the array.

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

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

Reimplemented from vtkDataArray.

vtkDataArray* vtkUnsignedShortArray::MakeObject   [virtual]
 

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

Implements vtkDataArray.

vtkUnsignedShortArray* vtkUnsignedShortArray::New   [static]
 

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

Reimplemented from vtkObject.

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.

vtkUnsignedShortArray* vtkUnsignedShortArray::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 vtkUnsignedShortArray::SetArray unsigned short *    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 vtkUnsignedShortArray::SetComponent const int    i,
const int    j,
const float    c
[virtual]
 

Set the data component at the ith tuple and jth component location. Note that i is less than NumberOfTuples and j is less than NumberOfComponents. Make sure enough memory has been allocated (use SetNumberOfTuples() and SetNumberOfComponents()).

Reimplemented from vtkDataArray.

void vtkUnsignedShortArray::SetNumberOfTuples const int    number [virtual]
 

Set the number of n-tuples in the array.

Implements vtkDataArray.

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

void vtkUnsignedShortArray::SetTuple const int    i,
const float *    tuple
[virtual]
 

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

Implements vtkDataArray.

void vtkUnsignedShortArray::SetValue const int    id,
const 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.

void vtkUnsignedShortArray::Squeeze   [inline, virtual]
 

Resize object to just fit data requirement. Reclaims extra memory.

Implements vtkDataArray.

unsigned short * vtkUnsignedShortArray::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.


The documentation for this class was generated from the following file:
Generated on Tue Mar 19 13:34:11 2002 for VTK by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002