[Orxonox-commit 2140] r6856 - in code/trunk/src/modules/objects: eventsystem triggers

[dafrick at orxonox.net]

Author: dafrick
Date: 2010-05-04 22:16:10 +0200 (Tue, 04 May 2010)
New Revision: 6856

Modified:
   code/trunk/src/modules/objects/eventsystem/EventListener.cc
   code/trunk/src/modules/objects/triggers/MultiTriggerContainer.cc
   code/trunk/src/modules/objects/triggers/MultiTriggerContainer.h
Log:
Documented and simplified MultiTriggerContainer.


Modified: code/trunk/src/modules/objects/eventsystem/EventListener.cc
===================================================================
--- code/trunk/src/modules/objects/eventsystem/EventListener.cc	2010-05-04 19:54:59 UTC (rev 6855)
+++ code/trunk/src/modules/objects/eventsystem/EventListener.cc	2010-05-04 20:16:10 UTC (rev 6856)
@@ -61,9 +61,10 @@
             return;
         }
         
-        COUT(4) << "EventListener: Processing event: originator: " << event.originator_->getIdentifier()->getName() << " (&" << event.originator_ << ")" << ", activate: " << event.activate_ << ", name: " << event.name_ << std::endl;
+        COUT(4) << "EventListener, processing event: originator: " << event.originator_->getIdentifier()->getName() << " (&" << event.originator_ << ")" << ", activate: " << event.activate_ << ", name: " << event.name_ << std::endl;
 
         this->bActive_ = true;
+        //TODO: Why not this->fireEvent(event)?
         this->fireEvent(event.activate_, event.originator_, event.name_);
         this->bActive_ = false;
     }

Modified: code/trunk/src/modules/objects/triggers/MultiTriggerContainer.cc
===================================================================
--- code/trunk/src/modules/objects/triggers/MultiTriggerContainer.cc	2010-05-04 19:54:59 UTC (rev 6855)
+++ code/trunk/src/modules/objects/triggers/MultiTriggerContainer.cc	2010-05-04 20:16:10 UTC (rev 6856)
@@ -26,27 +26,48 @@
  *
 */
 
+/**
+    @file MultiTriggerContainer.cc
+    @brief Implementation of the MultiTriggerContainer class.
+*/
+
 #include "MultiTriggerContainer.h"
 
 #include "core/CoreIncludes.h"
 
 namespace orxonox
 {
-
-    CreateFactory(MultiTriggerContainer);
     
+    /**
+    @brief
+        Default constructor. Registers the object and creates an empty container.
+    @param creator
+        The creator.
+    */
     MultiTriggerContainer::MultiTriggerContainer(BaseObject* creator) : BaseObject(creator), originator_(NULL), data_(NULL)
     {
         RegisterObject(MultiTriggerContainer);
-        
     }
-    
+
+    /**
+    @brief
+        Constructor. Registers the object and sets the input values.
+    @param creator
+        The creator.
+    @param originator
+        A pointer to the originator of the Event, i.e. the MultiTrigger that fired the Event. (or is about to)
+    @param data
+        A pointer to the data that should be sent with the container.
+    */
     MultiTriggerContainer::MultiTriggerContainer(BaseObject* creator, MultiTrigger* originator, BaseObject* data) : BaseObject(creator), originator_(originator), data_(data)
     {
         RegisterObject(MultiTriggerContainer);
-        
     }
-    
+
+    /**
+    @brief
+        Destructor.
+    */
     MultiTriggerContainer::~MultiTriggerContainer()
     {
         

Modified: code/trunk/src/modules/objects/triggers/MultiTriggerContainer.h
===================================================================
--- code/trunk/src/modules/objects/triggers/MultiTriggerContainer.h	2010-05-04 19:54:59 UTC (rev 6855)
+++ code/trunk/src/modules/objects/triggers/MultiTriggerContainer.h	2010-05-04 20:16:10 UTC (rev 6856)
@@ -20,12 +20,17 @@
  *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
  *   Author:
- *      ...
+ *      Damian 'Mozork' Frick
  *   Co-authors:
  *      ...
  *
 */
 
+/**
+    @file MultiTriggerContainer.h
+    @brief Definition of the MultiTriggerContainer class.
+*/
+
 #ifndef _MultiTriggerContainer_H__
 #define _MultiTriggerContainer_H__
 
@@ -36,22 +41,36 @@
 namespace orxonox
 {
 
+    /**
+    @brief
+        This class is used by the MultiTrigger class to transport additional data via Events.
+    @author
+        Damian 'Mozork' Frick
+    */
     class _ObjectsExport MultiTriggerContainer : public BaseObject
     {
+        
         public:
-            
-            MultiTriggerContainer(BaseObject* creator);
-            MultiTriggerContainer(BaseObject* creator, MultiTrigger* originator, BaseObject* data);
-            ~MultiTriggerContainer();
-            
+            MultiTriggerContainer(BaseObject* creator); //!< Default constructor. Registers the object and creates an empty container.
+            MultiTriggerContainer(BaseObject* creator, MultiTrigger* originator, BaseObject* data); //!< Constructor. Registers the object and sets the input values.
+            ~MultiTriggerContainer(); //!< Destructor.
+
+            /**
+            @brief Get the originator of the Event. (The MultiTrigger that fired the Event)
+            @return Returns a pointer to the originator.
+            */
             inline MultiTrigger* getOriginator(void)
                 { return this->originator_; }
+            /**
+            @brief Get the data of this container.
+            @return Returns a pointer ot the data.
+            */
             inline BaseObject* getData(void)
                 { return this->data_; }
             
         private:
-            MultiTrigger* originator_;
-            BaseObject* data_;
+            MultiTrigger* originator_; //!< The originator.
+            BaseObject* data_; //!< The data.
     };
     
 }