Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes | List of all members
Mezzanine::Singleton< Type > Class Template Reference

This is a convenience 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 destructor.
 

Static Public Member Functions

static Type * GetSingletonPtr ()
 Fetches a pointer to the singleton. More...
 
static Boole SingletonValid ()
 Checks to see if the singleton pointer is valid. More...
 

Protected Member Functions

 Singleton ()
 Class constructor.
 
template<>
Network::NetworkManagerSingletonPtr
 
template<>
Graphics::TextureManagerSingletonPtr
 
template<>
Graphics::MeshManagerSingletonPtr
 
template<>
Input::InputManagerSingletonPtr
 
template<>
Audio::AudioManagerSingletonPtr
 
template<>
Resource::ResourceManagerSingletonPtr
 
template<>
UI::UIManagerSingletonPtr
 
template<>
Physics::CollisionShapeManagerSingletonPtr
 
template<>
Graphics::GraphicsManagerSingletonPtr
 
template<>
EntresolSingletonPtr
 
template<>
EventManagerSingletonPtr
 

Static Protected Attributes

static Type * SingletonPtr
 The one and only pointer to the single object. More...
 

Detailed Description

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

This is a convenience 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 97 of file singleton.h.

template<class Type>
static Boole 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 110 of file singleton.h.

Member Data Documentation

template<class Type>
Type* Mezzanine::Singleton< Type >::SingletonPtr
staticprotected

The one and only pointer to the single object.

the base class is

Definition at line 72 of file singleton.h.


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