vtkDebugLeaks Class Reference

#include <vtkDebugLeaks.h>

Inheritance diagram for vtkDebugLeaks:

[legend]

Collaboration diagram for vtkDebugLeaks:

[legend]

List of all members.

---

Detailed Description

identify memory leaks at program termination

vtkDebugLeaks is used to report memory leaks at the exit of the program. It uses the vtkObjectFactory to intercept the construction of all VTK objects. It uses the UnRegister method of vtkObject to intercept the destruction of all objects. A table of object name to number of instances is kept. At the exit of the program if there are still VTK objects around it will print them out. To enable this class add the flag -DVTK_DEBUG_LEAKS to the compile line, and rebuild vtkObject and vtkObjectFactory.

Tests:

vtkDebugLeaks (Tests)

Definition at line 42 of file vtkDebugLeaks.h.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
Static Public Member Functions
static vtkDebugLeaks *	New ()
static int	IsTypeOf (const char *type)
static vtkDebugLeaks *	SafeDownCast (vtkObject *o)
static void	ConstructClass (const char *classname)
static void	DestructClass (const char *classname)
static int	PrintCurrentLeaks ()
static void	PromptUserOn ()
static void	PromptUserOff ()
static int	GetExitError ()
static void	SetExitError (int)
Protected Member Functions
	vtkDebugLeaks ()
virtual	~vtkDebugLeaks ()
Static Protected Member Functions
static int	DisplayMessageBox (const char *)
static void	ClassInitialize ()
static void	ClassFinalize ()
Friends
class	vtkDebugLeaksManager

---

Member Typedef Documentation

typedef vtkObject vtkDebugLeaks::Superclass

Reimplemented from vtkObject.

Definition at line 46 of file vtkDebugLeaks.h.

---

Constructor & Destructor Documentation

vtkDebugLeaks::vtkDebugLeaks

(

)

[inline, protected]

Definition at line 73 of file vtkDebugLeaks.h.

virtual vtkDebugLeaks::~vtkDebugLeaks

(

)

[inline, protected, virtual]

Definition at line 74 of file vtkDebugLeaks.h.

---

Member Function Documentation

static vtkDebugLeaks* vtkDebugLeaks::New

(

)

[static]

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

Reimplemented from vtkObject.

virtual const char* vtkDebugLeaks::GetClassName

(

)

[virtual]

Reimplemented from vtkObject.

static int vtkDebugLeaks::IsTypeOf

(

const char *

name

)

[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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkDebugLeaks::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 vtkDebugLeaks* vtkDebugLeaks::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkObject.

static void vtkDebugLeaks::ConstructClass

(

const char *

classname

)

[static]

Call this when creating a class of a given name.

static void vtkDebugLeaks::DestructClass

(

const char *

classname

)

[static]

Call this when deleting a class of a given name.

static int vtkDebugLeaks::PrintCurrentLeaks

(

)

[static]

Print all the values in the table. Returns non-zero if there were leaks.

static void vtkDebugLeaks::PromptUserOn

(

)

[static]

Deprecated:

Turn prompt at exit on/off (this setting is deprecated and will be ignored).

static void vtkDebugLeaks::PromptUserOff

(

)

[static]

Deprecated:

Turn prompt at exit on/off (this setting is deprecated and will be ignored).

static int vtkDebugLeaks::GetExitError

(

)

[static]

Get/Set flag for exiting with an error when leaks are present. Default is on when testing and off otherwise.

static void vtkDebugLeaks::SetExitError

(

int

)

[static]

Get/Set flag for exiting with an error when leaks are present. Default is on when testing and off otherwise.

static int vtkDebugLeaks::DisplayMessageBox

(

const char *

)

[static, protected]

static void vtkDebugLeaks::ClassInitialize

(

)

[static, protected]

static void vtkDebugLeaks::ClassFinalize

(

)

[static, protected]

---

Friends And Related Function Documentation

friend class vtkDebugLeaksManager [friend]

Definition at line 82 of file vtkDebugLeaks.h.

---

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

• dox/Common/vtkDebugLeaks.h