[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 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 | |
---|
[2911] | 29 | /** |
---|
[7456] | 30 | @file Notification.cc |
---|
[2911] | 31 | @brief Implementation of the Notification class. |
---|
| 32 | */ |
---|
| 33 | |
---|
[2280] | 34 | #include "Notification.h" |
---|
| 35 | |
---|
| 36 | #include "core/CoreIncludes.h" |
---|
[7403] | 37 | #include "network/NetworkFunction.h" |
---|
[7462] | 38 | #include "network/Host.h" |
---|
[2280] | 39 | #include "NotificationManager.h" |
---|
| 40 | |
---|
[2435] | 41 | namespace orxonox |
---|
| 42 | { |
---|
[2911] | 43 | |
---|
| 44 | /** |
---|
| 45 | @brief |
---|
| 46 | Default constructor. Initializes the object. |
---|
| 47 | */ |
---|
[7474] | 48 | Notification::Notification() |
---|
[2280] | 49 | { |
---|
[7474] | 50 | RegisterRootObject(Notification); |
---|
[2911] | 51 | this->initialize(); |
---|
[7403] | 52 | this->registerVariables(); |
---|
[2280] | 53 | } |
---|
[6417] | 54 | |
---|
[2911] | 55 | /** |
---|
| 56 | @brief |
---|
| 57 | Constructor. Creates a Notification with the input message. |
---|
[7401] | 58 | @param creator |
---|
[7403] | 59 | The creator. |
---|
[2911] | 60 | @param message |
---|
| 61 | The message of the Notification. |
---|
| 62 | */ |
---|
[7474] | 63 | Notification::Notification(const std::string & message) |
---|
[2280] | 64 | { |
---|
[7474] | 65 | RegisterRootObject(Notification); |
---|
[7193] | 66 | this->initialize(); |
---|
[2280] | 67 | this->message_ = message; |
---|
| 68 | } |
---|
[6417] | 69 | |
---|
[2911] | 70 | /** |
---|
| 71 | @brief |
---|
| 72 | Destructor. |
---|
| 73 | */ |
---|
[2280] | 74 | Notification::~Notification() |
---|
| 75 | { |
---|
[7163] | 76 | |
---|
[2280] | 77 | } |
---|
[6417] | 78 | |
---|
[2911] | 79 | /** |
---|
| 80 | @brief |
---|
| 81 | Registers the object and sets some default values. |
---|
| 82 | */ |
---|
[2280] | 83 | void Notification::initialize(void) |
---|
| 84 | { |
---|
[6417] | 85 | this->message_.clear(); |
---|
[2911] | 86 | this->sender_ = NotificationManager::NONE; |
---|
[2280] | 87 | this->sent_ = false; |
---|
| 88 | } |
---|
[6417] | 89 | |
---|
[2911] | 90 | /** |
---|
| 91 | @brief |
---|
| 92 | Sends the Notification to the Notificationmanager, which then in turn distributes it to the different NotificationQueues. |
---|
| 93 | @param sender |
---|
| 94 | The sender the Notification was sent by. Used by the NotificationManager to distributes the notification to the correct NotificationQueues. |
---|
| 95 | @return |
---|
| 96 | Returns true if successful. |
---|
| 97 | */ |
---|
[7474] | 98 | bool Notification::send(const std::string & sender) |
---|
[2280] | 99 | { |
---|
[7193] | 100 | if(this->isSent()) //TODO: Needed? |
---|
| 101 | return false; |
---|
[7403] | 102 | |
---|
[2911] | 103 | this->sender_ = sender; |
---|
| 104 | bool successful = NotificationManager::getInstance().registerNotification(this); |
---|
| 105 | if(!successful) |
---|
[2280] | 106 | return false; |
---|
[2911] | 107 | this->sent_ = true; |
---|
[6417] | 108 | |
---|
[2911] | 109 | COUT(3) << "Notification \"" << this->getMessage() << "\" sent." << std::endl; |
---|
[6417] | 110 | |
---|
[2435] | 111 | return true; |
---|
[2280] | 112 | } |
---|
[6417] | 113 | |
---|
[2911] | 114 | /** |
---|
| 115 | @brief |
---|
| 116 | Sets the message of the notification. |
---|
| 117 | @param message |
---|
| 118 | The message to be set. |
---|
| 119 | @return |
---|
| 120 | Returns true if successful. |
---|
| 121 | */ |
---|
[2280] | 122 | bool Notification::setMessage(const std::string & message) |
---|
| 123 | { |
---|
[2911] | 124 | if(this->isSent()) //!< The message cannot be changed if the message has already been sent. |
---|
[2280] | 125 | return false; |
---|
[2435] | 126 | this->message_ = message; |
---|
| 127 | return true; |
---|
[2280] | 128 | } |
---|
[2911] | 129 | |
---|
[2280] | 130 | } |
---|