Mezzanine::Singleton< Type > Class Template Reference

This is a convenient base class intended to be used with classes that need to be singletons. More...

#include <singleton.h>

Collaboration diagram for Mezzanine::Singleton< Type >:

Public Member Functions
	Singleton ()
	Class constructor.
	~Singleton ()
	Class destructor.

Static Public Member Functions
static Type *	GetSingletonPtr ()
	Fetches a pointer to the singleton. More...
static bool	SingletonValid ()
	Checks to see if the singleton pointer is valid. More...

Protected Member Functions
template<>
Graphics::MeshManager *	SingletonPtr
template<>
Input::InputManager *	SingletonPtr
template<>
Audio::AudioManager *	SingletonPtr
template<>
UI::UIManager *	SingletonPtr
template<>
Graphics::GraphicsManager *	SingletonPtr
template<>
Entresol *	SingletonPtr
template<>
Physics::CollisionShapeManager *	SingletonPtr
template<>
ResourceManager *	SingletonPtr
template<>
EventManager *	SingletonPtr

Static Protected Attributes
static Type *	SingletonPtr

Detailed Description

template<class Type>
class Mezzanine::Singleton< Type >

This is a convenient base class intended to be used with classes that need to be singletons.

This is based on the Ogre Singleton class.

Definition at line 62 of file singleton.h.

Member Function Documentation

template<class Type>

static Type* Mezzanine::Singleton< Type >::GetSingletonPtr ( )

inlinestatic

Fetches a pointer to the singleton.

Returns

Returns a pointer to the type of singleton this is.

Definition at line 91 of file singleton.h.

template<class Type>

static bool Mezzanine::Singleton< Type >::SingletonValid ( )

inlinestatic

Checks to see if the singleton pointer is valid.

Returns

Returns true if the singleton is valid, false otherwise.

Definition at line 101 of file singleton.h.

---

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

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/singleton.h