vtkStringArray Class Reference

a vtkAbstractArray subclass for strings More...

#include <vtkStringArray.h>

Inheritance diagram for vtkStringArray:

Collaboration diagram for vtkStringArray:

Public Types
typedef vtkAbstractArray	Superclass
Public Types inherited from vtkAbstractArray
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)
vtkStringArray *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
int	IsNumeric ()
void	Initialize ()
int	GetDataTypeSize ()
void	Squeeze ()
int	Resize (vtkIdType numTuples)
virtual void	SetTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source)
virtual void	InsertTuple (vtkIdType i, vtkIdType j, vtkAbstractArray *source)
virtual vtkIdType	InsertNextTuple (vtkIdType j, vtkAbstractArray *source)
virtual void	GetTuples (vtkIdList *ptIds, vtkAbstractArray *output)
virtual void	GetTuples (vtkIdType p1, vtkIdType p2, vtkAbstractArray *output)
int	Allocate (vtkIdType sz, vtkIdType ext=1000)
vtkStdString &	GetValue (vtkIdType id)
void	SetNumberOfValues (vtkIdType number)
vtkIdType	GetNumberOfValues ()
int	GetNumberOfElementComponents ()
int	GetElementComponentSize ()
void	SetVariantValue (vtkIdType idx, vtkVariant value)
void	DeepCopy (vtkAbstractArray *aa)
unsigned long	GetActualMemorySize ()
virtual vtkArrayIterator *	NewIterator ()
virtual vtkIdType	GetDataSize ()
virtual void	DataChanged ()
virtual void	DataElementChanged (vtkIdType id)
virtual void	ClearLookup ()
int	GetDataType ()
virtual void	InsertTuples (vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source)
virtual void	InsertTuples (vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source)
virtual void	InterpolateTuple (vtkIdType i, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights)
virtual void	InterpolateTuple (vtkIdType i, vtkIdType id1, vtkAbstractArray *source1, vtkIdType id2, vtkAbstractArray *source2, double t)
void	SetValue (vtkIdType id, vtkStdString value)
void	SetValue (vtkIdType id, const char *value)
virtual void	SetNumberOfTuples (vtkIdType number)
void	InsertValue (vtkIdType id, vtkStdString f)
void	InsertValue (vtkIdType id, const char *val)
vtkIdType	InsertNextValue (vtkStdString f)
vtkIdType	InsertNextValue (const char *f)
vtkStdString *	WritePointer (vtkIdType id, vtkIdType number)
vtkStdString *	GetPointer (vtkIdType id)
void *	GetVoidPointer (vtkIdType id)
void	SetArray (vtkStdString *array, vtkIdType size, int save)
virtual void	SetVoidArray (void *array, vtkIdType size, int save)
virtual vtkIdType	LookupValue (vtkVariant value)
virtual void	LookupValue (vtkVariant value, vtkIdList *ids)
vtkIdType	LookupValue (vtkStdString value)
void	LookupValue (vtkStdString value, vtkIdList *ids)
vtkIdType	LookupValue (const char *value)
void	LookupValue (const char *value, vtkIdList *ids)
Public Member Functions inherited from vtkAbstractArray
vtkAbstractArray *	NewInstance () const
void	SetComponentName (vtkIdType component, const char *name)
const char *	GetComponentName (vtkIdType component)
bool	HasAComponentName ()
int	CopyComponentNames (vtkAbstractArray *da)
virtual bool	HasStandardMemoryLayout ()
virtual void	ExportToVoidPointer (void *vtkNotUsed(out_ptr))
virtual vtkVariant	GetVariantValue (vtkIdType idx)
virtual void	InsertVariantValue (vtkIdType idx, vtkVariant value)
vtkInformation *	GetInformation ()
virtual void	SetNumberOfComponents (int)
int	GetNumberOfComponents ()
vtkIdType	GetNumberOfTuples ()
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 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 vtkStringArray *	New ()
static int	IsTypeOf (const char *type)
static vtkStringArray *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractArray
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 int	GetDataTypeSize (int type)
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
	vtkStringArray ()
	~vtkStringArray ()
vtkStdString *	ResizeAndExtend (vtkIdType sz)
Protected Member Functions inherited from vtkAbstractArray
	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
