Changeset 8449 for code/branches/tutoriallevel2/src/modules

Timestamp:

May 11, 2011, 10:55:30 PM (14 years ago)

Author:

dafrick

Message:

Moving the Notification class int NotificationManager, since it is only a container now.

Location:

code/branches/tutoriallevel2/src/modules/notifications

Files:

• CMakeLists.txt (modified) (1 diff)
• Notification.cc (deleted)
• Notification.h (deleted)
• NotificationManager.cc (modified) (2 diffs)
• NotificationManager.h (modified) (2 diffs)
• NotificationQueue.cc (modified) (1 diff)
• NotificationQueueCEGUI.cc (modified) (1 diff)

code/branches/tutoriallevel2/src/modules/notifications/CMakeLists.txt

@@ -1 +1 @@
 SET_SOURCE_FILES(NOTIFICATIONS_SRC_FILES
-  Notification.cc
   NotificationDispatcher.cc
   NotificationManager.cc

code/branches/tutoriallevel2/src/modules/notifications/NotificationManager.cc

@@ -41 +41 @@
 #include "interfaces/NotificationListener.h"
 
-#include "Notification.h"
 #include "NotificationQueue.h"
 #include "NotificationQueueCEGUI.h"
@@ -424 +423 @@
     }
 
+    // Notification class
+
+    /**
+    @brief
+        Constructor. Creates a Notification with the input message and sender.
+    @param message
+        The message of the Notification.
+    @param sender
+        The sender of the Notification.
+    @param type
+
+    */
+    Notification::Notification(const std::string& message, const std::string& sender, notificationMessageType::Value type)
+    {
+        this->initialize();
+        this->message_ = message;
+        this->sender_ = sender;
+        this->type_ = type;
+    }
+
+    /**
+    @brief
+        Destructor.
+    */
+    Notification::~Notification()
+    {
+
+    }
+
+    /**
+    @brief
+        Registers the object and sets some default values.
+    */
+    void Notification::initialize(void)
+    {
+        this->message_.clear();
+        this->sender_ = NotificationListener::NONE;
+    }
+
 }

code/branches/tutoriallevel2/src/modules/notifications/NotificationManager.h

@@ -42 +42 @@
 #include <string>
 
+#include "core/OrxonoxClass.h"
 #include "util/Singleton.h"
 #include "interfaces/NotificationListener.h"
@@ -47 +48 @@
 namespace orxonox // tolua_export
 { // tolua_export
+
+    /**
+    @brief
+        A Notification represents a short message used to inform the player about something that just happened. With the @ref orxonox::NotificationManager "NotificationManager" a Notification can be sent from any part of orxonox and is then displayed by the proper @ref orxonox::NotificationQueue "NotificationQueue(s)" (depending on which senders the specific @ref orxonox::NotificationQueue "NotificationQueues" accepts).
+
+        A Notification is just a data structure that is used internally by the Notifications module.
+
+    @author
+        Damian 'Mozork' Frick
+
+    @ingroup Notifications
+    */
+    class _NotificationsExport Notification
+    {
+        public:
+            Notification(const std::string& message, const std::string& sender, notificationMessageType::Value type);
+            virtual ~Notification();
+
+            /**
+            @brief Destroys the Notification.
+            */
+            void destroy(void)
+                { delete this; }
+
+            /**
+            @brief Get the message of the Notification.
+            @return Returns the message of the Notification.
+            */
+            inline const std::string & getMessage(void) const
+                { return this->message_; }
+
+            /**
+            @brief Get the sender of the Notification.
+            @return Returns the sender of the Notification.
+            */
+            inline const std::string & getSender(void) const
+                { return this->sender_; }
+
+            /**
+            @brief Get the type of the Notification.
+            @return Returns an enum with the type of the Notification.
+            */
+            inline notificationMessageType::Value getType(void) const
+                { return this->type_; }
+
+        private:
+            std::string message_; //!< The Notification message.
+            std::string sender_; //!< The sender of the notification.
+            notificationMessageType::Value type_; //!< The type of the notification.
+
+            void initialize(void); //!< Registers the object and sets some default values.
+
+    };
 
     /**

code/branches/tutoriallevel2/src/modules/notifications/NotificationQueue.cc

@@ -39 +39 @@
 #include "core/CoreIncludes.h"
 #include "util/SubString.h"
-
-#include "Notification.h"
 
 namespace orxonox

code/branches/tutoriallevel2/src/modules/notifications/NotificationQueueCEGUI.cc

@@ -41 +41 @@
 #include "core/LuaState.h"
 #include "util/Convert.h"
-
-#include "Notification.h"
 
 #include "ToluaBindNotifications.h"