Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/modules/notifications/Notification.cc @ 7342

Last change on this file since 7342 was 7297, checked in by landauf, 14 years ago

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

  • Property svn:eol-style set to native
File size: 3.6 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 thes
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 Notification class.
32*/
33
34#include "Notification.h"
35
36#include "core/CoreIncludes.h"
37#include "NotificationManager.h"
38
39namespace orxonox
40{
41
42    CreateUnloadableFactory(Notification);
43
44    /**
45    @brief
46        Default constructor. Initializes the object.
47    */
48    Notification::Notification(BaseObject* creator) : BaseObject(creator)
49    {
50        RegisterObject(Notification);
51        this->initialize();
52    }
53
54    /**
55    @brief
56        Constructor. Creates a Notification with the input message.
57    @param creator
58        The object that created this Notification
59    @param message
60        The message of the Notification.
61    */
62    Notification::Notification(BaseObject* creator, const std::string & message) : BaseObject(creator)
63    {
64        RegisterObject(Notification);
65        this->initialize();
66        this->message_ = message;
67    }
68
69    /**
70    @brief
71        Destructor.
72    */
73    Notification::~Notification()
74    {
75
76    }
77
78    /**
79    @brief
80        Registers the object and sets some default values.
81    */
82    void Notification::initialize(void)
83    {
84        this->message_.clear();
85        this->sender_ = NotificationManager::NONE;
86        this->sent_ = false;
87    }
88
89    /**
90    @brief
91        Sends the Notification to the Notificationmanager, with sender NetificationManager::NONE.
92    @return
93        Returns true if successful.
94    */
95    bool Notification::send(void)
96    {
97        return this->send(NotificationManager::NONE);
98    }
99
100    /**
101    @brief
102        Sends the Notification to the Notificationmanager, which then in turn distributes it to the different NotificationQueues.
103    @param sender
104        The sender the Notification was sent by. Used by the NotificationManager to distributes the notification to the correct NotificationQueues.
105    @return
106        Returns true if successful.
107    */
108    bool Notification::send(const std::string & sender)
109    {
110        if(this->isSent()) //TODO: Needed?
111            return false;
112       
113        this->sender_ = sender;
114        bool successful = NotificationManager::getInstance().registerNotification(this);
115        if(!successful)
116            return false;
117        this->sent_ = true;
118
119        COUT(3) << "Notification \"" << this->getMessage() << "\" sent." << std::endl;
120
121        return true;
122    }
123
124    /**
125    @brief
126        Sets the message of the notification.
127    @param message
128        The message to be set.
129    @return
130        Returns true if successful.
131    */
132    bool Notification::setMessage(const std::string & message)
133    {
134        if(this->isSent()) //!< The message cannot be changed if the message has already been sent.
135            return false;
136        this->message_ = message;
137        return true;
138    }
139
140}
Note: See TracBrowser for help on using the repository browser.