Index: denali.pro.user =================================================================== diff -u -rd8027c74c31ed6c4212d3fbb9a1523eedb7d685d -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- denali.pro.user (.../denali.pro.user) (revision d8027c74c31ed6c4212d3fbb9a1523eedb7d685d) +++ denali.pro.user (.../denali.pro.user) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -1,6 +1,6 @@ - + EnvironmentId Index: sources/canbus/CanInterface.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/canbus/CanInterface.h (.../CanInterface.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/canbus/CanInterface.h (.../CanInterface.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -34,7 +34,7 @@ namespace Can { /*! - * \brief CANBUS interface + * \brief CANBus interface * \details This class contains the interface to CANBUS * And utilizes Qt QCanBus to interact with the CANBUS * This class works only with the QCanBusFrame frames. @@ -139,6 +139,5 @@ void onFrameReceive (); void onFrameError (QCanBusDevice::CanBusError vError); void onFrameWritten (qint64 vFramesCount); - }; } Index: sources/canbus/MessageAcknowModel.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/canbus/MessageAcknowModel.h (.../MessageAcknowModel.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/canbus/MessageAcknowModel.h (.../MessageAcknowModel.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -159,6 +159,5 @@ void onAcknowTransmit(Can_Id vCan_Id, Sequence vSequence, const FrameList &vFrameList); // Add void onAcknowReceive ( Sequence vSequence ); // Del - }; } Index: sources/canbus/MessageBuilder.h =================================================================== diff -u -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/canbus/MessageBuilder.h (.../MessageBuilder.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) +++ sources/canbus/MessageBuilder.h (.../MessageBuilder.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -53,6 +53,9 @@ /*! * \brief The MessageBuilder class * \details This class is handling the can message by building and striping it. + * This class constructs a message by reading array of bytes (QByteArray) in CANBus frame(s) + * and converting them to messages by reading the Message ID, Data Length and data. + * On the other hand, this class converts bytes of data requires to be transmitted to frame(s) and vice versa. */ class MessageBuilder : public QObject { Index: sources/canbus/MessageDispatcher.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/canbus/MessageDispatcher.h (.../MessageDispatcher.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/canbus/MessageDispatcher.h (.../MessageDispatcher.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -206,6 +206,5 @@ // ---- Signal/Slots ADJUST_TRANSMT_MODEL_BRIDGE_DEFINITIONS_NOEMIT ACTION_RECEIVE_MODEL_BRIDGE_DEFINITIONS - }; } Index: sources/canbus/MessageGlobals.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/canbus/MessageGlobals.h (.../MessageGlobals.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/canbus/MessageGlobals.h (.../MessageGlobals.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -209,5 +209,4 @@ typedef QList MessageList; typedef QList FrameList; - } Index: sources/canbus/MessageInterpreter.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/canbus/MessageInterpreter.h (.../MessageInterpreter.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/canbus/MessageInterpreter.h (.../MessageInterpreter.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -33,6 +33,12 @@ * UI only understands GuiActionType and QVariantList data types * And CANBUS only understands QCanBusFrame with Hex values in QByteArrays * This is the class which interpret this data to/from. + * This class is converting the data of messages to frames regarding the Message ID from values to array of bytes + * or converting the payload of frames from data of messages regarding the Message ID from array of bytes to values. \n + * To make it simple : \n + * - UI => Data of Messages (Values) => Frames (Bytes) => CANBus. \n + * - CANBus => Frames (Bytes) => Data of Messages (Values) => UI. \n + */ class MessageInterpreter : public QObject { 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 Index: sources/gui/GuiView.h =================================================================== diff -u -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/gui/GuiView.h (.../GuiView.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) +++ sources/gui/GuiView.h (.../GuiView.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -31,6 +31,11 @@ * \brief The GuiView class * \details Global view which is used mostly for non-messaging purposes. * Different purposes could be like device notifications and such. + * This class is a general purpose class which is registered in the QML Engine + * to be able to interact with the QML files and receives the user actions and passes them to the GuiController + * for evaluation and applies the navigation validation on the QML. + * \note This class should be used carefully since having a global purpose class can lead to having an entity + * which potentially contains unrelated logics. */ class GuiView : public QObject { Index: sources/model/MDGDebugText.h =================================================================== diff -u -r5db87178d372acd2cc4e5d75bf99f4c0cb11f1f2 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/model/MDGDebugText.h (.../MDGDebugText.h) (revision 5db87178d372acd2cc4e5d75bf99f4c0cb11f1f2) +++ sources/model/MDGDebugText.h (.../MDGDebugText.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -33,21 +33,26 @@ * |:----:|:------:|:-----:|:----:|:---:|:---:|:----:|:---------------------------------------:|:----------------------------------------------------------:| * |0xFFF2| 0x070 | 17 | Event| N | DG | UI | DG debug text for UI to log ASCII text | 40 bytes, null term text + msg overhead will take 6 frames | * + * Logging info : + * + * | typeText | unitText | infoText | + * |:---------:|:--------:|:--------:| + * | Datum | HD | Debug | + * * \sa Data */ class MDGDebugText : public MAbstract { // friends friend class ::tst_models; - // DG Drain Pump Data (U32) Set pt. RPM (U32) DAC value QVariantList parameters() const override; QString _data; public: - Type_Enum typeText () const override { return Type_Enum::eEvent; } + Type_Enum typeText () const override { return Type_Enum::eDatum; } Unit_Enum unitText () const override { return Unit_Enum::eDG ; } QString infoText () const override { return QString("Debug") ; } Index: sources/model/MHDDebugText.h =================================================================== diff -u -r5db87178d372acd2cc4e5d75bf99f4c0cb11f1f2 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/model/MHDDebugText.h (.../MHDDebugText.h) (revision 5db87178d372acd2cc4e5d75bf99f4c0cb11f1f2) +++ sources/model/MHDDebugText.h (.../MHDDebugText.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -33,20 +33,25 @@ * |:----:|:------:|:-----:|:----:|:---:|:---:|:----:|:---------------------------------------:|:----------------------------------------------------------:| * |0xFFF1| 0x020 | 6 | Event| N | HD | UI | HD debug text for UI to log ASCII text | 40 bytes, null term text + msg overhead will take 6 frames | * + * Logging info : + * + * | typeText | unitText | infoText | + * |:---------:|:--------:|:--------:| + * | Datum | HD | Debug | + * * \sa Data */ class MHDDebugText : public MAbstract { // friends friend class ::tst_models; - // DG Drain Pump Data (U32) Set pt. RPM (U32) DAC value QVariantList parameters() const override; QString _data; public: - Type_Enum typeText () const override { return Type_Enum::eEvent; } + Type_Enum typeText () const override { return Type_Enum::eDatum; } Unit_Enum unitText () const override { return Unit_Enum::eHD ; } QString infoText () const override { return QString("Debug") ; } Index: sources/storage/StorageGlobals.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/storage/StorageGlobals.h (.../StorageGlobals.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/storage/StorageGlobals.h (.../StorageGlobals.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -25,5 +25,4 @@ // Log extern const char *SDCard_Base_Path_Name; - } Index: sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationConfirm.h =================================================================== diff -u -r5db87178d372acd2cc4e5d75bf99f4c0cb11f1f2 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationConfirm.h (.../VTreatmentAdjustmentUltrafiltrationConfirm.h) (revision 5db87178d372acd2cc4e5d75bf99f4c0cb11f1f2) +++ sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationConfirm.h (.../VTreatmentAdjustmentUltrafiltrationConfirm.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -70,5 +70,4 @@ */ void didAdjustment(const AdjustUltrafiltrationConfirmRequestData &vData); }; - } Index: sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationEdit.h =================================================================== diff -u -r5db87178d372acd2cc4e5d75bf99f4c0cb11f1f2 -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac --- sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationEdit.h (.../VTreatmentAdjustmentUltrafiltrationEdit.h) (revision 5db87178d372acd2cc4e5d75bf99f4c0cb11f1f2) +++ sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationEdit.h (.../VTreatmentAdjustmentUltrafiltrationEdit.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) @@ -68,5 +68,4 @@ */ void didAdjustment(const AdjustUltrafiltrationEditRequestData &vData); }; - }