Changeset 2261 for code/trunk/src/orxonox/objects/quest/QuestItem.cc

Timestamp:

Nov 25, 2008, 11:56:40 PM (15 years ago)

Author:

landauf

Message:

merged questsystem2 back to trunk

Location:

code/trunk

Files:

• . (modified) (1 prop)
• src/orxonox/objects/quest/QuestItem.cc (modified) (4 diffs, 1 prop)

code/trunk/src/orxonox/objects/quest/QuestItem.cc

@@ -26 +26 @@
  *
  */
+ 
+/**
+    @file QuestItem.cc
+    @brief
+    Implementation of the QuestItem class.
+*/
 
 #include "OrxonoxStableHeaders.h"
@@ -36 +42 @@
 namespace orxonox {
 
+    /**
+    @brief
+        Constructor. Registers and initializes the object.
+    */
     QuestItem::QuestItem(BaseObject* creator) : BaseObject(creator)
     {
         RegisterObject(QuestItem);
 
-        this->initialize();
+        this->id_ = "";
     }
 
@@ -52 +62 @@
     }
 
+    /**
+    @brief
+        Method for creating a QuestItem object through XML.
+    */
     void QuestItem::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     {
@@ -57 +71 @@
 
         XMLPortParam(QuestItem, "id", setId, getId, xmlelement, mode);
-        //Doesn't getDescription have to be of type getDescription(unsigned int) ?
-        //XMLPortObjectTemplate(QuestItem, QuestDescription, "", setDescription, getDescription, xmlelement, mode, unsigned int);
         XMLPortObject(QuestItem, QuestDescription, "", setDescription, getDescription, xmlelement, mode);
-
     }
-
 
     /**
     @brief
-        Initializes the object.
-        Should be called first in every constructor of this class.
+        Sets the id of the QuestItem.
+    The id must be of GUID form. See 'http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure' for more information.
+    @param id
+        The id to be set.
     */
-    void QuestItem::initialize(void)
-    {
-        RegisterObject(QuestItem);
-
-        this->id_ = "";
-    }
-
     void QuestItem::setId(const std::string & id)
     {
-        if(!isId(id))
+        if(!isId(id)) //!< Checks whether the id is a valid id.
         {
             COUT(2) << "Invalid id. QuestItem id {" << id << "} could not be set." << std::endl;
             return;
         }
+        
         this->id_ = id;
     }
-
-    //const QuestDescription* QuestItem::getDescription(unsigned int index) const //!< Returns the description of the QuestItem.
-    //{
-    //    if(index != 0)
-    //        return NULL;
-    //    return this->description_;
-    //}
 
     /**