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

vtkHeap *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void *	AllocateMemory (size_t n)
	Allocate the memory requested. More...

void	Reset ()
	This methods resets the current allocation location back to the beginning of the heap. More...

char *	StringDup (const char *str)
	Convenience method performs string duplication. More...


virtual void	SetBlockSize (size_t)
	Set/Get the size at which blocks are allocated. More...

virtual size_t	GetBlockSize ()
	Set/Get the size at which blocks are allocated. More...


virtual int	GetNumberOfBlocks ()
	Get the number of allocations thus far. More...

virtual int	GetNumberOfAllocations ()
	Get the number of allocations thus far. 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...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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	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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkHeap *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkHeap *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkHeap ()

	~vtkHeap () override

void	Add (size_t blockSize)

void	CleanAll ()

vtkHeapBlock *	DeleteAndNext ()

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 ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

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
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkHeap::Superclass

Definition at line 57 of file vtkHeap.h.

Constructor & Destructor Documentation

◆ vtkHeap()

vtkHeap::vtkHeap ( )

protected

◆ ~vtkHeap()

vtkHeap::~vtkHeap ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkHeap * vtkHeap::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkHeap::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkHeap * vtkHeap::NewInstance ( ) const

◆ PrintSelf()

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

◆ AllocateMemory()

void * vtkHeap::AllocateMemory ( size_t n )

Allocate the memory requested.

◆ SetBlockSize()

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.

◆ GetBlockSize()

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

◆ GetNumberOfBlocks()

virtual int vtkHeap::GetNumberOfBlocks ( )

virtual

Get the number of allocations thus far.

◆ GetNumberOfAllocations()

virtual int vtkHeap::GetNumberOfAllocations ( )

virtual

Get the number of allocations thus far.

◆ Reset()

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.

◆ StringDup()

char * vtkHeap::StringDup ( const char * str )

Convenience method performs string duplication.

◆ Add()

void vtkHeap::Add ( size_t blockSize )

protected

◆ CleanAll()

void vtkHeap::CleanAll ( )

protected

◆ DeleteAndNext()

vtkHeapBlock * vtkHeap::DeleteAndNext ( )

protected

Member Data Documentation

◆ BlockSize

size_t vtkHeap::BlockSize

protected

Definition at line 104 of file vtkHeap.h.

◆ NumberOfAllocations

int vtkHeap::NumberOfAllocations

protected

Definition at line 105 of file vtkHeap.h.

◆ NumberOfBlocks

int vtkHeap::NumberOfBlocks

protected

Definition at line 106 of file vtkHeap.h.

◆ Alignment

size_t vtkHeap::Alignment

protected

Definition at line 107 of file vtkHeap.h.

◆ First

vtkHeapBlock* vtkHeap::First

protected

Definition at line 110 of file vtkHeap.h.

◆ Last

vtkHeapBlock* vtkHeap::Last

protected

Definition at line 111 of file vtkHeap.h.

◆ Current

vtkHeapBlock* vtkHeap::Current

protected

Definition at line 112 of file vtkHeap.h.

◆ Position

size_t vtkHeap::Position

protected

Definition at line 114 of file vtkHeap.h.

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

Common/Misc/vtkHeap.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkHeap()

◆ ~vtkHeap()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ AllocateMemory()

◆ SetBlockSize()

◆ GetBlockSize()

◆ GetNumberOfBlocks()

◆ GetNumberOfAllocations()

◆ Reset()

◆ StringDup()

◆ Add()

◆ CleanAll()

◆ DeleteAndNext()

Member Data Documentation

◆ BlockSize

◆ NumberOfAllocations

◆ NumberOfBlocks

◆ Alignment

◆ First

◆ Last

◆ Current

◆ Position