abstract base class for most VTK objects More...

#include <vtkObjectBase.h>

Inheritance diagram for vtkObjectBase:

Collaboration diagram for vtkObjectBase:

Classes
class	vtkMemkindRAII
	A class to help modify and restore the global UsingMemkind state, like SetUsingMemkind(newValue), but safer. More...

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

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output. 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...

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	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. 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...


virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
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
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkGarbageCollectorToObjectBaseFriendship

class	vtkWeakPointerBaseToObjectBaseFriendship

class	vtkMemkindRAII

class	vtkTDSCMemkindRAII

class	vtkDebugLeaks

VTKCOMMONCORE_EXPORT ostream &	operator<< (ostream &os, vtkObjectBase &o)

template<typename T >
class	vtkWeakPtr

class	vtkInformationKey
	Some classes need to clear the reference counts manually due to the way they work. More...

class	vtkGarbageCollector
	Some classes need to clear the reference counts manually due to the way they work. More...

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 68 of file vtkObjectBase.h.

Constructor & Destructor Documentation

vtkObjectBase::vtkObjectBase ( )

protected

virtual vtkObjectBase::~vtkObjectBase ( )

protectedvirtual

vtkObjectBase::vtkObjectBase ( const vtkObjectBase & )

inlineprotected

Definition at line 349 of file vtkObjectBase.h.

Member Function Documentation

const char* vtkObjectBase::GetClassName ( ) const

Return the class name as a string.

virtual std::string vtkObjectBase::GetObjectDescription ( ) const

virtual

The object description printed in messages and PrintSelf output.

To be used only for reporting purposes.

Reimplemented in vtkObject.

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

static vtkIdType vtkObjectBase::GetNumberOfGenerationsFromBaseType ( const char * name )

static

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

If the named class is not in this class's inheritance tree, return a negative value. Valid responses will always be nonnegative. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

virtual vtkIdType vtkObjectBase::GetNumberOfGenerationsFromBase ( const char * name )

virtual

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

If the named class is not in this class's inheritance tree, return a negative value. Valid responses will always be nonnegative. 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 ( )

inlinestatic

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

Definition at line 160 of file vtkObjectBase.h.

void vtkObjectBase::InitializeObjectBase ( )

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.

void vtkObjectBase::Register ( vtkObjectBase * o )

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

virtual void vtkObjectBase::UnRegister ( vtkObjectBase * o )

virtual

Decrease the reference count (release by another object).

This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).

Reimplemented in vtkRenderWindow, vtkAbstractTransform, and vtkRenderWindowInteractor.

virtual bool vtkObjectBase::UsesGarbageCollector ( ) const

inlinevirtual

Indicate whether the class uses vtkGarbageCollector or not.

Most classes will not need to do this, but if the class participates in a strongly-connected reference count cycle, participation can resolve these cycles.

If overriding this method to return true, the ReportReferences method should be overridden to report references that may be in cycles.

Reimplemented in vtkInformation, vtkPointSet, vtkAlgorithm, vtkLocator, vtkSphereTree, vtkCollection, vtkExecutive, vtkAbstractCellLinks, vtkVisibilitySort, vtkImplicitWindowFunction, and vtkInformationVector.

Definition at line 219 of file vtkObjectBase.h.

int vtkObjectBase::GetReferenceCount ( )

inline

Return the current reference count of this object.

Definition at line 226 of file vtkObjectBase.h.

void vtkObjectBase::SetReferenceCount ( int )

Sets the reference count.

(This is very dangerous, use with care.)

static void vtkObjectBase::SetMemkindDirectory ( const char * directoryname )

static

The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

This must be called before any objects are constructed in the extended space. It can not be changed once setup.

static bool vtkObjectBase::GetUsingMemkind ( )

static

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

bool vtkObjectBase::GetIsInMemkind ( ) const

A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void vtkObjectBase::RegisterInternal	(	vtkObjectBase *	,
		vtkTypeBool	check
	)

