This is the documentation for Enlighten.
class Geo GeoSingleton
template<typename>
class Geo::GeoSingleton
Inherit from this class to add singleton behaviour to your class.
Variables
| Name | Description |
|---|---|
| tClass * m_Singleton = NULL | Pointer to the singleton instance or NULL if not started. |
Functions
| Name | Description |
|---|---|
| ~GeoSingleton() | Destructor clears singleton pointer. |
| GeoSingleton() | Constructor initialises singleton pointer. |
| Get() | Returns a pointer to the singleton instance. |
| IsAvailable() | Returns true if the singleton is available. |
| Start() | Setup the singleton instance. |
| Stop() | Release the singleton instance. |
Geo::GeoSingleton< tClass >::~GeoSingleton
protected: ~GeoSingleton()
Destructor clears singleton pointer.
Geo::GeoSingleton< tClass >::GeoSingleton
protected: GeoSingleton()
Constructor initialises singleton pointer.
tClass * Geo::GeoSingleton< tClass >::Get
public: tClass * Get()
Returns a pointer to the singleton instance.
bool Geo::GeoSingleton< tClass >::IsAvailable
public: bool IsAvailable()
Returns true if the singleton is available.
bool Geo::GeoSingleton< tClass >::Start
public: bool Start()
Setup the singleton instance.
void Geo::GeoSingleton< tClass >::Stop
public: void Stop()
Release the singleton instance.