ucommon
Public Member Functions | Protected Attributes
ucommon::auto_object Class Reference

A general purpose smart pointer helper class. More...

#include <object.h>

Collaboration diagram for ucommon::auto_object:
Collaboration graph
[legend]

Public Member Functions

 auto_object (ObjectProtocol *object)
 Construct an auto-pointer referencing an existing object.
 auto_object (const auto_object &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!= (ObjectProtocol *object) const
 test if the object being referenced is not the same as the object we specify.
void operator= (ObjectProtocol *object)
 Set our pointer to a specific object.
bool operator== (ObjectProtocol *object) const
 test if the object being referenced is the same as the object we specify.
void release (void)
 Manually release the pointer.
 ~auto_object ()
 Delete auto pointer.

Protected Attributes

ObjectProtocolobject

Detailed Description

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.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 132 of file object.h.


Constructor & Destructor Documentation

ucommon::auto_object::auto_object ( ObjectProtocol object)

Construct an auto-pointer referencing an existing object.

Parameters:
objectwe point to.
ucommon::auto_object::auto_object ( const auto_object pointer)

Construct an auto-pointer as a copy of another pointer.

The retention of the object being pointed to will be increased.

Parameters:
pointerwe are a copy of.

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.


Member Function Documentation

ucommon::auto_object::operator bool ( ) const

Test if the pointer is referencing an object.

Returns:
true if the pointer is currently referencing an object.

Test if the pointer is not set.

Returns:
true if the pointer is not referencing anything.

test if the object being referenced is not the same as the object we specify.

Parameters:
objectwe compare to.
Returns:
true if this is not the object our pointer references.
void ucommon::auto_object::operator= ( ObjectProtocol 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.

Parameters:
objectto assign to.
bool ucommon::auto_object::operator== ( ObjectProtocol object) const

test if the object being referenced is the same as the object we specify.

Parameters:
objectwe compare to.
Returns:
true if this is the object our pointer references.

Manually release the pointer.

This reduces the retention level of the object and resets the pointer to point to nobody.


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