Changeset 6690

Timestamp:

Apr 12, 2010, 3:30:51 PM (15 years ago)

Author:

smerkli

Message:

Few changes before the questions, completing doxy stuff.

Location:

code/branches/chat/src/orxonox

Files:

• ChatHistory.cc (modified) (9 diffs)
• ChatHistory.h (modified) (3 diffs)

code/branches/chat/src/orxonox/ChatHistory.cc

@@ -33 +33 @@
 {
 #endif
+  /* QUESTION */
   /* is this necessary? if yes uncomment please :P */
   //CreateFactory(ChatHistory);
@@ -67 +68 @@
     chat_hist_closelog();
     
-    /* TODO clear list */
+    /* clear list */
+    this->hist_buffer.clear();
   }
 
@@ -74 +76 @@
     unsigned int senderID)
   {
+    /* QUESTION */
     /* sanity - check for valid senderID */
-    /* sanity - check for valid string format */ 
 
-    /* format the message and senderID into a line */
-    std::string buf = "" + senderID; /* NOTE to be changed */
+    /* TODO make a correct name */
+    std::string name = "" + senderID; /* NOTE to be changed */
 
     /* TODO */
+    /* QUESTION */
     /* --> a) look up the actual name of the sender */
     /* --> b) add sender name and string up with a separator
@@ -87 +90 @@
 
     /* add the line to the history */
-    this->chat_hist_addline( buf + ": " + message );
+    this->chat_hist_addline( name + ": " + message );
 
     /* add the line to the log */
-    this->chat_hist_logline( buf + ": " + message );
+    this->chat_hist_logline( name + ": " + message );
   } 
 
@@ -109 +112 @@
     /* push to the front of the history */
     this->hist_buffer.push_back( toadd );
-
   }
 
@@ -115 +117 @@
   int ChatHistory::chat_hist_logline( const std::string& toadd )
   { 
-    /* TODO use already written class to batch write to file
-     * so not every line gets written on its own 
-     */
     /* output the line to the file if logging is enabled */
     if( this->hist_log_enabled )
@@ -126 +125 @@
   int ChatHistory::chat_hist_openlog()
   {
+    /* QUESTION */
     /* TODO: find out the name of the file to log to via settings 
      *       and set the this->hist_logfile_path variable to it
@@ -132 +132 @@
       std::fstream::out | std::fstream::app );
 
+    /* QUESTION */
     /* TODO check whether this works (not sure how you'd like it?) */
 
@@ -150 +151 @@
   void ChatHistory::debug_printhist()
   {
+    /* create deque iterator */
     std::deque<std::string>::iterator it;
 
+    /* output all the strings */
     for( it = this->hist_buffer.begin(); it != this->hist_buffer.end();
       ++it )
       std::cout << *it << std::endl;
 
+    /* output size */
     std::cout << "Size: " << hist_buffer.size() << std::endl;
-
-    
   }
 

code/branches/chat/src/orxonox/ChatHistory.h

@@ -32 +32 @@
 #include <iostream>
 
+/* define this if you're unit testing */
 #define TEST 0
 
@@ -80 +81 @@
       int syncLog();
 
-      /** debug-print */
+      /** debug-print: output the whole history to stdout */
       void debug_printhist();
       
@@ -133 +134 @@
 #endif
 
-
 #endif /* _ChatHistory_H__ */