protectedvirtual

Reimplemented in vtkObject.

virtual void vtkObjectBase::UnRegisterInternal	(	vtkObjectBase *	,
		vtkTypeBool	check
	)

protectedvirtual

Reimplemented in vtkObject.

virtual void vtkObjectBase::ReportReferences ( vtkGarbageCollector * )

protectedvirtual

Reimplemented in vtkAlgorithm, vtkPolyData, vtkUnstructuredGrid, vtkImageReslice, vtkInformation, vtkGeometryFilterDispatcher, vtkExplicitStructuredGrid, vtkGraphMapper, vtkProbeFilter, vtkPointSet, vtkExecutive, vtkImageResliceMapper, vtkCutter, vtkPlaneCutter, vtkContourFilter, vtkResampleWithDataSet, vtkSphereTree, vtkLocator, vtkStructuredDataPlaneCutter, vtkEncodedGradientEstimator, vtkCollection, vtkClipVolume, vtkSelectEnclosedPoints, vtkAbstractCellLinks, vtkSphereTreeFilter, vtkJumpAndWalkCellLocator, vtkSampleFunction, vtkVisibilitySort, vtkProgrammableAttributeDataFilter, vtkParallelopipedWidget, vtkImageOpenClose3D, vtkCompositeDataProbeFilter, vtkExtractHierarchicalBins, vtkSpatialRepresentationFilter, vtkImplicitDataSet, vtkImplicitWindowFunction, vtkSampleImplicitFunctionFilter, vtkInformationVector, vtkTrivialProducer, vtkImageStencilSource, vtkDataSetMapper, vtkProjectedTetrahedraMapper, vtkOpenGLPointGaussianMapper, and vtkInterpolateDataSetAttributes.

static vtkMallocingFunction vtkObjectBase::GetCurrentMallocFunction ( )

staticprotected

static vtkReallocingFunction vtkObjectBase::GetCurrentReallocFunction ( )

staticprotected

static vtkFreeingFunction vtkObjectBase::GetCurrentFreeFunction ( )

staticprotected

static vtkFreeingFunction vtkObjectBase::GetAlternateFreeFunction ( )

staticprotected

virtual void vtkObjectBase::ObjectFinalize ( )

protectedvirtual

void vtkObjectBase::operator= ( const vtkObjectBase & )

inlineprotected

Definition at line 350 of file vtkObjectBase.h.

Friends And Related Function Documentation

friend class vtkGarbageCollectorToObjectBaseFriendship

friend

Definition at line 307 of file vtkObjectBase.h.

friend class vtkWeakPointerBaseToObjectBaseFriendship

friend

Definition at line 308 of file vtkObjectBase.h.

friend class vtkMemkindRAII

friend

Definition at line 310 of file vtkObjectBase.h.

friend class vtkTDSCMemkindRAII

friend

Definition at line 311 of file vtkObjectBase.h.

template<typename T >

friend class vtkWeakPtr

friend

Definition at line 318 of file vtkObjectBase.h.

friend class vtkInformationKey

friend

Some classes need to clear the reference counts manually due to the way they work.

Definition at line 340 of file vtkObjectBase.h.

friend class vtkGarbageCollector

friend

Some classes need to clear the reference counts manually due to the way they work.

Definition at line 341 of file vtkObjectBase.h.

friend class vtkDebugLeaks

friend

Definition at line 345 of file vtkObjectBase.h.

VTKCOMMONCORE_EXPORT ostream& operator<<	(	ostream &	os,
		vtkObjectBase &	o
	)

friend

Member Data Documentation

std::atomic<int32_t> vtkObjectBase::ReferenceCount

protected

Definition at line 282 of file vtkObjectBase.h.

vtkWeakPointerBase** vtkObjectBase::WeakPointers

protected

Definition at line 283 of file vtkObjectBase.h.

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

Common/Core/vtkObjectBase.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation