vtkWeakPointer< T > Class Template Reference

a weak reference to a vtkObject. More...

#include <vtkWeakPointer.h>

Inheritance diagram for vtkWeakPointer< T >:

Collaboration diagram for vtkWeakPointer< T >:

Public Member Functions
	vtkWeakPointer ()
	vtkWeakPointer (T *r)
	vtkWeakPointer (const vtkWeakPointerBase &r)
vtkWeakPointer &	operator= (T *r)
vtkWeakPointer &	operator= (const vtkWeakPointerBase &r)
T *	GetPointer () const
T *	Get () const
	operator T * () const
T &	operator* () const
T *	operator-> () const
Public Member Functions inherited from vtkWeakPointerBase
	vtkWeakPointerBase ()
	vtkWeakPointerBase (vtkObjectBase *r)
	vtkWeakPointerBase (const vtkWeakPointerBase &r)
	~vtkWeakPointerBase ()
vtkWeakPointerBase &	operator= (vtkObjectBase *r)
vtkWeakPointerBase &	operator= (const vtkWeakPointerBase &r)
vtkObjectBase *	GetPointer () const

Protected Member Functions
	vtkWeakPointer (T *r, const NoReference &n)
Protected Member Functions inherited from vtkWeakPointerBase
	vtkWeakPointerBase (vtkObjectBase *r, const NoReference &)

Additional Inherited Members
Protected Attributes inherited from vtkWeakPointerBase
vtkObjectBase *	Object

Detailed Description

template<class T>
class vtkWeakPointer< T >

a weak reference to a vtkObject.

A weak reference to a vtkObject, which means that assigning a vtkObject to the vtkWeakPointer does not affect the reference count of the vtkObject. However, when the vtkObject is destroyed, the vtkWeakPointer gets initialized to NULL, thus avoiding any dangling references.

vtkTable *table = vtkTable::New();
vtkWeakPointer<vtkTable> weakTable = table;

Some time later the table may be deleted, but if it is tested for null then the weak pointer will not leave a dangling pointer.

table->Delete();
if (weakTable)
  {
  // Never executed as the weak table pointer will be null here
  cout << "Number of columns in table: " << weakTable->GetNumberOfColumns()
       << endl;
  }

Tests:

vtkWeakPointer (Tests)

Definition at line 51 of file vtkWeakPointer.h.

Constructor & Destructor Documentation

template<class T>

vtkWeakPointer< T >::vtkWeakPointer ( )

inline

Initialize smart pointer to NULL.

Definition at line 55 of file vtkWeakPointer.h.

template<class T>

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

inline

Initialize smart pointer to given object.

Definition at line 58 of file vtkWeakPointer.h.

template<class T>

vtkWeakPointer< T >::vtkWeakPointer ( const vtkWeakPointerBase &  r )

inline

Initialize smart pointer with the given smart pointer.

Definition at line 61 of file vtkWeakPointer.h.

template<class T>

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

inlineprotected

Definition at line 141 of file vtkWeakPointer.h.

Member Function Documentation

template<class T>

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

inline

Assign object to reference.

Definition at line 65 of file vtkWeakPointer.h.

template<class T>

vtkWeakPointer& vtkWeakPointer< T >::operator= ( const vtkWeakPointerBase &  r )

inline

Assign object to reference.

Definition at line 74 of file vtkWeakPointer.h.

template<class T>

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

inline

Get the contained pointer.

Definition at line 83 of file vtkWeakPointer.h.

template<class T>

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

inline

Get the contained pointer.

Definition at line 87 of file vtkWeakPointer.h.

template<class T>

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

inline

Get the contained pointer.

Definition at line 95 of file vtkWeakPointer.h.

template<class T>

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

inline

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

Definition at line 104 of file vtkWeakPointer.h.

template<class T>

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

inline

Provides normal pointer target member access using operator ->.

Definition at line 112 of file vtkWeakPointer.h.

---

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

• dox/Common/Core/vtkWeakPointer.h