itk::AutoPointer< TObjectType > Class Template Reference

#include <itkAutoPointer.h>

Inheritance diagram for itk::AutoPointer< TObjectType >:

List of all members.

Public Types
typedef TObjectType	ObjectType
typedef AutoPointer	Self

Public Member Functions
	AutoPointer ()
	AutoPointer (ObjectType *p, bool takeOwnership)
ObjectType *	GetPointer () const
bool	IsOwner (void) const
	operator bool () const
bool	operator!= (const AutoPointer &r) const
ObjectType *	operator-> () const
bool	operator< (const AutoPointer &r) const
bool	operator<= (const AutoPointer &r) const
bool	operator== (const AutoPointer &r) const
bool	operator> (const AutoPointer &r) const
bool	operator>= (const AutoPointer &r) const
void	TakeOwnership (void)
	AutoPointer (AutoPointer &p)
	~AutoPointer ()
void	Reset (void)
void	TakeOwnership (ObjectType *objectptr)
void	TakeNoOwnership (ObjectType *objectptr)
ObjectType *	ReleaseOwnership (void)
AutoPointer &	operator= (AutoPointer &r)

Private Member Functions
void	Swap (AutoPointer &r) throw ( )

Private Attributes
bool	m_IsOwner
ObjectType *	m_Pointer

---

Detailed Description

template<class TObjectType>
class itk::AutoPointer< TObjectType >

Implements an Automatic Pointer to an object.

AutoPointer is intended to facilitate the construction of objects on the fly for those objects that are not to be shared. An AutoPointer destroys its object when it goes out of scope. Ownership of the object is transferred from one AutoPointer to another AutoPointer when the assignement operator is used. An AutoPointer can release ownership of the object it holds.

This class follows the design of the std::auto_ptr class. The main reason for not using the std version is to avoid templated methods, which greatly increase the difficulty of wrapping for Tcl, Python and Java.

Definition at line 46 of file itkAutoPointer.h.

---

Member Typedef Documentation

template<class TObjectType>

typedef TObjectType itk::AutoPointer< TObjectType >::ObjectType

Extract information from template parameter.

Definition at line 50 of file itkAutoPointer.h.

template<class TObjectType>

typedef AutoPointer itk::AutoPointer< TObjectType >::Self

Definition at line 51 of file itkAutoPointer.h.

---

Constructor & Destructor Documentation

template<class TObjectType>

itk::AutoPointer< TObjectType >::AutoPointer ( )

inline

Constructor.

Definition at line 54 of file itkAutoPointer.h.

template<class TObjectType>

itk::AutoPointer< TObjectType >::AutoPointer ( AutoPointer< TObjectType > &  p )

inlineexplicit

Copy constructor.

Definition at line 58 of file itkAutoPointer.h.

template<class TObjectType>

itk::AutoPointer< TObjectType >::AutoPointer ( ObjectType *  p, bool  takeOwnership  )

inlineexplicit

Constructor to pointer p.

Definition at line 67 of file itkAutoPointer.h.

template<class TObjectType>

itk::AutoPointer< TObjectType >::~AutoPointer ( )

inline

Destructor.

Definition at line 72 of file itkAutoPointer.h.

---

Member Function Documentation

template<class TObjectType>

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

inline

Access function to pointer.

Definition at line 152 of file itkAutoPointer.h.

template<class TObjectType>

bool itk::AutoPointer< TObjectType >::IsOwner ( void  ) const

inline

Query for the ownership

Definition at line 129 of file itkAutoPointer.h.

Referenced by itk::AutoPointer< JPEG2000ImageIOInternal >::AutoPointer().

template<class TObjectType>

itk::AutoPointer< TObjectType >::operator bool ( ) const

inline

Casting operator to boolean. This is used in conditional statments to check the content of the pointer against null

Definition at line 189 of file itkAutoPointer.h.

template<class TObjectType>

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

inline

Comparison of pointers. NonEqual comparison.

