Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/presentation2/src/libraries/util/Singleton.h @ 6634

Last change on this file since 6634 was 6183, checked in by rgrieder, 15 years ago

Added preUpdate and postUpdate methods for all classes inheriting Singleton. Replaced update() with preUpdate except for the GraphicsManager (postUpdate).
However this does not apply to the Client and Server singletons in the network library. We should think about putting them in a scope as well.

  • Property svn:eol-style set to native
File size: 2.6 KB
Line 
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"
33#include <cassert>
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
43        MyClass::singletonPtr_s.
44        This can easily be done with a friend declaration.
45    */
46    template <class T>
47    class Singleton
48    {
49    public:
50        //! Returns a reference to the singleton instance
51        static T& getInstance()
52        {
53            assert(T::singletonPtr_s != 0);
54            return *T::singletonPtr_s;
55        }
56
57        //! Update method called by ClassSingletonManager (if used)
58        void preUpdateSingleton(const Clock& time) { static_cast<T*>(T::singletonPtr_s)->preUpdate(time); }
59        //! Empty update method for the static polymorphism
60        void preUpdate(const Clock& time) { }
61        //! Update method called by ClassSingletonManager (if used)
62        void postUpdateSingleton(const Clock& time) { static_cast<T*>(T::singletonPtr_s)->postUpdate(time); }
63        //! Empty update method for the static polymorphism
64        void postUpdate(const Clock& time) { }
65
66    protected:
67        //! Constructor sets the singleton instance pointer
68        Singleton()
69        {
70            assert(T::singletonPtr_s == 0);
71            T::singletonPtr_s = static_cast<T*>(this);
72        }
73
74        //! Constructor resets the singleton instance pointer
75        ~Singleton()
76        {
77            assert(T::singletonPtr_s != 0);
78            T::singletonPtr_s = 0;
79        }
80
81    private:
82        Singleton(const Singleton& rhs); //!< Don't use (undefined)
83    };
84}
85
86#endif /* __Util_Singleton_H__ */
Note: See TracBrowser for help on using the repository browser.