Changeset 2858 for code/branches/questsystem5/src/orxonox/overlays/notifications/NotificationManager.cc

Timestamp:

Mar 26, 2009, 9:45:23 PM (16 years ago)

Author:

dafrick

Message:

Done some documenting, and resolved some (possible) issues. So the Notifications are about finished…

File:

• code/branches/questsystem5/src/orxonox/overlays/notifications/NotificationManager.cc (modified) (3 diffs)

code/branches/questsystem5/src/orxonox/overlays/notifications/NotificationManager.cc

@@ -174 +174 @@
     @param queue
         The NotificationQueue the Notifications are fetched for.
+    @param map
+        A multimap, in which the notifications are stored.
     @param timeFrameStart
         The start time of the timeframe.
@@ -179 +181 @@
         The end time of the timeframe.
     @return
-        Returns a time-ordered list of Notifications.
-    @todo
-        Make sure the map is deleted.
-    */
-    std::multimap<std::time_t,Notification*>* NotificationManager::getNotifications(NotificationQueue* queue, const std::time_t & timeFrameStart, const std::time_t & timeFrameEnd)
-    {
-        std::multimap<std::time_t,Notification*>* notifications = this->notificationLists_[this->queueList_[queue]];
-        
-        if(notifications == NULL)
-            return NULL;
+        Returns true if successful.
+    */
+    bool NotificationManager::getNotifications(NotificationQueue* queue, std::multimap<std::time_t,Notification*>* map, const std::time_t & timeFrameStart, const std::time_t & timeFrameEnd)
+    {
+        if(queue == NULL || map == NULL)
+            return false;
+
+        std::multimap<std::time_t,Notification*>* notifications = this->notificationLists_[this->queueList_[queue]]; //!< The Notifications for the input NotificationQueue.
+        
+        if(notifications == NULL) //!< Returns NULL, if there are no Notifications.
+            return true;
     
         std::multimap<std::time_t,Notification*>::iterator it, itLowest, itHighest;
@@ -194 +197 @@
         itHighest = notifications->upper_bound(timeFrameStart);
         
-        std::multimap<std::time_t,Notification*>* map = new std::multimap<std::time_t,Notification*>();
-        
-        for(it = itLowest; it != itHighest; it++)
-        {
-            map->insert(std::pair<std::time_t,Notification*>(it->first,it->second));
-        }
-        
-        if(map->size() == 0)
-        {
-            delete map;
-            return NULL;
-        }
-        
-        return map;
+        for(it = itLowest; it != itHighest; it++) //!< Iterate through the Notifications from the start of the time Frame to the end of it.
+        {
+            map->insert(std::pair<std::time_t,Notification*>(it->first,it->second)); //!< Add the found Notifications to the map.
+        }
+        
+        return true;
     }