[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 | |
---|
[2779] | 29 | /** |
---|
| 30 | @file NotificationManager.h |
---|
| 31 | @brief Definition of the NotificationManager class. |
---|
| 32 | */ |
---|
| 33 | |
---|
[2280] | 34 | #ifndef _NotificationManager_H__ |
---|
| 35 | #define _NotificationManager_H__ |
---|
| 36 | |
---|
| 37 | #include "OrxonoxPrereqs.h" |
---|
| 38 | |
---|
| 39 | #include "core/BaseObject.h" |
---|
| 40 | |
---|
[2779] | 41 | #include <map> |
---|
[2280] | 42 | #include <string> |
---|
[2779] | 43 | #include <ctime> |
---|
[2280] | 44 | |
---|
[2779] | 45 | #include "NotificationOverlay.h" |
---|
| 46 | |
---|
[2435] | 47 | namespace orxonox |
---|
| 48 | { |
---|
[2280] | 49 | |
---|
| 50 | /** |
---|
| 51 | @brief |
---|
[2779] | 52 | The NotificationManager functions as a gateway between Notifications and NotificationQueues. |
---|
| 53 | It receives, organizes Notifications and the redistributes them to the specific NotificationQueues. |
---|
[2280] | 54 | @author |
---|
| 55 | Damian 'Mozork' Frick |
---|
| 56 | */ |
---|
| 57 | class _OrxonoxExport NotificationManager : public BaseObject |
---|
| 58 | { |
---|
[2779] | 59 | public: |
---|
| 60 | NotificationManager(BaseObject* creator); |
---|
| 61 | virtual ~NotificationManager(); |
---|
| 62 | |
---|
| 63 | static const std::string ALL; |
---|
| 64 | static const std::string NONE; |
---|
| 65 | |
---|
| 66 | //TDO: Visibility? |
---|
| 67 | static bool registerNotification(Notification* notification); //!< Registers a Notification within the NotificationManager. |
---|
| 68 | static bool registerQueue(NotificationQueue* queue); //!< Registers a NotificationQueue within the NotificationManager. |
---|
| 69 | |
---|
| 70 | static std::multimap<std::time_t,Notification*>* getNotifications(NotificationQueue* queue, const std::time_t & timeFrameStart, const std::time_t & timeFrameEnd); //!< Returns the Notifications for a specific NotificationQueue in a specified timeframe. |
---|
| 71 | |
---|
| 72 | /** |
---|
| 73 | @brief Fetches the Notifications for a specific NotificationQueue starting at a specified time. |
---|
| 74 | @param queue The NotificationQueue the Notifications are fetched for. |
---|
| 75 | @param timeFrameStart The start time the Notifications are fetched from. |
---|
| 76 | @return Returns a time-ordered list of Notifications. |
---|
| 77 | */ |
---|
| 78 | static std::multimap<std::time_t,Notification*>* getNotifications(NotificationQueue* queue, const std::time_t & timeFrameStart) |
---|
| 79 | { return NotificationManager::getNotifications(queue, timeFrameStart, std::time(0)); } |
---|
| 80 | /** |
---|
| 81 | @brief Fetches the Notifications for a specific NotificationQueue starting at a specified timespan before now. |
---|
| 82 | @param queue The NotificationQueue the Notifications are fetched for. |
---|
| 83 | @param timeDelay The timespan. |
---|
| 84 | @return Returns a time-ordered list of Notifications. |
---|
| 85 | */ |
---|
| 86 | static std::multimap<std::time_t,Notification*>* getNotifications(NotificationQueue* queue, int timeDelay) |
---|
| 87 | { return NotificationManager::getNotifications(queue, std::time(0)-timeDelay, std::time(0)); } |
---|
| 88 | |
---|
| 89 | private: |
---|
| 90 | static int highestIndex_s; //!< This variable holds the highest index (resp. key) in notificationLists_s, to secure that no key appears twice. |
---|
[2435] | 91 | |
---|
[2779] | 92 | static std::multimap<std::time_t,Notification*> allNotificationsList_s; //!< Container where all notifications are stored (together with their respecive timestamps). |
---|
| 93 | static std::map<NotificationQueue*,int> queueList_s; //!< Container where all NotificationQueues are stored with a number as identifier. |
---|
| 94 | static std::map<int,std::multimap<std::time_t,Notification*>*> notificationLists_s; //!< Container where all Notifications, for each identifier (associated with a NotificationQueue), are stored. |
---|
| 95 | |
---|
[2280] | 96 | |
---|
| 97 | }; |
---|
| 98 | |
---|
| 99 | } |
---|
| 100 | |
---|
| 101 | #endif /* _NotificationManager_H__ */ |
---|