vtkLongArray Class Reference

#include <vtkLongArray.h>

Inheritance diagram for vtkLongArray:

[legend]

Collaboration diagram for vtkLongArray:

[legend]

List of all members.

---

Detailed Description

dynamic, self-adjusting array of long

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

Tests:

vtkLongArray (Tests)

Definition at line 39 of file vtkLongArray.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, long *tuple)
void	SetTupleValue (vtkIdType i, const long *tuple)
void	InsertTupleValue (vtkIdType i, const long *tuple)
vtkIdType	InsertNextTupleValue (const long *tuple)
long	GetValue (vtkIdType id)
void	SetValue (vtkIdType id, long value)
void	SetNumberOfValues (vtkIdType number)
void	InsertValue (vtkIdType id, long f)
vtkIdType	InsertNextValue (long f)
long *	GetValueRange (int comp)
void	GetValueRange (long range[2], int comp)
long *	GetValueRange ()
void	GetValueRange (long range[2])
long *	WritePointer (vtkIdType id, vtkIdType number)
long *	GetPointer (vtkIdType id)
void	SetArray (long *array, vtkIdType size, int save)
void	SetArray (long *array, vtkIdType size, int save, int deleteMethod)
Static Public Member Functions
static vtkLongArray *	New ()
static int	IsTypeOf (const char *type)
static vtkLongArray *	SafeDownCast (vtkObject *o)
static long	GetDataTypeValueMin ()
static long	GetDataTypeValueMax ()
Protected Member Functions
	vtkLongArray (vtkIdType numComp=1)
	~vtkLongArray ()

---

Member Typedef Documentation

typedef vtkDataArray vtkLongArray::Superclass

Reimplemented from vtkDataArray.

Definition at line 44 of file vtkLongArray.h.

---

Constructor & Destructor Documentation

vtkLongArray::vtkLongArray

(

vtkIdType

numComp = 1

)

[protected]

vtkLongArray::~vtkLongArray

(

)

[protected]

---

Member Function Documentation

static vtkLongArray* vtkLongArray::New

(

)

[static]

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

Reimplemented from vtkObject.

virtual const char* vtkLongArray::GetClassName

(

)

[virtual]

Reimplemented from vtkDataArray.

static int vtkLongArray::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 vtkLongArray::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 vtkLongArray* vtkLongArray::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkDataArray.

void vtkLongArray::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 vtkLongArray::GetDataType

(

)

[inline, virtual]

Get the data type.

Implements vtkAbstractArray.

Definition at line 49 of file vtkLongArray.h.

void vtkLongArray::GetTupleValue	(	vtkIdType	i,
		long *	tuple
	)			[inline]

Copy the tuple value into a user-provided array.

Definition at line 55 of file vtkLongArray.h.

void vtkLongArray::SetTupleValue	(	vtkIdType	i,
		const long *	tuple
	)			[inline]

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

Definition at line 61 of file vtkLongArray.h.

void vtkLongArray::InsertTupleValue	(	vtkIdType	i,
		const long *	tuple
	)			[inline]

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

Definition at line 68 of file vtkLongArray.h.

vtkIdType vtkLongArray::InsertNextTupleValue

(

const long *

tuple

)

[inline]

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

Definition at line 75 of file vtkLongArray.h.

long vtkLongArray::GetValue

(

vtkIdType

id

)

[inline]

Get the data at a particular index.

Definition at line 81 of file vtkLongArray.h.

void vtkLongArray::SetValue	(	vtkIdType	id,
		long	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 88 of file vtkLongArray.h.

void vtkLongArray::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 96 of file vtkLongArray.h.

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

Insert data at a specified position in the array.

Definition at line 102 of file vtkLongArray.h.

vtkIdType vtkLongArray::InsertNextValue

(

long

f

)

[inline]

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

Definition at line 109 of file vtkLongArray.h.

long* vtkLongArray::GetValueRange

(

int

comp

)

[inline]

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

Definition at line 116 of file vtkLongArray.h.

void vtkLongArray::GetValueRange	(	long	range[2],
		int	comp
	)			[inline]

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

Definition at line 119 of file vtkLongArray.h.

long* vtkLongArray::GetValueRange

(

)

[inline]

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

Definition at line 127 of file vtkLongArray.h.

void vtkLongArray::GetValueRange

(

long

range[2]

)

[inline]

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

Definition at line 130 of file vtkLongArray.h.

static long vtkLongArray::GetDataTypeValueMin

(

)

[inline, static]

Get the minimum data value in its native type.

Definition at line 136 of file vtkLongArray.h.

static long vtkLongArray::GetDataTypeValueMax

(

)

[inline, static]

Get the maximum data value in its native type.

Definition at line 139 of file vtkLongArray.h.

long* vtkLongArray::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 145 of file vtkLongArray.h.

long* vtkLongArray::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 152 of file vtkLongArray.h.

void vtkLongArray::SetArray	(	long *	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 163 of file vtkLongArray.h.

void vtkLongArray::SetArray	(	long *	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 165 of file vtkLongArray.h.

---

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

• dox/Common/vtkLongArray.h