vtkHeap Class Reference
#include <vtkHeap.h>
Inheritance diagram for vtkHeap:
[legend]Collaboration diagram for vtkHeap:
[legend]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.
- 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
- Created by:
-
- CVS contributions (if > 5%):
- Schroeder, Will (78%)
- Martin, Ken (8%)
- Hoffman, Bill (7%)
- CVS logs (CVSweb):
/Common/vtkHeap.cxx)/Common/vtkHeap.h)
Definition at line 63 of file vtkHeap.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkHeap::vtkHeap |
( |
|
) |
[protected] |
|
Member Function Documentation
|
|
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] |
|
| 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. |
| 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 |
( |
|
) |
[inline, 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.
Definition at line 77 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. |
|
|
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
The documentation for this class was generated from the following file: