Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 6251 was 5929, checked in by rgrieder, 15 years ago

Merged core5 branch back to the trunk.
Key features include clean level unloading and an extended XML event system.

Two important notes:
Delete your keybindings.ini files! * or you will still get parser errors when loading the key bindings.
Delete build_dir/lib/modules/libgamestates.module! * or orxonox won't start.
Best thing to do is to delete the build folder ;)

  • Property svn:eol-style set to native
File size: 4.5 KB
RevLine 
[2280]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
[2911]29/**
[3196]30    @file
[2911]31    @brief Definition of the NotificationManager class.
32*/
33
[2280]34#ifndef _NotificationManager_H__
35#define _NotificationManager_H__
36
[5722]37#include "questsystem/QuestsystemPrereqs.h"
[2280]38
[3196]39#include <ctime>
[2911]40#include <map>
[2280]41#include <string>
[3370]42
[5929]43#include "util/Singleton.h"
[3196]44#include "core/OrxonoxClass.h"
[2280]45
[2435]46namespace orxonox
47{
[2280]48    /**
49    @brief
[5619]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.
[2280]52    @author
53        Damian 'Mozork' Frick
54    */
[5929]55    class _QuestsystemExport NotificationManager : public Singleton<NotificationManager>, public OrxonoxClass
[2280]56    {
[5929]57            friend class Singleton<NotificationManager>;
[2911]58        public:
59            NotificationManager();
60            virtual ~NotificationManager();
[3034]61
[2911]62            static const std::string ALL;
63            static const std::string NONE;
[3034]64
[2911]65            bool registerNotification(Notification* notification); //!< Registers a Notification within the NotificationManager.
[5619]66            bool registerListener(NotificationListener* listener); //!< Registers a NotificationListener within the NotificationManager.
[3034]67
[5619]68            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.
[3034]69
[2911]70            /**
[5619]71            @brief Fetches the Notifications for a specific NotificationListener starting at a specified time.
72            @param listener The NotificationListener the Notifications are fetched for.
[2911]73            @param map A multimap, in which the notifications are stored.
74            @param timeFrameStart The start time the Notifications are fetched from.
75            @return Returns true if successful.
76            */
[5619]77            bool getNotifications(NotificationListener* listener, std::multimap<std::time_t,Notification*>* map, const std::time_t & timeFrameStart)
78                { return this->getNotifications(listener, map, timeFrameStart, std::time(0)); }
[2911]79            /**
[5619]80            @brief Fetches the Notifications for a specific NotificationListener starting at a specified timespan before now.
81            @param listener The NotificationListener the Notifications are fetched for.
[2911]82            @param map A multimap, in which the notifications are stored.
83            @param timeDelay The timespan.
84            @return Returns true if successful.
85            */
[5619]86            bool getNotifications(NotificationListener* listener, std::multimap<std::time_t,Notification*>* map, int timeDelay)
87                { return this->getNotifications(listener, map, std::time(0)-timeDelay, std::time(0)); }
[3034]88
[2911]89        private:
[3370]90            static NotificationManager* singletonPtr_s;
[2911]91
92            int highestIndex_; //!< This variable holds the highest index (resp. key) in notificationLists_s, to secure that  no key appears twice.
[3034]93
[2911]94            std::multimap<std::time_t,Notification*> allNotificationsList_; //!< Container where all notifications are stored (together with their respecive timestamps).
[5619]95            std::map<NotificationListener*,int> listenerList_; //!< Container where all NotificationListeners are stored with a number as identifier.
96            std::map<int,std::multimap<std::time_t,Notification*>*> notificationLists_; //!< Container where all Notifications, for each identifier (associated with a NotificationListener), are stored.
[2280]97
[3034]98
[2280]99    };
100
101}
102
103#endif /* _NotificationManager_H__ */
Note: See TracBrowser for help on using the repository browser.