vtkWeakPointer< T > Class Template Reference

#include <vtkWeakPointer.h>

Inheritance diagram for vtkWeakPointer< T >:

Inheritance graph
[legend]
Collaboration diagram for vtkWeakPointer< T >:

Collaboration graph
[legend]

List of all members.


Detailed Description

template<class T>
class vtkWeakPointer< T >

a weak reference to a vtkObject.

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

Definition at line 30 of file vtkWeakPointer.h.


Public Member Functions

 vtkWeakPointer ()
 vtkWeakPointer (T *r)
 vtkWeakPointer (const vtkWeakPointerBase &r)
vtkWeakPointeroperator= (T *r)
vtkWeakPointeroperator= (const vtkWeakPointerBase &r)
T * GetPointer () const
 operator T * () const
T & operator* () const
T * operator-> () const

Protected Member Functions

 vtkWeakPointer (T *r, const NoReference &n)

Constructor & Destructor Documentation

template<class T>
vtkWeakPointer< T >::vtkWeakPointer (  )  [inline]

Initialize smart pointer to NULL.

Definition at line 34 of file vtkWeakPointer.h.

template<class T>
vtkWeakPointer< T >::vtkWeakPointer ( T *  r  )  [inline]

Initialize smart pointer to given object.

Definition at line 37 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 40 of file vtkWeakPointer.h.

template<class T>
vtkWeakPointer< T >::vtkWeakPointer ( T *  r,
const NoReference n 
) [inline, protected]

Definition at line 116 of file vtkWeakPointer.h.


Member Function Documentation

template<class T>
vtkWeakPointer& vtkWeakPointer< T >::operator= ( T *  r  )  [inline]

Assign object to reference.

Definition at line 44 of file vtkWeakPointer.h.

template<class T>
vtkWeakPointer& vtkWeakPointer< T >::operator= ( const vtkWeakPointerBase r  )  [inline]

Assign object to reference.

Reimplemented from vtkWeakPointerBase.

Definition at line 53 of file vtkWeakPointer.h.

template<class T>
T* vtkWeakPointer< T >::GetPointer (  )  const [inline]

Get the contained pointer.

Reimplemented from vtkWeakPointerBase.

Definition at line 62 of file vtkWeakPointer.h.

template<class T>
vtkWeakPointer< T >::operator T * (  )  const [inline]

Get the contained pointer.

Definition at line 70 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 79 of file vtkWeakPointer.h.

template<class T>
T* vtkWeakPointer< T >::operator-> (  )  const [inline]

Provides normal pointer target member access using operator ->.

Definition at line 87 of file vtkWeakPointer.h.


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

Generated on Sat Dec 27 13:59:08 2008 for VTK by  doxygen 1.5.6