Abstract superclass for all arrays. More...

#include <vtkAbstractArray.h>

Inheritance diagram for vtkAbstractArray:

Collaboration diagram for vtkAbstractArray:

Public Types
enum	{ MAX_DISCRETE_VALUES = 32 }

enum	{ AbstractArray = 0, DataArray, TypedDataArray, DataArrayTemplate, MappedDataArray }

typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAbstractArray *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual int	Allocate (vtkIdType sz, vtkIdType ext=1000)=0

virtual void	Initialize ()=0

virtual int	GetDataType ()=0

virtual int	GetElementComponentSize ()=0

void	SetComponentName (vtkIdType component, const char *name)

const char *	GetComponentName (vtkIdType component)

bool	HasAComponentName ()

int	CopyComponentNames (vtkAbstractArray *da)

virtual void	SetNumberOfTuples (vtkIdType number)=0

virtual void	SetTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source)=0

virtual void	InsertTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source)=0

virtual vtkIdType	InsertNextTuple (vtkIdType j, vtkAbstractArray *source)=0

virtual void	GetTuples (vtkIdList ptIds, vtkAbstractArray output)

virtual void	GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output)

virtual bool	HasStandardMemoryLayout ()

virtual void *	GetVoidPointer (vtkIdType id)=0

virtual void	DeepCopy (vtkAbstractArray *da)

virtual void	Squeeze ()=0

virtual int	Resize (vtkIdType numTuples)=0

virtual void	ExportToVoidPointer (void *vtkNotUsed(out_ptr))

virtual unsigned long	GetActualMemorySize ()=0

virtual int	IsNumeric ()=0

virtual vtkArrayIterator *	NewIterator ()=0

virtual vtkVariant	GetVariantValue (vtkIdType idx)

virtual void	InsertVariantValue (vtkIdType idx, vtkVariant value)

virtual void	SetVariantValue (vtkIdType idx, vtkVariant value)=0

virtual void	DataChanged ()=0

virtual void	ClearLookup ()=0

vtkInformation *	GetInformation ()


virtual void	SetNumberOfComponents (int)

int	GetNumberOfComponents ()


vtkIdType	GetNumberOfTuples ()


virtual void	InsertTuples (vtkIdList dstIds, vtkIdList srcIds, vtkAbstractArray *source)=0


virtual void	InsertTuples (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source)=0


virtual void	InterpolateTuple (vtkIdType i, vtkIdList ptIndices, vtkAbstractArray source, double *weights)=0


virtual void	InterpolateTuple (vtkIdType i, vtkIdType id1, vtkAbstractArray source1, vtkIdType id2, vtkAbstractArray source2, double t)=0


void	Reset ()


vtkIdType	GetSize ()


vtkIdType	GetMaxId ()


virtual void	SetVoidArray (void *vtkNotUsed(array), vtkIdType vtkNotUsed(size), int vtkNotUsed(save))=0


virtual void	SetName (const char *)

virtual char *	GetName ()


virtual const char *	GetDataTypeAsString (void)


virtual vtkIdType	GetDataSize ()


virtual vtkIdType	LookupValue (vtkVariant value)=0

virtual void	LookupValue (vtkVariant value, vtkIdList *ids)=0


virtual void	GetProminentComponentValues (int comp, vtkVariantArray *values, double uncertainty=1.e-6, double minimumProminence=1.e-3)


bool	HasInformation ()


virtual int	CopyInformation (vtkInformation *infoFrom, int deep=1)


virtual unsigned int	GetMaxDiscreteValues ()

virtual void	SetMaxDiscreteValues (unsigned int)


virtual int	GetArrayType ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkAbstractArray *	SafeDownCast (vtkObjectBase *o)

static vtkAbstractArray *	CreateArray (int dataType)

static vtkInformationIntegerKey *	GUI_HIDE ()

static vtkInformationInformationVectorKey *	PER_COMPONENT ()

static vtkInformationVariantVectorKey *	DISCRETE_VALUES ()

static vtkInformationDoubleVectorKey *	DISCRETE_VALUE_SAMPLE_PARAMETERS ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractArray ()

	~vtkAbstractArray ()

virtual void	SetInformation (vtkInformation *)

virtual void	UpdateDiscreteValueSet (double uncertainty, double minProminence)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkIdType	Size

