#include <itkAutoPointer.h>
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 |
using itk::AutoPointer< TObjectType >::ObjectType = TObjectType |
Extract information from template parameter.
Definition at line 50 of file itkAutoPointer.h.
using itk::AutoPointer< TObjectType >::Self = AutoPointer |
Definition at line 51 of file itkAutoPointer.h.
|
inline |
Constructor.
Definition at line 54 of file itkAutoPointer.h.
Referenced by itk::AutoPointer< const Self >::operator=().
|
inlineexplicit |
Copy constructor.
Definition at line 59 of file itkAutoPointer.h.
|
inlineexplicit |
Constructor to pointer p.
Definition at line 67 of file itkAutoPointer.h.
|
inline |
Destructor.
Definition at line 73 of file itkAutoPointer.h.
|
inline |
Access function to pointer.
Definition at line 154 of file itkAutoPointer.h.
|
inline |
Query for the ownership
Definition at line 128 of file itkAutoPointer.h.
Referenced by itk::AutoPointer< const Self >::AutoPointer(), and itk::operator<<().
itk::AutoPointer< TObjectType >::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION | ( | Self | ) |
|
inline |
Casting operator to boolean. This is used in conditional statements to check the content of the pointer against null
Definition at line 206 of file itkAutoPointer.h.
|
inline |
Overload operator ->.
Definition at line 77 of file itkAutoPointer.h.
|
inline |
Comparison of pointers. Less than comparison.
Definition at line 169 of file itkAutoPointer.h.
|
inline |
Comparison of pointers. Less than or equal to comparison.
Definition at line 183 of file itkAutoPointer.h.
|
inline |
Overload operator assignment.
Definition at line 198 of file itkAutoPointer.h.
|
inline |
Comparison of pointers. Equal comparison.
Definition at line 161 of file itkAutoPointer.h.
|
inline |
Comparison of pointers. Greater than comparison.
Definition at line 177 of file itkAutoPointer.h.
|
inline |
Comparison of pointers. Greater than or equal to comparison.
Definition at line 191 of file itkAutoPointer.h.
|
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 146 of file itkAutoPointer.h.
Referenced by itk::AutoPointer< const Self >::AutoPointer().
|
inline |
Clear the AutoPointer. If it had a pointer the object is deleted and the pointer is set to null.
Definition at line 85 of file itkAutoPointer.h.
Referenced by itk::AutoPointer< const Self >::~AutoPointer().
|
inlineprivatenoexcept |
Function to print object pointed to. Exchange the content of two AutoPointers
Definition at line 221 of file itkAutoPointer.h.
Referenced by itk::AutoPointer< const Self >::operator=().
|
inline |
Explicitly reject ownership
Definition at line 116 of file itkAutoPointer.h.
|
inline |
Explicitly set the ownership
Definition at line 97 of file itkAutoPointer.h.
|
inline |
Explicitly set the ownership
Definition at line 104 of file itkAutoPointer.h.
|
private |
Definition at line 231 of file itkAutoPointer.h.
|
private |
The pointer to the object referred to by this smart pointer.
Definition at line 230 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>=().