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

vtkFloatArray Class Reference

dynamic, self-adjusting floating point array. More...

#include <vtkFloatArray.h>

Inheritance diagram for vtkFloatArray:

[legend]Collaboration diagram for vtkFloatArray:

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 ()
vtkDataArray *	MakeObject ()
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)
void	Squeeze ()
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)
float	GetValue (const int id)
void	SetValue (const int id, const float value)
void	SetNumberOfValues (const int number)
void	InsertValue (const int id, const float f)
int	InsertNextValue (const float f)
float *	WritePointer (const int id, const int number)
void *	GetVoidPointer (const int id)
float *	GetPointer (const int id)
void	DeepCopy (vtkDataArray *fa)
void	SetArray (float *array, int size, int save)
void	SetVoidArray (void *array, int size, int save)
void	DeepCopy (vtkDataArray &fa)
Static Public Methods
vtkFloatArray *	New ()
int	IsTypeOf (const char *type)
vtkFloatArray *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkFloatArray (int numComp=1)
	~vtkFloatArray ()
	vtkFloatArray (const vtkFloatArray &)
void	operator= (const vtkFloatArray &)
float *	Resize (const int sz)
Protected Attributes
float *	Array
int	SaveUserArray

Detailed Description

dynamic, self-adjusting floating point array.

Date:: 2000/12/10 20:08:09

Revision:: 1.56

vtkFloatArray is an array of floating point numbers. It provides methods for insertion and retrieval of floating point values, and will automatically resize itself to hold new data.

Examples:: vtkFloatArray (examples)

Definition at line 59 of file vtkFloatArray.h.

Constructor & Destructor Documentation

vtkFloatArray::vtkFloatArray ( int numComp = 1 ) [protected]

vtkFloatArray::~vtkFloatArray ( ) [protected]

vtkFloatArray::vtkFloatArray ( const vtkFloatArray & ) [inline, protected]

Definition at line 178 of file vtkFloatArray.h.

Member Function Documentation

vtkFloatArray* vtkFloatArray::New ( ) [static]

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

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

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

virtual int vtkFloatArray::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.

vtkFloatArray* vtkFloatArray::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 vtkFloatArray::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 vtkFloatArray::Allocate ( const int sz,

const int ext = 1000

) [virtual]

Allocate memory for this array. Delete old storage only if necessary.
Reimplemented from vtkDataArray.
Referenced by SetNumberOfValues().

void vtkFloatArray::Initialize ( ) [virtual]

Release storage and reset array to initial state.
Reimplemented from vtkDataArray.

vtkDataArray* vtkFloatArray::MakeObject ( ) [virtual]

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

int vtkFloatArray::GetDataType ( ) [inline, virtual]

Get the data type.
Reimplemented from vtkDataArray.
Definition at line 76 of file vtkFloatArray.h.

void vtkFloatArray::SetNumberOfTuples ( const int number ) [virtual]

Set the number of n-tuples in the array.
Reimplemented from vtkDataArray.

float* vtkFloatArray::GetTuple ( const int i ) [virtual]

Get a pointer to a tuple at the ith location.
Reimplemented from vtkDataArray.

void vtkFloatArray::GetTuple ( const int i,

float * tuple

) [virtual]

Copy the tuple value into a user-provided array.
Reimplemented from vtkDataArray.

void vtkFloatArray::GetTuple ( const int i,

double * tuple

) [virtual]

Reimplemented from vtkDataArray.

void vtkFloatArray::SetTuple ( const int i,

const float * tuple

) [virtual]

Set the tuple value at the ith location in the array.
Reimplemented from vtkDataArray.

void vtkFloatArray::SetTuple ( const int i,

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

void vtkFloatArray::InsertTuple ( const int i,

const float * tuple

) [virtual]

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

void vtkFloatArray::InsertTuple ( const int i,

const double * tuple

) [virtual]

Reimplemented from vtkDataArray.

int vtkFloatArray::InsertNextTuple ( const float * tuple ) [virtual]

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

int vtkFloatArray::InsertNextTuple ( const double * tuple ) [virtual]

Reimplemented from vtkDataArray.

void vtkFloatArray::Squeeze ( ) [inline, virtual]

Resize object to just fit data requirement. Reclaims extra memory.
Reimplemented from vtkDataArray.
Definition at line 104 of file vtkFloatArray.h.

float vtkFloatArray::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.

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

float vtkFloatArray::GetValue ( const int id ) [inline]

Get the data at a particular index.
Definition at line 123 of file vtkFloatArray.h.

void vtkFloatArray::SetValue ( const int id,

const float 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 128 of file vtkFloatArray.h.

void vtkFloatArray::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.
Definition at line 187 of file vtkFloatArray.h.

void vtkFloatArray::InsertValue ( const int id,

const float f

) [inline]

Insert data at a specified position in the array.
Definition at line 208 of file vtkFloatArray.h.
Referenced by InsertNextValue().

int vtkFloatArray::InsertNextValue ( const float f ) [inline]

Insert data at the end of the array. Return its location in the array.
Definition at line 221 of file vtkFloatArray.h.

float * vtkFloatArray::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.
Definition at line 194 of file vtkFloatArray.h.

void* vtkFloatArray::GetVoidPointer ( const int id ) [inline, virtual]

Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.
Reimplemented from vtkDataArray.
Definition at line 150 of file vtkFloatArray.h.

float* vtkFloatArray::GetPointer ( const int id ) [inline]

Definition at line 152 of file vtkFloatArray.h.

void vtkFloatArray::DeepCopy ( vtkDataArray * fa ) [virtual]

Deep copy of another float array.
Reimplemented from vtkDataArray.

void vtkFloatArray::SetArray ( float * 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 vtkFloatArray::SetVoidArray ( void * array,

int size,

int save

) [inline]

Definition at line 165 of file vtkFloatArray.h.

void vtkFloatArray::DeepCopy ( vtkDataArray & fa ) [inline]

For legacy compatibility. Do not use.
Reimplemented from vtkDataArray.
Definition at line 170 of file vtkFloatArray.h.

void vtkFloatArray::operator= ( const vtkFloatArray & ) [inline, protected]

Definition at line 179 of file vtkFloatArray.h.

float* vtkFloatArray::Resize ( const int sz ) [protected]

Referenced by InsertValue(), and WritePointer().

Member Data Documentation

float* vtkFloatArray::Array [protected]

Definition at line 181 of file vtkFloatArray.h.

int vtkFloatArray::SaveUserArray [protected]

Definition at line 184 of file vtkFloatArray.h.

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

common/vtkFloatArray.h

Generated on Wed Nov 21 12:47:57 2001 for VTK by

vtkFloatArray Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation