Click here to Skip to main content
11,702,890 members (72,746 online)
Click here to Skip to main content

A Singleton Template Class

, 19 Mar 2003 123.8K 1.7K 28
Rate this:
Please Sign up or sign in to vote.
A Singleton Template Class

Introduction

There are times, when you need to have a class which can be instantiated once only. The Singleton Design Pattern provides a solution for such a situation.

There are several possible ways to implement a singleton pattern, but it all pretty much comes down to a class that has a private constructor and a static member function to create and retrieve an instance of the class. My implementation does not differ much from this scenario, with the exception that I created a singleton template class.

So, why a template class?

Well I have searched the Internet for an elegant implementation of a singleton class but I did not really find a solution to my satisfaction. Most classes I found consist of a Singleton base class that you can use to derive your own singleton class from. The problem with most of these classes is the fact that you still have to override the GetInstance function to return a pointer to your derived class. A template base class does not have this limitation as I can return any type of pointer.

How it works

To prevent outside source from creating (or copying) an instance of our singleton class, we need to shield the constructor and copy constructor of the singleton class. Further we need to provide a method to create and retrieve a reference to the singleton object:

static T* Instance()
{
if (m_instance == NULL) m_instance = new T;
            ASSERT(m_instance != NULL);
return m_instance;
};

When this method is called for the first time, it creates an instance of the singleton class, any sequential calls will return a reference to the created class instance. To get a reference to the singleton object, all we have to do is call this method as following:

CMySingleton* mySingleton = CMySingleton::Instance();

That is almost all that there is to it. Next to shielding the constructors, I also shielded the destructor, so the singleton class cannot be deleted by accident. Just call the DestroyInstance() method to destroy the singleton object. However, be careful when to call this method, because after you have called this method, all your class data will be destroyed and a sequential to the Instance() method will create a new instance.

So how do you create a class derived from the singleton template class? Again there is nothing to it. Just include the attached header file and create your object as following:

class CMySingleton : public CSingleton<CMySingleton>
{
    friend CSingleton<CMySingleton>;   
 
       private:      

           CMySingleton();
           ~CMySingleton();
 
    ...
}

Conclusion

This implementation of the Singleton Pattern makes creating your own singleton class incredibly easy. But you do have to be careful when to destroy the singleton class instance. If you find this to be a problem you could consider adding (automatic) reference counting.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Brian van der Beek
Web Developer
Netherlands Netherlands
Brian van der Beek has been working as a software engineer at Philips TASS since 1999. He worked on a Digital Video Broadcasting system based on COM components. After that he has worked on test and factory equipment for DVD+RW drives. And since the last 2 year he is working on firmware for the Philips/BenQ Blu-ray drive.

You may also be interested in...

Comments and Discussions

 
GeneralAnother good link Pin
Peace ON20-Jul-13 8:41
memberPeace ON20-Jul-13 8:41 
QuestionAnother possibility Pin
James_7225-Jul-11 19:03
memberJames_7225-Jul-11 19:03 
GeneralSingleton flawed Pin
Mark Ginnane24-Jul-10 15:03
memberMark Ginnane24-Jul-10 15:03 
GeneralI want to subclass CMySingleton but I'm having problems... Pin
Demented-TED24-Mar-09 19:06
memberDemented-TED24-Mar-09 19:06 
Questionwont compile on vs2005. Pin
miche_mannen26-Sep-07 9:39
membermiche_mannen26-Sep-07 9:39 
Generalimplemetation Pin
Paul the Great18-Sep-07 1:33
memberPaul the Great18-Sep-07 1:33 
GeneralSimilar threadsafe (+older) article: Pin
Paul Evans9-Nov-03 21:51
memberPaul Evans9-Nov-03 21:51 
GeneralYour sample makes you still have to destroy the Singleton. Pin
WREY6-Jul-03 12:01
memberWREY6-Jul-03 12:01 
GeneralRe: You sample makes you still have to destroy the Singleton. Pin
Brian van der Beek6-Jul-03 20:34
memberBrian van der Beek6-Jul-03 20:34 
GeneralRe: Your sample makes you still have to destroy the Singleton. Pin
WREY7-Jul-03 0:34
memberWREY7-Jul-03 0:34 
GeneralArticle updated: Pin
Brian van der Beek20-Mar-03 20:58
memberBrian van der Beek20-Mar-03 20:58 
GeneralDoes not fully implement the singleton pattern I'm afraid Pin
Jörgen Sigvardsson20-Mar-03 13:05
memberJörgen Sigvardsson20-Mar-03 13:05 
GeneralRe: Does not fully implement the singleton pattern I'm afraid Pin
Jim A. Johnson20-Mar-03 13:53
memberJim A. Johnson20-Mar-03 13:53 
GeneralRe: Does not fully implement the singleton pattern I'm afraid Pin
Jörgen Sigvardsson20-Mar-03 22:24
memberJörgen Sigvardsson20-Mar-03 22:24 
GeneralRe: Does not fully implement the singleton pattern I'm afraid Pin
Brian van der Beek20-Mar-03 20:31
memberBrian van der Beek20-Mar-03 20:31 
QuestionUhhhhh? Singleton Template? Pin
Anonymous20-Mar-03 12:37
sussAnonymous20-Mar-03 12:37 
AnswerRe: Uhhhhh? Singleton Template? Pin
Brian van der Beek20-Mar-03 20:14
memberBrian van der Beek20-Mar-03 20:14 
GeneralRe: Uhhhhh? Singleton Template? Pin
Anonymous21-Mar-03 8:16
sussAnonymous21-Mar-03 8:16 
GeneralIf templates are your thing Pin
Barry Lapthorn20-Mar-03 11:58
editorBarry Lapthorn20-Mar-03 11:58 
GeneralRe: If templates are your thing Pin
João Paulo Figueira20-Mar-03 13:02
memberJoão Paulo Figueira20-Mar-03 13:02 
GeneralRe: If templates are your thing Pin
Jörgen Sigvardsson20-Mar-03 13:11
memberJörgen Sigvardsson20-Mar-03 13:11 
GeneralRe: If templates are your thing Pin
Peter Hancock20-Mar-03 13:35
memberPeter Hancock20-Mar-03 13:35 
GeneralRe: If templates are your thing Pin
Brian van der Beek20-Mar-03 20:11
memberBrian van der Beek20-Mar-03 20:11 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.150819.1 | Last Updated 20 Mar 2003
Article Copyright 2003 by Brian van der Beek
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid