Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

Ogre::SharedPtr< T > Class Template Reference

Reference-counted shared pointer, used for objects where implicit destruction is required. More...

#include <OgreSharedPtr.h>

List of all members.

Public Member Functions

OGRE_AUTO_SHARED_MUTEX SharedPtr ()
 Constructor, does not initialise the SharedPtr.
template<class Y>
 SharedPtr (Y *rep, SharedPtrFreeMethod freeMethod=SPFM_DELETE)
 Constructor.
 SharedPtr (const SharedPtr &r)
SharedPtroperator= (const SharedPtr &r)
template<class Y>
 SharedPtr (const SharedPtr< Y > &r)
template<class Y>
SharedPtroperator= (const SharedPtr< Y > &r)
virtual ~SharedPtr ()
T & operator * () const
T * operator-> () const
T * get () const
void bind (T *rep, SharedPtrFreeMethod freeMethod=SPFM_DELETE)
 Binds rep to the SharedPtr.
bool unique () const
unsigned int useCount () const
unsigned int * useCountPointer () const
T * getPointer () const
SharedPtrFreeMethod freeMethod () const
bool isNull (void) const
void setNull (void)

Protected Member Functions

void release (void)
virtual void destroy (void)
virtual void swap (SharedPtr< T > &other)

Protected Attributes

T * pRep
unsigned int * pUseCount
SharedPtrFreeMethod useFreeMethod


Detailed Description

template<class T>
class Ogre::SharedPtr< T >

Reference-counted shared pointer, used for objects where implicit destruction is required.

Remarks:
This is a standard shared pointer implementation which uses a reference count to work out when to delete the object.
If OGRE_THREAD_SUPPORT is defined to be 1, use of this class is thread-safe.

Definition at line 55 of file OgreSharedPtr.h.


Constructor & Destructor Documentation

template<class T>
OGRE_AUTO_SHARED_MUTEX Ogre::SharedPtr< T >::SharedPtr  ) 
 

Constructor, does not initialise the SharedPtr.

Remarks:
Dangerous! You have to call bind() before using the SharedPtr.

Definition at line 67 of file OgreSharedPtr.h.

template<class T>
template<class Y>
Ogre::SharedPtr< T >::SharedPtr Y *  rep,
SharedPtrFreeMethod  freeMethod = SPFM_DELETE
[explicit]
 

Constructor.

Parameters:
rep The pointer to take ownership of
freeMode The mechanism to use to free the pointer

Definition at line 77 of file OgreSharedPtr.h.

template<class T>
Ogre::SharedPtr< T >::SharedPtr const SharedPtr< T > &  r  ) 
 

Definition at line 85 of file OgreSharedPtr.h.

template<class T>
template<class Y>
Ogre::SharedPtr< T >::SharedPtr const SharedPtr< Y > &  r  ) 
 

Definition at line 116 of file OgreSharedPtr.h.

template<class T>
virtual Ogre::SharedPtr< T >::~SharedPtr  )  [virtual]
 

Definition at line 146 of file OgreSharedPtr.h.


Member Function Documentation

template<class T>
void Ogre::SharedPtr< T >::bind T *  rep,
SharedPtrFreeMethod  freeMethod = SPFM_DELETE
 

Binds rep to the SharedPtr.

Remarks:
Assumes that the SharedPtr is uninitialised!

Definition at line 159 of file OgreSharedPtr.h.

template<class T>
virtual void Ogre::SharedPtr< T >::destroy void   )  [protected, virtual]
 

Reimplemented in Ogre::MeshPtr.

Definition at line 215 of file OgreSharedPtr.h.

Referenced by Ogre::SharedPtr< Skeleton >::release().

template<class T>
SharedPtrFreeMethod Ogre::SharedPtr< T >::freeMethod  )  const
 

Definition at line 173 of file OgreSharedPtr.h.

Referenced by Ogre::SharedPtr< Skeleton >::bind(), and Ogre::SharedPtr< Skeleton >::SharedPtr().

template<class T>
T* Ogre::SharedPtr< T >::get void   )  const
 

Definition at line 153 of file OgreSharedPtr.h.

Referenced by Ogre::operator!=(), and Ogre::operator==().

template<class T>
T* Ogre::SharedPtr< T >::getPointer  )  const
 

Definition at line 172 of file OgreSharedPtr.h.

Referenced by Ogre::CompositorPtr::CompositorPtr(), Ogre::FontPtr::FontPtr(), Ogre::GpuProgramPtr::GpuProgramPtr(), Ogre::HighLevelGpuProgramPtr::HighLevelGpuProgramPtr(), Ogre::MaterialPtr::MaterialPtr(), Ogre::PatchMeshPtr::operator=(), Ogre::PatchMeshPtr::PatchMeshPtr(), Ogre::SharedPtr< Skeleton >::SharedPtr(), Ogre::SkeletonPtr::SkeletonPtr(), and Ogre::TexturePtr::TexturePtr().