vtkStdString *	Array
int	SaveUserArray
Protected Attributes inherited from vtkAbstractArray
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

Detailed Description

a vtkAbstractArray subclass for strings

$Date$ $Revision$

Points and cells may sometimes have associated data that are stored as strings, e.g. labels for information visualization projects. This class provides a clean way to store and access those strings.

Thanks:

Andy Wilson (atwil.nosp@m.so@s.nosp@m.andia.nosp@m..gov) wrote this class.

Examples:

vtkStringArray (Examples)

Tests:

vtkStringArray (Tests)

Definition at line 44 of file vtkStringArray.h.

Member Typedef Documentation

typedef vtkAbstractArray vtkStringArray::Superclass

Definition at line 48 of file vtkStringArray.h.

Constructor & Destructor Documentation

vtkStringArray::vtkStringArray ( )

protected

vtkStringArray::~vtkStringArray ( )

protected

Member Function Documentation

static vtkStringArray* vtkStringArray::New ( )

static

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

static

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

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

static

virtual vtkObjectBase* vtkStringArray::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractArray.

vtkStringArray* vtkStringArray::NewInstance

(

)

const

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

int vtkStringArray::GetDataType ( )

inlinevirtual

Get the data type.

Implements vtkAbstractArray.

Definition at line 59 of file vtkStringArray.h.

int vtkStringArray::IsNumeric ( )

inlinevirtual

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

Implements vtkAbstractArray.

Definition at line 63 of file vtkStringArray.h.

void vtkStringArray::Initialize ( )

virtual

Release storage and reset array to initial state.

Implements vtkAbstractArray.

int vtkStringArray::GetDataTypeSize ( )

virtual

Return the size of the data type. WARNING: This may not mean what you expect with strings. It will return sizeof(std::string) and not take into account the data included in any particular string.

Implements vtkAbstractArray.

void vtkStringArray::Squeeze ( )

inlinevirtual

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

Implements vtkAbstractArray.

Definition at line 75 of file vtkStringArray.h.

int vtkStringArray::Resize ( vtkIdType  numTuples )

virtual

Resize the array while conserving the data.

Implements vtkAbstractArray.

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

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.

Implements vtkAbstractArray.

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

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.

Implements vtkAbstractArray.

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

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.

Implements vtkAbstractArray.

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

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.

Implements vtkAbstractArray.

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

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.

Implements vtkAbstractArray.

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

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.

Implements vtkAbstractArray.

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

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.

Implements vtkAbstractArray.

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

virtual

Given a list of indices, return an array of values. You must insure that the output array has been previously allocated with enough space to hold the data and that the types match sufficiently to allow conversion (if necessary).

Reimplemented from vtkAbstractArray.

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

virtual

Get the values for the range of indices specified (i.e., p1->p2 inclusive). You must insure that the output array has been previously allocated with enough space to hold the data and that the type of the output array is compatible with the type of this array.

Reimplemented from vtkAbstractArray.

int vtkStringArray::Allocate ( vtkIdType  sz, vtkIdType  ext = 1000  )

virtual

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

Implements vtkAbstractArray.

vtkStdString& vtkStringArray::GetValue

(

vtkIdType

id

)

Get the data at a particular index.

void vtkStringArray::SetValue ( vtkIdType  id, vtkStdString  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 156 of file vtkStringArray.h.

void vtkStringArray::SetValue	(	vtkIdType	id,
		const char *	value
	)

Set the data at a particular index. Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data.

virtual void vtkStringArray::SetNumberOfTuples ( vtkIdType  number )

inlinevirtual

Set the number of tuples (a component group) in the array. Note that this may allocate space depending on the number of components.

Implements vtkAbstractArray.

Definition at line 165 of file vtkStringArray.h.

void vtkStringArray::SetNumberOfValues

(

vtkIdType

number

)

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.

vtkIdType vtkStringArray::GetNumberOfValues ( )

inline

Definition at line 174 of file vtkStringArray.h.

int vtkStringArray::GetNumberOfElementComponents ( )

inline

Definition at line 176 of file vtkStringArray.h.

int vtkStringArray::GetElementComponentSize ( )

inlinevirtual

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).

