#include <itkAutoPointer.h>
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 45 of file itkAutoPointer.h.
Public Types | |
| typedef TObjectType | ObjectType |
| typedef AutoPointer | Self |
Public Member Functions | |
| AutoPointer (ObjectType *p, bool takeOwnership) | |
| AutoPointer () | |
| 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 & | operator= (AutoPointer &r) const |
| ObjectType * | Print (std::ostream &os) const |
| ObjectType * | ReleaseOwnership (void) |
| void | Reset (void) |
| void | TakeNoOwnership (ObjectType *objectptr) |
| void | TakeOwnership (ObjectType *objectptr) |
| typedef TObjectType itk::AutoPointer< TObjectType >::ObjectType |
Extract information from template parameter.
Definition at line 49 of file itkAutoPointer.h.
| typedef AutoPointer itk::AutoPointer< TObjectType >::Self |
Definition at line 50 of file itkAutoPointer.h.
| itk::AutoPointer< TObjectType >::AutoPointer | ( | ) | [inline] |
Constructor.
Definition at line 53 of file itkAutoPointer.h.
| itk::AutoPointer< TObjectType >::AutoPointer | ( | AutoPointer< TObjectType > & | p | ) | [inline, explicit] |
Copy constructor.
Definition at line 57 of file itkAutoPointer.h.
References itk::AutoPointer< TObjectType >::IsOwner(), and itk::AutoPointer< TObjectType >::ReleaseOwnership().
| itk::AutoPointer< TObjectType >::AutoPointer | ( | ObjectType * | p, | |
| bool | takeOwnership | |||
| ) | [inline, explicit] |
Constructor to pointer p.
Definition at line 66 of file itkAutoPointer.h.
| itk::AutoPointer< TObjectType >::~AutoPointer | ( | ) | [inline] |
Destructor.
Definition at line 71 of file itkAutoPointer.h.
| itk::AutoPointer< TObjectType >::AutoPointer | ( | AutoPointer< TObjectType > & | p | ) | [inline, explicit] |
Copy constructor.
Definition at line 57 of file itkAutoPointer.h.
References itk::AutoPointer< TObjectType >::IsOwner(), and itk::AutoPointer< TObjectType >::ReleaseOwnership().
| itk::AutoPointer< TObjectType >::~AutoPointer | ( | ) | [inline] |
Destructor.
Definition at line 71 of file itkAutoPointer.h.
| ObjectType* itk::AutoPointer< TObjectType >::GetPointer | ( | ) | const [inline] |
Access function to pointer.
Definition at line 152 of file itkAutoPointer.h.
| bool itk::AutoPointer< TObjectType >::IsOwner | ( | void | ) | const [inline] |
Query for the ownership
Definition at line 129 of file itkAutoPointer.h.
Referenced by itk::AutoPointer< TObjectType >::AutoPointer().
| 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.
References NULL.
| bool itk::AutoPointer< TObjectType >::operator!= | ( | const AutoPointer< TObjectType > & | r | ) | const [inline] |
Comparison of pointers. NonEqual comparison.
Definition at line 160 of file itkAutoPointer.h.
References itk::AutoPointer< TObjectType >::m_Pointer.
| ObjectType* itk::AutoPointer< TObjectType >::operator-> | ( | ) | const [inline] |
Overload operator ->.
Definition at line 83 of file itkAutoPointer.h.
| 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.
References itk::AutoPointer< TObjectType >::m_Pointer.
| 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.
References itk::AutoPointer< TObjectType >::m_Pointer.
| AutoPointer& itk::AutoPointer< TObjectType >::operator= | ( | AutoPointer< TObjectType > & | r | ) | const [inline] |
Overload operator assignment.
Definition at line 180 of file itkAutoPointer.h.
| bool itk::AutoPointer< TObjectType >::operator== | ( | const AutoPointer< TObjectType > & | r | ) | const [inline] |
Comparison of pointers. Equal comparison.
Definition at line 156 of file itkAutoPointer.h.
References itk::AutoPointer< TObjectType >::m_Pointer.
| 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.
References itk::AutoPointer< TObjectType >::m_Pointer.
| 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.
References itk::AutoPointer< TObjectType >::m_Pointer.
| ObjectType* itk::AutoPointer< TObjectType >::Print | ( | std::ostream & | os | ) | const [inline] |
Function to print object pointed to.
Definition at line 193 of file itkAutoPointer.h.
| 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< TObjectType >::AutoPointer().
| 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 88 of file itkAutoPointer.h.
| void itk::AutoPointer< TObjectType >::TakeNoOwnership | ( | ObjectType * | objectptr | ) | [inline] |
Explicitly reject ownership
Definition at line 117 of file itkAutoPointer.h.
| void itk::AutoPointer< TObjectType >::TakeOwnership | ( | ObjectType * | objectptr | ) | [inline] |
Explicitly set the ownership
Definition at line 105 of file itkAutoPointer.h.
| void itk::AutoPointer< TObjectType >::TakeOwnership | ( | void | ) | [inline] |
Explicitly set the ownership
Definition at line 101 of file itkAutoPointer.h.
1.5.1 written by Dimitri van Heesch,
© 1997-2000