vtkIdType	MaxId

int	NumberOfComponents

unsigned int	MaxDiscreteValues

char *	Name

bool	RebuildArray

vtkInformation *	Information

vtkInternalComponentNames *	ComponentNames

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkDataArrayTemplateHelper

static int	GetDataTypeSize (int type)

virtual int	GetDataTypeSize ()=0

Detailed Description

Abstract superclass for all arrays.

vtkAbstractArray is an abstract superclass for data array objects. This class defines an API that all subclasses must support. The data type must be assignable and copy-constructible, but no other assumptions about its type are made. Most of the subclasses of this array deal with numeric data either as scalars or tuples of scalars. A program can use the IsNumeric() method to check whether an instance of vtkAbstractArray contains numbers. It is also possible to test for this by attempting to SafeDownCast an array to an instance of vtkDataArray, although this assumes that all numeric arrays will always be descended from vtkDataArray.

Every array has a character-string name. The naming of the array occurs automatically when it is instantiated, but you are free to change this name using the SetName() method. (The array name is used for data manipulation.)

See also: vtkDataArray vtkStringArray vtkCellArray

Tests:: vtkAbstractArray (Tests)

Definition at line 64 of file vtkAbstractArray.h.

Member Typedef Documentation

typedef vtkObject vtkAbstractArray::Superclass

Definition at line 69 of file vtkAbstractArray.h.

Member Enumeration Documentation

anonymous enum

Enumerator
MAX_DISCRETE_VALUES

Definition at line 447 of file vtkAbstractArray.h.

anonymous enum

Enumerator
AbstractArray
DataArray
TypedDataArray
DataArrayTemplate
MappedDataArray

Definition at line 458 of file vtkAbstractArray.h.

Constructor & Destructor Documentation

vtkAbstractArray::vtkAbstractArray ( )

protected

vtkAbstractArray::~vtkAbstractArray ( )

protected

Member Function Documentation

static int vtkAbstractArray::IsTypeOf ( const char * type )

static

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

Reimplemented in vtkTypeTemplate< vtkDataArrayTemplate< Scalar >, vtkTypedDataArray< Scalar > >, vtkTypeTemplate< vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkMappedDataArray< Scalar > >, vtkTypeTemplate< vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkMappedDataArray< Scalar > >, vtkTypeTemplate< vtkDataArrayTemplate< T >, vtkTypedDataArray< T > >, vtkTypeTemplate< vtkTypedDataArray< T >, vtkDataArray >, vtkTypeTemplate< vtkPeriodicDataArray< Scalar >, vtkMappedDataArray< Scalar > >, vtkTypeTemplate< vtkMappedDataArray< Scalar >, vtkTypedDataArray< Scalar > >, vtkTypeTemplate< vtkTypedDataArray< Scalar >, vtkDataArray >, vtkDataArray, vtkIntArray, vtkVariantArray, vtkUnsignedLongArray, vtkLongArray, vtkShortArray, vtkUnsignedIntArray, vtkUnsignedShortArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkUnsigned__Int64Array, vtkUnsignedCharArray, vtk__Int64Array, vtkLongLongArray, vtkUnsignedLongLongArray, vtkCharArray, vtkSignedCharArray, vtkStringArray, vtkUnicodeStringArray, vtkTypeInt64Array, vtkTypeUInt64Array, vtkBitArray, vtkTypeFloat32Array, vtkTypeFloat64Array, vtkTypeInt16Array, vtkTypeInt32Array, vtkTypeInt8Array, vtkTypeUInt16Array, vtkTypeUInt32Array, and vtkTypeUInt8Array.

