Diff: SPS/SPS.cpp

Revision:

26:68277a308839

Parent:

25:57f9e3273979

Child:

28:ed0d29f63b55

--- a/SPS/SPS.cpp	Fri Jun 02 10:43:14 2017 +0000
+++ b/SPS/SPS.cpp	Tue Aug 15 13:41:07 2017 +0000
@@ -138,7 +138,23 @@
     addToCurrentString(LINESTOP); 
 };
 
-//Updates current header string
+//! UpdateHeaderString, header / RMRK update method
+/*! 
+
+    Updates header / RMRK string
+
+    \param identifier_id: string containing the identifier id of the unit.
+    \param group_id: string containing the group id of the unit. 
+    \param ZZZ: string containing "ZZZ" :)
+    \param encoding: string containing encoding as described in the *.sps documentation
+    \param source_id: string containing the source id of the unit eg. "0000"
+    \param interpreter_id: string containing the interpreter id of the unit eg. "00"
+    \param data_line_version: string containing data line version as described in the *.sps documentation, eg. "01" 
+    \param source_firmware_version: string containing the firmware version of the unit eg. "1.2"
+    \param barcode: string containing the barcode of the unit, eg. "12345" 
+    \param interpreter_firmware_version: string containing interpreter firmware version
+              
+*/
 void SPS::UpdateHeaderString(string barcode, string identifier_id, string group_id, string ZZZ, string encoding,string source_id, string interpreter_id, string data_line_version, string source_firmware_version, string interpreter_firmware_version){
 
     this->headerString = "";
@@ -427,6 +443,11 @@
 };
 
 
+
+//! addToCurrentHeaderString, appends string to the current header string
+/*! 
+    \param data: data string
+*/ 
 void SPS::addToCurrentHeaderString(string data){
     int currentStartIndex = strlen(this->headerString.c_str());
     char dataStrLen = 0;
@@ -447,6 +468,10 @@
 };
 
 
+//! addToCurrentHeaderString, appends char to the current header string
+/*! 
+    \param data: data char
+*/ 
 void SPS::addToCurrentHeaderString(char data){
     int currentStartIndex = strlen(this->headerString.c_str());
     this->headerString[currentStartIndex] = data;