class ref_ptr Reference Counted Pointer Class. More... Definition #include <ref_ptr.hh> Template form ref_ptr<class _Tp> List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

•  ref_ptr (_Tp* __p = 0)
•  ref_ptr (const ref_ptr& __r)
• ref_ptr&  operator= (const ref_ptr& __r)
•  ~ref_ptr ()
• inline _Tp&  operator* () const
• inline _Tp*  operator-> () const
• inline _Tp*  get () const
• inline bool  operator== (const ref_ptr& rp) const
• inline bool  is_empty () const
• inline bool  is_only () const
• bool  at_least (int n) const
• inline void  release () const

Detailed Description

The ref_ptr class is a strong reference class. It maintains a count of how many references to an object exist and releases the memory associated with the object when the reference count reaches zero. The reference pointer can be dereferenced like an ordinary pointer to call methods on the reference counted object.

At the time of writing the only supported memory management is through the new and delete operators. At a future date, this class should support the STL allocator classes or an equivalent to provide greater flexibility.

Construct a reference pointer for object.

Parameters:

p	pointer to object to be reference counted. p must be allocated using operator new as it will be destructed using delete when the reference count reaches zero.

Copy Constructor

Constructs a reference pointer for object. Raises reference count associated with object by 1.

Assignment Operator

Assigns reference pointer to new object.

Destruct reference pointer instance and lower reference count on object being tracked. The object being tracked will be deleted if the reference count falls to zero because of the destruction of the reference pointer.

[const]

Dereference reference counted object.

Returns: reference to object.

[const]

Dereference pointer to refence counted object.

Returns: pointer to object.

[const]

Dereference pointer to refence counted object.

Returns: pointer to object.

[const]

Equality Operator

Returns: true if reference pointers refer to same object.

[const]

Check if reference pointer refers to an object or whether it has been assigned a null object.

Returns: true if reference pointer refers to a null object.

[const]

Returns: true if reference pointer represents only reference to object.

[const]

Parameters:

n	minimum count.

Returns: true if there are at least n references to object.

[const]

Release reference on object. The reference pointers underlying object is set to null, and the former object is destructed if necessary.