static vtkAbstractArray* vtkAbstractArray::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkAbstractArray::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkTypeTemplate< vtkDataArrayTemplate< Scalar >, vtkTypedDataArray< Scalar > >, vtkTypeTemplate< vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkMappedDataArray< Scalar > >, vtkTypeTemplate< vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkMappedDataArray< Scalar > >, vtkTypeTemplate< vtkDataArrayTemplate< T >, vtkTypedDataArray< T > >, vtkTypeTemplate< vtkTypedDataArray< T >, vtkDataArray >, vtkTypeTemplate< vtkPeriodicDataArray< Scalar >, vtkMappedDataArray< Scalar > >, vtkTypeTemplate< vtkMappedDataArray< Scalar >, vtkTypedDataArray< Scalar > >, vtkTypeTemplate< vtkTypedDataArray< Scalar >, vtkDataArray >, vtkDataArray, vtkIntArray, vtkVariantArray, vtkUnsignedLongArray, vtkLongArray, vtkShortArray, vtkUnsignedIntArray, vtkUnsignedShortArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkUnsigned__Int64Array, vtkUnsignedCharArray, vtk__Int64Array, vtkLongLongArray, vtkUnsignedLongLongArray, vtkCharArray, vtkSignedCharArray, vtkStringArray, vtkUnicodeStringArray, vtkTypeInt64Array, vtkTypeUInt64Array, vtkBitArray, vtkTypeFloat32Array, vtkTypeFloat64Array, vtkTypeInt16Array, vtkTypeInt32Array, vtkTypeInt8Array, vtkTypeUInt16Array, vtkTypeUInt32Array, and vtkTypeUInt8Array.

vtkAbstractArray* vtkAbstractArray::NewInstance ( ) const

void vtkAbstractArray::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 vtkObject.

Reimplemented in vtkDataArray, vtkIntArray, vtkMappedDataArray< Scalar >, vtkVariantArray, vtkUnsignedLongArray, vtkLongArray, vtkShortArray, vtkUnsignedIntArray, vtkUnsignedShortArray, vtkDoubleArray, vtkFloatArray, vtkIdTypeArray, vtkUnsigned__Int64Array, vtkUnsignedCharArray, vtkLongLongArray, vtkUnsignedLongLongArray, vtkCharArray, vtkSignedCharArray, vtkStringArray, vtkAngularPeriodicDataArray< Scalar >, vtkUnicodeStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkTypeInt64Array, vtkTypeUInt64Array, vtkBitArray, vtkPeriodicDataArray< Scalar >, vtkTypeFloat32Array, vtkTypeFloat64Array, vtkTypeInt16Array, vtkTypeInt32Array, vtkTypeInt8Array, vtkTypeUInt16Array, vtkTypeUInt32Array, and vtkTypeUInt8Array.

virtual int vtkAbstractArray::Allocate	(	vtkIdType	sz,
		vtkIdType	ext = `1000`
	)

pure virtual

Allocate memory for this array. Delete old storage only if necessary. Note that ext is no longer used.

Implemented in vtkStringArray, vtkPeriodicDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkVariantArray, vtkUnicodeStringArray, and vtkBitArray.

virtual void vtkAbstractArray::Initialize ( )

pure virtual

Release storage and reset array to initial state.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkVariantArray, vtkStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkUnicodeStringArray, vtkBitArray, and vtkPeriodicDataArray< Scalar >.

virtual int vtkAbstractArray::GetDataType ( )

pure virtual

Return the underlying data type. An integer indicating data type is returned as specified in vtkSetGet.h.

Implemented in vtkTypedDataArray< Scalar >, vtkTypedDataArray< T >, vtkVariantArray, vtkIdTypeArray, vtkStringArray, vtkUnicodeStringArray, and vtkBitArray.

virtual int vtkAbstractArray::GetDataTypeSize ( )

pure virtual

Return the size of the underlying data type. For a bit, 0 is returned. For string 0 is returned. Arrays with variable length components return 0.

Implemented in vtkTypedDataArray< Scalar >, vtkTypedDataArray< T >, vtkVariantArray, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkUnicodeStringArray, and vtkBitArray.

static int vtkAbstractArray::GetDataTypeSize ( int type )

static

Return the size of the underlying data type. For a bit, 0 is returned. For string 0 is returned. Arrays with variable length components return 0.

virtual int vtkAbstractArray::GetElementComponentSize ( )

pure virtual

Return the size, in bytes, of the lowest-level element of an array. For vtkDataArray and subclasses this is the size of the data type. For vtkStringArray, this is sizeof(vtkStdString::value_type), which winds up being sizeof(char).

Implemented in vtkStringArray, vtkVariantArray, vtkDataArray, and vtkUnicodeStringArray.

virtual void vtkAbstractArray::SetNumberOfComponents ( int )

virtual

Set/Get the dimension (n) of the components. Must be >= 1. Make sure that this is set before allocation.

