Orfeo Toolbox  4.0
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
itk::AutoPointer< TObjectType > Class Template Reference

Implements an Automatic Pointer to an object. More...

#include <itkAutoPointer.h>

Public Types

typedef TObjectType ObjectType
 
typedef AutoPointer Self
 

Public Member Functions

 AutoPointer ()
 
 AutoPointer (AutoPointer &p)
 
 AutoPointer (ObjectType *p, bool takeOwnership)
 
 ~AutoPointer ()
 
ObjectTypeGetPointer () const
 
bool IsOwner (void) const
 
 operator bool () const
 
bool operator!= (const AutoPointer &r) const
 
ObjectTypeoperator-> () const
 
bool operator< (const AutoPointer &r) const
 
bool operator<= (const AutoPointer &r) const
 
AutoPointeroperator= (AutoPointer &r)
 
bool operator== (const AutoPointer &r) const
 
bool operator> (const AutoPointer &r) const
 
bool operator>= (const AutoPointer &r) const
 
ObjectTypeReleaseOwnership (void)
 
void Reset (void)
 
void TakeNoOwnership (ObjectType *objectptr)
 
void TakeOwnership (void)
 
void TakeOwnership (ObjectType *objectptr)
 

Private Member Functions

void Swap (AutoPointer &r) throw ( )
 

Private Attributes

bool m_IsOwner
 
ObjectTypem_Pointer
 

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 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<typename TObjectType >
typedef TObjectType itk::AutoPointer< TObjectType >::ObjectType

Extract information from template parameter.

Definition at line 50 of file itkAutoPointer.h.

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

Definition at line 51 of file itkAutoPointer.h.

Constructor & Destructor Documentation

template<typename TObjectType >
itk::AutoPointer< TObjectType >::AutoPointer ( )
inline

Constructor.

Definition at line 54 of file itkAutoPointer.h.

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

template<typename TObjectType >
itk::AutoPointer< TObjectType >::AutoPointer ( AutoPointer< TObjectType > &  p)
inlineexplicit
template<typename TObjectType >
itk::AutoPointer< TObjectType >::AutoPointer ( ObjectType p,
bool  takeOwnership 
)
inlineexplicit

Constructor to pointer p.

Definition at line 66 of file itkAutoPointer.h.

template<typename TObjectType >
itk::AutoPointer< TObjectType >::~AutoPointer ( )
inline

Destructor.

Definition at line 71 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::Reset().

Member Function Documentation

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

Access function to pointer.

Definition at line 141 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_Pointer.

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

Query for the ownership

Definition at line 119 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_IsOwner.

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

template<typename 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 177 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_Pointer, and NULL.

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

Comparison of pointers. NonEqual comparison.

Definition at line 149 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_Pointer.

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

Overload operator ->.

Definition at line 77 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_Pointer.

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

Comparison of pointers. Less than comparison.

Definition at line 153 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_Pointer.

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 161 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_Pointer.

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

Overload operator assignment.

Definition at line 169 of file itkAutoPointer.h.

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

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

Comparison of pointers. Equal comparison.

Definition at line 145 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_Pointer.

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

Comparison of pointers. Greater than comparison.

Definition at line 157 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_Pointer.

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 165 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_Pointer.

template<typename 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 134 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_IsOwner, and itk::AutoPointer< TObjectType >::m_Pointer.

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

template<typename 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 82 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_IsOwner, and itk::AutoPointer< TObjectType >::m_Pointer.

Referenced by itk::AutoPointer< TObjectType >::~AutoPointer().

template<typename 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 193 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_Pointer.

template<typename TObjectType >
void itk::AutoPointer< TObjectType >::TakeNoOwnership ( ObjectType objectptr)
inline

Explicitly reject ownership

Definition at line 108 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_IsOwner, and itk::AutoPointer< TObjectType >::m_Pointer.

template<typename TObjectType >
void itk::AutoPointer< TObjectType >::TakeOwnership ( void  )
inline

Explicitly set the ownership

Definition at line 93 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_IsOwner.

Referenced by itk::QuadEdgeMeshPolygonCell< TCellInterface >::New().

template<typename TObjectType >
void itk::AutoPointer< TObjectType >::TakeOwnership ( ObjectType objectptr)
inline

Explicitly set the ownership

Definition at line 97 of file itkAutoPointer.h.

References itk::AutoPointer< TObjectType >::m_IsOwner, and itk::AutoPointer< TObjectType >::m_Pointer.

Member Data Documentation

template<typename TObjectType >
bool itk::AutoPointer< TObjectType >::m_IsOwner
private
template<typename TObjectType >
ObjectType* itk::AutoPointer< TObjectType >::m_Pointer
private

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

Generated at Sat Mar 8 2014 16:37:40 for Orfeo Toolbox with doxygen 1.8.3.1