Changeset 233 in tmcsimulator for branches/FEPSimulator/DataPacker.h

Timestamp:

11/13/2017 06:07:07 PM (8 years ago)

Author:

jtorres

Message:

FEPSim: finalized comments, added to both header and source files.

File:

• branches/FEPSimulator/DataPacker.h (modified) (1 diff)

branches/FEPSimulator/DataPacker.h

@@ -31 +31 @@
 
 private:
+    // static message var
     static unsigned char *msg;
-    // Packs the static data in message sent to ATMS
+    /**
+     * Packs the static meta data into the msg
+     * 
+     * @param station station being packed
+     * @return the msg
+     */
     unsigned char * staticDataPack(STATION *station);
-    // Packs dynamic data in message sent to ATMS
+    /**
+     * Packs the dynamic (occ/vol) data into the message
+     * 
+     * @param station the station being packed
+     * @param packNo number that specifies which lane types to compare
+     * @param pos position in the message (byte number)
+     * @return position (int)
+     */
     int dynamicDataPack(STATION *station, int packNo, int pos);
-    // Sets last byte of message
+    /**
+     * Returns the sum of values from byte 1 (after 0x0D0A) to the second to last byte
+     * 
+     * @param dataptr msg data pointer
+     * @param len length of message
+     * @return checksum value
+     */
     char chksum(unsigned char *dataptr, int len);
-    // Tells whether or not data is available for specified lane
+    /**
+     * Checks if there is data available at the specified lane
+     * @param flag
+     * @param num
+     * @return bool (is data available)
+     */
     bool DataAvail(char flag, int num);
-    // Helper function: packs vol and occ into two byte data packet
+    /**
+     * Convert volume and occupancy data to a two-byte data packet
+     * @param vol
+     * @param occ
+     * @return the volume occupancy two byte data packet struct
+     */
     VOLOCC packVOLOCC(int vol, int occ);