Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/modules/notifications/NotificationManager.h @ 7342

Last change on this file since 7342 was 7164, checked in by dafrick, 14 years ago

Moving notifications to own module.

  • Property svn:eol-style set to native
File size: 5.3 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
31    @brief Definition of the NotificationManager class.
32*/
33
34#ifndef _NotificationManager_H__
35#define _NotificationManager_H__
36
37#include "notifications/NotificationsPrereqs.h"
38
39#include <ctime>
40#include <map>
41#include <string>
42
43#include "util/Singleton.h"
44#include "core/OrxonoxClass.h"
45
46namespace orxonox
47{
48    /**
49    @brief
50        The Singleton NotificationManager functions as a gateway between Notifications and NotificationListeners.
51        It receives, organizes Notifications and the redistributes them to the specific NotificationListeners.
52    @author
53        Damian 'Mozork' Frick
54    */
55    class _NotificationsExport NotificationManager : public Singleton<NotificationManager>, public OrxonoxClass
56    {
57            friend class Singleton<NotificationManager>;
58        public:
59            NotificationManager();
60            virtual ~NotificationManager();
61
62            static const std::string ALL; //!< Static string to indicate a sender that sends to all NotificationListeners.
63            static const std::string NONE; //!< Static string to indicare a sender that sends to no specific NotificationListener.
64
65            bool registerNotification(Notification* notification); //!< Registers a Notification within the NotificationManager.
66            void unregisterNotification(Notification* notification, NotificationListener* listener); //!< Unregisters a Notification within the NotificationManager.
67            bool registerListener(NotificationListener* listener); //!< Registers a NotificationListener within the NotificationManager.
68            void unregisterListener(NotificationListener* listener); //!< Unregisters a NotificationListener withing the NotificationManager.
69
70            bool getNotifications(NotificationListener* listener, std::multimap<std::time_t,Notification*>* map, const std::time_t & timeFrameStart, const std::time_t & timeFrameEnd); //!< Returns the Notifications for a specific NotificationListener in a specified timeframe.
71
72            /**
73            @brief Fetches the Notifications for a specific NotificationListener starting at a specified time.
74            @param listener The NotificationListener the Notifications are fetched for.
75            @param map A multimap, in which the notifications are stored.
76            @param timeFrameStart The start time the Notifications are fetched from.
77            @return Returns true if successful.
78            */
79            bool getNotifications(NotificationListener* listener, std::multimap<std::time_t,Notification*>* map, const std::time_t & timeFrameStart)
80                { return this->getNotifications(listener, map, timeFrameStart, std::time(0)); }
81            /**
82            @brief Fetches the Notifications for a specific NotificationListener starting at a specified timespan before now.
83            @param listener The NotificationListener the Notifications are fetched for.
84            @param map A multimap, in which the notifications are stored.
85            @param timeDelay The timespan.
86            @return Returns true if successful.
87            */
88            bool getNotifications(NotificationListener* listener, std::multimap<std::time_t,Notification*>* map, int timeDelay)
89                { return this->getNotifications(listener, map, std::time(0)-timeDelay, std::time(0)); }
90
91        private:
92            static NotificationManager* singletonPtr_s;
93
94            int highestIndex_; //!< This variable holds the highest index (resp. key) in notificationLists_s, to secure that no key appears twice.
95
96            std::multimap<std::time_t,Notification*> allNotificationsList_; //!< Container where all notifications are stored.
97            std::map<NotificationListener*,int> listenerList_; //!< Container where all NotificationListeners are stored with a number as identifier.
98            std::map<int,std::multimap<std::time_t,Notification*>*> notificationLists_; //!< Container where all Notifications, for each identifier (associated with a NotificationListener), are stored.
99            std::map<Notification*, unsigned int> listenerCounter_; //!< A container to store the number of NotificationListeners a Notification is registered with.
100
101            bool removeNotification(Notification* notification, std::multimap<std::time_t, Notification*>& map); //!< Helper method that removes an input notification form an input map.
102
103    };
104
105}
106
107#endif /* _NotificationManager_H__ */
Note: See TracBrowser for help on using the repository browser.