#include <itkAutoPointer.h>

Detailed Description

template<typename 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 assignment operator is used. An AutoPointer can release ownership of the object it holds.

This class follows the design of the std::unique_ptr (auto_ptr being deprecated in C++11) 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.

Public Types
using	ObjectType = TObjectType

using	Self = AutoPointer

Public Member Functions
	AutoPointer ()

	AutoPointer (AutoPointer &p)

	AutoPointer (ObjectType *p, bool takeOwnership)

ObjectType *	GetPointer () const

bool	IsOwner () const

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)

	operator bool () const

ObjectType *	operator-> () const

bool	operator< (const AutoPointer &r) const

bool	operator<= (const AutoPointer &r) const

AutoPointer &	operator= (AutoPointer &r)

bool	operator== (const AutoPointer &r) const

bool	operator> (const AutoPointer &r) const

bool	operator>= (const AutoPointer &r) const

ObjectType *	ReleaseOwnership ()

void	Reset ()

void	TakeNoOwnership (ObjectType *objectptr)

void	TakeOwnership ()

void	TakeOwnership (ObjectType *objectptr)

	~AutoPointer ()

Private Member Functions
void	Swap (AutoPointer &r) noexcept

Private Attributes
bool	m_IsOwner { false }

ObjectType *	m_Pointer

Member Typedef Documentation

◆ ObjectType

template<typename TObjectType>

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

Extract information from template parameter.

Definition at line 50 of file itkAutoPointer.h.

◆ Self

template<typename TObjectType>

using itk::AutoPointer< TObjectType >::Self = AutoPointer

Definition at line 51 of file itkAutoPointer.h.

Constructor & Destructor Documentation

◆ AutoPointer() [1/3]

template<typename TObjectType>

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

inline

Constructor.

Definition at line 54 of file itkAutoPointer.h.

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

◆ AutoPointer() [2/3]

template<typename TObjectType>

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

inlineexplicit

Copy constructor.

Definition at line 59 of file itkAutoPointer.h.

◆ AutoPointer() [3/3]

template<typename TObjectType>

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

inlineexplicit

Constructor to pointer p.

Definition at line 65 of file itkAutoPointer.h.

◆ ~AutoPointer()

template<typename TObjectType>

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

inline

Destructor.

Definition at line 71 of file itkAutoPointer.h.

Member Function Documentation

◆ GetPointer()

template<typename TObjectType>

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

inlinenodiscard

Access function to pointer.

Definition at line 152 of file itkAutoPointer.h.

◆ IsOwner()

template<typename TObjectType>

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

inlinenodiscard

Query for the ownership

Definition at line 126 of file itkAutoPointer.h.

Referenced by itk::operator<<().

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION()

template<typename TObjectType>

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

◆ operator bool()

template<typename TObjectType>

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

inline

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

Definition at line 204 of file itkAutoPointer.h.

◆ operator->()

template<typename TObjectType>

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

inline

Overload operator ->.

Definition at line 75 of file itkAutoPointer.h.

◆ operator<()

template<typename TObjectType>

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

inline

Comparison of pointers. Less than comparison.

Definition at line 167 of file itkAutoPointer.h.

◆ operator<=()

template<typename TObjectType>

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

inline

Comparison of pointers. Less than or equal to comparison.

Definition at line 181 of file itkAutoPointer.h.

◆ operator=()

template<typename TObjectType>

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

inline

Overload operator assignment.

Definition at line 196 of file itkAutoPointer.h.

◆ operator==()

template<typename TObjectType>

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

inline

Comparison of pointers. Equal comparison.

Definition at line 159 of file itkAutoPointer.h.

◆ operator>()

template<typename TObjectType>

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

inline

Comparison of pointers. Greater than comparison.

Definition at line 175 of file itkAutoPointer.h.

◆ operator>=()

template<typename TObjectType>

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

inline

Comparison of pointers. Greater than or equal to comparison.

Definition at line 189 of file itkAutoPointer.h.

◆ ReleaseOwnership()

template<typename TObjectType>

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

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.

◆ Reset()

template<typename TObjectType>

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

inline

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

Definition at line 83 of file itkAutoPointer.h.

Referenced by itk::AutoPointer< const Self >::~AutoPointer().

◆ Swap()

template<typename TObjectType>

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

inlineprivatenoexcept

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

Definition at line 219 of file itkAutoPointer.h.

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

◆ TakeNoOwnership()

template<typename TObjectType>

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

inline

Explicitly reject ownership

Definition at line 114 of file itkAutoPointer.h.

◆ TakeOwnership() [1/2]

template<typename TObjectType>

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

inline

Explicitly set the ownership

Definition at line 95 of file itkAutoPointer.h.

◆ TakeOwnership() [2/2]

template<typename TObjectType>

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

inline

Explicitly set the ownership

Definition at line 102 of file itkAutoPointer.h.

Member Data Documentation

◆ m_IsOwner

template<typename TObjectType>

bool itk::AutoPointer< TObjectType >::m_IsOwner { false }

private

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

Definition at line 228 of file itkAutoPointer.h.

◆ m_Pointer

template<typename TObjectType>

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

private

Definition at line 229 of file itkAutoPointer.h.

Referenced by itk::AutoPointer< const Self >::operator<(), itk::AutoPointer< const Self >::operator<=(), itk::AutoPointer< const Self >::operator==(), itk::AutoPointer< const Self >::operator>(), and itk::AutoPointer< const Self >::operator>=().

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

itkAutoPointer.h

Detailed Description

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ ObjectType

◆ Self

Constructor & Destructor Documentation

◆ AutoPointer() [1/3]

◆ AutoPointer() [2/3]

◆ AutoPointer() [3/3]

◆ ~AutoPointer()

Member Function Documentation

◆ GetPointer()

◆ IsOwner()

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION()

◆ operator bool()

◆ operator->()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ ReleaseOwnership()

◆ Reset()

◆ Swap()

◆ TakeNoOwnership()

◆ TakeOwnership() [1/2]

◆ TakeOwnership() [2/2]

Member Data Documentation

◆ m_IsOwner

◆ m_Pointer