Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkHeap Class Reference

#include <vtkHeap.h>

Inheritance diagram for vtkHeap:

Inheritance graph
Collaboration diagram for vtkHeap:

Collaboration graph
List of all members.

Detailed Description

replacement for malloc/free and new/delete

This class is a replacement for malloc/free and new/delete for software that has inherent memory leak or performance problems. For example, external software such as the PLY library (vtkPLY) and VRML importer (vtkVRMLImporter) are often written with lots of malloc() calls but without the corresponding free() invocations. The class vtkOrderedTriangulator may create and delete millions of new/delete calls. This class allows the overloading of the C++ new operator (or other memory allocation requests) by using the method AllocateMemory(). Memory is deleted with an invocation of CleanAll() (which deletes ALL memory; any given memory allocation cannot be deleted). Note: a block size can be used to control the size of each memory allocation. Requests for memory are fulfilled from the block until the block runs out, then a new block is created.

Do not use this class as a general replacement for system memory allocation. This class should be used only as a last resort if memory leaks cannot be tracked down and eliminated by conventional means. Also, deleting memory from vtkHeap is not supported. Only the deletion of the entire heap is. (A Reset() method allows you to reuse previously allocated memory.)
See also:
vtkVRMLImporter vtkPLY vtkOrderedTriangulator

Definition at line 51 of file vtkHeap.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Reset ()
char * StringDup (const char *str)
void * AllocateMemory (size_t n)
virtual void SetBlockSize (size_t)
virtual size_t GetBlockSize ()
virtual int GetNumberOfBlocks ()
virtual int GetNumberOfAllocations ()

Static Public Member Functions

static vtkHeapNew ()
static int IsTypeOf (const char *type)
static vtkHeapSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkHeap ()
 ~vtkHeap ()
void Add (size_t blockSize)
void CleanAll ()
vtkHeapBlock * DeleteAndNext ()

Protected Attributes

size_t BlockSize
int NumberOfAllocations
int NumberOfBlocks
int Alignment
vtkHeapBlock * First
vtkHeapBlock * Last
vtkHeapBlock * Current
size_t Position

Member Typedef Documentation

typedef vtkObject vtkHeap::Superclass

Reimplemented from vtkObject.

Definition at line 55 of file vtkHeap.h.

Constructor & Destructor Documentation

vtkHeap::vtkHeap  )  [protected]

vtkHeap::~vtkHeap  )  [protected]

Member Function Documentation

static vtkHeap* vtkHeap::New  )  [static]

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

Reimplemented from vtkObject.

virtual const char* vtkHeap::GetClassName  )  [virtual]

Reimplemented from vtkObject.

static int vtkHeap::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkHeap::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkHeap* vtkHeap::SafeDownCast vtkObject o  )  [static]

Reimplemented from vtkObject.

void vtkHeap::PrintSelf ostream &  os,
vtkIndent  indent

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.

void* vtkHeap::AllocateMemory size_t  n  ) 

Allocate the memory requested.

virtual void vtkHeap::SetBlockSize size_t   )  [virtual]

Set/Get the size at which blocks are allocated. If a memory request is bigger than the block size, then that size will be allocated.

virtual size_t vtkHeap::GetBlockSize  )  [inline, virtual]

Allocate the memory requested.

Definition at line 65 of file vtkHeap.h.

virtual int vtkHeap::GetNumberOfBlocks  )  [virtual]

Get the number of allocations thus far.

virtual int vtkHeap::GetNumberOfAllocations  )  [virtual]

Get the number of allocations thus far.

void vtkHeap::Reset  ) 

This methods resets the current allocation location back to the beginning of the heap. This allows reuse of previously allocated memory which may be beneficial to performance in many cases.

char* vtkHeap::StringDup const char *  str  ) 

Convenience method performs string duplication.

void vtkHeap::Add size_t  blockSize  )  [protected]

void vtkHeap::CleanAll  )  [protected]

vtkHeapBlock* vtkHeap::DeleteAndNext  )  [protected]

Member Data Documentation

size_t vtkHeap::BlockSize [protected]

Definition at line 90 of file vtkHeap.h.

int vtkHeap::NumberOfAllocations [protected]

Definition at line 91 of file vtkHeap.h.

int vtkHeap::NumberOfBlocks [protected]

Definition at line 92 of file vtkHeap.h.

int vtkHeap::Alignment [protected]

Definition at line 93 of file vtkHeap.h.

vtkHeapBlock* vtkHeap::First [protected]

Definition at line 96 of file vtkHeap.h.

vtkHeapBlock* vtkHeap::Last [protected]

Definition at line 97 of file vtkHeap.h.

vtkHeapBlock* vtkHeap::Current [protected]

Definition at line 98 of file vtkHeap.h.

size_t vtkHeap::Position [protected]

Definition at line 100 of file vtkHeap.h.

The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:46:58 2008 for VTK by  doxygen 1.4.3-20050530