A reference to an RCObject which automatically ref() and deref() on creation and destruction. More...
#include <RCObject.h>
Public Member Functions | |
| T * | get () const |
| T & | operator* () const |
| T * | operator-> () const |
| RCPtr & | operator= (const RCPtr &rhs) |
| RCPtr (T *pRef=0) | |
| RCPtr (const RCPtr &from) | |
| T * | refAndGet () const |
| If not null, ref() the object and then return it. More... | |
| ~RCPtr () | |
Detailed Description
template<class T>
class agg_util::RCPtr< T >
A reference to an RCObject which automatically ref() and deref() on creation and destruction.
Use this for temporary references to an RCObject* instead of std::auto_ptr to avoid leaks or double deletion. It is templated to allow RCObject subclass specific pointers.
For example,
RCPtr<RCObject> obj = RCPtr<RCObject>(new RCObject()); // count is now 1. // make a call to add to container that might throw exception. // we assume the container will up the ref() itself on a successful addition. addToContainer(obj.get()); // if previous line exceptions, ~RCPtr will unref() it back to 0, causing it to delete. // if we get here, the object is safely in the container and has been ref() to 2, // so ~RCPtr correctly drops it back to 1.
- Note
- We don't have a class for weak references, so make sure to not generate reference loops with back pointers (circular ref graphs) Back pointers should be raw pointers (until/unless we add weak references) and ref() should only be called when it's a strong reference! (ie one that shares ownership).
Definition at line 279 of file RCObject.h.
Constructor & Destructor Documentation
|
inline |
Definition at line 282 of file RCObject.h.
|
inline |
Definition at line 288 of file RCObject.h.
|
inline |
Definition at line 294 of file RCObject.h.
Member Function Documentation
|
inline |
Definition at line 334 of file RCObject.h.
Referenced by ncml_module::NetcdfElement::getAggMemberDataset(), ncml_module::ScanElement::getDatasetList(), ncml_module::NCMLElement::Factory::makeElement(), and agg_util::WeakRCPtr< agg_util::AggMemberDataset >::WeakRCPtr().
|
inline |
Definition at line 320 of file RCObject.h.
|
inline |
Definition at line 328 of file RCObject.h.
|
inline |
Definition at line 304 of file RCObject.h.
|
inline |
If not null, ref() the object and then return it.
Useful for adding a reference to a container, e.g.:
RCPtr<T> myObj; vector<T> myVecOfObj; myVecOfObj.push_back(myObj.refAndGet());
- Returns
Definition at line 352 of file RCObject.h.
Referenced by ncml_module::ScanElement::getDatasetList().
The documentation for this class was generated from the following file:
