Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/util/Singleton.h @ 6858

Last change on this file since 6858 was 6751, checked in by rgrieder, 15 years ago

Removed FORCEINLINE from Singleton.h: There seems to be unexpected problems when a Singleton fails to load.

  • Property svn:eol-style set to native
File size: 2.8 KB
RevLine 
[3364]1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Reto Grieder
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef __Util_Singleton_H__
30#define __Util_Singleton_H__
31
32#include "UtilPrereqs.h"
[3367]33#include <cassert>
[3364]34
35namespace orxonox
36{
37    /**
38    @brief
39        Base for singleton classes.
40
41        Usage:
42        Inherit publicly from Singleton<MyClass> and provide access to
[3366]43        MyClass::singletonPtr_s.
44        This can easily be done with a friend declaration.
[3364]45    */
46    template <class T>
47    class Singleton
48    {
49    public:
50        //! Returns a reference to the singleton instance
[6751]51        static T& getInstance()
[3364]52        {
[6536]53            assert(T::singletonPtr_s != NULL);
[3366]54            return *T::singletonPtr_s;
[3364]55        }
56
[6536]57        //! Tells whether the singleton has been created
[6751]58        static bool exists()
[6536]59        {
60            return (T::singletonPtr_s != NULL);
61        }
62
[5929]63        //! Update method called by ClassSingletonManager (if used)
[6751]64        void preUpdateSingleton(const Clock& time) { static_cast<T*>(T::singletonPtr_s)->preUpdate(time); }
[5929]65        //! Empty update method for the static polymorphism
[6751]66        void preUpdate(const Clock& time) { }
[6417]67        //! Update method called by ClassSingletonManager (if used)
[6751]68        void postUpdateSingleton(const Clock& time) { static_cast<T*>(T::singletonPtr_s)->postUpdate(time); }
[6417]69        //! Empty update method for the static polymorphism
[6751]70        void postUpdate(const Clock& time) { }
[5929]71
[3364]72    protected:
[3366]73        //! Constructor sets the singleton instance pointer
[3364]74        Singleton()
75        {
[6536]76            assert(T::singletonPtr_s == NULL);
[3366]77            T::singletonPtr_s = static_cast<T*>(this);
[3364]78        }
[3366]79
80        //! Constructor resets the singleton instance pointer
[3364]81        ~Singleton()
82        {
[6536]83            assert(T::singletonPtr_s != NULL);
84            T::singletonPtr_s = NULL;
[3364]85        }
86
87    private:
88        Singleton(const Singleton& rhs); //!< Don't use (undefined)
89    };
90}
91
92#endif /* __Util_Singleton_H__ */
Note: See TracBrowser for help on using the repository browser.