int vtkAbstractArray::GetNumberOfComponents ( )

inline

Set/Get the dimension (n) of the components. Must be >= 1. Make sure that this is set before allocation.

Definition at line 101 of file vtkAbstractArray.h.

void vtkAbstractArray::SetComponentName	(	vtkIdType	component,
		const char *	name
	)

Set the name for a component. Must be >= 1.

const char* vtkAbstractArray::GetComponentName ( vtkIdType component )

Get the component name for a given component. Note: will return the actual string that is stored

bool vtkAbstractArray::HasAComponentName ( )

Returns if any component has had a name assigned

int vtkAbstractArray::CopyComponentNames ( vtkAbstractArray * da )

Copies the component names from the inputed array to the current array make sure that the current array has the same number of components as the input array

virtual void vtkAbstractArray::SetNumberOfTuples ( vtkIdType number )

pure virtual

Set the number of tuples (a component group) in the array. Note that this may allocate space depending on the number of components. Also note that if allocation is performed no copy is performed so existing data will be lost (if data conservation is sought, one may use the Resize method instead).

Implemented in vtkStringArray, vtkPeriodicDataArray< Scalar >, vtkVariantArray, vtkDataArrayTemplate< T >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkDataArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkBitArray, and vtkUnicodeStringArray.

vtkIdType vtkAbstractArray::GetNumberOfTuples ( )

inline

Get the number of tuples (a component group) in the array.

Definition at line 128 of file vtkAbstractArray.h.

virtual void vtkAbstractArray::SetTuple	(	vtkIdType	i,
		vtkIdType	j,
		vtkAbstractArray *	source
	)

pure virtual

Set the tuple at the ith location using the jth tuple in the source array. This method assumes that the two arrays have the same type and structure. Note that range checking and memory allocation is not performed; use in conjunction with SetNumberOfTuples() to allocate space.

Implemented in vtkPeriodicDataArray< Scalar >, vtkVariantArray, vtkDataArray, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkBitArray, and vtkUnicodeStringArray.

virtual void vtkAbstractArray::InsertTuple	(	vtkIdType	i,
		vtkIdType	j,
		vtkAbstractArray *	source
	)

pure virtual

Insert the jth tuple in the source array, at ith location in this array. Note that memory allocation is performed as necessary to hold the data.

Implemented in vtkPeriodicDataArray< Scalar >, vtkVariantArray, vtkDataArray, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkBitArray, and vtkUnicodeStringArray.

virtual void vtkAbstractArray::InsertTuples	(	vtkIdList *	dstIds,
		vtkIdList *	srcIds,
		vtkAbstractArray *	source
	)

pure virtual

Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in this array. Note that memory allocation is performed as necessary to hold the data.

Implemented in vtkPeriodicDataArray< Scalar >, vtkVariantArray, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkBitArray, and vtkUnicodeStringArray.

virtual void vtkAbstractArray::InsertTuples	(	vtkIdType	dstStart,
		vtkIdType	n,
		vtkIdType	srcStart,
		vtkAbstractArray *	source
	)

pure virtual

Copy n consecutive tuples starting at srcStart from the source array to this array, starting at the dstStart location. Note that memory allocation is performed as necessary to hold the data.

Implemented in vtkPeriodicDataArray< Scalar >, vtkVariantArray, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkBitArray, and vtkUnicodeStringArray.

virtual vtkIdType vtkAbstractArray::InsertNextTuple	(	vtkIdType	j,
		vtkAbstractArray *	source
	)

pure virtual

Insert the jth tuple in the source array, at the end in this array. Note that memory allocation is performed as necessary to hold the data. Returns the location at which the data was inserted.

Implemented in vtkPeriodicDataArray< Scalar >, vtkVariantArray, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkDataArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkBitArray, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkUnicodeStringArray.

virtual void vtkAbstractArray::GetTuples	(	vtkIdList *	ptIds,
		vtkAbstractArray *	output
	)

virtual

Given a list of point ids, return an array of tuples. You must insure that the output array has been previously allocated with enough space to hold the data.

Reimplemented in vtkStringArray, vtkDataArray, vtkMappedDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkPeriodicDataArray< Scalar >.

virtual void vtkAbstractArray::GetTuples	(	vtkIdType	p1,
		vtkIdType	p2,
		vtkAbstractArray *	output
	)

