/ - Diff - Colony - Robotics Club

Revision 629

Added by Jason knichel about 16 years ago

added some more documentation

     using namespace std;
     /**
      * @brief Constructor for the Command class
+     *
      * @param connection_pool_temp The connection pool this instance of the Command class is supposed to use
      * @param cs The ColonetServer this instance of the Command class is supposed to use
      */
     Command::Command(ConnectionPool * connection_pool_temp, ColonetServer* cs) {
       connection_pool = connection_pool_temp;
       colonet_server = cs;
+    }
     /**
      * @brief Destructor for the Command class
      */
     Command::~Command() {}
     /**
     * Called by connection pool to parse command from client.
     */
      * @brief Called by connection pool to parse command from client.
+     *
      * @param command The command to parse
      * @param pool_index The index in the connection pool of the client who generated this command
+     *
      * @return 0 on success, negative error code on failure
      */
     int Command::parse_command(char* command, int pool_index) {
       char tokens[MAX_TOKENS][MAX_TOKEN_SIZE];
       int number_tokens = 0;
-...
         return -1;
+      }
       //look for the end of the next token (tokens are separated by spaces)
       while ((end_token = strstr(next_token, " "))) {
         //set the location of the space to a null terminator
         *end_token = '\0';
         //make sure the token isn't too long
         if (strlen(next_token) > MAX_TOKEN_SIZE-1) {
           return -1;
+        }
         //copy the next token into the token array
         strcpy(tokens[number_tokens], next_token);
         number_tokens++;
         next_token = end_token + 1;
         //skip over extra whitespace if there is any between tokens
         while (isspace(*next_token) && *next_token != '\0') {
           next_token++;
+        }
+      }
       //get the last token if there were no spaces at the end of the string to indicate an end of token
       if (end_token == NULL && *next_token != '\0') {
         if (strlen(next_token) > MAX_TOKEN_SIZE-1) {
           return -1;
-...
       return 0;
+    }
     //TODO: fill in the doxygen comments for this
     /**
     * @brief Sends parsed command from server to robot(s).
+    *
     * @param number_int_tokens
     * @param tokens
     * @param pool_index
+    *
     * @return 0 on success, negative error code on failure
     */
     int Command::parse_send_to_robot(int number_int_tokens, char tokens[MAX_TOKENS][MAX_TOKEN_SIZE], int pool_index) {
       unsigned char int_tokens[MAX_TOKENS], arguments[PACKET_DATA_LEN];
-...
+    }
     /**
+    *
     */
+     *
      */
     int Command::parse_request_from_server(int number_tokens, char tokens[MAX_TOKENS][MAX_TOKEN_SIZE], int pool_index) {
       char* end_pointer = NULL;

     /**************************** Private functions ******************************/
     //TODO: fill in the doxygen comments
     /**
      * @brief
+     *
      * @return Void
      */
     static void timeout_handler() {
       // printf("colonet wireless - timeout!\n");
+    }
     //TODO: fill in the doxygen comments
     /**
      * @brief
+     *
      * @param frame
      * @param received
+     *
      * @return Void
      */
     static void handle_response(int frame, int received) {
       //TODO: These are just here to get rid of compiler warnings
       frame = frame;
-...
       printf("handle_response\n");
+    }
     /**
      * @brief When a packet is received via wireless, the data is passed to this function
+     *
      * @param type
      * @param source The robot the packet came from
      * @param data The data the robot sent
      * @param len The length of the data
+     *
      * @return Void
      */
     static void handle_receive(char type, int source, unsigned char* data, int len) {
       type = type; //TODO: This is just here to get rid of compiler warnings.
-...
         int robot_x, robot_y;
         PositionMonitor* pm = colonet_server.getPositionMonitor();
         int num_robots = pm->getNumVisibleRobots();
         //ask the position monitor for where that robot is.
         int ret = pm->getRobotPosition(source, &robot_x, &robot_y);
         if (ret != 0 && num_robots != 1) {
-...
+      }
+    }
     //TODO: fill in the doxygen comments
     /**
      * @brief
+     *
      * @return Void
      */
     static void unregister(void) {
       printf("unregister\n");
+    }
-...
       while (1) {
         wl_do();
         //this sleep is here so the thread this runs in doesn't hog the cpu
         usleep(1000);
+      }
-...
       return NULL;
+    }
     /** @brief
     /**
      * @brief
+     *
      * @param pkt Packet to be logged
+     *

Also available in: Unified diff

Project

General

Profile

Colony

Revision 629