coil::Singleton< SingletonClass > Class Template Reference

Singleton template class. More...

#include <Singleton.h>

Collaboration diagram for coil::Singleton< SingletonClass >:

Public Types
typedef SingletonClass *	SingletonClassPtr
typedef ::coil::Mutex	Mutex

Static Public Member Functions
static SingletonClass &	instance ()
	Create instance. More...

Protected Member Functions
	Singleton ()
	Constructor. More...
	~Singleton ()
	Destructor. More...

Static Protected Attributes
static coil::Mutex	m_mutex
	Mutual exclusion object. More...
static SingletonClass *	m_instance
	SingletonClass object. More...

Detailed Description

template<class SingletonClass>
class coil::Singleton< SingletonClass >

Singleton template class.

This class template makes any classed into Singleton classes. Usage is as follows.

class A { // }; typedef coil::Singleton<A> A_;

In the any places, A& a(A_:instance()); // a has singular instance of A

Since the constructor of A is still public, however, user can create other instance of A as follows.

A* a = new A();

If you want to prohibit user from creating new instance, please inherit Singleton class (CRTP) and declare it as a friend class in the target class.

class A : public coil::Singleton<A> { public: private: A(){}

friend class coil::Singelton<A>; };

A* a = new A(); // compile error A& a(A::instance()); // This is the only method to get unique instance

Member Typedef Documentation

template<class SingletonClass>

typedef ::coil::Mutex coil::Singleton< SingletonClass >::Mutex

template<class SingletonClass>

typedef SingletonClass* coil::Singleton< SingletonClass >::SingletonClassPtr

Constructor & Destructor Documentation

template<class SingletonClass>

coil::Singleton< SingletonClass >::Singleton ( )

inlineprotected

Constructor.

Constructor

Referenced by coil::Singleton< LocalServiceAdmin >::~Singleton().

template<class SingletonClass>

coil::Singleton< SingletonClass >::~Singleton ( )

inlineprotected

Destructor.

Destructor

Member Function Documentation

template<class SingletonClass>

static SingletonClass& coil::Singleton< SingletonClass >::instance ( )

inlinestatic

Create instance.

Create instance.

Returns

Instances

Member Data Documentation

template<class SingletonClass>

Singleton< SingletonClass >::SingletonClassPtr coil::Singleton< SingletonClass >::m_instance

staticprotected

SingletonClass object.

Referenced by coil::Singleton< LocalServiceAdmin >::instance().

template<class SingletonClass>

Singleton< SingletonClass >::Mutex coil::Singleton< SingletonClass >::m_mutex

staticprotected

Mutual exclusion object.

Referenced by coil::Singleton< LocalServiceAdmin >::instance().

---

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

• /home/openrtm/doc-build/OpenRTM-aist-1.2.1/src/lib/coil/include/coil/Singleton.h