Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/notifications/NotificationManager.h @ 8460

Last change on this file since 8460 was 7552, checked in by dafrick, 14 years ago

Resolving some TODOs and doing some additional cleanup. Almost done now…

  • Property svn:eol-style set to native
File size: 6.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 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file NotificationManager.h
31    @brief Definition of the NotificationManager class.
32    @ingroup Notifications
33*/
34
35#ifndef _NotificationManager_H__
36#define _NotificationManager_H__
37
38#include "notifications/NotificationsPrereqs.h"
39
40#include <ctime>
41#include <map>
42#include <string>
43
44#include "util/Singleton.h"
45#include "core/OrxonoxClass.h"
46
47namespace orxonox // tolua_export
48{ // tolua_export
49
50    /**
51    @brief
52        The Singleton NotificationManager functions as a gateway between @ref orxonox::Notification "Notifications" and @ref orxonox::NotificationListener "NotificationListeners".
53        It receives, organizes @ref orxonox::Notification "Notifications" and the redistributes them to the specific @ref orxonox::NotificationListener "NotificationListeners".
54        It also provides a static function to send @ref orxonox::Notification "Notifications" and works as a liaison between the @ref orxonox::NotificationQueue "NotificationQueues" and the GUI that displays notification, called NotificationLayer.
55
56    @author
57        Damian 'Mozork' Frick
58
59    @ingroup Notifications
60    */
61    class _NotificationsExport NotificationManager // tolua_export
62        : public Singleton<NotificationManager>, public OrxonoxClass
63    { // tolua_export
64            friend class Singleton<NotificationManager>;
65        public:
66            NotificationManager();
67            virtual ~NotificationManager();
68
69            virtual void preDestroy(void); //!< Is called before the object is destroyed.
70
71            /**
72            @brief Get the instance of the NotificationManager Singleton.
73            @return Returns a reference to the NotificationManager.
74            */
75            static NotificationManager& getInstance() { return Singleton<NotificationManager>::getInstance(); } // tolua_export
76
77            static const std::string ALL; //!< Static string to indicate a sender that sends to all NotificationListeners.
78            static const std::string NONE; //!< Static string to indicare a sender that sends to no specific NotificationListener.
79
80            //! Sends a Notification with the specified message to the specified client from the specified sender.
81            static void sendNotification(const std::string& message, unsigned int clientId, const std::string& sender = NotificationManager::NONE, bool isLocal = false);
82
83            bool registerNotification(Notification* notification); //!< Registers a Notification within the NotificationManager.
84            void unregisterNotification(Notification* notification, NotificationListener* listener); //!< Unregisters a Notification within the NotificationManager for a given NotificationListener.
85            bool registerListener(NotificationListener* listener); //!< Registers a NotificationListener within the NotificationManager.
86            void unregisterListener(NotificationListener* listener); //!< Unregisters a NotificationListener withing the NotificationManager.
87
88            void getNotifications(NotificationListener* listener, std::multimap<std::time_t, Notification*>* map, const std::time_t & timeFrameStart, const std::time_t & timeFrameEnd); //!< Fetches the Notifications for a specific NotificationListener in a specified timeframe and stores them in the input map.
89
90            /**
91            @brief Fetches the Notifications for a specific NotificationListener in a timeframe from now-timeDelay to now and stores them in the input map.
92            @param listener The NotificationListener the Notifications are fetched for.
93            @param map A pointer to a multimap, in which the notifications are stored. The map needs to have been allocated.
94            @param timeDelay The timespan.
95            @return Returns true if successful.
96            */
97            void getNotifications(NotificationListener* listener, std::multimap<std::time_t, Notification*>* map, int timeDelay)
98                { this->getNotifications(listener, map, std::time(0)-timeDelay, std::time(0)); }
99
100            void enterEditMode(void); //!< Enters the edit mode of the NotificationLayer.
101
102            bool registerQueue(NotificationQueue* queue); //!< Registers a NotificationQueue.
103            void unregisterQueue(NotificationQueue* queue); //!< Unregisters a NotificationQueue.
104
105            // tolua_begin
106            void loadQueues(void); //!< Loads all the NotificationQueues that should exist.
107            void createQueue(const std::string& name); //!< Creates a new NotificationQueue.
108            orxonox::NotificationQueue* getQueue(const std::string & name); //!< Get the NotificationQueue with the input name.
109            // tolua_end
110
111        private:
112            static NotificationManager* singletonPtr_s;
113
114            unsigned int highestIndex_; //!< This variable holds the highest index (resp. key) in notificationLists_s, to secure that no key appears twice.
115
116            std::multimap<std::time_t, Notification*> allNotificationsList_; //!< Container where all Notifications are stored.
117            std::map<NotificationListener*, unsigned int> listenerList_; //!< Container where all NotificationListeners are stored with a number as identifier.
118            std::map<int,std::multimap<std::time_t, Notification*>*> notificationLists_; //!< Container where all Notifications, for each identifier (associated with a NotificationListener), are stored.
119
120            std::map<const std::string, NotificationQueue*> queues_; //!< The list of NotificationQueues created by the NotificationManager.
121
122            bool removeNotification(Notification* notification, std::multimap<std::time_t, Notification*>& map); //!< Helper method that removes an input Notification form an input map.
123
124    }; // tolua_export
125
126} // tolua_export
127
128#endif /* _NotificationManager_H__ */
Note: See TracBrowser for help on using the repository browser.