Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/resource/src/orxonox/overlays/notifications/NotificationManager.cc @ 3366

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

Derived all singletons implemented in a usual manner from orxonox::Singleton<T>.
This resolves inconsistencies with the singletonPtr_s variable in case of exceptions (asserts were being triggered then).
And while at it replaced singletonRef_s with singletonPtr_s for it to be less misleading (as fabian has already pointed out).

  • Property svn:eol-style set to native
File size: 7.1 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
31    @brief Implementation of the NotificationManager class.
32*/
33
34#include "NotificationManager.h"
35
36#include <set>
37
38#include "core/CoreIncludes.h"
39#include "Notification.h"
40#include "NotificationQueue.h"
41
42namespace orxonox
43{
44
45    const std::string NotificationManager::ALL = "all";
46    const std::string NotificationManager::NONE = "none";
47
48    NotificationManager* NotificationManager::singletonPtr_s = NULL;
49
50    /**
51    @brief
52        Constructor. Registers the Object.
53    */
54    NotificationManager::NotificationManager()
55    {
56        RegisterRootObject(NotificationManager);
57
58        this->highestIndex_ = 0;
59    }
60
61    /**
62    @brief
63        Destructor.
64    */
65    NotificationManager::~NotificationManager()
66    {
67    }
68
69    /**
70    @brief
71        Registers a Notification within the NotificationManager and makes sure that the Notification is displayed in all the NotificationQueues associated with its sender.
72    @param notification
73        The Notification to be registered.
74    @return
75        Returns true if successful.
76    */
77    bool NotificationManager::registerNotification(Notification* notification)
78    {
79   
80        if(notification == NULL) //!< A NULL-Notification cannot be registered.
81            return false;
82       
83        std::time_t time = std::time(0); //TDO: Doesn't this expire? //!< Get current time.
84       
85        this->allNotificationsList_.insert(std::pair<std::time_t,Notification*>(time,notification));
86       
87        if(notification->getSender() == NONE) //!< If the sender has no specific name, then the Notification is only added to the list of all Notifications.
88            return true;
89       
90        bool all = false;
91        if(notification->getSender() == ALL) //!< If all are the sender, then the Notifications is added to every NotificationQueue.
92            all = true;
93       
94        //!< Insert the notification in all queues that have its sender as target.
95        for(std::map<NotificationQueue*,int>::iterator it = this->queueList_.begin(); it != this->queueList_.end(); it++) //!< Iterate through all queues.
96        {
97            std::set<std::string> set = it->first->getTargetsSet();
98            if(all || set.find(notification->getSender()) != set.end() || set.find(ALL) != set.end()) //TDO: Make sure this works.
99            {
100                this->notificationLists_[it->second]->insert(std::pair<std::time_t,Notification*>(time,notification)); //!< Insert the Notification in the Notifications list of the current NotificationQueue.
101                it->first->update(notification, time); //!< Update the queue.
102            }
103        }
104       
105        COUT(3) << "Notification registered with the NotificationManager." << std::endl;
106       
107        return true;
108    }
109   
110    /**
111    @brief
112        Registers a NotificationQueue within the NotificationManager.
113    @param queue
114        The NotificationQueue to be registered.
115    @return
116        Returns true if successful.
117    */
118    bool NotificationManager::registerQueue(NotificationQueue* queue)
119    {
120        this->highestIndex_ += 1;
121        int index = this->highestIndex_;
122       
123        this->queueList_[queue] = index; //!< Add the NotificationQueue to the list of queues.
124       
125        std::set<std::string> set = queue->getTargetsSet(); //TDO: Works this?
126       
127        //! If all senders are the target of the queue, then the list of notification for that specific queue is te same as the list of all Notifications.
128        if(set.find(ALL) != set.end())
129        {
130            this->notificationLists_[index] = &this->allNotificationsList_;
131            COUT(3) << "NotificationQueue registered with the NotificationManager." << std::endl;
132            return true;
133        }
134       
135        this->notificationLists_[index] = new std::multimap<std::time_t,Notification*>;
136        std::multimap<std::time_t,Notification*> map = *this->notificationLists_[index];
137       
138        //! Iterate through all Notifications to determine whether any of them should belong to the newly registered NotificationQueue.
139        for(std::multimap<std::time_t,Notification*>::iterator it = this->allNotificationsList_.begin(); it != this->allNotificationsList_.end(); it++)
140        {
141            if(set.find(it->second->getSender()) != set.end()) //!< Checks whether the overlay has the sender of the current notification as target.
142            {
143                map.insert(std::pair<std::time_t,Notification*>(it->first, it->second));
144            }
145        }
146       
147        queue->update(); //!< Update the queue.
148
149        COUT(3) << "NotificationQueue registered with the NotificationManager." << std::endl;
150       
151        return true;
152    }
153   
154    /**
155    @brief
156        Fetches the Notifications for a specific NotificationQueue in a specified timeframe.
157    @param queue
158        The NotificationQueue the Notifications are fetched for.
159    @param map
160        A multimap, in which the notifications are stored.
161    @param timeFrameStart
162        The start time of the timeframe.
163    @param timeFrameEnd
164        The end time of the timeframe.
165    @return
166        Returns true if successful.
167    */
168    bool NotificationManager::getNotifications(NotificationQueue* queue, std::multimap<std::time_t,Notification*>* map, const std::time_t & timeFrameStart, const std::time_t & timeFrameEnd)
169    {
170        if(queue == NULL || map == NULL)
171            return false;
172
173        std::multimap<std::time_t,Notification*>* notifications = this->notificationLists_[this->queueList_[queue]]; //!< The Notifications for the input NotificationQueue.
174       
175        if(notifications == NULL) //!< Returns NULL, if there are no Notifications.
176            return true;
177   
178        std::multimap<std::time_t,Notification*>::iterator it, itLowest, itHighest;
179        itLowest = notifications->lower_bound(timeFrameStart);
180        itHighest = notifications->upper_bound(timeFrameStart);
181       
182        for(it = itLowest; it != itHighest; it++) //!< Iterate through the Notifications from the start of the time Frame to the end of it.
183        {
184            map->insert(std::pair<std::time_t,Notification*>(it->first,it->second)); //!< Add the found Notifications to the map.
185        }
186       
187        return true;
188    }
189
190}
Note: See TracBrowser for help on using the repository browser.