A general purpose smart pointer helper class. More...
#include <object.h>
Public Member Functions | |
auto_pointer (Object *object) | |
Construct an auto-pointer referencing an existing object. | |
auto_pointer (const auto_pointer &pointer) | |
Construct an auto-pointer as a copy of another pointer. | |
operator bool () const | |
Test if the pointer is referencing an object. | |
bool | operator! () const |
Test if the pointer is not set. | |
bool | operator!= (Object *object) const |
test if the object being referenced is not the same as the object we specify. | |
void | operator= (Object *object) |
Set our pointer to a specific object. | |
bool | operator== (Object *object) const |
test if the object being referenced is the same as the object we specify. | |
void | release (void) |
Manually release the pointer. | |
~auto_pointer () | |
Delete auto pointer. | |
Protected Attributes | |
Object * | object |
A general purpose smart pointer helper class.
This is particularly useful in conjunction with reference counted objects which can be managed and automatically removed from the heap when they are no longer being referenced by a smart pointer. The smart pointer itself would normally be constructed and initialized as an auto variable in a method call, and will dereference the object when the pointer falls out of scope. This is actually a helper class for the typed pointer template.
Definition at line 193 of file object.h.
ucc::auto_pointer::auto_pointer | ( | Object * | object | ) |
Construct an auto-pointer referencing an existing object.
object | we point to. |
ucc::auto_pointer::auto_pointer | ( | const auto_pointer & | pointer | ) |
Construct an auto-pointer as a copy of another pointer.
The retention of the object being pointed to will be increased.
pointer | we are a copy of. |
ucc::auto_pointer::~auto_pointer | ( | ) |
Delete auto pointer.
When it falls out of scope, the retention of the object it references is reduced. If it falls to zero in a reference counted object, then the object is auto-deleted.
ucc::auto_pointer::operator bool | ( | ) | const |
Test if the pointer is referencing an object.
bool ucc::auto_pointer::operator! | ( | ) | const |
Test if the pointer is not set.
bool ucc::auto_pointer::operator!= | ( | Object * | object | ) | const |
test if the object being referenced is not the same as the object we specify.
object | we compare to. |
void ucc::auto_pointer::operator= | ( | Object * | object | ) |
Set our pointer to a specific object.
If the pointer currently references another object, that object is released. The pointer references our new object and that new object is retained.
object | to assign to. |
bool ucc::auto_pointer::operator== | ( | Object * | object | ) | const |
test if the object being referenced is the same as the object we specify.
object | we compare to. |
void ucc::auto_pointer::release | ( | void | ) |
Manually release the pointer.
This reduces the retention level of the object and resets the pointer to point to nobody.