Changeset 6475 for code/branches/pickup3/src/orxonox/pickup

Timestamp:

Mar 5, 2010, 6:26:54 PM (15 years ago)

Author:

dafrick

Message:

Additional documentation, code niceifying and potential bug fixing. Also: Renamed DroppedItem to DroppedPickup.

Location:

code/branches/pickup3/src/orxonox/pickup

Files:

• PickupIdentifier.cc (modified) (4 diffs)
• PickupIdentifier.h (modified) (1 diff)

code/branches/pickup3/src/orxonox/pickup/PickupIdentifier.cc

@@ -34 +34 @@
 {
     
+    /**
+    @brief
+        Constructor. Registers the object and initializes member variables.
+    */
     PickupIdentifier::PickupIdentifier()
     {
         RegisterRootObject(PickupIdentifier);
         
-        
+        this->classIdentifier_ = NULL;
     }
     
@@ -52 +56 @@
         Pointer to the second PickupIdentifier, b.
     @return
-        Returns an int.
+        Returns an integer. 0 if the two compared PickupIdentifiers are the same, <0 if a < b and >0 if a > b.
     */
-    int PickupIdentifier::compare(const PickupIdentifier& identifier) const
+    int PickupIdentifier::compare(const PickupIdentifier* identifier) const
     {
-        if(!identifier.classIdentifier_->isExactlyA(this->classIdentifier_))
-            return this->classIdentifier_->getName().compare(identifier.classIdentifier_->getName());
+        //! If the classIdentifiers are not the same (meaning the PickupIdentifiers identify different classes), the obviously the two Pickupables identified by the PickupIdentifiers cannot be the same. An ordering is established through the alphabetical ordering of the respective classnames.
+        if(!identifier->classIdentifier_->isExactlyA(this->classIdentifier_))
+            return this->classIdentifier_->getName().compare(identifier->classIdentifier_->getName());
         
-        if(!(this->parameters_.size() == identifier.parameters_.size()))
+        //! If the class is the same for both PickupIdentifiers we go on to check the parameters of the class.
+        //! If the two have a different number of parameters then obviusly something is very wrong.
+        if(!(this->parameters_.size() == identifier->parameters_.size()))
         {
             COUT(1) << "Something went wrong in PickupIdentifier!" << std::endl;
-            return this->parameters_.size()-identifier.parameters_.size();
+            return this->parameters_.size()-identifier->parameters_.size();
         }
         
+        //! We iterate through all parameters and compar their values (which are strings). The first parameter is the most significant. The ordering is once again established by the alphabetical comparison of the two value strings.
         for(std::map<std::string, std::string>::const_iterator it = this->parameters_.begin(); it != this->parameters_.end(); it++)
         {
-            if(identifier.parameters_.find(it->first) == identifier.parameters_.end())
+            //!< If a parameter present in one of the identifiers is not found in the other, once again, something is very wrong.
+            if(identifier->parameters_.find(it->first) == identifier->parameters_.end())
             {
                 COUT(1) << "Something went wrong in PickupIdentifier!" << std::endl;
                 return -1;
             }
-            if(identifier.parameters_.find(it->first)->second != it->second)
-                return it->second.compare(identifier.parameters_.find(it->first)->second);
+            if(identifier->parameters_.find(it->first)->second != it->second)
+                return it->second.compare(identifier->parameters_.find(it->first)->second);
         }
             
@@ -79 +88 @@
     }
     
+    /**
+    @brief
+        Add the class of the Pickupable to its PickupIdentifier.
+    @param identifier
+        A pointer to the Identifier of the class.
+    */
     void PickupIdentifier::addClass(Identifier* identifier)
     {
@@ -84 +99 @@
     }
     
+    /**
+    @brief
+        Add a parameter to the PickupIdentifier.
+    @param name
+        The name of the parameter.
+    @param value
+        The value of the parameter.
+    @return
+        Returns false if the parameter already existed, true if not.
+    */
     bool PickupIdentifier::addParameter(std::string & name, std::string & value)
     {

code/branches/pickup3/src/orxonox/pickup/PickupIdentifier.h

@@ -32 +32 @@
 #include "OrxonoxPrereqs.h"
 
-#include "core/OrxonoxClass.h" 
-#include "core/Identifier.h"
 #include <map>
 #include <string>
+#include "core/Identifier.h"
+
+#include "core/OrxonoxClass.h" 
 
 namespace orxonox
 {
     
+    /**
+    @brief
+        The purpose of the PickupIdentifier class is to identify different types of pickups allthough they are of the same class.
+        This allows for more generic classes (or pickups in this case) that can be a number of different pickup types and can be identified as such without the need for a lot of different classes. An example is the HealthPickup class that encompasses a wide variety of different types of health pickups, e.g a HealthPickup that adds 10 health every second for 10 seconds or a HealthPickup that adds 100 health as soon as it is picked up, a.s.o.
+        To that purpose this class provides functionality to compare two PickupIdentifier (and since all Pickupables have an Identifier through that Pickupables can be compared). It als provides functionality to add parameters that distinguish between different types of pickups in the same pickup class.
+        Lastly a struct is provided that can be used in stl containers to establish a strictly lesser ordering between PickupIdentifiers (and thus Pickupables).
+    @author
+        Damian 'Mozork' Frick
+    */
     class _OrxonoxExport PickupIdentifier : virtual public OrxonoxClass
     {
         
         public:
-            PickupIdentifier(void);
-            ~PickupIdentifier();
+            PickupIdentifier(void); //!< Constructor.
+            ~PickupIdentifier(); //!< Destructor.
             
-            virtual int compare(const PickupIdentifier& identifier) const;
+            virtual int compare(const PickupIdentifier* identifier) const; //!< Compares two PickupIdentifiers and returns 0 if a == b, <0 if a < b and >0 if a > b for a.compare(b).
             
-            void addClass(Identifier* identifier);
-            bool addParameter(std::string & name, std::string & value);
+            void addClass(Identifier* identifier); //!< Add the class of the Pickupable to its PickupIdentifier.
+            bool addParameter(std::string & name, std::string & value); //!< Add a parameter to the PickupIdentifier.
             
         private:
-            Identifier* classIdentifier_;
-            std::map<std::string, std::string> parameters_;
-            
+            Identifier* classIdentifier_; //!< The Identifier of the class.
+            std::map<std::string, std::string> parameters_; //!< The parameters identifying the type of the pickup beyond the class.
             
     };
     
-    //TODO: Needed?
+    /**
+    @brief
+        Struct that overloads the compare operation between two PickupIdentifier pointers.
+    */
     struct PickupIdentifierCompare
     {
-        bool operator() (const PickupIdentifier& lhs, const PickupIdentifier& rhs) const
-            { return lhs.compare(rhs) < 0; }
-    };
-    
-    struct PickupIdentifierPtrCompare
-    {
         bool operator() (const PickupIdentifier* lhs, const PickupIdentifier* rhs) const
-            { return lhs->compare(*rhs) < 0; }
+            { return lhs->compare(rhs) < 0; }
     };