Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/archive/toonshader/src/orxonox/overlays/notifications/NotificationManager.h @ 10739

Last change on this file since 10739 was 2911, checked in by landauf, 16 years ago

Merged r1-2096 of questsystem5 back to trunk

I hope there weren't more "hidden merge changes" in r2909 than the one in OverlayGroup (removeElement) (and related to this the adjustments in NotificationQueue).

The corresponding media commit seems not yet to be done, but it doesn't break the build.

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