VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkVoidArray Class Reference

dynamic, self-adjusting array of void* pointers More...

#include <vtkVoidArray.h>

Inheritance diagram for vtkVoidArray:
[legend]
Collaboration diagram for vtkVoidArray:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkVoidArrayNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkTypeBool Allocate (vtkIdType sz, vtkIdType ext=1000)
 Allocate memory for this array. More...
 
void Initialize ()
 Release storage and reset array to initial state. More...
 
int GetDataType ()
 Return the type of data. More...
 
int GetDataTypeSize ()
 Return the size of the data contained in the array. More...
 
void SetNumberOfPointers (vtkIdType number)
 Set the number of void* pointers held in the array. More...
 
vtkIdType GetNumberOfPointers ()
 Get the number of void* pointers held in the array. More...
 
void * GetVoidPointer (vtkIdType id)
 Get the void* pointer at the ith location. More...
 
void SetVoidPointer (vtkIdType id, void *ptr)
 Set the void* pointer value at the ith location in the array. More...
 
void InsertVoidPointer (vtkIdType i, void *ptr)
 Insert (memory allocation performed) the void* into the ith location in the array. More...
 
vtkIdType InsertNextVoidPointer (void *tuple)
 Insert (memory allocation performed) the void* pointer at the end of the array. More...
 
void Reset ()
 Reuse already allocated data; make the container look like it is empty. More...
 
void Squeeze ()
 Resize the array to just fit the inserted memory. More...
 
void ** GetPointer (vtkIdType id)
 Get the address of a particular data index. More...
 
void ** WritePointer (vtkIdType id, vtkIdType number)
 Get the address of a particular data index. More...
 
void DeepCopy (vtkVoidArray *va)
 Deep copy of another void array. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkVoidArrayNew ()
 Initialize with empty array. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVoidArraySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkVoidArray ()
 
 ~vtkVoidArray () override
 
void ** ResizeAndExtend (vtkIdType sz)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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 NumberOfPointers
 
vtkIdType Size
 
void ** Array
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

dynamic, self-adjusting array of void* pointers

vtkVoidArray is an array of pointers to void. It provides methods for insertion and retrieval of these pointers values, and will automatically resize itself to hold new data.

Definition at line 30 of file vtkVoidArray.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 of file vtkVoidArray.h.

Constructor & Destructor Documentation

◆ vtkVoidArray()

vtkVoidArray::vtkVoidArray ( )
protected

◆ ~vtkVoidArray()

vtkVoidArray::~vtkVoidArray ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkVoidArray* vtkVoidArray::New ( )
static

Initialize with empty array.

◆ IsTypeOf()

static vtkTypeBool vtkVoidArray::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkVoidArray::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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkVoidArray::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkVoidArray* vtkVoidArray::NewInstance ( ) const

◆ PrintSelf()

void vtkVoidArray::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

◆ Allocate()

vtkTypeBool vtkVoidArray::Allocate ( vtkIdType  sz,
vtkIdType  ext = 1000 
)

Allocate memory for this array.

Delete old storage only if necessary. Note that the parameter ext is no longer used.

◆ Initialize()

void vtkVoidArray::Initialize ( )

Release storage and reset array to initial state.

◆ GetDataType()

int vtkVoidArray::GetDataType ( )
inline

Return the type of data.

Definition at line 55 of file vtkVoidArray.h.

◆ GetDataTypeSize()

int vtkVoidArray::GetDataTypeSize ( )
inline

Return the size of the data contained in the array.

Definition at line 60 of file vtkVoidArray.h.

◆ SetNumberOfPointers()

void vtkVoidArray::SetNumberOfPointers ( vtkIdType  number)
inline

Set the number of void* pointers held in the array.

Definition at line 65 of file vtkVoidArray.h.

◆ GetNumberOfPointers()

vtkIdType vtkVoidArray::GetNumberOfPointers ( )
inline

Get the number of void* pointers held in the array.

Definition at line 71 of file vtkVoidArray.h.

◆ GetVoidPointer()

void* vtkVoidArray::GetVoidPointer ( vtkIdType  id)
inline

Get the void* pointer at the ith location.

Definition at line 77 of file vtkVoidArray.h.

◆ SetVoidPointer()

void vtkVoidArray::SetVoidPointer ( vtkIdType  id,
void *  ptr 
)
inline

Set the void* pointer value at the ith location in the array.

Definition at line 83 of file vtkVoidArray.h.

◆ InsertVoidPointer()

void vtkVoidArray::InsertVoidPointer ( vtkIdType  i,
void *  ptr 
)

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

◆ InsertNextVoidPointer()

vtkIdType vtkVoidArray::InsertNextVoidPointer ( void *  tuple)

Insert (memory allocation performed) the void* pointer at the end of the array.

◆ Reset()

void vtkVoidArray::Reset ( )
inline

Reuse already allocated data; make the container look like it is empty.

Definition at line 102 of file vtkVoidArray.h.

◆ Squeeze()

void vtkVoidArray::Squeeze ( )
inline

Resize the array to just fit the inserted memory.

Reclaims extra memory.

Definition at line 108 of file vtkVoidArray.h.

◆ GetPointer()

void** vtkVoidArray::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 115 of file vtkVoidArray.h.

◆ WritePointer()

void** vtkVoidArray::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 NumberOfPointers according to the number of data values requested.

◆ DeepCopy()

void vtkVoidArray::DeepCopy ( vtkVoidArray va)

Deep copy of another void array.

◆ ResizeAndExtend()

void** vtkVoidArray::ResizeAndExtend ( vtkIdType  sz)
protected

Member Data Documentation

◆ NumberOfPointers

vtkIdType vtkVoidArray::NumberOfPointers
protected

Definition at line 133 of file vtkVoidArray.h.

◆ Size

vtkIdType vtkVoidArray::Size
protected

Definition at line 134 of file vtkVoidArray.h.

◆ Array

void** vtkVoidArray::Array
protected

Definition at line 135 of file vtkVoidArray.h.


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