Hold a reference to a vtkObjectBase instance. More...

#include <vtkSmartPointer.h>

Collaboration diagram for vtkSmartPointer< T >:

Public Member Functions
	vtkSmartPointer ()

	vtkSmartPointer (T *r)


template<class U >
	vtkSmartPointer (const vtkSmartPointer< U > &r)


vtkSmartPointer &	operator= (T *r)


template<class U >
vtkSmartPointer &	operator= (const vtkSmartPointer< U > &r)


T *	GetPointer () const

T *	Get () const


	operator T * () const


T &	operator* () const


T *	operator-> () const


void	TakeReference (T *t)

Public Member Functions inherited from vtkSmartPointerBase
	vtkSmartPointerBase ()

	vtkSmartPointerBase (vtkObjectBase *r)

	vtkSmartPointerBase (const vtkSmartPointerBase &r)

	~vtkSmartPointerBase ()

void	Report (vtkGarbageCollector collector, const char desc)

vtkSmartPointerBase &	operator= (vtkObjectBase *r)

vtkSmartPointerBase &	operator= (const vtkSmartPointerBase &r)

vtkObjectBase *	GetPointer () const

Static Public Member Functions

static vtkSmartPointer< T >	New ()


static vtkSmartPointer< T >	NewInstance (T *t)


static vtkSmartPointer< T >	Take (T *t)

Protected Member Functions
	vtkSmartPointer (T *r, const NoReference &n)

Protected Member Functions inherited from vtkSmartPointerBase
	vtkSmartPointerBase (vtkObjectBase *r, const NoReference &)

Additional Inherited Members
Protected Attributes inherited from vtkSmartPointerBase
vtkObjectBase *	Object

Detailed Description

template<class T>
class vtkSmartPointer< T >

Hold a reference to a vtkObjectBase instance.

vtkSmartPointer is a class template that provides automatic casting for objects held by the vtkSmartPointerBase superclass.

Examples:: vtkSmartPointer (Examples)

Tests:: vtkSmartPointer (Tests)

Definition at line 34 of file vtkSmartPointer.h.

Constructor & Destructor Documentation

template<class T>

vtkSmartPointer< T >::vtkSmartPointer ( )

inline

Initialize smart pointer to NULL.

Definition at line 39 of file vtkSmartPointer.h.

template<class T>

vtkSmartPointer< T >::vtkSmartPointer ( T * r )

inline

Initialize smart pointer to given object.

Definition at line 42 of file vtkSmartPointer.h.

template<class T>

template<class U >

vtkSmartPointer< T >::vtkSmartPointer ( const vtkSmartPointer< U > & r )

inline

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

Definition at line 48 of file vtkSmartPointer.h.

template<class T>

vtkSmartPointer< T >::vtkSmartPointer	(	T *	r,
		const NoReference &	n
	)

inlineprotected

Definition at line 178 of file vtkSmartPointer.h.

Member Function Documentation

template<class T>

vtkSmartPointer& vtkSmartPointer< T >::operator= ( T * r )

inline

Assign object to reference. This removes any reference to an old object.

Definition at line 55 of file vtkSmartPointer.h.

template<class T>

template<class U >

vtkSmartPointer& vtkSmartPointer< T >::operator= ( const vtkSmartPointer< U > & r )

inline

Assign object to reference. This removes any reference to an old object.

Definition at line 66 of file vtkSmartPointer.h.

template<class T>

T* vtkSmartPointer< T >::GetPointer ( ) const

inline

Get the contained pointer.

Definition at line 75 of file vtkSmartPointer.h.

template<class T>

T* vtkSmartPointer< T >::Get ( ) const

inline

Get the contained pointer.

Definition at line 79 of file vtkSmartPointer.h.

template<class T>

vtkSmartPointer< T >::operator T * ( ) const

inline

Get the contained pointer.

Definition at line 87 of file vtkSmartPointer.h.

template<class T>

T& vtkSmartPointer< T >::operator* ( ) const

inline

Dereference the pointer and return a reference to the contained object.

Definition at line 96 of file vtkSmartPointer.h.

template<class T>

T* vtkSmartPointer< T >::operator-> ( ) const

inline

Provides normal pointer target member access using operator ->.

Definition at line 104 of file vtkSmartPointer.h.

template<class T>

void vtkSmartPointer< T >::TakeReference ( T * t )

inline

Transfer ownership of one reference to the given VTK object to this smart pointer. This does not increment the reference count of the object, but will decrement it later. The caller is effectively passing ownership of one reference to the smart pointer. This is useful for code like: vtkSmartPointer<vtkFoo> foo; foo.TakeReference(bar->NewFoo()); The input argument may not be another smart pointer.

Definition at line 118 of file vtkSmartPointer.h.

template<class T>

static vtkSmartPointer<T> vtkSmartPointer< T >::New ( )

inlinestatic

Create an instance of a VTK object.

Definition at line 126 of file vtkSmartPointer.h.

template<class T>

static vtkSmartPointer<T> vtkSmartPointer< T >::NewInstance ( T * t )

inlinestatic

Create a new instance of the given VTK object.

Definition at line 134 of file vtkSmartPointer.h.

template<class T>

static vtkSmartPointer<T> vtkSmartPointer< T >::Take ( T * t )

inlinestatic

Transfer ownership of one reference to the given VTK object to a new smart pointer. The returned smart pointer does not increment the reference count of the object on construction but will decrement it on destruction. The caller is effectively passing ownership of one reference to the smart pointer. This is useful for code like: vtkSmartPointer<vtkFoo> foo = vtkSmartPointer<vtkFoo>::Take(bar->NewFoo()); The input argument may not be another smart pointer.

Definition at line 149 of file vtkSmartPointer.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Core/vtkSmartPointer.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class T> class vtkSmartPointer< T >

Constructor & Destructor Documentation

Member Function Documentation

template<class T>
class vtkSmartPointer< T >