itk::WeakPointer< TObjectType > Class Template Reference

#include <itkWeakPointer.h>

Detailed Description

template<typename 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 44 of file itkWeakPointer.h.

Public Types
using	ObjectType = TObjectType

Public Member Functions
ObjectType *	GetPointer () const
bool	IsNotNull () const
bool	IsNull () const
	operator ObjectType * () const
template<typename R >
bool	operator!= (R r) const
ObjectType *	operator-> () const
bool	operator< (const WeakPointer &r) const
bool	operator<= (const WeakPointer &r) const
template<typename R >
bool	operator== (R r) const
bool	operator> (const WeakPointer &r) const
bool	operator>= (const WeakPointer &r) const
	WeakPointer ()=default
	WeakPointer (ObjectType *p)
	WeakPointer (std::nullptr_t)
ObjectType *	Print (std::ostream &os) const

Private Attributes
ObjectType *	m_Pointer { nullptr }

Member Typedef Documentation

ObjectType

template<typename TObjectType>

using itk::WeakPointer< TObjectType >::ObjectType = TObjectType

Extract information from template parameter.

Definition at line 48 of file itkWeakPointer.h.

Constructor & Destructor Documentation

WeakPointer() [1/3]

template<typename TObjectType>

itk::WeakPointer< TObjectType >::WeakPointer ( )

default

Explicitly-defaulted default-constructor.

Note

The other five "special member functions" (copy-constructor, copy-assignment operator, move-constructor, move-assignment operator, and destructor) are defaulted implicitly, following the C++ "Rule of Zero".

WeakPointer() [2/3]

template<typename TObjectType>

itk::WeakPointer< TObjectType >::WeakPointer ( std::nullptr_t  )

inline

Constructor, converting from nullptr.

Definition at line 58 of file itkWeakPointer.h.

WeakPointer() [3/3]

template<typename TObjectType>

itk::WeakPointer< TObjectType >::WeakPointer ( ObjectType *  p )

inline

Constructor to pointer p.

Definition at line 61 of file itkWeakPointer.h.

Member Function Documentation

GetPointer()

template<typename TObjectType>

ObjectType* itk::WeakPointer< TObjectType >::GetPointer ( ) const

inline

Access function to pointer.

Definition at line 94 of file itkWeakPointer.h.

IsNotNull()

template<typename TObjectType>

bool itk::WeakPointer< TObjectType >::IsNotNull ( ) const

inline

Test if the pointer is not NULL.

Definition at line 101 of file itkWeakPointer.h.

IsNull()

template<typename TObjectType>

bool itk::WeakPointer< TObjectType >::IsNull ( ) const

inline

Test if the pointer is NULL.

Definition at line 108 of file itkWeakPointer.h.

Referenced by itk::WeakPointer< itk::ImageToImageFilter >::Print().

operator ObjectType *()

template<typename TObjectType>

itk::WeakPointer< TObjectType >::operator ObjectType * ( ) const

inline

Return pointer to object.

Definition at line 73 of file itkWeakPointer.h.

operator!=()

template<typename TObjectType>

template<typename R >

bool itk::WeakPointer< TObjectType >::operator!= ( R  r ) const

inline

Definition at line 86 of file itkWeakPointer.h.

operator->()

template<typename TObjectType>

ObjectType* itk::WeakPointer< TObjectType >::operator-> ( ) const

inline

Overload operator ->.

Definition at line 67 of file itkWeakPointer.h.

operator<()

template<typename TObjectType>

bool itk::WeakPointer< TObjectType >::operator< ( const WeakPointer< TObjectType > &  r ) const

inline

Comparison of pointers. Less than comparison.

Definition at line 115 of file itkWeakPointer.h.

operator<=()

template<typename TObjectType>

bool itk::WeakPointer< TObjectType >::operator<= ( const WeakPointer< TObjectType > &  r ) const

inline

Comparison of pointers. Less than or equal to comparison.

Definition at line 129 of file itkWeakPointer.h.

operator==()

template<typename TObjectType>

template<typename R >

bool itk::WeakPointer< TObjectType >::operator== ( R  r ) const

inline

Template comparison operators.

Definition at line 78 of file itkWeakPointer.h.

Referenced by itk::WeakPointer< itk::ImageToImageFilter >::operator!=().

operator>()

template<typename TObjectType>

bool itk::WeakPointer< TObjectType >::operator> ( const WeakPointer< TObjectType > &  r ) const

inline

Comparison of pointers. Greater than comparison.

Definition at line 122 of file itkWeakPointer.h.

operator>=()

template<typename TObjectType>

bool itk::WeakPointer< TObjectType >::operator>= ( const WeakPointer< TObjectType > &  r ) const

inline

Comparison of pointers. Greater than or equal to comparison.

Definition at line 136 of file itkWeakPointer.h.

Print()

template<typename TObjectType>

ObjectType* itk::WeakPointer< TObjectType >::Print ( std::ostream &  os ) const

inline

Function to print object pointed to.

Definition at line 143 of file itkWeakPointer.h.

Referenced by itk::operator<<().

Member Data Documentation

m_Pointer

template<typename TObjectType>

ObjectType* itk::WeakPointer< TObjectType >::m_Pointer { nullptr }

private

The pointer to the object referred to by this smart pointer.

Definition at line 160 of file itkWeakPointer.h.

Referenced by itk::WeakPointer< itk::ImageToImageFilter >::GetPointer(), itk::WeakPointer< itk::ImageToImageFilter >::IsNotNull(), itk::WeakPointer< itk::ImageToImageFilter >::IsNull(), itk::WeakPointer< itk::ImageToImageFilter >::operator ObjectType *(), itk::WeakPointer< itk::ImageToImageFilter >::operator->(), itk::WeakPointer< itk::ImageToImageFilter >::operator<(), itk::WeakPointer< itk::ImageToImageFilter >::operator<=(), itk::WeakPointer< itk::ImageToImageFilter >::operator==(), itk::WeakPointer< itk::ImageToImageFilter >::operator>(), itk::WeakPointer< itk::ImageToImageFilter >::operator>=(), and itk::WeakPointer< itk::ImageToImageFilter >::Print().

---

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

• itkWeakPointer.h