Changeset 4748 in orxonox.OLD for orxonox/trunk/src

Timestamp:

Jul 1, 2005, 4:37:15 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: some nicer debug information, and doxygen tags

Location:

orxonox/trunk/src

Files:

• lib/lang/class_list.cc (modified) (7 diffs)
• lib/lang/class_list.h (modified) (1 diff)
• orxonox.cc (modified) (2 diffs)

orxonox/trunk/src/lib/lang/class_list.cc

@@ -21 +21 @@
 #include "compiler.h"
 #include "debug.h"
+#include <string.h>
+#include <math.h>
 
 using namespace std;
@@ -26 +28 @@
 
 /**
-   \brief standard constructor
-   \todo this constructor is not jet implemented - do it
+   \brief Creates a new ClassList
 */
 ClassList::ClassList(const long& classID, const char* className)
@@ -35 +36 @@
   this->className = className;
   this->classID = classID;
+
+  ++ClassList::classCount;
 }
 
@@ -44 +47 @@
 ClassList::~ClassList ()
 {
-  // delete what has to be deleted here
+  --ClassList::classCount;
 }
 
+//! the first class that is registered
 ClassList*  ClassList::first = NULL;
+
+//! the Count of classes
 unsigned int ClassList::classCount = 0;
 
-
-
+/**
+ * Adds a new Object to the ClassList (and if necessary a new Class)
+ * @param objectPointer Pointer to the Object at hand
+ * @param classID ID of the Given ObjectType \see ClassID
+ * @param className name of the Class to add
+ */
 void ClassList::addToClassList(BaseObject* objectPointer, const long& classID, const char* className)
 {
@@ -78 +88 @@
 }
 
+/**
+ * removes an Object from a the ClassList
+ * @param objectPointer the Object to delete from the List
+ */
 void ClassList::removeFromClassList(BaseObject* objectPointer)
 {
@@ -92 +106 @@
 }
 
-
+/**
+ * Print out some very nice debug information
+ */
 void ClassList::debug()
 {
@@ -98 +114 @@
   PRINT(0)("=  CLASS_LIST   =\n");
   PRINT(0)("=================\n");
+  PRINT(0)("has %d Elements\n\n", ClassList::classCount);
   ClassList* tmp = ClassList::first;
+  char niceString[100];
+  unsigned int lenCount = 0;
+
   while (likely(tmp != NULL))
   {
-    PRINT(0)("CLASS %s has %d instances\n", tmp->className, tmp->objectCount);
+    lenCount = 1;
+    while (pow(10,lenCount) <= tmp->objectCount)
+      ++lenCount;
+    for (int i=0; i < 30-strlen(tmp->className) - lenCount; i++)
+      (niceString[i]) = ' ';
+    niceString[30-strlen(tmp->className) - lenCount] = '\0';
+
+    PRINT(0)("CLASS %s:%s %d instances\n", tmp->className, niceString, tmp->objectCount);
 
     tmp = tmp->next;
   }
   PRINT(0)("==============CL=\n");
-
 }

orxonox/trunk/src/lib/lang/class_list.h

@@ -36 +36 @@
     struct ObjectList
     {
-      BaseObject*            pointerToObject;
-      ObjectList*            next;
+      BaseObject*            pointerToObject;        //! Pointer to the Object
+      ObjectList*            next;                   //!< pointer to the next Object in the List
     };
 
-    long                     classID;
-    const char*              className;
+    long                     classID;                //!< ClassID stored in this ClassList \see ClassID
+    const char*              className;              //!< Name of the Class Stored here
 
-    ClassList*               next;
+    ClassList*               next;                   //!< Pointer to the next class in the List
 
-    unsigned int             objectCount;
+    unsigned int             objectCount;            //!< how many Objects of this particular Object have been loaded??
 
 
-    static ClassList*        first;
-    static unsigned int      classCount;
+    static ClassList*        first;                  //!< The first Class in the List (should be BaseObject)
+    static unsigned int      classCount;             //!< The Count of classes that have been registered (should match the lower description)
 
 };

orxonox/trunk/src/orxonox.cc

@@ -43 +43 @@
 #include "cd_engine.h"
 
+#include "class_list.h"
+
 #include <string.h>
 
@@ -81 +83 @@
   delete TextEngine::getInstance();
   delete EventHandler::getInstance();
+
+  ClassList::debug();
 }