virtual

Get the tuples for the range of points ids specified (i.e., p1->p2 inclusive). You must insure that the output array has been previously allocated with enough space to hold the data.

Reimplemented in vtkStringArray, vtkDataArray, vtkMappedDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkPeriodicDataArray< Scalar >.

virtual bool vtkAbstractArray::HasStandardMemoryLayout ( )

virtual

Returns true if this array uses the standard memory layout defined in the VTK user guide, e.g. a contiguous array: {t1c1, t1c2, t1c3, ... t1cM, t2c1, ... tNcM} where t1c2 is the second component of the first tuple. If the array does not have the standard memory layout GetVoidPointer should not be used, as a deep copy of the data must be made. Instead, use a vtkTypedDataArrayIterator to get pointer-like semantics that can safely access the data values. Subclasses that return false here must derive from vtkMappedDataArray to ensure that they will work safely with the rest of the pipeline.

Reimplemented in vtkMappedDataArray< Scalar >.

virtual void* vtkAbstractArray::GetVoidPointer ( vtkIdType id )

pure virtual

Return a void pointer. For image pipeline interface and other special pointer manipulation. If the data is simply being iterated over, consider using vtkDataArrayIteratorMacro for safety and efficiency, rather than using this member directly.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkBitArray, vtkVariantArray, vtkMappedDataArray< Scalar >, and vtkUnicodeStringArray.

virtual void vtkAbstractArray::DeepCopy ( vtkAbstractArray * da )

virtual

Deep copy of data. Implementation left to subclasses, which should support as many type conversions as possible given the data type. Subclasses should call vtkAbstractArray::DeepCopy() so that the information object (if one exists) is copied from da.

Reimplemented in vtkDataArray, vtkStringArray, vtkBitArray, vtkPeriodicDataArray< Scalar >, vtkVariantArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkUnicodeStringArray, and vtkMappedDataArray< Scalar >.

virtual void vtkAbstractArray::InterpolateTuple	(	vtkIdType	i,
		vtkIdList *	ptIndices,
		vtkAbstractArray *	source,
		double *	weights
	)

pure virtual

Set the ith tuple in this array as the interpolated tuple value, given the ptIndices in the source array and associated interpolation weights. This method assumes that the two arrays are of the same type and strcuture.

Implemented in vtkPeriodicDataArray< Scalar >, vtkVariantArray, vtkDataArray, vtkStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkMappedDataArray< Scalar >, and vtkUnicodeStringArray.

virtual void vtkAbstractArray::InterpolateTuple	(	vtkIdType	i,
		vtkIdType	id1,
		vtkAbstractArray *	source1,
		vtkIdType	id2,
		vtkAbstractArray *	source2,
		double	t
	)

pure virtual

Insert the ith tuple in this array as interpolated from the two values, p1 and p2, and an interpolation factor, t. The interpolation factor ranges from (0,1), with t=0 located at p1. This method assumes that the three arrays are of the same type. p1 is value at index id1 in source1, while, p2 is value at index id2 in source2.

Implemented in vtkPeriodicDataArray< Scalar >, vtkVariantArray, vtkDataArray, vtkStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkMappedDataArray< Scalar >, and vtkUnicodeStringArray.

virtual void vtkAbstractArray::Squeeze ( )

pure virtual

Free any unnecessary memory. Description: Resize object to just fit data requirement. Reclaims extra memory.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkVariantArray, vtkBitArray, vtkStringArray, vtkUnicodeStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkPeriodicDataArray< Scalar >.

virtual int vtkAbstractArray::Resize ( vtkIdType numTuples )

pure virtual

Resize the array while conserving the data. Returns 1 if resizing succeeded and 0 otherwise.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkVariantArray, vtkBitArray, vtkPeriodicDataArray< Scalar >, vtkStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkUnicodeStringArray.

void vtkAbstractArray::Reset ( )

inline

Reset to an empty state, without freeing any memory.

Definition at line 228 of file vtkAbstractArray.h.

vtkIdType vtkAbstractArray::GetSize ( )

inline

Return the size of the data.

Definition at line 237 of file vtkAbstractArray.h.

vtkIdType vtkAbstractArray::GetMaxId ( )

inline

What is the maximum id currently in the array.

