vtkSmartPointerBase Class Reference

#include <vtkSmartPointerBase.h>

Inheritance diagram for vtkSmartPointerBase:

[legend]Collaboration diagram for vtkSmartPointerBase:

[legend]List of all members.

Detailed Description

Non-templated superclass for vtkSmartPointer.

vtkSmartPointerBase holds a pointer to a vtkObjectBase or subclass instance and performs one Register/UnRegister pair. This is useful for storing VTK objects in STL containers. This class is not intended to be used directly. Instead, use the vtkSmartPointer class template to automatically perform proper cast operations.

Created by:

King, Brad

CVS contributions (if > 5%):

King, Brad (90%)
Martin, Ken (9%)

CVS logs (CVSweb):

.cxx (/Common/vtkSmartPointerBase.cxx)
.h (/Common/vtkSmartPointerBase.h)

Definition at line 41 of file vtkSmartPointerBase.h.

Public Member Functions

vtkSmartPointerBase ()

vtkSmartPointerBase (vtkObjectBase *r)

vtkSmartPointerBase (const vtkSmartPointerBase &r)

~vtkSmartPointerBase ()

vtkSmartPointerBase & operator= (vtkObjectBase *r)

vtkSmartPointerBase & operator= (const vtkSmartPointerBase &r)

vtkObjectBase * GetPointer () const

operator SafeBool ()

SafeBool operator! ()

Protected Member Functions

vtkSmartPointerBase (vtkObjectBase *r, const NoReference &)

Protected Attributes

vtkObjectBase * Object

Constructor & Destructor Documentation

vtkSmartPointerBase::vtkSmartPointerBase ( )

Initialize smart pointer to NULL.

vtkSmartPointerBase::vtkSmartPointerBase ( vtkObjectBase * r )

Initialize smart pointer to given object.

vtkSmartPointerBase::vtkSmartPointerBase ( const vtkSmartPointerBase & r )

Initialize smart pointer with a new reference to the same object referenced by given smart pointer.

vtkSmartPointerBase::~vtkSmartPointerBase ( )

Destroy smart pointer and remove the reference to its object.

vtkSmartPointerBase::vtkSmartPointerBase ( vtkObjectBase * r,

const NoReference &

) [protected]

Member Function Documentation

vtkSmartPointerBase& vtkSmartPointerBase::operator= ( vtkObjectBase * r )

Assign object to reference. This removes any reference to an old object.
Referenced by vtkSmartPointer< vtkDataObject >::operator=().

vtkSmartPointerBase& vtkSmartPointerBase::operator= ( const vtkSmartPointerBase & r )

Assign object to reference. This removes any reference to an old object.
Reimplemented in vtkSmartPointer< T >, and vtkSmartPointer< vtkDataObject >.

vtkObjectBase* vtkSmartPointerBase::GetPointer ( ) const [inline]

Get the contained pointer.
Reimplemented in vtkSmartPointer< T >, and vtkSmartPointer< vtkDataObject >.
Definition at line 69 of file vtkSmartPointerBase.h.

vtkSmartPointerBase::operator SafeBool ( ) [inline]

Return true if pointer is set to non-null.
Definition at line 79 of file vtkSmartPointerBase.h.

SafeBool vtkSmartPointerBase::operator! ( ) [inline]

Return true if pointer is set to null.
Definition at line 87 of file vtkSmartPointerBase.h.

Member Data Documentation

vtkObjectBase* vtkSmartPointerBase::Object [protected]

Definition at line 101 of file vtkSmartPointerBase.h.

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

dox/Common/vtkSmartPointerBase.h


Public Member Functions
	vtkSmartPointerBase ()
	vtkSmartPointerBase (vtkObjectBase *r)
	vtkSmartPointerBase (const vtkSmartPointerBase &r)
	~vtkSmartPointerBase ()

vtkSmartPointerBase &	operator= (vtkObjectBase *r)
vtkSmartPointerBase &	operator= (const vtkSmartPointerBase &r)

vtkObjectBase *	GetPointer () const

	operator SafeBool ()

SafeBool	operator! ()
Protected Member Functions
	vtkSmartPointerBase (vtkObjectBase *r, const NoReference &)
Protected Attributes
vtkObjectBase *	Object