Implements vtkAbstractArray.

Definition at line 177 of file vtkStringArray.h.

void vtkStringArray::InsertValue	(	vtkIdType	id,
		vtkStdString	f
	)

Insert data at a specified position in the array.

void vtkStringArray::InsertValue	(	vtkIdType	id,
		const char *	val
	)

Insert data at a specified position in the array.

void vtkStringArray::SetVariantValue ( vtkIdType  idx, vtkVariant  value  )

virtual

Set a value in the array form a variant. Insert a value into the array from a variant.

Implements vtkAbstractArray.

vtkIdType vtkStringArray::InsertNextValue

(

vtkStdString

f

)

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

vtkIdType vtkStringArray::InsertNextValue

(

const char *

f

)

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

vtkStdString* vtkStringArray::WritePointer	(	vtkIdType	id,
		vtkIdType	number
	)

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.

vtkStdString* vtkStringArray::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 213 of file vtkStringArray.h.

void* vtkStringArray::GetVoidPointer ( vtkIdType  id )

inlinevirtual

Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.

Implements vtkAbstractArray.

Definition at line 214 of file vtkStringArray.h.

void vtkStringArray::DeepCopy ( vtkAbstractArray *  aa )

virtual

Deep copy of another string array. Will complain and change nothing if the array passed in is not a vtkStringArray.

Reimplemented from vtkAbstractArray.

void vtkStringArray::SetArray	(	vtkStdString *	array,
		vtkIdType	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 supplied array. If save is 0, then this class is free to delete the array when it cleans up or reallocates. In that case, it is required that the array was allocated using the C++ new operator (and not malloc).

virtual void vtkStringArray::SetVoidArray ( void *  array, vtkIdType  size, int  save  )

inlinevirtual

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. If save is 0, then this class is free to delete the array when it cleans up or reallocates. In that case, it is required that the array was allocated using the C++ new operator (and not malloc).

Definition at line 235 of file vtkStringArray.h.

unsigned long vtkStringArray::GetActualMemorySize ( )

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. This function takes into account the size of the contents of the strings as well as the string containers themselves.

Implements vtkAbstractArray.

virtual vtkArrayIterator* vtkStringArray::NewIterator ( )

virtual

Returns a vtkArrayIteratorTemplate<vtkStdString>.

Implements vtkAbstractArray.

virtual vtkIdType vtkStringArray::GetDataSize ( )

virtual

Returns the size of the data in DataTypeSize units. Thus, the number of bytes for the data can be computed by GetDataSize() * GetDataTypeSize(). The size computation includes the string termination character for each string.

Reimplemented from vtkAbstractArray.

virtual vtkIdType vtkStringArray::LookupValue ( vtkVariant  value )

virtual

Return the indices where a specific value appears.

Implements vtkAbstractArray.

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

virtual

Return the indices where a specific value appears.

Implements vtkAbstractArray.

vtkIdType vtkStringArray::LookupValue

(

vtkStdString

value

)

Return the indices where a specific value appears.

void vtkStringArray::LookupValue	(	vtkStdString	value,
		vtkIdList *	ids
	)

Return the indices where a specific value appears.

vtkIdType vtkStringArray::LookupValue

(

const char *

value

)

Return the indices where a specific value appears.

void vtkStringArray::LookupValue	(	const char *	value,
		vtkIdList *	ids
	)

Return the indices where a specific value appears.

virtual void vtkStringArray::DataChanged ( )

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.

Implements vtkAbstractArray.

virtual void vtkStringArray::DataElementChanged ( vtkIdType  id )

virtual

Tell the array explicitly that a single data element has changed. Like DataChanged(), then is only necessary when you modify the array contents without using the array's API.

virtual void vtkStringArray::ClearLookup ( )

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.

Implements vtkAbstractArray.

vtkStdString* vtkStringArray::ResizeAndExtend ( vtkIdType  sz )

protected

Member Data Documentation

vtkStdString* vtkStringArray::Array

protected

Definition at line 292 of file vtkStringArray.h.

int vtkStringArray::SaveUserArray

protected

Definition at line 295 of file vtkStringArray.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/vtkStringArray.h