Index: sources/gui/GuiController.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/gui/GuiController.h (.../GuiController.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/gui/GuiController.h (.../GuiController.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -37,6 +37,11 @@ * This class is the Gui gate keeper for decisions and will decide if a message should pass through the other observers. * Currently (08/30/2020) is a bridge and will pass all the messages. * Later with implementation/help of the Gui state machine will decide on the state of the device what needs to be done. + * This class contains the state of the GUI and it is the first interface between the GUI and the business logic by interfacing with ApplicationController. + * Any Action that happens by the user on the screens needs to be passed to this class, which collaborates with the ApplicationController to validate the action + * and decide on what needs to be done regarding re data transmitting/receiving and the current state of the UI Software application. + * Messages to be transmitted from UI Application perspective to the entities on the CANBus will be passed by onActionTransmit + * and will be decided to be passed down to by emitting the didActionTransmit() signal or needs to be handled by handleTransmit() * \note States are like [wait for user , user attention required , Time outs , ... ] */ class GuiController : public QObject