Changeset 2909 for code/trunk/src/orxonox/overlays/notifications/NotificationManager.h

Timestamp:

Apr 8, 2009, 1:07:27 AM (15 years ago)

Author:

dafrick

Message:

Merging the QuestSystem branch to the trunk. Let's hope, this isn't a 'third time's the charm'-thing…

File:

• code/trunk/src/orxonox/overlays/notifications/NotificationManager.h (modified) (2 diffs)

code/trunk/src/orxonox/overlays/notifications/NotificationManager.h

@@ -27 +27 @@
  */
 
+/**
+    @file NotificationManager.h
+    @brief Definition of the NotificationManager class.
+*/
+
 #ifndef _NotificationManager_H__
 #define _NotificationManager_H__
@@ -32 +37 @@
 #include "OrxonoxPrereqs.h"
 
-#include "core/BaseObject.h"
+#include "core/OrxonoxClass.h"
 
-#include <list>
+#include <map>
 #include <string>
+#include <ctime>
+
+#include "NotificationOverlay.h"
 
 namespace orxonox
 {
-    struct NotificationContainer
-    {
-        Notification* notification;
-        float remainingTime;
-    };
 
     /**
     @brief
-        
+        The Singleton NotificationManager functions as a gateway between Notifications and NotificationQueues.
+        It receives, organizes Notifications and the redistributes them to the specific NotificationQueues.
     @author
         Damian 'Mozork' Frick
     */
-    class _OrxonoxExport NotificationManager : public BaseObject
+    class _OrxonoxExport NotificationManager : public OrxonoxClass
     {
-    
-    public:
-        NotificationManager(BaseObject* creator);
-        virtual ~NotificationManager();
+        public:
+            NotificationManager();
+            virtual ~NotificationManager();
+                
+            static const std::string ALL;
+            static const std::string NONE;
+         
+            static NotificationManager & getInstance(); //! Returns a reference to the single instance of the NotificationManager.
+
+            bool registerNotification(Notification* notification); //!< Registers a Notification within the NotificationManager.
+            bool registerQueue(NotificationQueue* queue); //!< Registers a NotificationQueue within the NotificationManager.
+            
+            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.
+            
+            /**
+            @brief Fetches the Notifications for a specific NotificationQueue starting at a specified time.
+            @param queue The NotificationQueue the Notifications are fetched for.
+            @param map A multimap, in which the notifications are stored.
+            @param timeFrameStart The start time the Notifications are fetched from.
+            @return Returns true if successful.
+            */
+            bool getNotifications(NotificationQueue* queue, std::multimap<std::time_t,Notification*>* map, const std::time_t & timeFrameStart)
+                { return this->getNotifications(queue, map, timeFrameStart, std::time(0)); }
+            /**
+            @brief Fetches the Notifications for a specific NotificationQueue starting at a specified timespan before now.
+            @param queue The NotificationQueue the Notifications are fetched for.
+            @param map A multimap, in which the notifications are stored.
+            @param timeDelay The timespan.
+            @return Returns true if successful.
+            */
+            bool getNotifications(NotificationQueue* queue, std::multimap<std::time_t,Notification*>* map, int timeDelay)
+                { return this->getNotifications(queue, map, std::time(0)-timeDelay, std::time(0)); }
+     
+        private:
+            static NotificationManager* singletonRef_s;
+
+            int highestIndex_; //!< This variable holds the highest index (resp. key) in notificationLists_s, to secure that  no key appears twice.
         
-        static bool insertNotification(Notification* notification);
-        
-        static void tick(float dt);
-        
-    private:
-        static std::list<NotificationContainer*> notifications_s;
-        
-        static void updateQueue(void);
-        static const std::string clipMessage(const std::string & message);
+            std::multimap<std::time_t,Notification*> allNotificationsList_; //!< Container where all notifications are stored (together with their respecive timestamps).
+            std::map<NotificationQueue*,int> queueList_; //!< Container where all NotificationQueues are stored with a number as identifier.
+            std::map<int,std::multimap<std::time_t,Notification*>*> notificationLists_; //!< Container where all Notifications, for each identifier (associated with a NotificationQueue), are stored.
+            
 
     };