Diff: src/ConfigurationHandler/Controls/SetpointControl.cpp

Revision:

195:21df85341cb3

Parent:

194:5aa463e15d27

Child:

198:2fe695f5cb42

--- a/src/ConfigurationHandler/Controls/SetpointControl.cpp	Thu Oct 06 15:46:13 2016 +0000
+++ b/src/ConfigurationHandler/Controls/SetpointControl.cpp	Thu Oct 06 19:31:13 2016 +0000
@@ -13,13 +13,14 @@
 
 extern mDot *GLOBAL_mdot;
 
-// Method:          load
-// Description:     open the configuration file and assign data to the
+//
+// method:          load
+// description:     open the configuration file and assign data to the
 //                  setpoint control object
 //
 // @param           controlFile -> name of the control file
 // @return          true if data is assigned; false on error
-
+//
 bool SetpointControl::load(string _controlFile)
 {
     MbedJSONValue json_value;           // JSON parsing element
@@ -78,26 +79,28 @@
     return true;        // object created successfully
 }
 
-// Method:          start
-// Description:     start the setpoint control
+//
+// method:          start
+// description:     start the setpoint control
 //
 // @param           none
 // @return          none
-
+//
 void SetpointControl::start(void)
 {
     // this is the initial state; what else needs to be done??
     this->currentState = STATE_STARTUP;
 }
 
-// Method:          update
-// Description:     based on the state of the control, check for
+//
+// method:          update
+// description:     based on the state of the control, check for
 //                  under limit and over limit values, adjust the
 //                  state accordingly
 //
 // @param           none
 // @return          none
-
+//
 void SetpointControl::update(void)
 {
     switch (this->currentState) {
@@ -139,13 +142,14 @@
     }
 }
 
-// Method:              overLimit
-// Description:         (see @return)
+//
+// method:              overLimit
+// description:         (see @return)
 //
 // @param               none
 // @return              true if product is over the upper limit for normal mode
 //                      or under the limit for reverse mode; false otherwise
-
+//
 bool SetpointControl::overLimit(void)
 {
     ModbusValue value;
@@ -161,14 +165,14 @@
     }
 }
 
-
-// Method:              underLimit
-// Description:         (see @return)
+//
+// method:              underLimit
+// description:         (see @return)
 //
 // @param               none
 // @return              true if product is under lower limit for normal mode or
 //                      over the upper limit for reverse mode; false otherwise
-
+//
 bool SetpointControl::underLimit(void)
 {
     ModbusValue value;
@@ -184,13 +188,14 @@
     }
 }
 
-// Method:              startFeed()
-// Description:         send ON indication to Output Master for this control's
+//
+// method:              startFeed()
+// description:         send ON indication to Output Master for this control's
 //                      relay
 //
 // @param               none
 // @return              none
-
+//
 void SetpointControl::startFeed(void)
 {
     logInfo("%s: %s attempting to start feed on relay %s\n",
@@ -208,13 +213,14 @@
     OutputMasterMailBox.put(output_mail);
 }
 
-// Method:              stopFeed
-// Description:         send OFF indication to Output Master for this control's
+//
+// method:              stopFeed
+// description:         send OFF indication to Output Master for this control's
 //                      relay
 //
 // @param               none
 // @return              none
-
+//
 void SetpointControl::stopFeed(void)
 {
     logInfo("%s: %s attempting to stop feed on relay %s\n",
@@ -232,12 +238,14 @@
     OutputMasterMailBox.put(output_mail);
 }
 
-// Method:              unregisterControl
-// Description:         send OFF indication to Output Master for this control's
+//
+// dethod:              unregisterControl
+// description:         send OFF indication to Output Master for this control's
 //                      relay
 //
 // @param               none
 // @return              none
+//
 void SetpointControl::unregisterControl(void)
 {
     logInfo("%s: %s attempting to unregister %s\n",
@@ -255,11 +263,13 @@
     OutputMasterMailBox.put(output_mail);
 }
 
-// Method:              display
-// Description:         display the control's information
+//
+// method:              display
+// description:         display the control's information
 //
 // @param               none
 // @return              none
+//
 void SetpointControl::display(void)
 {
     // NOTE: this mapping must be 1:1 with "State" enumeration in SetpointControl.h