Definition at line 160 of file itkAutoPointer.h.

template<class TObjectType>

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

inline

Overload operator ->.

Definition at line 84 of file itkAutoPointer.h.

template<class TObjectType>

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

inline

Comparison of pointers. Less than comparison.

Definition at line 164 of file itkAutoPointer.h.

template<class TObjectType>

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

inline

Comparison of pointers. Less than or equal to comparison.

Definition at line 172 of file itkAutoPointer.h.

template<class TObjectType>

AutoPointer& itk::AutoPointer< TObjectType >::operator= ( AutoPointer< TObjectType > &  r )

inline

Overload operator assignment.

Definition at line 180 of file itkAutoPointer.h.

template<class TObjectType>

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

inline

Comparison of pointers. Equal comparison.

Definition at line 156 of file itkAutoPointer.h.

template<class TObjectType>

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

inline

Comparison of pointers. Greater than comparison.

Definition at line 168 of file itkAutoPointer.h.

template<class TObjectType>

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

inline

Comparison of pointers. Greater than or equal to comparison.

Definition at line 176 of file itkAutoPointer.h.

template<class TObjectType>

ObjectType* itk::AutoPointer< TObjectType >::ReleaseOwnership ( void  )

inline

Release the pointer hold by the current AutoPointer and return the raw pointer so it can be hold by another AutoPointer. This operation is intended to be used for facilitating polymorphism.

Example: if class Cow derives from Mammal, AutoPointer<Cow> onecow = new Cow; AutoPointer<Mammal> onemammal = onecow.ReleaseOwnership();

Note that the AutoPointer still points to the object after the ReleaseOwnership operation, but it doesn't own the object any more.

Definition at line 144 of file itkAutoPointer.h.

Referenced by itk::AutoPointer< JPEG2000ImageIOInternal >::AutoPointer().

template<class TObjectType>

void itk::AutoPointer< TObjectType >::Reset ( void  )

inline

Clear the AutoPointer. If it had a pointer the object is deleted and the pointer is set to null.

Definition at line 89 of file itkAutoPointer.h.

template<class TObjectType>

void itk::AutoPointer< TObjectType >::Swap ( AutoPointer< TObjectType > &  r ) throw ( )

inlineprivate

Function to print object pointed to. Exchange the content of two AutoPointers

Definition at line 205 of file itkAutoPointer.h.

Referenced by itk::AutoPointer< JPEG2000ImageIOInternal >::operator=().

template<class TObjectType>

void itk::AutoPointer< TObjectType >::TakeNoOwnership ( ObjectType *  objectptr )

inline

Explicitly reject ownership

Definition at line 117 of file itkAutoPointer.h.

template<class TObjectType>

void itk::AutoPointer< TObjectType >::TakeOwnership ( void  )

inline

Explicitly set the ownership

Definition at line 101 of file itkAutoPointer.h.

template<class TObjectType>

void itk::AutoPointer< TObjectType >::TakeOwnership ( ObjectType *  objectptr )

inline

Explicitly set the ownership

Definition at line 105 of file itkAutoPointer.h.

---

Member Data Documentation

template<class TObjectType>

bool itk::AutoPointer< TObjectType >::m_IsOwner

private

Definition at line 216 of file itkAutoPointer.h.

template<class TObjectType>

ObjectType* itk::AutoPointer< TObjectType >::m_Pointer

private

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

Definition at line 215 of file itkAutoPointer.h.

Referenced by itk::AutoPointer< JPEG2000ImageIOInternal >::operator!=(), itk::AutoPointer< JPEG2000ImageIOInternal >::operator<(), itk::AutoPointer< JPEG2000ImageIOInternal >::operator<=(), itk::AutoPointer< JPEG2000ImageIOInternal >::operator==(), itk::AutoPointer< JPEG2000ImageIOInternal >::operator>(), and itk::AutoPointer< JPEG2000ImageIOInternal >::operator>=().

---

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

• itkAutoPointer.h