gpucalc::Singleton< T > Class Template Reference

Singleton class. More...

#include <singleton.h>

Inheritance diagram for gpucalc::Singleton< T >:

List of all members.

Public Member Functions
const std::string &	getClassName () const
	Returns name of class of our object.
const std::string &	getObjectName () const
	Returns name of our object.
void	getSpecificParameter (const std::string &ParameterName, void *ParameterValue)
	Method for obtaining some specific parameters, such as texture specific params, and so on.
bool	isLocked () const
	returns state of object.
template<>
Timer *	mSingleton
template<>
Timer *	mSingleton
template<>
Profiler *	mSingleton
template<>
LogManager *	mSingleton
template<>
debugger::Debugger *	mSingleton
template<>
debugger::CommandParser *	mSingleton
template<>
Application *	mSingleton
	Singleton (const std::string &SingletonType)
	~Singleton ()
Static Public Member Functions
static T &	getSingleton ()
	Override standard Singleton retrieval.
static T *	getSingletonPtr ()
Protected Member Functions
void	addSpecificParameter (const std::string &ParameterName, void *ParameterValue, size_t Size)
void	lock ()
void	unlock ()
Static Protected Attributes
static T *	mSingleton

---

Detailed Description

template<typename T>
class gpucalc::Singleton< T >

Singleton class.

Classes inherited from this class has static members getSingleton() and getSingletonPtr() which return reference and pointer to the object of this class. This method is very useful when we need to work with some objects (object A), inside other objects (object B) and we do not want to pass pointer or reference of A inside object B.

Note:

Hmm, maybe i explain this class wrong, correct me if my explanation is incorrect.

Definition at line 54 of file singleton.h.

---

Constructor & Destructor Documentation

template<typename T>

gpucalc::Singleton< T >::Singleton

(

const std::string &

SingletonType

)

[inline]

Definition at line 61 of file singleton.h.

                                             : Object(_SingletonClassName, SingletonType)
   {
    assert(!mSingleton);
    mSingleton = static_cast< T * >(this);
   }

template<typename T>

gpucalc::Singleton< T >::~Singleton

(

)

[inline]

Definition at line 68 of file singleton.h.

   {
    assert(mSingleton);
    mSingleton = 0;
   }

---

Member Function Documentation

void gpucalc::Object::addSpecificParameter	(	const std::string &	ParameterName,
		void *	ParameterValue,
		size_t	Size
	)			[inline, protected, inherited]

Definition at line 254 of file object.h.

   {
    SpecificParametersMap::iterator i = mSpecificParameters.find(ParameterName);
    if (i != mSpecificParameters.end())
    {
     mSpecificParameters.erase(i);
    }
    mSpecificParameters[ParameterName] = Any(ParameterValue, Size);
   }

const std::string& gpucalc::Object::getClassName

(

)

const [inline, inherited]

Returns name of class of our object.

Definition at line 92 of file object.h.

   {
    return mClassName;
   }

const std::string& gpucalc::Object::getObjectName

(

)

const [inline, inherited]

Returns name of our object.

Definition at line 101 of file object.h.

   {
    return mObjectName;
   }

template<typename T>

static T& gpucalc::Singleton< T >::getSingleton

(

)

[inline, static]

Override standard Singleton retrieval.

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented in gpucalc::Application, gpucalc::debugger::CommandParser, gpucalc::debugger::Debugger, gpucalc::LogManager, gpucalc::Profiler, gpucalc::Timer, and gpucalc::Timer.

Definition at line 91 of file singleton.h.

   {
    assert(mSingleton);
    return (* mSingleton);
   }

template<typename T>

static T* gpucalc::Singleton< T >::getSingletonPtr

(

)

[inline, static]

Override standard Singleton retrieval.

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented in gpucalc::Application, gpucalc::debugger::CommandParser, gpucalc::debugger::Debugger, gpucalc::LogManager, gpucalc::Profiler, gpucalc::Timer, and gpucalc::Timer.

Definition at line 101 of file singleton.h.

   {
    return mSingleton;
   }

void gpucalc::Object::getSpecificParameter	(	const std::string &	ParameterName,
		void *	ParameterValue
	)			[inline, inherited]

Method for obtaining some specific parameters, such as texture specific params, and so on.

Parameters:

	ParameterName	- name of parameter, usually it similar to specific method of some object (for example, GLTextureID)
	ParameterValue	- contain value of named parameter, it must be allocated and have sufficient size.

Todo:

Think for better realization.

Definition at line 128 of file object.h.

   {
    SpecificParametersMap::iterator i = mSpecificParameters.find(ParameterName);
    if (i != mSpecificParameters.end())
    {
     i->second.copyValue(ParameterValue);
    }
    else
    {
     Except<ERR_ITEM_NOT_FOUND>(this, "Parameter \"" + ParameterName + "\" does not exists.", "Object::getSpecificParameter()", __FILE__, __LINE__);
    }
   }

bool gpucalc::Object::isLocked

(

)

const [inline, inherited]

returns state of object.

If object is locked then we cannot change some state of it, because object is used in computation. If object is unlocked then we can change some state of it, object is not in computation.

Definition at line 113 of file object.h.

   {
    return mIsLocked;
   }

void gpucalc::Object::lock

(

)

[inline, protected, inherited]

Definition at line 265 of file object.h.

   {
    mIsLocked = true;
   }

template<>

Timer * gpucalc::Singleton< Timer >::mSingleton

(

)

[inline]

Definition at line 42 of file win32_timer_impl.cpp.

template<>

Timer * gpucalc::Singleton< Timer >::mSingleton

(

)

[inline]

Definition at line 45 of file unix_timer_impl.cpp.

template<>

Profiler * gpucalc::Singleton< Profiler >::mSingleton

(

)

[inline]

Definition at line 39 of file profiler.cpp.

template<>

LogManager * gpucalc::Singleton< LogManager >::mSingleton

(

)

[inline]

Definition at line 38 of file log_manager.cpp.

template<>

debugger::Debugger * gpucalc::Singleton< debugger::Debugger >::mSingleton

(

)

[inline]

Definition at line 42 of file debugger.cpp.

template<>

debugger::CommandParser * gpucalc::Singleton< debugger::CommandParser >::mSingleton

(

)

[inline]

Definition at line 41 of file command_parser.cpp.

template<>

Application * gpucalc::Singleton< Application >::mSingleton

(

)

[inline]

Definition at line 44 of file application.cpp.

void gpucalc::Object::unlock

(

)

[inline, protected, inherited]

Definition at line 271 of file object.h.

   {
    mIsLocked = false;
   }

---

Member Data Documentation

template<typename T>

T* gpucalc::Singleton< T >::mSingleton [static, protected]

Definition at line 108 of file singleton.h.

---

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

• gpucalc/singleton.h