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

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.cpp (modified) (6 diffs)

branches/FEPSimulator/DataPacker.cpp

@@ -1 +1 @@
 #include "DataPacker.h"
 
+// declare static message var
 unsigned char * DataPacker::msg;
 
+/**
+ * Returns packed data message to be sent to ATMS Server in fep_reply via RPC
+ * 
+ * @param station The station for which the message is to be made
+ * @return The packed data message
+ */
 unsigned char * DataPacker::packData(STATION *station) {
     int pos = 26;
@@ -44 +51 @@
 }
 
+/**
+ * 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 DataPacker::dynamicDataPack(STATION *station, int packNo, int pos) {
     
@@ -97 +112 @@
     return pos;
 }
-
+/**
+ * Packs the static meta data into the msg
+ * 
+ * @param station station being packed
+ * @return the msg
+ */
 unsigned char * DataPacker::staticDataPack(STATION *station) {
     int j;
@@ -208 +228 @@
 }
 
+/**
+ * Checks if there is data available at the specified lane
+ * @param flag
+ * @param num
+ * @return bool (is data available)
+ */
 bool DataPacker::DataAvail(char flag, int num) {
     int mag, fel;
@@ -238 +264 @@
 }
 
-// checksum based on data from byte 1 (after 0DOA) to the second last byte (the 
+/**
+ * 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 DataPacker::chksum(unsigned char *dataptr, int len) {
     int i;
@@ -249 +281 @@
 }
 
-// convert vol and occ data to a 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 DataPacker::packVOLOCC(int vol, int occ)
 {