Changeset 684 for code/branches/FICN/src/orxonox/core/DebugLevel.h

Timestamp:

Dec 26, 2007, 2:19:53 PM (16 years ago)

Author:

landauf

Message:

• added new class: the OutputHandler replaces std::cout in Debug.h and redirects the output not only to the console, but also into orxonox.log (this works, of course, only for output using COUT(level) from Debug.h)
• commented DebugLevel

File:

• code/branches/FICN/src/orxonox/core/DebugLevel.h (modified) (2 diffs)

code/branches/FICN/src/orxonox/core/DebugLevel.h

@@ -26 +26 @@
  */
 
+/*!
+    @file DebugLevel.h
+    @brief Definition of the DebugLevel class.
+
+    The DebugLevel class is a singleton, only used to configure the amount of debug
+    output (see Debug.h) into the console and the log-file (see OutputHandler.h).
+*/
+
 #ifndef _DebugLevel_H__
 #define _DebugLevel_H__
@@ -35 +43 @@
 namespace orxonox
 {
+    //! The DebugLevel class is a singleton, only used to configure the amount of debug output.
     class _CoreExport DebugLevel : public OrxonoxClass
     {
         public:
-            DebugLevel();
             static int getSoftDebugLevel();
 
         private:
-            int softDebugLevel_s;
-            static DebugLevel* pointer_s;
-            static bool bCreatingDebugLevelObject_s;
+            DebugLevel();                       // don't create
+            DebugLevel(const DebugLevel& dl) {} // don't copy
+            ~DebugLevel() {}                    // don't delete
+
+            int softDebugLevel_s;                       //!< The output level
+            static DebugLevel* pointer_s;               //!< A pointer to the only existing instance of this class
+            static bool bCreatingDebugLevelObject_s;    //!< True if the only instance is being created (this is needed to avoid recurstion - creating the object produces debug output, debug output needs the object)
     };
 }