itk::WeakPointer< TObjectType > Class Template Reference
[ITK System Objects, Data Access Objects]

Implements a weak reference to an object. More...

#include <itkWeakPointer.h>

Collaboration diagram for itk::WeakPointer< TObjectType >:

[legend]List of all members.

Public Types
typedef TObjectType	ObjectType
Public Member Functions
	WeakPointer ()
	WeakPointer (const WeakPointer< ObjectType > &p)
	WeakPointer (ObjectType *p)
	~WeakPointer ()
ObjectType *	operator-> () const
	operator ObjectType * () const
ObjectType *	GetPointer () const
bool	operator< (const WeakPointer &r)
bool	operator> (const WeakPointer &r)
bool	operator<= (const WeakPointer &r)
bool	operator>= (const WeakPointer &r)
WeakPointer &	operator= (const WeakPointer &r)
WeakPointer &	operator= (ObjectType *r)
template<typename R> bool	operator== (R r) const
template<typename R> bool	operator!= (R r) const
ObjectType *	Print (std::ostream &os) const

---

Detailed Description

template<class TObjectType>
class itk::WeakPointer< TObjectType >

Implements a weak reference to an object.

WeakPointer implements a weak reference to an object. A natural interface to the class is defined by operator -> (and *) among others. WeakPointer is really nothing more than a standard pointer. It is used to call attention to the fact that it does not adjust the reference count of an object like SmartPointer does. WeakPointer is used internally to Insight to manage (break) reference counting loops. At some point, an object may keep track of how many objects hold weak references to itself. In all cases, however, an outstanding weak reference will not keep an object from destructing.

Definition at line 43 of file itkWeakPointer.h.

---

Member Typedef Documentation

template<class TObjectType> typedef TObjectType itk::WeakPointer< TObjectType >::ObjectType

Extract information from template parameter. Definition at line 47 of file itkWeakPointer.h.

---

Constructor & Destructor Documentation

template<class TObjectType> itk::WeakPointer< TObjectType >::WeakPointer (   )  [inline]

Constructor. Definition at line 50 of file itkWeakPointer.h.

template<class TObjectType> itk::WeakPointer< TObjectType >::WeakPointer (  const WeakPointer< ObjectType > &  p  )  [inline]

Copy constructor. Definition at line 54 of file itkWeakPointer.h.

template<class TObjectType> itk::WeakPointer< TObjectType >::WeakPointer (  ObjectType *  p  )  [inline]

Constructor to pointer p. Definition at line 58 of file itkWeakPointer.h.

template<class TObjectType> itk::WeakPointer< TObjectType >::~WeakPointer (   )  [inline]

Destructor. Definition at line 62 of file itkWeakPointer.h.

---

Member Function Documentation

template<class TObjectType> ObjectType* itk::WeakPointer< TObjectType >::GetPointer (   )  const [inline]

Access function to pointer. Definition at line 87 of file itkWeakPointer.h. Referenced by itk::WeakPointer< ProcessObject >::operator=(), and itk::SmartPointer< const ImageType >::SmartPointer().

template<class TObjectType> itk::WeakPointer< TObjectType >::operator ObjectType * (   )  const [inline]

Return pointer to object. Definition at line 70 of file itkWeakPointer.h.

template<class TObjectType> template<typename R> bool itk::WeakPointer< TObjectType >::operator!= (  R  r  )  const [inline]

Template comparison operators. Definition at line 80 of file itkWeakPointer.h.

template<class TObjectType> ObjectType* itk::WeakPointer< TObjectType >::operator-> (   )  const [inline]

Overload operator ->. Definition at line 66 of file itkWeakPointer.h.

template<class TObjectType> bool itk::WeakPointer< TObjectType >::operator< (  const WeakPointer< TObjectType > &  r  )  [inline]

Comparison of pointers. Less than comparison. Definition at line 91 of file itkWeakPointer.h.

template<class TObjectType> bool itk::WeakPointer< TObjectType >::operator<= (  const WeakPointer< TObjectType > &  r  )  [inline]

Comparison of pointers. Less than or equal to comparison. Definition at line 99 of file itkWeakPointer.h.

template<class TObjectType> WeakPointer& itk::WeakPointer< TObjectType >::operator= (  ObjectType *  r  )  [inline]

Overload operator assignment. Definition at line 111 of file itkWeakPointer.h.

template<class TObjectType> WeakPointer& itk::WeakPointer< TObjectType >::operator= (  const WeakPointer< TObjectType > &  r  )  [inline]

Overload operator assignment. Definition at line 107 of file itkWeakPointer.h.

template<class TObjectType> template<typename R> bool itk::WeakPointer< TObjectType >::operator== (  R  r  )  const [inline]

Template comparison operators. Definition at line 75 of file itkWeakPointer.h.

template<class TObjectType> bool itk::WeakPointer< TObjectType >::operator> (  const WeakPointer< TObjectType > &  r  )  [inline]

Comparison of pointers. Greater than comparison. Definition at line 95 of file itkWeakPointer.h.

template<class TObjectType> bool itk::WeakPointer< TObjectType >::operator>= (  const WeakPointer< TObjectType > &  r  )  [inline]

Comparison of pointers. Greater than or equal to comparison. Definition at line 103 of file itkWeakPointer.h.

template<class TObjectType> ObjectType* itk::WeakPointer< TObjectType >::Print (  std::ostream &  os  )  const [inline]

Function to print object pointed to. Definition at line 118 of file itkWeakPointer.h.

---

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

• itkWeakPointer.h

---