Definition at line 243 of file vtkAbstractArray.h.

virtual void vtkAbstractArray::SetVoidArray	(	void *	vtkNotUsedarray,
		vtkIdType	vtkNotUsedsize,
		int	vtkNotUsedsave
	)

pure virtual

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 supplied array.

virtual void vtkAbstractArray::ExportToVoidPointer ( void * vtkNotUsedout_ptr )

inlinevirtual

This method copies the array data to the void pointer specified by the user. It is up to the user to allocate enough memory for the void pointer.

Definition at line 262 of file vtkAbstractArray.h.

virtual unsigned long vtkAbstractArray::GetActualMemorySize ( )

pure virtual

Return the memory in kibibytes (1024 bytes) consumed by this data array. Used to support streaming and reading/writing data. The value returned is guaranteed to be greater than or equal to the memory required to actually represent the data represented by this object. The information returned is valid only after the pipeline has been updated.

Implemented in vtkDataArray, vtkStringArray, vtkVariantArray, vtkPeriodicDataArray< Scalar >, and vtkUnicodeStringArray.

virtual void vtkAbstractArray::SetName ( const char * )

virtual

Set/get array's name

virtual char* vtkAbstractArray::GetName ( )

virtual

Set/get array's name

virtual const char* vtkAbstractArray::GetDataTypeAsString ( void )

inlinevirtual

Get the name of a data type as a string.

Definition at line 280 of file vtkAbstractArray.h.

static vtkAbstractArray* vtkAbstractArray::CreateArray ( int dataType )

static

Creates an array for dataType where dataType is one of VTK_BIT, VTK_CHAR, VTK_UNSIGNED_CHAR, VTK_SHORT, VTK_UNSIGNED_SHORT, VTK_INT, VTK_UNSIGNED_INT, VTK_LONG, VTK_UNSIGNED_LONG, VTK_DOUBLE, VTK_DOUBLE, VTK_ID_TYPE, VTK_STRING. Note that the data array returned has to be deleted by the user.

virtual int vtkAbstractArray::IsNumeric ( )

pure virtual

This method is here to make backward compatibility easier. It must return true if and only if an array contains numeric data.

Implemented in vtkVariantArray, vtkUnicodeStringArray, vtkDataArray, and vtkStringArray.

virtual vtkArrayIterator* vtkAbstractArray::NewIterator ( )

pure virtual

Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkBitArray, vtkVariantArray, vtkUnicodeStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, and vtkPeriodicDataArray< Scalar >.

virtual vtkIdType vtkAbstractArray::GetDataSize ( )

inlinevirtual

Returns the size of the data in DataTypeSize units. Thus, the number of bytes for the data can be computed by GetDataSize() * GetDataTypeSize(). Non-contiguous or variable- size arrays need to override this method.

Reimplemented in vtkStringArray.

Definition at line 304 of file vtkAbstractArray.h.

virtual vtkIdType vtkAbstractArray::LookupValue ( vtkVariant value )

pure virtual

Return the indices where a specific value appears.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkVariantArray, vtkBitArray, vtkUnicodeStringArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkPeriodicDataArray< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual void vtkAbstractArray::LookupValue	(	vtkVariant	value,
		vtkIdList *	ids
	)

pure virtual

Return the indices where a specific value appears.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkVariantArray, vtkBitArray, vtkUnicodeStringArray, vtkPeriodicDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual vtkVariant vtkAbstractArray::GetVariantValue ( vtkIdType idx )

virtual

Retrieve value from the array as a variant.

Reimplemented in vtkUnicodeStringArray, vtkPeriodicDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkMappedDataArray< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual void vtkAbstractArray::InsertVariantValue	(	vtkIdType	idx,
		vtkVariant	value
	)

virtual

Insert a value into the array from a variant. This method does bounds checking.

virtual void vtkAbstractArray::SetVariantValue	(	vtkIdType	idx,
		vtkVariant	value
	)

pure virtual

Set a value in the array from a variant. This method does NOT do bounds checking.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkVariantArray, vtkStringArray, vtkPeriodicDataArray< Scalar >, vtkBitArray, vtkCPExodusIIResultsArrayTemplate< Scalar >, vtkCPExodusIINodalCoordinatesTemplate< Scalar >, vtkUnicodeStringArray, and vtkMappedDataArray< Scalar >.

