abstract base class for most VTK objects More...

#include <vtkObjectBase.h>

Inheritance diagram for vtkObjectBase:

Collaboration diagram for vtkObjectBase:

Public Member Functions
const char *	GetClassName () const
virtual int	IsA (const char *name)
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	PrintSelf (ostream &os, vtkIndent indent)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()
Static Public Member Functions
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()
Protected Member Functions
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)
Protected Attributes
vtkAtomicInt< vtkTypeInt32 >	ReferenceCount
vtkWeakPointerBase **	WeakPointers
Friends
class	vtkGarbageCollectorToObjectBaseFriendship
class	vtkWeakPointerBaseToObjectBaseFriendship
VTKCOMMONCORE_EXPORT ostream &	operator<< (ostream &os, vtkObjectBase &o)

Detailed Description

abstract base class for most VTK objects

vtkObjectBase is the base class for all reference counted classes in the VTK. These classes include vtkCommand classes, vtkInformationKey classes, and vtkObject classes.

vtkObjectBase performs reference counting: objects that are reference counted exist as long as another object uses them. Once the last reference to a reference counted object is removed, the object will spontaneously destruct.

Constructor and destructor of the subclasses of vtkObjectBase should be protected, so that only New() and UnRegister() actually call them. Debug leaks can be used to see if there are any objects left with nonzero reference count.

Warning:: Note: Objects of subclasses of vtkObjectBase should always be created with the New() method and deleted with the Delete() method. They cannot be allocated off the stack (i.e., automatic objects) because the constructor is a protected method.

See also:: vtkObject vtkCommand vtkInformationKey

Tests:: vtkObjectBase (Tests)

Definition at line 58 of file vtkObjectBase.h.

Constructor & Destructor Documentation

vtkObjectBase::vtkObjectBase ( ) [protected]

virtual vtkObjectBase::~vtkObjectBase ( ) [protected, virtual]

vtkObjectBase::vtkObjectBase ( const vtkObjectBase & ) [inline, protected]

Definition at line 184 of file vtkObjectBase.h.

Member Function Documentation

const char* vtkObjectBase::GetClassName ( ) const

Return the class name as a string.

static int vtkObjectBase::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.

virtual int vtkObjectBase::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.

virtual void vtkObjectBase::Delete ( ) [virtual]

Delete a VTK object. This method should always be used to delete an object when the New() method was used to create it. Using the C++ delete method will not work with reference counting.

virtual void vtkObjectBase::FastDelete ( ) [virtual]

Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.

static vtkObjectBase* vtkObjectBase::New ( void ) [inline, static]

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

Definition at line 112 of file vtkObjectBase.h.

void vtkObjectBase::Print ( ostream & os )

Print an object to an ostream. This is the method to call when you wish to see print the internal state of an object.

virtual void vtkObjectBase::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.

virtual void vtkObjectBase::PrintHeader	(	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.

virtual void vtkObjectBase::PrintTrailer	(	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.

virtual void vtkObjectBase::Register ( vtkObjectBase * o ) [virtual]

Increase the reference count (mark as used by another object).

Reimplemented in vtkInformation, vtkAlgorithm, vtkExecutive, vtkLocator, vtkCollection, vtkVisibilitySort, vtkPointSet, vtkPainter, vtkImplicitWindowFunction, vtkInformationVector, and vtkInformationKey.