vtkDebugLeaks Class Reference

identify memory leaks at program termination More...

#include <vtkDebugLeaks.h>

Inheritance diagram for vtkDebugLeaks:

Collaboration diagram for vtkDebugLeaks:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkDebugLeaks *	NewInstance () const
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 ()
virtual void	PrintSelf (ostream &os, vtkIndent indent)
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 vtkDebugLeaks *	New ()
static int	IsTypeOf (const char *type)
static vtkDebugLeaks *	SafeDownCast (vtkObjectBase *o)
static void	ConstructClass (const char *classname)
static void	DestructClass (const char *classname)
static int	PrintCurrentLeaks ()
static int	GetExitError ()
static void	SetExitError (int)
static void	SetDebugLeaksObserver (vtkDebugLeaksObserver *observer)
static vtkDebugLeaksObserver *	GetDebugLeaksObserver ()
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
	vtkDebugLeaks ()
virtual	~vtkDebugLeaks ()
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 &)

Static Protected Member Functions
static int	DisplayMessageBox (const char *)
static void	ClassInitialize ()
static void	ClassFinalize ()
static void	ConstructingObject (vtkObjectBase *object)
static void	DestructingObject (vtkObjectBase *object)

Friends
class	vtkDebugLeaksManager
class	vtkObjectBase

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 44 of file vtkDebugLeaks.h.

Member Typedef Documentation

typedef vtkObject vtkDebugLeaks::Superclass

Definition at line 48 of file vtkDebugLeaks.h.

Constructor & Destructor Documentation

vtkDebugLeaks::vtkDebugLeaks ( )

inlineprotected

Definition at line 72 of file vtkDebugLeaks.h.

virtual vtkDebugLeaks::~vtkDebugLeaks ( )

inlineprotectedvirtual

Definition at line 73 of file vtkDebugLeaks.h.

Member Function Documentation

static vtkDebugLeaks* vtkDebugLeaks::New ( )

static

static int vtkDebugLeaks::IsTypeOf ( const char *  type )

static

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 ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkDebugLeaks::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkDebugLeaks* vtkDebugLeaks::NewInstance

(

)

const

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 int vtkDebugLeaks::GetExitError ( )

static

Get/Set flag for exiting with an error when leaks are present. Default is on when VTK_DEBUG_LEAKS is on 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 VTK_DEBUG_LEAKS is on and off otherwise.

static void vtkDebugLeaks::SetDebugLeaksObserver ( vtkDebugLeaksObserver *  observer )

static

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

static vtkDebugLeaksObserver* vtkDebugLeaks::GetDebugLeaksObserver ( )

static

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

static int vtkDebugLeaks::DisplayMessageBox ( const char *  )

staticprotected

static void vtkDebugLeaks::ClassInitialize ( )

staticprotected

static void vtkDebugLeaks::ClassFinalize ( )

staticprotected

static void vtkDebugLeaks::ConstructingObject ( vtkObjectBase *  object )

staticprotected

static void vtkDebugLeaks::DestructingObject ( vtkObjectBase *  object )

staticprotected

Friends And Related Function Documentation

friend class vtkDebugLeaksManager

friend

Definition at line 84 of file vtkDebugLeaks.h.

friend class vtkObjectBase

friend

Definition at line 85 of file vtkDebugLeaks.h.

---

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

• dox/Common/Core/vtkDebugLeaks.h