virtual void vtkAbstractArray::DataChanged ( )

pure virtual

Tell the array explicitly that the data has changed. This is only necessary to call when you modify the array contents without using the array's API (i.e. you retrieve a pointer to the data and modify the array contents). You need to call this so that the fast lookup will know to rebuild itself. Otherwise, the lookup functions will give incorrect results.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkVariantArray, vtkBitArray, vtkMappedDataArray< Scalar >, and vtkUnicodeStringArray.

virtual void vtkAbstractArray::ClearLookup ( )

pure virtual

Delete the associated fast lookup data structure on this array, if it exists. The lookup will be rebuilt on the next call to a lookup function.

Implemented in vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkStringArray, vtkVariantArray, vtkBitArray, vtkUnicodeStringArray, vtkPeriodicDataArray< Scalar >, vtkCPExodusIIResultsArrayTemplate< Scalar >, and vtkCPExodusIINodalCoordinatesTemplate< Scalar >.

virtual void vtkAbstractArray::GetProminentComponentValues	(	int	comp,
		vtkVariantArray *	values,
		double	uncertainty = `1.e-6`,
		double	minimumProminence = `1.e-3`
	)

virtual

Populate the given vtkVariantArray with a set of distinct values taken on by the requested component (or, when passed -1, by the tuples as a whole). If the set of prominent values has more than 32 entries, then the array is assumed to be continuous in nature and no values are returned. This method takes 2 parameters: uncertainty and minimumProminence. Note that this set of returned values may not be complete if uncertainty and minimumProminence are both larger than 0.0; in order to perform interactively, a subsample of the array is used to determine the set of values. The first parameter (uncertainty, U) is the maximum acceptable probability that a prominent value will not be detected. Setting this to 0 will cause every value in the array to be examined. The second parameter (minimumProminence, P) specifies the smallest relative frequency (in [0,1]) with which a value in the array may occur and still be considered prominent. Setting this to 0 will force every value in the array to be traversed. Using numbers close to 0 for this parameter quickly causes the number of samples required to obtain the given uncertainty to subsume the entire array, as rare occurrences require frequent sampling to detect. For an array with T tuples and given uncertainty U and mininumum prominence P, we sample N values, with N = f(T; P, U). We want f to be sublinear in T in order to interactively handle large arrays; in practice, we can make f independent of T: $N >= \frac{5}{P}\mathrm{ln}\left(\frac{1}{PU})$ , but note that small values of P are costly to achieve. The default parameters will locate prominent values that occur at least 1 out of every 1000 samples with a confidence of 0.999999 (= 1 - 1e6). Thanks to Seshadri Comandur (Sandia National Laboratories) for the bounds on the number of samples. The first time this is called, the array is examined and unique values are stored in the vtkInformation object associated with the array. The list of unique values will be updated on subsequent calls only if the array's MTime is newer than the associated vtkInformation object or if better sampling (lower uncertainty or minimumProminence) is requested. The DISCRETE_VALUE_SAMPLE_PARAMETERS() information key is used to store the numbers which produced any current set of prominent values. Also, note that every value encountered is reported and counts toward the maximum of 32 distinct values, regardless of the value's frequency. This is required for an efficient implementation. Use the vtkOrderStatistics filter if you wish to threshold the set of distinct values to eliminate "unprominent" (infrequently-occurring) values.

vtkInformation* vtkAbstractArray::GetInformation ( )

Get an information object that can be used to annotate the array. This will always return an instance of vtkInformation, if one is not currently associated with the array it will be created.

bool vtkAbstractArray::HasInformation ( )

inline

Inquire if this array has an instance of vtkInformation already associated with it.

Definition at line 399 of file vtkAbstractArray.h.

virtual int vtkAbstractArray::CopyInformation	(	vtkInformation *	infoFrom,
		int	deep = `1`
	)

virtual

Copy information instance. Arrays use information objects in a variety of ways. It is important to have flexibility in this regard because certain keys should not be coppied, while others must be. NOTE: Subclasses must always call their superclass's CopyInformation method, so that all classes in the hierarchy get a chance to remove keys they do not wish to be coppied. The subclass will not need to explicilty copy the keys as it's handled here.

Reimplemented in vtkDataArray.

