Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 7391 was 7163, checked in by dafrick, 14 years ago

Merged presentation3 branch into trunk.

  • Property svn:eol-style set to native
File size: 2.8 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
34#include <cassert>
35#include <cstring>
36
37namespace orxonox
38{
39    /**
40    @brief
41        Base for singleton classes.
42
43        Usage:
44        Inherit publicly from Singleton<MyClass> and provide access to
45        MyClass::singletonPtr_s.
46        This can easily be done with a friend declaration.
47    */
48    template <class T>
49    class Singleton
50    {
51    public:
52        //! Returns a reference to the singleton instance
53        static T& getInstance()
54        {
55            assert(T::singletonPtr_s != NULL);
56            return *T::singletonPtr_s;
57        }
58
59        //! Tells whether the singleton has been created
60        static bool exists()
61        {
62            return (T::singletonPtr_s != NULL);
63        }
64
65        //! Update method called by ClassSingletonManager (if used)
66        void preUpdateSingleton(const Clock& time) { static_cast<T*>(T::singletonPtr_s)->preUpdate(time); }
67        //! Empty update method for the static polymorphism
68        void preUpdate(const Clock& time) { }
69        //! Update method called by ClassSingletonManager (if used)
70        void postUpdateSingleton(const Clock& time) { static_cast<T*>(T::singletonPtr_s)->postUpdate(time); }
71        //! Empty update method for the static polymorphism
72        void postUpdate(const Clock& time) { }
73
74    protected:
75        //! Constructor sets the singleton instance pointer
76        Singleton()
77        {
78            assert(T::singletonPtr_s == NULL);
79            T::singletonPtr_s = static_cast<T*>(this);
80        }
81
82        //! Constructor resets the singleton instance pointer
83        ~Singleton()
84        {
85            assert(T::singletonPtr_s != NULL);
86            T::singletonPtr_s = NULL;
87        }
88
89    private:
90        Singleton(const Singleton& rhs); //!< Don't use (undefined)
91    };
92}
93
94#endif /* __Util_Singleton_H__ */
Note: See TracBrowser for help on using the repository browser.