Index: sources/ApplicationController.h =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rc503f43840024e18650c1ac558448dd0f3b70427 --- sources/ApplicationController.h (.../ApplicationController.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/ApplicationController.h (.../ApplicationController.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) @@ -18,10 +18,10 @@ #include // Project -#include "main.h" +#include "main.h" // Doxygen : don't remove +#include "MModel.h" #include "GuiGlobals.h" #include "ApplicationPost.h" -#include "MModel.h" #include "MessageGlobals.h" // define @@ -34,10 +34,21 @@ using namespace Gui; using namespace Can; +/*! + * \brief The ApplicationController class + * \details Singleton class which is the main gateway of all signal/slots. + * This class is the main 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 main state machine will decide on the state of the device what needs to be done. + * \note States are like [Idle, Out of Battery, Fault, FW connection lost] and such + */ class ApplicationController : public QObject { Q_OBJECT + // Singleton + SINGLETON(ApplicationController) + // friends friend class ::tst_initializations; @@ -46,9 +57,6 @@ QThread *_thread = nullptr; bool _init = false; -// Singleton -SINGLETON(ApplicationController); - public slots: bool init(); bool init(QThread &vThread);