static vtkInformationIntegerKey* vtkAbstractArray::GUI_HIDE ( )

static

This key is a hint to end user interface that this array is internal and should not be shown to the end user.

static vtkInformationInformationVectorKey* vtkAbstractArray::PER_COMPONENT ( )

static

This key is used to hold a vector of COMPONENT_VALUES (and, for vtkDataArray subclasses, COMPONENT_RANGE) keys – one for each component of the array. You may add additional per-component key-value pairs to information objects in this vector. However if you do so, you must be sure to either (1) set COMPONENT_VALUES to an invalid variant and set COMPONENT_RANGE to {VTK_DOUBLE_MAX, VTK_DOUBLE_MIN} or (2) call ComputeUniqueValues(component) and ComputeRange(component) before modifying the information object. Otherwise it is possible for modifications to the array to take place without the bounds on the component being updated since the modification time of the vtkInformation object is used to determine when the COMPONENT_RANGE values are out of date.

static vtkInformationVariantVectorKey* vtkAbstractArray::DISCRETE_VALUES ( )

static

A key used to hold discrete values taken on either by the tuples of the array (when present in this->GetInformation()) or individual components (when present in one entry of the PER_COMPONENT() information vector).

static vtkInformationDoubleVectorKey* vtkAbstractArray::DISCRETE_VALUE_SAMPLE_PARAMETERS ( )

static

A key used to hold conditions under which cached discrete values were generated; the value is a 2-vector of doubles. The first entry corresponds to the maximum uncertainty that prominent values exist but have not been detected. The second entry corresponds to the smallest relative frequency a value is allowed to have and still appear on the list.

virtual unsigned int vtkAbstractArray::GetMaxDiscreteValues ( )

virtual

Get/Set the maximum number of prominent values this array may contain before it is considered continuous. Default value is 32.

virtual void vtkAbstractArray::SetMaxDiscreteValues ( unsigned int )

virtual

Get/Set the maximum number of prominent values this array may contain before it is considered continuous. Default value is 32.

virtual int vtkAbstractArray::GetArrayType ( )

inlinevirtual

Method for type-checking in FastDownCast implementations.

Reimplemented in vtkDataArray, vtkDataArrayTemplate< T >, vtkDataArrayTemplate< Scalar >, vtkTypedDataArray< Scalar >, vtkTypedDataArray< T >, and vtkMappedDataArray< Scalar >.

Definition at line 468 of file vtkAbstractArray.h.

virtual void vtkAbstractArray::SetInformation ( vtkInformation * )

protectedvirtual

Set an information object that can be used to annotate the array. Use this with caution as array instances depend on persistence of information keys. See CopyInformation.

virtual void vtkAbstractArray::UpdateDiscreteValueSet	(	double	uncertainty,
		double	minProminence
	)

protectedvirtual

Obtain the set of unique values taken on by each component of the array, as well as by the tuples of the array. The results are stored in the PER_COMPONENT() vtkInformation objects using the DISCRETE_VALUES() key. If the key is present but stores 0 values, the array either has no entries or does not behave as a discrete set. If the key is not present, the array has not been examined for distinct values or has been modified since the last examination.

Friends And Related Function Documentation

friend class vtkDataArrayTemplateHelper

friend

Definition at line 67 of file vtkAbstractArray.h.

Member Data Documentation

vtkIdType vtkAbstractArray::Size

protected

Definition at line 493 of file vtkAbstractArray.h.

vtkIdType vtkAbstractArray::MaxId

protected

Definition at line 494 of file vtkAbstractArray.h.

int vtkAbstractArray::NumberOfComponents

protected

Definition at line 495 of file vtkAbstractArray.h.

unsigned int vtkAbstractArray::MaxDiscreteValues

protected

Definition at line 498 of file vtkAbstractArray.h.

char* vtkAbstractArray::Name

protected

Definition at line 500 of file vtkAbstractArray.h.

bool vtkAbstractArray::RebuildArray

protected

Definition at line 502 of file vtkAbstractArray.h.

vtkInformation* vtkAbstractArray::Information

protected

Definition at line 504 of file vtkAbstractArray.h.

vtkInternalComponentNames* vtkAbstractArray::ComponentNames

protected

Definition at line 507 of file vtkAbstractArray.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Core/vtkAbstractArray.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation