VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkHeap Class Reference

replacement for malloc/free and new/delete More...

#include <vtkHeap.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkHeapNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void * AllocateMemory (size_t n)
 
void Reset ()
 
char * StringDup (const char *str)
 
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 (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 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
 

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.

Warning
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 52 of file vtkHeap.h.

Member Typedef Documentation

typedef vtkObject vtkHeap::Superclass

Definition at line 56 of file vtkHeap.h.

Constructor & Destructor Documentation

vtkHeap::vtkHeap ( )
protected
vtkHeap::~vtkHeap ( )
protected

Member Function Documentation

static vtkHeap* vtkHeap::New ( )
static
static int vtkHeap::IsTypeOf ( const char *  type)
static
virtual int vtkHeap::IsA ( const char *  type)
virtual
static vtkHeap* vtkHeap::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkHeap::NewInstanceInternal ( ) const
protectedvirtual
vtkHeap* vtkHeap::NewInstance ( ) const
void vtkHeap::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 ( )
inlinevirtual

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.

Definition at line 66 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 91 of file vtkHeap.h.

int vtkHeap::NumberOfAllocations
protected

Definition at line 92 of file vtkHeap.h.

int vtkHeap::NumberOfBlocks
protected

Definition at line 93 of file vtkHeap.h.

int vtkHeap::Alignment
protected

Definition at line 94 of file vtkHeap.h.

vtkHeapBlock* vtkHeap::First
protected

Definition at line 97 of file vtkHeap.h.

vtkHeapBlock* vtkHeap::Last
protected

Definition at line 98 of file vtkHeap.h.

vtkHeapBlock* vtkHeap::Current
protected

Definition at line 99 of file vtkHeap.h.

size_t vtkHeap::Position
protected

Definition at line 101 of file vtkHeap.h.


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