template<class T>
bool Ogre::SharedPtr< T >::isNull void   )  const
 

Definition at line 175 of file OgreSharedPtr.h.

template<class T>
T& Ogre::SharedPtr< T >::operator *  )  const
 

Definition at line 151 of file OgreSharedPtr.h.

template<class T>
T* Ogre::SharedPtr< T >::operator->  )  const
 

Definition at line 152 of file OgreSharedPtr.h.

template<class T>
template<class Y>
SharedPtr& Ogre::SharedPtr< T >::operator= const SharedPtr< Y > &  r  ) 
 

Definition at line 137 of file OgreSharedPtr.h.

template<class T>
SharedPtr& Ogre::SharedPtr< T >::operator= const SharedPtr< T > &  r  ) 
 

Definition at line 105 of file OgreSharedPtr.h.

template<class T>
void Ogre::SharedPtr< T >::release void   )  [protected]
 

Definition at line 189 of file OgreSharedPtr.h.

Referenced by Ogre::SharedPtr< Skeleton >::setNull(), and Ogre::SharedPtr< Skeleton >::~SharedPtr().

template<class T>
void Ogre::SharedPtr< T >::setNull void   ) 
 

Definition at line 177 of file OgreSharedPtr.h.

template<class T>
virtual void Ogre::SharedPtr< T >::swap SharedPtr< T > &  other  )  [protected, virtual]
 

Definition at line 239 of file OgreSharedPtr.h.

Referenced by Ogre::SharedPtr< Skeleton >::operator=().

template<class T>
bool Ogre::SharedPtr< T >::unique  )  const
 

Definition at line 168 of file OgreSharedPtr.h.

template<class T>
unsigned int Ogre::SharedPtr< T >::useCount  )  const
 

Definition at line 169 of file OgreSharedPtr.h.

template<class T>
unsigned int* Ogre::SharedPtr< T >::useCountPointer  )  const
 

Definition at line 170 of file OgreSharedPtr.h.

Referenced by Ogre::CompositorPtr::CompositorPtr(), Ogre::FontPtr::FontPtr(), Ogre::GpuProgramPtr::GpuProgramPtr(), Ogre::HighLevelGpuProgramPtr::HighLevelGpuProgramPtr(), Ogre::MaterialPtr::MaterialPtr(), Ogre::PatchMeshPtr::operator=(), Ogre::PatchMeshPtr::PatchMeshPtr(), Ogre::SharedPtr< Skeleton >::SharedPtr(), Ogre::SkeletonPtr::SkeletonPtr(), and Ogre::TexturePtr::TexturePtr().


Member Data Documentation

template<class T>
T* Ogre::SharedPtr< T >::pRep [protected]
 

Definition at line 58 of file OgreSharedPtr.h.

Referenced by Ogre::SharedPtr< Skeleton >::bind(), Ogre::SharedPtr< Skeleton >::destroy(), Ogre::SharedPtr< Skeleton >::get(), Ogre::SharedPtr< Skeleton >::getPointer(), Ogre::SharedPtr< Skeleton >::isNull(), Ogre::SharedPtr< Skeleton >::operator *(), Ogre::SharedPtr< Skeleton >::operator->(), Ogre::SharedPtr< Skeleton >::operator=(), Ogre::SharedPtr< Skeleton >::setNull(), Ogre::SharedPtr< Skeleton >::SharedPtr(), and Ogre::SharedPtr< Skeleton >::swap().

template<class T>
unsigned int* Ogre::SharedPtr< T >::pUseCount [protected]
 

Definition at line 59 of file OgreSharedPtr.h.

Referenced by Ogre::SharedPtr< Skeleton >::bind(), Ogre::SharedPtr< Skeleton >::destroy(), Ogre::SharedPtr< Skeleton >::release(), Ogre::SharedPtr< Skeleton >::setNull(), Ogre::SharedPtr< Skeleton >::SharedPtr(), Ogre::SharedPtr< Skeleton >::swap(), Ogre::SharedPtr< Skeleton >::unique(), Ogre::SharedPtr< Skeleton >::useCount(), and Ogre::SharedPtr< Skeleton >::useCountPointer().

template<class T>
SharedPtrFreeMethod Ogre::SharedPtr< T >::useFreeMethod [protected]
 

Definition at line 60 of file OgreSharedPtr.h.

Referenced by Ogre::SharedPtr< Skeleton >::bind(), Ogre::SharedPtr< Skeleton >::destroy(), Ogre::SharedPtr< Skeleton >::freeMethod(), Ogre::SharedPtr< Skeleton >::SharedPtr(), and Ogre::SharedPtr< Skeleton >::swap().


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

Copyright © 2008 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat Apr 11 13:54:25 2009