pcce::Singleton< T > Class Template Reference

Singleton template class. More...

#include <Singleton.h>

List of all members.

Static Public Member Functions
static void	Initialize ()
static void	Shutdown ()
static boost::shared_ptr< T >	Get ()
static bool	IsInitialized ()
Static Private Attributes
static boost::shared_ptr< T >	sT
static boost::mutex	sMutex

---

Detailed Description

template<class T>
class pcce::Singleton< T >

Singleton template class.

This is a template class to automatically create thread-safe singletons. T should be a class with a default constructor. Note: While the Singleton class itself is thread-safe, it can make no guarantees about the class it manages. That must be handled seperately.

Definition at line 51 of file Singleton.h.

---

Member Function Documentation

template<class T>

static void pcce::Singleton< T >::Initialize

(

)

[inline, static]

Definition at line 56 of file Singleton.h.

References PCCE_THROW, pcce::Singleton< T >::sMutex, and pcce::Singleton< T >::sT.

                             {
      boost::mutex::scoped_lock lock(sMutex);
      if (sT) {
        PCCE_THROW("Attempt to reinitialize singleton class");
      }
      sT.reset(new T());
    }

template<class T>

static void pcce::Singleton< T >::Shutdown

(

)

[inline, static]

Definition at line 63 of file Singleton.h.

References PCCE_THROW, pcce::Singleton< T >::sMutex, and pcce::Singleton< T >::sT.

                           {
      boost::mutex::scoped_lock lock(sMutex);
      if (!sT) {
        PCCE_THROW("Attempt to shutdown unintialized singleton class");
      }
      if (sT.use_count() != 1) {
        PCCE_THROW("Attempt to shutdown singleton class while still in use");
      }
      sT.reset();
    }

template<class T>

static boost::shared_ptr<T> pcce::Singleton< T >::Get

(

)

[inline, static]

Definition at line 73 of file Singleton.h.

References PCCE_THROW, pcce::Singleton< T >::sMutex, and pcce::Singleton< T >::sT.

Referenced by pcce::EventConnectionManager::AddHandler(), pcce::SoundStream::DoDispatchEvent(), pcce::SoundBuffer::DoDispatchEvent(), pcce::Scene::GetGameObject(), pcce::Protocce::Initialize(), pcce::InputTranslator::ReceiveKeyboardInput(), pcce::InputTranslator::ReceiveMouseButtonInput(), pcce::InputTranslator::ReceiveMouseMoveInput(), pcce::Scene::RemoveEntity(), pcce::Protocce::RunGame(), pcce::SetActiveInputTranslator(), pcce::EventType< pcce::SoundStreamEvent >::sGetEventType(), pcce::Protocce::Shutdown(), pcce::IThreadedSubSystem::ThreadStart(), pcce::InputSubSystem::vInitialize(), pcce::IResource::~IResource(), pcce::IThreadedSubSystem::~IThreadedSubSystem(), and pcce::Scene::~Scene().

                                    {
      boost::mutex::scoped_lock lock(sMutex);
      if (!sT) {
        PCCE_THROW("Attempt to use unintialized singleton class");
      }
      return sT;
    }

template<class T>

static bool pcce::Singleton< T >::IsInitialized

(

)

[inline, static]

Definition at line 80 of file Singleton.h.

References pcce::Singleton< T >::sMutex, and pcce::Singleton< T >::sT.

                                {
      boost::mutex::scoped_lock lock(sMutex);
      return sT;
    }

---

Member Data Documentation

template<class T>

boost::shared_ptr< T > pcce::Singleton< T >::sT [inline, static, private]

Definition at line 53 of file Singleton.h.

Referenced by pcce::Singleton< T >::Get(), pcce::Singleton< T >::Initialize(), pcce::Singleton< T >::IsInitialized(), and pcce::Singleton< T >::Shutdown().

template<class T>

boost::mutex pcce::Singleton< T >::sMutex [inline, static, private]

Definition at line 54 of file Singleton.h.

Referenced by pcce::Singleton< T >::Get(), pcce::Singleton< T >::Initialize(), pcce::Singleton< T >::IsInitialized(), and pcce::Singleton< T >::Shutdown().

---

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

• include/Singleton.h