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

#include <vtkHeap.h>

Inheritance diagram for vtkHeap:

Collaboration diagram for vtkHeap:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkHeap *	NewInstance () 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 ()

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 vtkHeap *	New ()

static int	IsTypeOf (const char *type)

static vtkHeap *	SafeDownCast (vtkObjectBase *o)

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

	vtkHeap ()

	~vtkHeap ()

void	Add (size_t blockSize)

void	CleanAll ()

vtkHeapBlock *	DeleteAndNext ()

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
size_t	BlockSize

int	NumberOfAllocations

int	NumberOfBlocks

size_t	Alignment

vtkHeapBlock *	First

vtkHeapBlock *	Last

vtkHeapBlock *	Current

size_t	Position

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

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

static

virtual vtkObjectBase* vtkHeap::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkHeap* vtkHeap::NewInstance ( ) const

void vtkHeap::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.

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.

size_t 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:

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation