UT/UT_SharedPtr.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        UT_IntrusivePtr.h (UT Library, C++)
 *
 * COMMENTS:    A wrapper around boost::shared_ptr.
 *
 */

#ifndef __UT_SHAREDPTR_H_INCLUDED__
#define __UT_SHAREDPTR_H_INCLUDED__

#include <boost/shared_ptr.hpp>

/// @brief Wrapper around boost::shared_ptr
///
/// An shared pointer takes ownership of the object referenced.  The reference
/// counting is done outside the object interface, so the size of a
/// UT_SharedPtr is larger than a vanilla pointer.
///
/// As this is a wrapper around the boost shared pointer template, the type (T)
/// must have a <b>Copy Constructor</b> and a valid <b>Assignment Operator</b>
/// @see UT_IntrusivePtr
template<class T>
class UT_SharedPtr : public boost::shared_ptr<T>
{
public:
    UT_SharedPtr(T *p = 0) : boost::shared_ptr<T>(p)    { }

    /// Convenience method to clear the pointer
    void        clear()         { *this = NULL; }

    /// Steal and take ownership of the data passed in.
    void        steal(T *src)   { reset(src); }
};

#endif // __UT_SHAREDPTR_H_INCLUDED__

---