Index: denali.pro.user =================================================================== diff -u -r4df19fe88c454bd54abcdaf983be59464c5ef5bc -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- denali.pro.user (.../denali.pro.user) (revision 4df19fe88c454bd54abcdaf983be59464c5ef5bc) +++ denali.pro.user (.../denali.pro.user) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,6 +1,6 @@ - + EnvironmentId @@ -1187,7 +1187,7 @@ Qt 5.12.5 (iMX8) Qt 5.12.5 (iMX8) {5d6458ef-f917-4aef-a092-c77bbe106149} - 0 + 1 0 0 Index: main.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- main.cpp (.../main.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ main.cpp (.../main.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -15,10 +15,16 @@ /*! * \mainpage UI Software Design Description - * \section Detailed Description + * \details Detailed Description.\n * This document has been generated by Doxygen.\n * This document describes the detail description of the UI Application Software design.\n - * UI Application starts by Application Initialization which happens in \ref main.cpp "Initialization section".\n + * UI Application starts by Application Initialization which happens in \ref main() "Application Initialization".\n + * For information please see : + * - \ref main() + * - \subpage CommandLineSwitches + * - \subpage DenaliMessageStructure + * - \subpage MessageFlow + * - \subpage MessageView */ // Qt @@ -31,16 +37,16 @@ #include // Project -#include "maintimer.h" -#include "caninterface.h" -#include "frameinterface.h" -#include "messageacknowmodel.h" -#include "messagedispatcher.h" -#include "applicationcontroller.h" -#include "guicontroller.h" -#include "logger.h" +#include "MainTimer.h" +#include "CanInterface.h" +#include "FrameInterface.h" +#include "MessageAcknowModel.h" +#include "MessageDispatcher.h" +#include "ApplicationController.h" +#include "GuiController.h" +#include "Logger.h" #include "DriveWatcher.h" -#include "threads.h" +#include "Threads.h" // kernel #include @@ -76,26 +82,32 @@ bool gConsoleoutCanInterface = false ; /*! - * \brief commandlineParse - * \details parses the command line arguments \n - * Usage: ./denali [options] \n - * Denali \n - * \n - * Options: \n - * -h, --help Displays this help. \n - * -v, --version Displays version information. \n - * -c, --canOut Show the Can Frame Output \n - * -m, --msgOut Show the Message Output \n - * -0, --enable-keep-awake Enable send low priority, empty message on \n - * the CANBus just to keep UI board CAN driver \n - * awake \n - * -i, --fake-interval Test fake message interval(ms) \n - * -f, --fake-message Test fake message data \n - * will use default sequenced long fake message \n - * if set to 00(default) \n - * will used only if correct intger value \n - * assigned for interval option \n + * \page CommandLineSwitches Denali Command Line Switches + * \verbatim + * Usage: ./denali [options] + * Denali + * + * Options: + * -h, --help Displays this help. + * -v, --version Displays version information. + * -c, --canOut Show the Can Frame Output + * -m, --msgOut Show the Message Output + * -0, --enable-keep-awake Enable send low priority, empty message on + * the CANBus just to keep UI board CAN driver + * awake + * -i, --fake-interval Test fake message interval(ms) + * -f, --fake-message Test fake message data + * will use default sequenced long fake message + * if set to 00(default) + * will used only if correct integer value + * assigned for interval option + * \endverbatim */ +/*! + * \brief commandlineParse + * \details parses the command line arguments + * \ref CommandLineSwitches + */ void commandlineParse() { QCommandLineParser parser; parser.setApplicationDescription(QApplication::applicationName()); @@ -214,10 +226,11 @@ #include TEST_CLASS_INCLUDE QTEST_MAIN(TEST_CLASS_NAME) #else -/*! \brief Application Initialization\n - * Some part of the application need to be initialized out of any thread. - * So is initialized here to be initialized in the main thread. - * this section also includes: +/*! + * \brief Application Initialization + * \details Some part of the application need to be initialized out of any thread. + * So is initialized here to be initialized in the main thread. + * this section also includes: */ int main(int argc, char *argv[]) { @@ -271,21 +284,21 @@ " \n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ "); } - //! - Initializing USB Watcher + //! - Initializing the Drive Watcher _DriveWatcher.init(Threads::_DriveWatcher_Thread); - //! - Initializing CanBus Interface + //! - Initializing the CANBus Interface if (_CanInterface.init(Threads::_CanFrame_Thread)) { _CanInterface.enableConsoleOut(gConsoleoutCanInterface); } - //! - Initializing CanBus Message Handler + //! - Initializing the CANBus Message Handler _FrameInterface.init(Threads::_CanFrame_Thread); - //! - Initializing the CanBus Message Acknowledgment Model + //! - Initializing the CANBus Message Acknowledgment Model _MessageAcknowModel.init(Threads::_CanAcknow_Thread); - //! - Initializing CanBus Message Dispatcher + //! - Initializing the CANBus Message Dispatcher if (_MessageDispatcher.init(Threads::_CanMessage_Thread)) { _MessageDispatcher.enableConsoleOut(gConsoleoutFrameInterface); } @@ -300,7 +313,7 @@ _MainTimer.init(); - //! - Initialize the Qml Viewer and starts GUI + //! - Initialize the QML Viewer and starts GUI int app_exec = -1; LOG_DEBUG("UI Initializing"); if ( startGui() ) { Index: sources/ApplicationPost.cpp =================================================================== diff -u -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/ApplicationPost.cpp (.../ApplicationPost.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) +++ sources/ApplicationPost.cpp (.../ApplicationPost.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file ApplicationPost.cpp * \author (last) Behrouz NematiPour - * \date (last) 13-Apr-2020 + * \date (last) 20-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 * Index: sources/MainTimer.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/MainTimer.cpp (.../MainTimer.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/MainTimer.cpp (.../MainTimer.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file MainTimer.cpp * \author (last) Behrouz NematiPour - * \date (last) 13-Apr-2020 + * \date (last) 03-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 * Index: sources/abstract/singleton.h._ =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/abstract/singleton.h._ (.../singleton.h._) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/abstract/singleton.h._ (.../singleton.h._) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,16 +1,16 @@ /*! - * + * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * + * * \file singleton.h * \author (last) Behrouz NematiPour * \date (last) 02-Jan-2020 * \author (original) Behrouz NematiPour * \date (original) 02-Jan-2020 - * + * */ #pragma once Index: sources/canbus/CanInterface.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/canbus/CanInterface.cpp (.../CanInterface.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/canbus/CanInterface.cpp (.../CanInterface.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file CanInterface.cpp * \author (last) Behrouz NematiPour - * \date (last) 07-May-2020 + * \date (last) 25-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 28-Oct-2019 * Index: sources/canbus/CanInterface.h =================================================================== diff -u -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/canbus/CanInterface.h (.../CanInterface.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) +++ sources/canbus/CanInterface.h (.../CanInterface.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file CanInterface.h * \author (last) Behrouz NematiPour - * \date (last) 02-Mar-2020 + * \date (last) 20-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 28-Oct-2019 * Index: sources/canbus/MessageAcknowModel.h =================================================================== diff -u -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/canbus/MessageAcknowModel.h (.../MessageAcknowModel.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) +++ sources/canbus/MessageAcknowModel.h (.../MessageAcknowModel.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file MessageAcknowModel.h * \author (last) Behrouz NematiPour - * \date (last) 07-May-2020 + * \date (last) 10-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 17-Jan-2020 * Index: sources/canbus/MessageBuilder.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/canbus/MessageBuilder.cpp (.../MessageBuilder.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/canbus/MessageBuilder.cpp (.../MessageBuilder.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file MessageBuilder.cpp * \author (last) Behrouz NematiPour - * \date (last) 07-May-2020 + * \date (last) 20-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 09-Dec-2019 * Index: sources/canbus/MessageBuilder.h =================================================================== diff -u -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/canbus/MessageBuilder.h (.../MessageBuilder.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) +++ sources/canbus/MessageBuilder.h (.../MessageBuilder.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file MessageBuilder.h * \author (last) Behrouz NematiPour - * \date (last) 07-May-2020 + * \date (last) 20-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 09-Dec-2019 * Index: sources/canbus/MessageInterpreter.h =================================================================== diff -u -r37e62f8f5c0345cd65b5e4161f07e86b442c22ac -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/canbus/MessageInterpreter.h (.../MessageInterpreter.h) (revision 37e62f8f5c0345cd65b5e4161f07e86b442c22ac) +++ sources/canbus/MessageInterpreter.h (.../MessageInterpreter.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -88,6 +88,5 @@ signals: ACTION_RECEIVE_SIGNALS - }; } Index: sources/configuration/display.cpp._ =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/configuration/display.cpp._ (.../display.cpp._) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/configuration/display.cpp._ (.../display.cpp._) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,16 +1,16 @@ /*! - * + * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * + * * \file display.cpp * \author (last) Behrouz NematiPour * \date (last) 16-Jan-2020 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 - * + * */ #include "display.h" Index: sources/configuration/display.h._ =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/configuration/display.h._ (.../display.h._) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/configuration/display.h._ (.../display.h._) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,16 +1,16 @@ /*! - * + * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * + * * \file display.h * \author (last) Behrouz NematiPour * \date (last) 24-Oct-2019 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 - * + * */ #pragma once Index: sources/configuration/sound.cpp._ =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/configuration/sound.cpp._ (.../sound.cpp._) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/configuration/sound.cpp._ (.../sound.cpp._) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,16 +1,16 @@ /*! - * + * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * + * * \file sound.cpp * \author (last) Behrouz NematiPour * \date (last) 16-Jan-2020 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 - * + * */ #include "sound.h" Index: sources/configuration/sound.h._ =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/configuration/sound.h._ (.../sound.h._) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/configuration/sound.h._ (.../sound.h._) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,16 +1,16 @@ /*! - * + * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * + * * \file sound.h * \author (last) Behrouz NematiPour * \date (last) 24-Oct-2019 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 - * + * */ #pragma once Index: sources/gui/GuiView.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/gui/GuiView.cpp (.../GuiView.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/gui/GuiView.cpp (.../GuiView.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file GuiView.cpp * \author (last) Behrouz NematiPour - * \date (last) 21-May-2020 + * \date (last) 25-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 * Index: sources/main.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/main.h (.../main.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/main.h (.../main.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -33,6 +33,10 @@ vCLASS(vCLASS const &) = delete; \ vCLASS & operator = (vCLASS const &) = delete; \ public: \ + /*! \brief instance accessor + \details A singleton class single instance creator/accessor + \return reference to the class static instance + */\ static vCLASS &I() { \ static vCLASS _instance; \ return _instance; \ @@ -50,46 +54,77 @@ //--------------------------------------------------------------------------------// #define DEBUG_PROPERTY_CHANGED(vVARIABLE) //qDebug() << "#" << #vVARIABLE << v##vVARIABLE; //--------------------------------------------------------------------------------// -#define PROPERTY_SLOT( vTYPE , vVARIABLE ) \ - protected : \ - void vVARIABLE ( const vTYPE & v##vVARIABLE ) { \ - static bool init = false; \ - if ( !init || _##vVARIABLE != v##vVARIABLE ) { \ - DEBUG_PROPERTY_CHANGED(vVARIABLE) \ - init = true; \ - _##vVARIABLE = v##vVARIABLE; \ - emit vVARIABLE##Changed( _##vVARIABLE ); \ - } \ +#define PROPERTY_SLOT( vTYPE , vVARIABLE ) \ + protected : \ + /*! \brief Property setter + \details The property setter which update the private variable \n + - if only the value has been changed \n + - or it's the first time property is set. \n + emits the Property notify (...Changed) signal on update. \n + the notify signal (...Changed) passes the new value as its parameter. \n + \param new value + */\ + void vVARIABLE ( const vTYPE & v##vVARIABLE ) { \ + static bool init = false; \ + if ( !init || _##vVARIABLE != v##vVARIABLE ) { \ + DEBUG_PROPERTY_CHANGED(vVARIABLE) \ + init = true; \ + _##vVARIABLE = v##vVARIABLE; \ + emit vVARIABLE##Changed( _##vVARIABLE ); \ + } \ } //--------------------------------------------------------------------------------// -#define TRIGGER_SLOT( vTYPE , vVARIABLE ) \ - protected: \ - void vVARIABLE ( const vTYPE & v##vVARIABLE ) { \ - DEBUG_PROPERTY_CHANGED(vVARIABLE) \ - _##vVARIABLE = v##vVARIABLE; \ - emit vVARIABLE##Triggered( _##vVARIABLE ); \ +#define TRIGGER_SLOT( vTYPE , vVARIABLE ) \ + protected: \ + /*! \brief Trigger setter + \details The Trigger setter which update the private variable \n + with no condition each time the value the passed. \n + emits the Trigger notify (...Triggered) signal after update. \n + the notify signal (...Triggered) passes the new value as its parameter.\n + \param new value + */\ + void vVARIABLE ( const vTYPE & v##vVARIABLE ) { \ + DEBUG_PROPERTY_CHANGED(vVARIABLE) \ + _##vVARIABLE = v##vVARIABLE; \ + emit vVARIABLE##Triggered( _##vVARIABLE ); \ } //--------------------------------------------------------------------------------// -#define PROPERTY_BASE(vTYPE , vVARIABLE , vDEFVALUE, vSIGNAL) \ - Q_PROPERTY( vTYPE vVARIABLE \ - READ vVARIABLE \ - WRITE vVARIABLE \ - NOTIFY vVARIABLE##vSIGNAL) \ - Q_SIGNALS: \ - void vVARIABLE##vSIGNAL( const vTYPE & v##vVARIABLE ); \ - private: \ - vTYPE _##vVARIABLE = vDEFVALUE; \ - protected: \ - vTYPE vVARIABLE () const { \ - return _##vVARIABLE ; \ - } +#define PROPERTY_BASE(vTYPE , vVARIABLE , vDEFVALUE, vSIGNAL) \ + /*! \brief Qt Property declaration + \details The Qt Property definition by Q_PROPERTY documentation. + */\ + Q_PROPERTY( vTYPE vVARIABLE \ + READ vVARIABLE \ + WRITE vVARIABLE \ + NOTIFY vVARIABLE##vSIGNAL) \ + Q_SIGNALS: \ + /*! \brief Property notify signal + \details The property notify signal (...Changed) + which will be emitted by property setter + - if only the value has been changed \n + - or it's the first time property is set. \n + \return current value + */\ + void vVARIABLE##vSIGNAL( const vTYPE & v##vVARIABLE ); \ + private: \ + vTYPE _##vVARIABLE = vDEFVALUE; \ + protected: \ + /*! \brief Property getter + \details The property getter which reads the private variable + \return current value + */\ + vTYPE vVARIABLE () const { \ + return _##vVARIABLE ; \ + } //--------------------------------------------------------------------------------// -#define PROPERTY( vTYPE , vVARIABLE , vDEFVALUE ) \ - PROPERTY_BASE( vTYPE , vVARIABLE , vDEFVALUE , Changed ) \ +#define PROPERTY( vTYPE , vVARIABLE , vDEFVALUE ) \ + \ + PROPERTY_BASE( vTYPE , vVARIABLE , vDEFVALUE , Changed ) \ PROPERTY_SLOT( vTYPE , vVARIABLE) //--------------------------------------------------------------------------------// -#define TRIGGER( vTYPE , vVARIABLE , vDEFVALUE ) \ - PROPERTY_BASE( vTYPE , vVARIABLE , vDEFVALUE , Triggered) \ +#define TRIGGER( vTYPE , vVARIABLE , vDEFVALUE ) \ + \ + PROPERTY_BASE( vTYPE , vVARIABLE , vDEFVALUE , Triggered) \ TRIGGER_SLOT( vTYPE , vVARIABLE) //--------------------------------------------------------------------------------// //--------------------------------------------------------------------------------// @@ -114,53 +149,91 @@ //--------------------------------------------------------------------------------// #define ACTION_RECEIVE_PRIVATE_SLOT(vTYPE) \ private Q_SLOTS: \ + /*! \brief Bridge slot + \details The bridge slot is for thread safety between classes for received message + and is used to emit its signal to pass the model data to next observer. + \param vData - The model data which has been received. + \note This method is private and the interface is signals only. (starts with 'on') + */\ void onActionReceive (const vTYPE &vData) { \ emit didActionReceive(vData); \ } //--------------------------------------------------------------------------------// #define ADJUST_TRANSMT_PRIVATE_SLOT_DEFINITION(vTYPE) \ private Q_SLOTS: \ + /*! \brief Adjustment slot + \details The bridge slot is for thread safety between classes for adjustment messages + and is used to emit its signal to pass the model data to next observer. + \param vData - The model data to be used for adjustment + \note This method is private and the interface is signals only. (starts with 'on') + This slot has to have its specific implementation and is not a bridge (not a signal emitter). + */\ void onAdjustment (const vTYPE &vData); //--------------------------------------------------------------------------------// #define ADJUST_TRANSMT_PRIVATE_SLOT(vTYPE) \ private Q_SLOTS: \ + /*! \brief Adjustment bridge slot + \details The bridge slot is for thread safety between classes for adjustment messages + and is used to emit its signal to pass the model data to next observer. + \param vData - The model data to be used for adjustment + \note This method is private and the interface is signals only. (starts with 'on') + */\ void onAdjustment (const vTYPE &vData) { \ emit didAdjustment( vData); \ } //--------------------------------------------------------------------------------// #define ADJUST_TRANSMT_PUBLIC_SLOT(vTYPE) \ public Q_SLOTS: \ + /*! \brief Adjustment invocable/exposed slot + \details This slot is able to be called within QML context + when an object of the class is instantiated in QML. + For thread safety it's calling its designated signal to notify observers. + \note This method is public and is the interface. (starts with 'do') + */\ void doAdjustment (const vTYPE &vData) { \ emit didAdjustment( vData); \ } //--------------------------------------------------------------------------------// #define ACTION_RECEIVE_SIGNAL(vTYPE) \ Q_SIGNALS: \ + /*! \brief Receive bridge signal + \details The bridge signal is for thread safety between classes for received message + and is used to be emitted in its slot to pass the model data to next observer. + \param vData - The model data which has been received. + \note This method is public to be exposed to the observers to be able to connect to it as the interface. (starts with 'did') + */\ void didActionReceive (const vTYPE &vData); //--------------------------------------------------------------------------------// -#define ACTION_TRANSMT_SIGNAL(vTYPE) \ -Q_SIGNALS: \ - void didActionTransmit(const vTYPE &vData); -//--------------------------------------------------------------------------------// #define ADJUST_TRANSMT_SIGNAL(vTYPE) \ Q_SIGNALS: \ + /*! \brief Adjustment bridge signal + \details The bridge signal is for thread safety between classes for received message + and is used to be emitted in its slot to pass the model data to next observer. + \param vData - The model data which has been received. + \note This method is public to be exposed to the observers to be able to connect to it as the interface. (starts with 'did') + */\ void didAdjustment (const vTYPE &vData); //--------------------------------------------------------------------------------// #define ACTION_RECEIVE_BRIDGE_DEFINITION(vTYPE) \ + \ ACTION_RECEIVE_PRIVATE_SLOT (vTYPE) \ - ACTION_RECEIVE_SIGNAL (vTYPE) + ACTION_RECEIVE_SIGNAL (vTYPE) \ //--------------------------------------------------------------------------------// #define ADJUST_TRANSMT_BRIDGE_DEFINITION_NOEMIT(vTYPE) \ + \ ADJUST_TRANSMT_PRIVATE_SLOT_DEFINITION (vTYPE) \ - ADJUST_TRANSMT_SIGNAL (vTYPE) + ADJUST_TRANSMT_SIGNAL (vTYPE) \ //--------------------------------------------------------------------------------// #define ADJUST_TRANSMT_BRIDGE_DEFINITION(vTYPE) \ + \ ADJUST_TRANSMT_PRIVATE_SLOT (vTYPE) \ - ADJUST_TRANSMT_SIGNAL (vTYPE) + ADJUST_TRANSMT_SIGNAL (vTYPE) \ //--------------------------------------------------------------------------------// #define ADJUST_TRANSMT_BRIDGE_DEFINITION_PUBLIC(vTYPE) \ + \ ADJUST_TRANSMT_PUBLIC_SLOT (vTYPE) \ - ADJUST_TRANSMT_SIGNAL (vTYPE) + ADJUST_TRANSMT_SIGNAL (vTYPE) \ + //--------------------------------------------------------------------------------// #define REGISTER_METATYPE(vTYPE) \ qRegisterMetaType < vTYPE > (#vTYPE); Index: sources/model/MAbstract.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/MAbstract.h (.../MAbstract.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/MAbstract.h (.../MAbstract.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -23,6 +23,12 @@ namespace Model { +/*! + * \brief The MAbstract class + * \details All the Message Models has to be inherited from MAbstract + * As this class is abstract it dictates children to implement required methods. + * And also implements some some share methods to ease implementing Models. + */ class MAbstract { private: @@ -33,7 +39,8 @@ enum class Type_Enum { eDatum, eEvent, - }; + }; + enum class Unit_Enum { eUI, eHD, @@ -53,18 +60,43 @@ }; public: - // the model needs to implement these since each model have different meaning of the bytes from different source(unit). + + /*! + * \brief fromByteArray + * \details converts the values from Byte Arrays to the Model data. + * \param vByteArray - the byte array input + * \param vIndex - current index of each data section in byte array + * \return true on successful conversion + */ virtual bool fromByteArray(const QByteArray &vByteArray , int *vIndex = nullptr) = 0; + /*! + * \brief typeText + * \details type of the model which can be Data or Event which is mostly used in logging. + * \return Enum of Types + */ virtual Type_Enum typeText ( ) const = 0; + /*! + * \brief unitText + * \details the unit which UI communicates with by using this model and is used in Logging mostly + * \return Enum of Units + */ virtual Unit_Enum unitText ( ) const = 0; + /*! + * \brief infoText + * \details the text description of the model which will be used in the logging. + * \return QString + */ virtual QString infoText ( ) const = 0; + /*! + * \brief parameters + * \return current data values of the models. + */ virtual QVariantList parameters ( ) const = 0; - // Non-virtuals which working with parameters virtual method. + // Non-virtual methods which working with parameters virtual method. void toVariantList(QVariantList &vData) const; QString toString ( ) const; QString description ( ) const; }; - } Index: sources/model/MDGDebugText.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/MDGDebugText.cpp (.../MDGDebugText.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/MDGDebugText.cpp (.../MDGDebugText.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -5,11 +5,9 @@ * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file MDGDebugText.cpp - * \author (last) Behrouz NematiPour - * \date (last) 20-Aug-2020 - * \author (original) Behrouz NemaiPour - * \date (original) 13-Jul-2020 + * \file MDGDebugText.h + * \date 7/9/2020 + * \author Behrouz NematiPour * */ #include "MDGDebugText.h" @@ -29,6 +27,11 @@ return true ; } +/*! + * \brief MDGDebugText::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MDGDebugText::Data MDGDebugText::data() const { Data data; data.text = _data; Index: sources/model/MDGDebugText.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/MDGDebugText.h (.../MDGDebugText.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/MDGDebugText.h (.../MDGDebugText.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -5,11 +5,9 @@ * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file MDGDebugText.h - * \author (last) Behrouz NematiPour - * \date (last) 03-Aug-2020 - * \author (original) Behrouz NemaiPour - * \date (original) 13-Jul-2020 + * \file MDGDebugText.h + * \date 7/9/2020 + * \author Behrouz NematiPour * */ #pragma once @@ -26,19 +24,34 @@ namespace Model { +/*! + * \brief The MDGDebugText class + * \details the Debug Text Message from DG + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | Payload | + * |:----:|:------:|:-----:|:----:|:---:|:---:|:----:|:---------------------------------------:|:----------------------------------------------------------:| + * |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") ; } @@ -47,9 +60,8 @@ }; bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; - Data data ( ) const; + Data data ( ) const ; }; - } typedef Model::MDGDebugText::Data DGDebugTextData; Index: sources/model/MHDDebugText.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/MHDDebugText.cpp (.../MHDDebugText.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/MHDDebugText.cpp (.../MHDDebugText.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -5,11 +5,9 @@ * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file MHDDebugText.cpp - * \author (last) Behrouz NematiPour - * \date (last) 20-Aug-2020 - * \author (original) Behrouz NemaiPour - * \date (original) 13-Jul-2020 + * \file MHDDebugText.h + * \date 7/9/2020 + * \author Behrouz NematiPour * */ #include "MHDDebugText.h" @@ -29,6 +27,11 @@ return true ; } +/*! + * \brief MHDDebugText::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MHDDebugText::Data MHDDebugText::data() const { Data data; data.text = _data; Index: sources/model/MHDDebugText.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/MHDDebugText.h (.../MHDDebugText.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/MHDDebugText.h (.../MHDDebugText.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -5,11 +5,9 @@ * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file MHDDebugText.h - * \author (last) Behrouz NematiPour - * \date (last) 03-Aug-2020 - * \author (original) Behrouz NemaiPour - * \date (original) 13-Jul-2020 + * \file MHDDebugText.h + * \date 7/9/2020 + * \author Behrouz NematiPour * */ #pragma once @@ -26,18 +24,33 @@ namespace Model { +/*! + * \brief The MHDDebugText class + * \details the Debug Text Message from HD + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | Payload | + * |:----:|:------:|:-----:|:----:|:---:|:---:|:----:|:---------------------------------------:|:----------------------------------------------------------:| + * |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") ; } @@ -46,9 +59,8 @@ }; bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; - Data data ( ) const; + Data data ( ) const ; }; - } typedef Model::MHDDebugText::Data HDDebugTextData; Index: sources/model/MModel.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/MModel.h (.../MModel.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/MModel.h (.../MModel.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -5,11 +5,9 @@ * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file MModel.h - * \author (last) Behrouz NematiPour - * \date (last) 20-Aug-2020 - * \author (original) Behrouz NemaiPour - * \date (original) 02-Jul-2020 + * \file MModel.h + * \date 3/4/2020 + * \author Behrouz NematiPour * */ #pragma once @@ -53,71 +51,128 @@ #include "MTreatmentAdjustSalineResponse.h" /*! - * \brief Message interpretation instruction - * \details This comment explains how to add a Denali Message in Denali UI Application + * \page MessageFlow Message interpretation Flow + * \dot + * digraph callgraph { + * node [shape=ellipse, fontname=Arial, fontsize=11]; + * user [shape=box ]; + * QML [URL="\ref application/sources/gui" ]; + * GuiView [URL="\ref Gui::GuiView" ]; + * View [URL="\ref application/sources/view" ]; + * GuiController [URL="\ref Gui::GuiController" ]; + * ApplicationController [URL="\ref ApplicationController" ]; + * FrameInterface [URL="\ref Can::FrameInterface" ]; + * CanInterface [URL="\ref Can::CanInterface" ]; + * CANBus [shape=box ]; + * subgraph MessageDispatcher { + * node [shape=ellipse, fontname=Arial, fontsize=11, URL="\ref Can::MessageDispatcher"]; + * label = "Message_Dispatcher"; + * MessageAcknow [URL="\ref Can::MessageAcknowModel" ]; + * MessageInterpreter [URL="\ref Can::MessageInterpreter" ]; + * MessageBuilder [URL="\ref Can::MessageBuilder" ]; + * MessageDispatcher -> MessageInterpreter [dir="both" ]; + * MessageDispatcher -> MessageAcknow [dir="both" ]; + * MessageInterpreter -> MessageBuilder [dir="both" ]; + * } + * user -> QML [dir="both" ]; + * QML -> { GuiView, } [dir="both" ]; + * { GuiView, } -> GuiController [dir="both" ]; + * GuiController -> ApplicationController [dir="both" ]; + * ApplicationController -> MessageDispatcher [dir="both" ]; + * MessageDispatcher -> FrameInterface [dir="both" ]; + * FrameInterface -> CanInterface [dir="both" ]; + * CanInterface -> CANBus [dir="both" ]; + * } * - * 1 - Look at the message structure in the "message list.xlsx" * - * 2 - MSG ID : - * Add an enum for the message in the guiglobals.h : GuiActionsType_Enum - * and assign a correct message value to it. - * example : MSG ID = 9 => - * \code{.cpp} - * PressureOcclusion = 0x0900, //(little endian) - * \endcode + * \enddot * - * 3 - MSG Payload Len : - * Add a line in the "messageglobals.h" in payloadLen hash table - * to define the required payload length of the message + * \note + * 00 - sort .pro file after all new files added. * - * 4 - Model Implementation : - * Implement a model like MPressureOcclusion by copy/paste the closest model .h/.cpp file - * and adding it to project and modify to fit the new model. + * \details + * This comment explains how to add a Denali Message in Denali UI Application * - * 5 - Register Model : - * Add the required lines like the other models in the mmodel.h file. + * Model : * - * 6 - Populate/Interpret Model Data : - * Copy/Paste one of the other implementations of the Messages setter/getter. - * example : be careful about the type. - * in the header should be like: - * \code{.cpp} - * bool pressureOcclusionData (const Message &vMessage, QVariantList &vData) __attribute_warn_unused_result__; - * \endcode - * in the implementation should be like: - * \code{.cpp} - * bool MessageInterpreter::pressureOcclusionData(const Message &vMessage, QVariantList &vData) - * { - * // TODO : review other methods - * bool ok = false; - * if ( ! isType (vMessage, Gui::GuiActionType::PressureOcclusion) ) return ok; - * if ( ! isPayloadLenValid(vMessage, Gui::GuiActionType::PressureOcclusion) ) return ok; + * 01 - Look at the message structure in the "message list.xlsx" and in GuiGlobals.h define enum ID_ + * Add an enum for the message in the guiglobals.h : GuiActionsType_Enum + * and assign a correct message value to it. + * Note that it needs to be in little endian so if you have a message Id of 37 your enum should have a value of 0x2500 in hex. + * \code{.cpp} + * ID_HDOperationModeData = 0x2500, // 37 // little endian + * \endcode * - * Model::MPressureOcclusion mData; - * ok = mData.fromByteArray(vMessage.data); - * LOG_DATUM("HD," + mData.toString()); + * 02 - MessageGlobals.h : add len + * \code{.cpp} + * {Gui::GuiActionType::ID_HDOperationModeData , 1 * 4 }, // 1 parameter each 4bytes + * \endcode * - * mData.toVariantList(vData); - * emit didActionReceive(mData.data()); + * 03 - Implement the model by copy/paste of the closest model, fit to your need. + * \sa MHDOperationMode + * \sa MHDOperationModeData.h + * \sa MHDOperationModeData.cpp * - * return ok; - * } - * \endcode + * 04 - Added #include in MModel.h for the implemented model + * \code{.cpp} + * #include "MHDOperationModeData.h" + * \endcode * - * Add a case in MessageInterpreter::interpretMessage_HD for that message id Enum - * with lines like : - * \code{.cpp} - * case Gui::GuiActionType::PressureOcclusion: - * ok = pressureOcclusionData (vMessage, vData); - * break; - * \endcode + * 05 - Register the model in MModel.h by adding it to the macro lists : + * - \ref REGISTER_MODEL_METATYPES + * - \ref ACTION_RECEIVE_MODEL_BRIDGE_CONNECTIONS + * - \ref ACTION_RECEIVE_MODEL_BRIDGE_DEFINITIONS + * - \ref ACTION_RECEIVE_SIGNALS * + * 06 - In the MessageInterpreter add a line of handler in interpretMessage_ method + * and put the enum and model. + * \sa MessageInterpreter::interpretMessage_HD + * \sa MessageInterpreter::interpretMessage_DG + * \sa MessageInterpreter.cpp + * + * View : + * 07 - Implement the view by copy/paste of the closest view, fit to your need. + * \sa VHDOperationMode + * \sa VHDOperationModeData.h + * \sa VHDOperationModeData.cpp + * + * 08 - Register the view in VView.h in macro list + * \sa REGISTER_VIEW_TYPES + * \sa VView.h + * + * 09 - Include the view header in the GuiGlobals.cpp + * \code{.cpp} + * #include "VHDOperationModeData.h" + * \endcode + * \sa GuiGlobals.cpp + * + * QML : + * 10 - Import the registered view + * \code{.js} + * import VHDOperationMode 0.1; + * \endcode + * \sa main.qml + * + * 11 - Create an object + * \code{.js} + * VHDOperationMode { id: vHDOperationMode } + * \endcode + * \sa main.qml + * + * 12 - Use it. */ + //--------------------------------------------------------------------------------// //-------- Please add the model type to the lists below to register them ---------// //--------------------------------------------------------------------------------// + +/*! + \def REGISTER_MODEL_METATYPES + \details Registers the models in the Qt MetaType so it can be used in signal/slots between threads. + */ #define REGISTER_MODEL_METATYPES \ + \ REGISTER_METATYPE( BloodFlowData ) \ REGISTER_METATYPE( DialysateFlowData ) \ REGISTER_METATYPE( OutletFlowData ) \ @@ -145,7 +200,7 @@ \ REGISTER_METATYPE( HDDebugTextData ) \ REGISTER_METATYPE( DGDebugTextData ) \ - /* Request */ \ + /* Request */ \ REGISTER_METATYPE( AdjustBloodDialysateRequestData ) \ REGISTER_METATYPE( AdjustDurationRequestData ) \ REGISTER_METATYPE( AdjustUltrafiltrationStateRequestData ) \ @@ -158,10 +213,11 @@ REGISTER_METATYPE( AdjustUltrafiltrationStateResponseData ) \ REGISTER_METATYPE( AdjustUltrafiltrationEditResponseData ) \ REGISTER_METATYPE( AdjustUltrafiltrationConfirmResponseData ) \ - REGISTER_METATYPE( AdjustSalineResponseData ) + REGISTER_METATYPE( AdjustSalineResponseData ) \ //===============================================================================// #define ACTION_RECEIVE_MODEL_BRIDGE_CONNECTIONS(vSOURCE) \ + \ ACTION_RECEIVE_BRIDGE_CONNECTION(vSOURCE, BloodFlowData ) \ ACTION_RECEIVE_BRIDGE_CONNECTION(vSOURCE, DialysateFlowData ) \ ACTION_RECEIVE_BRIDGE_CONNECTION(vSOURCE, OutletFlowData ) \ @@ -194,17 +250,21 @@ ACTION_RECEIVE_BRIDGE_CONNECTION(vSOURCE, AdjustDurationResponseData ) \ ACTION_RECEIVE_BRIDGE_CONNECTION(vSOURCE, AdjustUltrafiltrationEditResponseData ) \ ACTION_RECEIVE_BRIDGE_CONNECTION(vSOURCE, AdjustUltrafiltrationConfirmResponseData ) \ - ACTION_RECEIVE_BRIDGE_CONNECTION(vSOURCE, AdjustSalineResponseData ) + ACTION_RECEIVE_BRIDGE_CONNECTION(vSOURCE, AdjustSalineResponseData ) \ + // /* Request */ ---------------------------------------------------------// #define ADJUST_TRANSMT_MODEL_BRIDGE_CONNECTIONS(vSOURCE) \ + \ ADJUST_TRANSMT_BRIDGE_CONNECTION(vSOURCE, AdjustBloodDialysateRequestData ) \ ADJUST_TRANSMT_BRIDGE_CONNECTION(vSOURCE, AdjustDurationRequestData ) \ ADJUST_TRANSMT_BRIDGE_CONNECTION(vSOURCE, AdjustUltrafiltrationStateRequestData ) \ ADJUST_TRANSMT_BRIDGE_CONNECTION(vSOURCE, AdjustUltrafiltrationEditRequestData ) \ ADJUST_TRANSMT_BRIDGE_CONNECTION(vSOURCE, AdjustUltrafiltrationConfirmRequestData ) \ - ADJUST_TRANSMT_BRIDGE_CONNECTION(vSOURCE, AdjustSalineRequestData ) + ADJUST_TRANSMT_BRIDGE_CONNECTION(vSOURCE, AdjustSalineRequestData ) \ + //===============================================================================// #define ACTION_RECEIVE_MODEL_BRIDGE_DEFINITIONS \ + \ ACTION_RECEIVE_BRIDGE_DEFINITION( BloodFlowData ) \ ACTION_RECEIVE_BRIDGE_DEFINITION( DialysateFlowData ) \ ACTION_RECEIVE_BRIDGE_DEFINITION( OutletFlowData ) \ @@ -237,25 +297,30 @@ ACTION_RECEIVE_BRIDGE_DEFINITION( AdjustDurationResponseData ) \ ACTION_RECEIVE_BRIDGE_DEFINITION( AdjustUltrafiltrationEditResponseData ) \ ACTION_RECEIVE_BRIDGE_DEFINITION( AdjustUltrafiltrationConfirmResponseData ) \ - ACTION_RECEIVE_BRIDGE_DEFINITION( AdjustSalineResponseData ) -// /* Request */ ---------------------------------------------------------// + ACTION_RECEIVE_BRIDGE_DEFINITION( AdjustSalineResponseData ) \ + + #define ADJUST_TRANSMT_MODEL_BRIDGE_DEFINITIONS \ + /* Request --------------------------------------------------------- */ \ ADJUST_TRANSMT_BRIDGE_DEFINITION( AdjustBloodDialysateRequestData ) \ ADJUST_TRANSMT_BRIDGE_DEFINITION( AdjustDurationRequestData ) \ ADJUST_TRANSMT_BRIDGE_DEFINITION( AdjustUltrafiltrationStateRequestData ) \ ADJUST_TRANSMT_BRIDGE_DEFINITION( AdjustUltrafiltrationEditRequestData ) \ ADJUST_TRANSMT_BRIDGE_DEFINITION( AdjustUltrafiltrationConfirmRequestData ) \ - ADJUST_TRANSMT_BRIDGE_DEFINITION( AdjustSalineRequestData ) -// /* Request */ ----------------------- NoEmit --------------------------// + ADJUST_TRANSMT_BRIDGE_DEFINITION( AdjustSalineRequestData ) \ + + #define ADJUST_TRANSMT_MODEL_BRIDGE_DEFINITIONS_NOEMIT \ + /* Request ----------------------- NoEmit -------------------------- */ \ ADJUST_TRANSMT_BRIDGE_DEFINITION_NOEMIT( AdjustBloodDialysateRequestData ) \ ADJUST_TRANSMT_BRIDGE_DEFINITION_NOEMIT( AdjustDurationRequestData ) \ ADJUST_TRANSMT_BRIDGE_DEFINITION_NOEMIT( AdjustUltrafiltrationStateRequestData ) \ ADJUST_TRANSMT_BRIDGE_DEFINITION_NOEMIT( AdjustUltrafiltrationEditRequestData ) \ ADJUST_TRANSMT_BRIDGE_DEFINITION_NOEMIT( AdjustUltrafiltrationConfirmRequestData ) \ - ADJUST_TRANSMT_BRIDGE_DEFINITION_NOEMIT( AdjustSalineRequestData ) -// /* Request */ ----------------------- public --------------------------// + ADJUST_TRANSMT_BRIDGE_DEFINITION_NOEMIT( AdjustSalineRequestData ) \ + #define ADJUST_TRANSMT_MODEL_BRIDGE_DEFINITIONS_PUBLIC \ + /* Request ----------------------- public -------------------------- */ \ ADJUST_TRANSMT_BRIDGE_DEFINITION_PUBLIC( AdjustBloodDialysateRequestData ) \ ADJUST_TRANSMT_BRIDGE_DEFINITION_PUBLIC( AdjustDurationRequestData ) \ ADJUST_TRANSMT_BRIDGE_DEFINITION_PUBLIC( AdjustUltrafiltrationStateRequestData ) \ @@ -264,6 +329,7 @@ ADJUST_TRANSMT_BRIDGE_DEFINITION_PUBLIC( AdjustSalineRequestData ) //===============================================================================// #define ACTION_RECEIVE_SIGNALS \ + /* Received signals */ \ ACTION_RECEIVE_SIGNAL( BloodFlowData ) \ ACTION_RECEIVE_SIGNAL( DialysateFlowData ) \ ACTION_RECEIVE_SIGNAL( OutletFlowData ) \ Index: sources/model/MPowerOff.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/MPowerOff.cpp (.../MPowerOff.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/MPowerOff.cpp (.../MPowerOff.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -29,6 +29,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MPowerOff::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MPowerOff::Data MPowerOff::data() const { Data data; data.mStatus = _data.mStatus.value; Index: sources/model/MPowerOff.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/MPowerOff.h (.../MPowerOff.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/MPowerOff.h (.../MPowerOff.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -23,6 +23,17 @@ namespace Model { +/*! + * \brief The MPowerOff class + * \details The power off model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U08) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------:|:--: | + * |0x0100| 0x020 | 6 | Cmd | N | HD | UI | Power Off | \ref Data::mStatuS | + * + * \sa Data + * + */ class MPowerOff : public MAbstract { public: Type_Enum typeText () const override { return Type_Enum::eEvent; } @@ -45,7 +56,6 @@ bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MPowerOff::Data PowerOffData; Index: sources/model/dg/data/MDGDrainPumpData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGDrainPumpData.cpp (.../MDGDrainPumpData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGDrainPumpData.cpp (.../MDGDrainPumpData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -32,6 +32,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MDGDrainPump::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MDGDrainPump::Data MDGDrainPump::data() const { Data data; data.mRPM = _data.mRPM .value; Index: sources/model/dg/data/MDGDrainPumpData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGDrainPumpData.h (.../MDGDrainPumpData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGDrainPumpData.h (.../MDGDrainPumpData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,12 +26,22 @@ namespace Model { +/*! + * \brief The MDGDrainPump class + * \details The DG drain pump data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: | + * |0x2400| 0x080 | 8 | 1 Hz | N | DG | All | DG Drain Pump Data | \ref Data::mRPM | \ref Data::mDAC | + * + * \sa Data + * + */ class MDGDrainPump : public MAbstract { // friends friend class ::tst_models; - // DG Drain Pump Data (U32) Set pt. RPM (U32) DAC value QVariantList parameters() const override; struct { @@ -46,16 +56,15 @@ QString infoText () const override { return QString("DrainPump"); } struct Data { - quint32 mRPM = 0; /*!< Reservoir1 Prim value of type float extracted out */ - quint32 mDAC = 0; /*!< Reservoir2 Bkup value of type float extracted out */ + quint32 mRPM = 0; ///< Set pt. RPM + quint32 mDAC = 0; ///< DAC value }; MDGDrainPump () { } bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MDGDrainPump::Data DGDrainPumpData; Index: sources/model/dg/data/MDGHeatersData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGHeatersData.cpp (.../MDGHeatersData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGHeatersData.cpp (.../MDGHeatersData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -35,6 +35,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MDGHeaters::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MDGHeaters::Data MDGHeaters::data() const { Data data; data.mMainPrimaryDC = _data.mMainPrimaryDC .value; Index: sources/model/dg/data/MDGHeatersData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGHeatersData.h (.../MDGHeatersData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGHeatersData.h (.../MDGHeatersData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,17 @@ namespace Model { +/*! + * \brief The MDGHeaters class + * \details The DG heaters data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | + * |0x2C00| 0x080 | 8 | 2 Hz | N | DG | All | DG Heaters Data | \ref Data::mMainPrimaryDC | \ref Data::mSmallPrimaryDC | \ref Data::mTrimmerDC | + * + * \sa Data + * + */ class MDGHeaters : public MAbstract { // friends @@ -47,17 +58,16 @@ QString infoText () const override { return QString("Heaters"); } struct Data { - quint32 mMainPrimaryDC = 0; /*!< Reservoir1 Prim value of type float extracted out */ - quint32 mSmallPrimaryDC = 0; /*!< Reservoir1 Bkup value of type float extracted out */ - quint32 mTrimmerDC = 0; /*!< Reservoir2 Prim value of type float extracted out */ + quint32 mMainPrimaryDC = 0; ///< main Primary DC + quint32 mSmallPrimaryDC = 0; ///< small Primary DC + quint32 mTrimmerDC = 0; ///< trimmer DC }; MDGHeaters () {} bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MDGHeaters::Data DGHeatersData; Index: sources/model/dg/data/MDGLoadCellReadingsData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGLoadCellReadingsData.cpp (.../MDGLoadCellReadingsData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGLoadCellReadingsData.cpp (.../MDGLoadCellReadingsData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -38,6 +38,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MDGLoadCellReadings::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MDGLoadCellReadings::Data MDGLoadCellReadings::data() const { Data data; data.mReservoir1Prim = _data.mReservoir1Prim .value; Index: sources/model/dg/data/MDGLoadCellReadingsData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGLoadCellReadingsData.h (.../MDGLoadCellReadingsData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGLoadCellReadingsData.h (.../MDGLoadCellReadingsData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,12 +26,22 @@ namespace Model { +/*! + * \brief The MDGLoadCellReadings class + * \details The DG load cell readings data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | #2:(F32) | #3:(F32) | #4:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: | + * |0x0C00| 0x080 | 8 | 10 Hz | N | DG | All | DG Load Cell Readings Data | \ref Data::mReservoir1Prim | \ref Data::mReservoir1Bkup | \ref Data::mReservoir2Prim | \ref Data::mReservoir2Bkup | + * + * \sa Data + * + */ class MDGLoadCellReadings : public MAbstract { // friends friend class ::tst_models; - // Load Cell Readings Data Rs1 Prim. (F32) Rs1 Bkup (F32) Rs2 Prim. (F32) Rs2 Bkup (F32) QVariantList parameters() const override; struct { @@ -48,18 +58,17 @@ QString infoText () const override { return QString("LoadCell"); } struct Data { - float mReservoir1Prim = 0; /*!< Reservoir1 Prim value of type float extracted out */ - float mReservoir1Bkup = 0; /*!< Reservoir1 Bkup value of type float extracted out */ - float mReservoir2Prim = 0; /*!< Reservoir2 Prim value of type float extracted out */ - float mReservoir2Bkup = 0; /*!< Reservoir2 Bkup value of type float extracted out */ + float mReservoir1Prim = 0; ///< Reservoir1 Primary + float mReservoir1Bkup = 0; ///< Reservoir1 Back up + float mReservoir2Prim = 0; ///< Reservoir2 Primary + float mReservoir2Bkup = 0; ///< Reservoir2 Back up }; MDGLoadCellReadings () {} bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MDGLoadCellReadings::Data DGLoadCellReadingsData; Index: sources/model/dg/data/MDGOperationModeData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGOperationModeData.cpp (.../MDGOperationModeData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGOperationModeData.cpp (.../MDGOperationModeData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -29,6 +29,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MDGOperationMode::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MDGOperationMode::Data MDGOperationMode::data() const { Data data; data.mOpMode = _data.mOpMode.value; Index: sources/model/dg/data/MDGOperationModeData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGOperationModeData.h (.../MDGOperationModeData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGOperationModeData.h (.../MDGOperationModeData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,17 @@ namespace Model { +/*! + * \brief The MDGOperationMode class + * \details The DG operation mode data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | + * |0x2700| 0x080 | 8 | 1 Hz | N | DG | All | DG Operation Mode Data | \ref Data::mOpMode | + * + * \sa Data + * + */ class MDGOperationMode : public MAbstract { // friends @@ -45,15 +56,14 @@ QString infoText () const override { return QString("OpMode"); } struct Data { - quint32 mOpMode = 0; /*!< Reservoir1 Prim value of type float extracted out */ + quint32 mOpMode = 0; ///< DG operation }; MDGOperationMode () {} bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MDGOperationMode::Data DGOperationModeData; Index: sources/model/dg/data/MDGPressuresData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGPressuresData.cpp (.../MDGPressuresData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGPressuresData.cpp (.../MDGPressuresData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -38,6 +38,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MDGPressures::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MDGPressures::Data MDGPressures::data() const { Data data; data.mROInletPSI = _data.mROInletPSI .value; Index: sources/model/dg/data/MDGPressuresData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGPressuresData.h (.../MDGPressuresData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGPressuresData.h (.../MDGPressuresData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,12 +26,22 @@ namespace Model { +/*! + * \brief The MDGPressures class + * \details The DG pressures data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | #2:(F32) | #3:(F32) | #4:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: | + * |0x2000| 0x080 | 8 | 1 Hz | N | DG | All | DG Pressures Data | \ref Data::mROInletPSI | \ref Data::mROOutletPSI | \ref Data::mDrainInletPSI | \ref Data::mDrainOutletPSI | + * + * \sa Data + * + */ class MDGPressures : public MAbstract { // friends friend class ::tst_models; - // DG Pressures Data (F32) RO inlet PSI (F32) RO outlet PSI (F32) Drain inlet PSI (F32) Drain outlet PSI QVariantList parameters() const override; struct { @@ -48,18 +58,17 @@ QString infoText () const override { return QString("Pressures"); } struct Data { - float mROInletPSI = 0; /*!< Reservoir1 Prim value of type float extracted out */ - float mROOutletPSI = 0; /*!< Reservoir1 Bkup value of type float extracted out */ - float mDrainInletPSI = 0; /*!< Reservoir2 Prim value of type float extracted out */ - float mDrainOutletPSI = 0; /*!< Reservoir2 Bkup value of type float extracted out */ + float mROInletPSI = 0; ///< RO inlet PSI + float mROOutletPSI = 0; ///< RO outlet PSI + float mDrainInletPSI = 0; ///< Drain inlet PSI + float mDrainOutletPSI = 0; ///< Drain outlet PSI }; MDGPressures () {} bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MDGPressures::Data DGPressuresData; Index: sources/model/dg/data/MDGROPumpData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGROPumpData.cpp (.../MDGROPumpData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGROPumpData.cpp (.../MDGROPumpData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -35,6 +35,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MDGROPump::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MDGROPump::Data MDGROPump::data() const { Data data; data.mPressure = _data.mPressure.value; Index: sources/model/dg/data/MDGROPumpData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGROPumpData.h (.../MDGROPumpData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGROPumpData.h (.../MDGROPumpData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -5,11 +5,9 @@ * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file MDGROPumpData.h - * \author (last) Behrouz NemaiPour - * \date (last) 17-Jul-2020 - * \author (original) Behrouz NemaiPour - * \date (original) 02-Jul-2020 + * \file MDGROPumpData.h + * \date 7/1/2020 + * \author Behrouz NematiPour * */ #pragma once @@ -26,12 +24,22 @@ namespace Model { +/*! + * \brief The MDGROPump class + * \details The DG RO pump data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(F32) | #3:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | + * |0x1F00| 0x080 | 8 | 1 Hz | N | DG | All | DG RO Pump Data | \ref Data::mPressure | \ref Data::mFlowRate | \ref Data::mPWM | + * + * \sa Data + * + */ class MDGROPump : public MAbstract { // friends friend class ::tst_models; - // DG RO Pump Data (U32) Set pt. pressure (F32) flow rate (F32) PWM QVariantList parameters() const override; struct { @@ -47,17 +55,16 @@ QString infoText () const override { return QString("ROPump"); } struct Data { - quint32 mPressure = 0; /*!< ArterialPressure value of type float extracted out */ - float mFlowRate = 0; /*!< VenousPressure value of type float extracted out */ - float mPWM = 0; /*!< BloodPumpOcclusion value of type float extracted out */ + quint32 mPressure = 0; ///< Set pt. pressure + float mFlowRate = 0; ///< flow rate + float mPWM = 0; ///< PWM }; MDGROPump () { } bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MDGROPump::Data DGROPumpData; Index: sources/model/dg/data/MDGReservoirData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGReservoirData.cpp (.../MDGReservoirData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGReservoirData.cpp (.../MDGReservoirData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -35,6 +35,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MDGReservoir::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MDGReservoir::Data MDGReservoir::data() const { Data data; data.mActiveReservoir = _data.mActiveReservoir .value; Index: sources/model/dg/data/MDGReservoirData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGReservoirData.h (.../MDGReservoirData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGReservoirData.h (.../MDGReservoirData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,12 +26,22 @@ namespace Model { +/*! + * \brief The MDGReservoir class + * \details The DG reservoir data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | + * |0x2800| 0x080 | 8 | 1 Hz | N | DG | All | DG Reservoir Data | \ref Data::mActiveReservoir | \ref Data::mFillToVol | \ref Data::mDrainToVol | + * + * \sa Data + * + */ class MDGReservoir : public MAbstract { // friends friend class ::tst_models; - // DG Reservoir Data (U32) active reservoir (U32) Fill to vol (mL) (U32) Drain to vol (mL) QVariantList parameters() const override; struct { @@ -47,17 +57,16 @@ QString infoText () const override { return QString("Reservoir"); } struct Data { - quint32 mActiveReservoir = 0; - quint32 mFillToVol = 0; - quint32 mDrainToVol = 0; + quint32 mActiveReservoir = 0; ///< Active reservoir + quint32 mFillToVol = 0; ///< Fill to vol (mL) + quint32 mDrainToVol = 0; ///< Drain to vol (mL) }; MDGReservoir () {} bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MDGReservoir::Data DGReservoirData; Index: sources/model/dg/data/MDGTemperaturesData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGTemperaturesData.cpp (.../MDGTemperaturesData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGTemperaturesData.cpp (.../MDGTemperaturesData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -63,6 +63,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MDGTemperatures::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MDGTemperatures::Data MDGTemperatures::data() const { Data data; data.mInletPrimaryHeater = _data.mInletPrimaryHeater .value; Index: sources/model/dg/data/MDGTemperaturesData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGTemperaturesData.h (.../MDGTemperaturesData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGTemperaturesData.h (.../MDGTemperaturesData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,25 @@ namespace Model { +/*! + * \brief The MDGTemperatures class + * \details The DG temperatures data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | #2:(F32) | #3:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | + * |0x2D00| 0x080 | 8 | 2 Hz | N | DG | All | DG Temperatures Data | \ref Data::mInletPrimaryHeater | \ref Data::mOutletPrimaryHeater | \ref Data::mConductivitySensor1 | + * + * | #4:(F32) | #5:(F32) | #6:(F32) | #7:(F32) | #8:(F32) | + * |:--: |:--: |:--: |:--: |:--: | + * | \ref Data::mConductivitySensor2 | \ref Data::mOutletRedundancy | \ref Data::mInletDialysate | \ref Data::mPrimaryHeaterThermoCouple | \ref Data::mTrimmerHeaterThermoCouple | + * + * | #9:(F32) | #10:(F32) | #11:(F32) | #12:(F32) | + * | :--: |:--: |:--: |:--: | + * | \ref Data::mPrimaryHeaterColdJunction | \ref Data::mTrimmerHeaterColdJunction | \ref Data::mPrimaryHeaterInternal | \ref Data::mTrimmerHeaterInternal | + * + * \sa Data + * + */ class MDGTemperatures : public MAbstract { // friends @@ -38,18 +57,18 @@ QVariantList parameters() const override; struct { - Types::F32 mInletPrimaryHeater ; - Types::F32 mOutletPrimaryHeater ; - Types::F32 mConductivitySensor1 ; - Types::F32 mConductivitySensor2 ; - Types::F32 mOutletRedundancy ; - Types::F32 mInletDialysate ; - Types::F32 mPrimaryHeaterThermoCouple ; - Types::F32 mTrimmerHeaterThermoCouple ; - Types::F32 mPrimaryHeaterColdJunction ; - Types::F32 mTrimmerHeaterColdJunction ; - Types::F32 mPrimaryHeaterInternal ; - Types::F32 mTrimmerHeaterInternal ; + Types::F32 mInletPrimaryHeater ; /* 01 */ + Types::F32 mOutletPrimaryHeater ; /* 02 */ + Types::F32 mConductivitySensor1 ; /* 03 */ + Types::F32 mConductivitySensor2 ; /* 04 */ + Types::F32 mOutletRedundancy ; /* 05 */ + Types::F32 mInletDialysate ; /* 06 */ + Types::F32 mPrimaryHeaterThermoCouple ; /* 07 */ + Types::F32 mTrimmerHeaterThermoCouple ; /* 08 */ + Types::F32 mPrimaryHeaterColdJunction ; /* 09 */ + Types::F32 mTrimmerHeaterColdJunction ; /* 10 */ + Types::F32 mPrimaryHeaterInternal ; /* 11 */ + Types::F32 mTrimmerHeaterInternal ; /* 12 */ } _data; public: @@ -78,7 +97,6 @@ bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MDGTemperatures::Data DGTemperaturesData; Index: sources/model/dg/data/MDGValvesStatesData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGValvesStatesData.cpp (.../MDGValvesStatesData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGValvesStatesData.cpp (.../MDGValvesStatesData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -31,6 +31,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MDGValvesStates::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MDGValvesStates::Data MDGValvesStates::data() const { Data data; data.mStates = _data.mStates; Index: sources/model/dg/data/MDGValvesStatesData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGValvesStatesData.h (.../MDGValvesStatesData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGValvesStatesData.h (.../MDGValvesStatesData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,18 @@ namespace Model { +/*! + * \brief The MDGValvesStates class + * \details The DG valves states data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U16) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | + * |0x2A00| 0x080 | 8 | 2 Hz | N | DG | All | DG Valves States Data | \ref Data::mStates | + * + * \sa Data + * \sa Flag + */ + class MDGValvesStates : public MAbstract { // friends @@ -71,7 +83,6 @@ bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MDGValvesStates::Data DGValvesStatesData; Index: sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.cpp (.../MTreatmentAdjustBloodDialysateResponse.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.cpp (.../MTreatmentAdjustBloodDialysateResponse.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -21,7 +21,7 @@ _data.mAccepted .value, _data.mReason .value, _data.mBloodRate .value, - _data.mDialydateReate.value + _data.mDialysateRate .value }; } @@ -30,19 +30,24 @@ if (GetValue(vByteArray, index, _data.mAccepted )) if (GetValue(vByteArray, index, _data.mReason )) if (GetValue(vByteArray, index, _data.mBloodRate )) - if (GetValue(vByteArray, index, _data.mDialydateReate )) + if (GetValue(vByteArray, index, _data.mDialysateRate )) return true ; else { if(vIndex) *vIndex = index; return false; } else { if(vIndex) *vIndex = index; return false; } else { if(vIndex) *vIndex = index; return false; } else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MAdjustBloodDialysateResponse::data + * \details Provides model's Data from the received messages data values + * \return Data + */ AdjustBloodDialysateResponseData MAdjustBloodDialysateResponse::data() const { Data data; data.mAccepted = _data.mAccepted .value; data.mReason = _data.mReason .value; data.mBloodRate = _data.mBloodRate .value; - data.mDialydateReate = _data.mDialydateReate.value; + data.mDialysateRate = _data.mDialysateRate .value; return data; } Index: sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.h (.../MTreatmentAdjustBloodDialysateResponse.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.h (.../MTreatmentAdjustBloodDialysateResponse.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,17 @@ namespace Model { +/*! + * \brief The MBlooddialysateratechangeResponse class + * \details The blood/dialysate rate change response model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | #4:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: | + * |0x1800| 0x020 | 6 | Rsp | Y | HD | UI | Blood/dialysate rate change Response | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mBloodRate | \ref Data::mDialysateRate | + * + * \sa Data + * + */ class MAdjustBloodDialysateResponse : public MAbstract { // friends @@ -37,7 +48,7 @@ Types::U32 mAccepted ; Types::U32 mReason ; Types::U32 mBloodRate ; - Types::U32 mDialydateReate ; + Types::U32 mDialysateRate ; } _data; public: @@ -50,15 +61,14 @@ bool mAccepted = 0; /*!< Accepted value of type quint32 extracted out */ quint32 mReason = 0; /*!< Reason value of type quint32 extracted out */ quint32 mBloodRate = 0; /*!< BloodRate value of type quint32 extracted out */ - quint32 mDialydateReate = 0; /*!< DialydateReate value of type quint32 extracted out */ + quint32 mDialysateRate = 0; /*!< DialysateRate value of type quint32 extracted out */ }; MAdjustBloodDialysateResponse () { } bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MAdjustBloodDialysateResponse::Data AdjustBloodDialysateResponseData; Index: sources/model/hd/adjustment/MTreatmentAdjustDurationResponse.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustDurationResponse.cpp (.../MTreatmentAdjustDurationResponse.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustDurationResponse.cpp (.../MTreatmentAdjustDurationResponse.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -39,6 +39,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MAdjustDurationResponse::data + * \details Provides model's Data from the received messages data values + * \return Data + */ AdjustDurationResponseData MAdjustDurationResponse::data() const { Data data; data.mAccepted = _data.mAccepted.value; Index: sources/model/hd/adjustment/MTreatmentAdjustDurationResponse.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustDurationResponse.h (.../MTreatmentAdjustDurationResponse.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustDurationResponse.h (.../MTreatmentAdjustDurationResponse.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,17 @@ namespace Model { +/*! + * \brief The MTreatmentDurationchangeResponse class + * \details The treatment duration change response model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | #5:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: | + * |0x1B00| 0x020 | 6 | Rsp | Y | HD | UI | Treatment Duration change Response | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mDuration | \ref Data::mUFVolume | + * + * \sa Data + * + */ class MAdjustDurationResponse : public MAbstract { // friends @@ -59,7 +70,6 @@ bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MAdjustDurationResponse::Data AdjustDurationResponseData; Index: sources/model/hd/adjustment/MTreatmentAdjustRequests.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustRequests.h (.../MTreatmentAdjustRequests.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustRequests.h (.../MTreatmentAdjustRequests.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -5,21 +5,19 @@ * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file MTreatmentAdjustRequests.h - * \author (last) Behrouz NematiPour - * \date (last) 10-Aug-2020 - * \author (original) Behrouz NemaiPour - * \date (original) 02-Jul-2020 + * \file MTreatmentAdjustRequests.h + * \date 2020/06/08 + * \author Behrouz NematiPour * */ #pragma once // Qt -#include +#include //project -#include "guiglobals.h" +#include "GuiGlobals.h" namespace Model { @@ -31,16 +29,32 @@ * Otherwise the parameters are so tiny models. */ -#include - class MModel { protected: + /*! + * \brief toString + * \details the global toString function for all the request message models + * which is mainly used for logging and debugging. + * \param vStringPrefix - a prefix string to be inserted after senderID (UI) and parameter values list. + * This is comma separated. + * \param vParameters - list of parameter values of the model as a comma separated string. + * \return QString + */ static QString toString (const QString &vStringPrefix, const QVariant &vParameters) { QString senderID = "UI,"; return QString(senderID + vStringPrefix + "," + vParameters.toStringList().join(',')); } }; +/*! + * \brief The MAdjustPowerOffReq class + * \details The power off request model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U08) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | + * |0x0100| 0x020 | 6 | Cmd | N | HD | UI | Power Off | \ref state | + * + */ class MAdjustPowerOffReq : public MModel { public: quint8 state; @@ -57,6 +71,15 @@ } }; +/*! + * \brief The MAdjustBloodDialysateReq class + * \details The blood/dialysate rate change request model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: | + * |0x1700| 0x100 | 9 | Req | Y | UI | HD | Blood/dialysate rate Change | \ref bloodFlow | \ref dialysateFlow | + * + */ class MAdjustBloodDialysateReq : public MModel { public: quint32 bloodFlow = 0; @@ -72,6 +95,15 @@ } }; +/*! + * \brief The MAdjustDurationReq class + * \details The treatment duration change request model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | + * |0x1600| 0x100 | 9 | Req | Y | UI | HD | Treatment Duration Change Request | \ref duration | + * + */ class MAdjustDurationReq : public MModel { public: quint32 duration = 0; @@ -86,12 +118,22 @@ } }; +/*! + * \brief The MAdjustUltrafiltrationStateReq class + * \details The ultrafiltration pause/resume request model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | + * |0x1000| 0x100 | 9 | Req | Y | UI | HD | UF Pause/Resume | \ref requestedState | + * + */ class MAdjustUltrafiltrationStateReq : public MModel { public: enum State{ ePaused = 0, eRunning = 1, - }; + }; + State requestedState = ePaused; // the requested state. Initially it's running => paused. // coco begin validated : Has been validated manually. // This object is used statically for now, kept the logic for later usage. @@ -104,6 +146,15 @@ } }; +/*! + * \brief The MAdjustUltrafiltrationEditReq class + * \details The ultrafiltration volume change request model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | + * |0x1100| 0x100 | 9 | Req | Y | UI | HD | UF Vol. Change Request | \ref volume | + * + */ class MAdjustUltrafiltrationEditReq : public MModel { public: float volume = 0; @@ -118,12 +169,24 @@ } }; +/*! + * \brief The MAdjustUltrafiltrationConfirmReq class + * \details The ultrafiltration volume change user confirm request model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | #2:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: | + * |0x1500| 0x100 | 9 | Req | Y | UI | HD | UF Vol. Change User Confirm | \ref volume | \ref option | + * + * \sa Options + * + */ class MAdjustUltrafiltrationConfirmReq : public MModel { public: enum Options : quint32 { eDuration = Gui::GuiActions::UF_ADJ_TREATMENT_TIME, eRate = Gui::GuiActions::UF_ADJ_UF_RATE, - }; + }; + float volume = 0; Options option = eDuration; // coco begin validated : Has been validated manually. @@ -137,12 +200,26 @@ } }; +/*! + * \brief The MAdjustSalineReq class + * \details The model to request the Saline Bolus state + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1:(U32) | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:--------------------:|:-------------------:| + * | 18 | 0x100 | 9 | Req | Y | UI | HD | Saline Bolus Request | \ref requestedState | + * + * \sa State + * \sa MTreatmentSaline : Saline Bolus Data + * \sa MAdjustSalineResponse : Saline Bolus Response + * + */ class MAdjustSalineReq : public MModel { public: enum State { eStop = 0, eStart = 1, - }; + }; + State requestedState = eStop; // the requested state. Initially it's Stop => start. // coco begin validated : Has been validated manually. // This object is used statically for now, kept the logic for later usage. @@ -155,6 +232,15 @@ } }; +/*! + * \brief The MAlarmSilenceReq class + * \details The model to request alarm silent + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1:(U32) | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:--------------------:|:-------------------:| + * | | | | Req | Y | UI | HD | Alarm Silent Request | | + * + */ class MAlarmSilenceReq : public MModel { public: bool state = 0; Index: sources/model/hd/adjustment/MTreatmentAdjustSalineResponse.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustSalineResponse.cpp (.../MTreatmentAdjustSalineResponse.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustSalineResponse.cpp (.../MTreatmentAdjustSalineResponse.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -36,6 +36,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MAdjustSalineResponse::data + * \details Provides model's Data from the received messages data values + * \return Data + */ AdjustSalineResponseData MAdjustSalineResponse::data() const { Data data; data.mAccepted = _data.mAccepted.value; Index: sources/model/hd/adjustment/MTreatmentAdjustSalineResponse.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustSalineResponse.h (.../MTreatmentAdjustSalineResponse.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustSalineResponse.h (.../MTreatmentAdjustSalineResponse.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,19 @@ namespace Model { +/*! + * \brief The MAdjustSalineResponse class + * \details The Saline Bolus adjustment response model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1:(U32) | #2:(U32) | #3:(U32) | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:---------------------:|:--------------------:|:-------------------:|:-------------------:| + * | 20 | 0x020 | 6 | Rsp | Y | HD | UI | Saline Bolus Response | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mTarget | + * + * \sa Data + * \sa MAdjustSalineReq : Saline Bolus Request + * \sa MTreatmentSaline : Saline Bolus Data + * + */ class MAdjustSalineResponse : public MAbstract { // friends Index: sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationConfirmResponse.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationConfirmResponse.cpp (.../MTreatmentAdjustUltrafiltrationConfirmResponse.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationConfirmResponse.cpp (.../MTreatmentAdjustUltrafiltrationConfirmResponse.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -49,6 +49,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MAdjustUltrafiltrationConfirmResponse::data + * \details Provides model's Data from the received messages data values + * \return Data + */ AdjustUltrafiltrationConfirmResponseData MAdjustUltrafiltrationConfirmResponse::data() const { Data data; data.mAccepted = _data.mAccepted .value; Index: sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationConfirmResponse.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationConfirmResponse.h (.../MTreatmentAdjustUltrafiltrationConfirmResponse.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationConfirmResponse.h (.../MTreatmentAdjustUltrafiltrationConfirmResponse.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MAdjustUltrafiltrationConfirmResponse class + * \details The uf vol. change confirmation response model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(F32) | #4:(U32) | #5:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: | + * |0x2E00| 0x020 | 6 | Rsp | Y | HD | UI | UF Vol. Change Confirmation Response | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mVolume | \ref Data::mDuration | \ref Data::mRate | + * + * \sa Data + * + */ class MAdjustUltrafiltrationConfirmResponse { // friends @@ -60,7 +71,6 @@ Data data() const; }; - } typedef Model::MAdjustUltrafiltrationConfirmResponse::Data AdjustUltrafiltrationConfirmResponseData; Index: sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationEditResponse.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationEditResponse.cpp (.../MTreatmentAdjustUltrafiltrationEditResponse.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationEditResponse.cpp (.../MTreatmentAdjustUltrafiltrationEditResponse.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -61,6 +61,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MAdjustUltrafiltrationEditResponse::data + * \details Provides model's Data from the received messages data values + * \return Data + */ AdjustUltrafiltrationEditResponseData MAdjustUltrafiltrationEditResponse::data() const { Data data; data.mAccepted = _data.mAccepted .value; Index: sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationEditResponse.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationEditResponse.h (.../MTreatmentAdjustUltrafiltrationEditResponse.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationEditResponse.h (.../MTreatmentAdjustUltrafiltrationEditResponse.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,17 @@ namespace Model { +/*! + * \brief The MAdjustUltrafiltrationEditResponse class + * \details The uf vol. change response model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #1:(U32) | #2:(U32) | #3:(F32) | #4:(U32) | #5:(F32) | #6:(U32) | #7:(U32) | #8:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: |:--: |:--: |:--: |:--: | + * |0x1300| 0x020 | 6 | Rsp | Y | HD | UI | UF Vol. Change Response | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mAccepted | \ref Data::mReason | \ref Data::mVolume | \ref Data::mDuration | \ref Data::mRate | \ref Data::mDurationDiff | \ref Data::mRateDiff | \ref Data::mRateOld | + * + * \sa Data + * + */ class MAdjustUltrafiltrationEditResponse : public MAdjustUltrafiltrationConfirmResponse { @@ -56,7 +67,6 @@ Data data() const; }; - } typedef Model::MAdjustUltrafiltrationEditResponse::Data AdjustUltrafiltrationEditResponseData; Index: sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationStateResponse.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationStateResponse.cpp (.../MTreatmentAdjustUltrafiltrationStateResponse.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationStateResponse.cpp (.../MTreatmentAdjustUltrafiltrationStateResponse.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -30,6 +30,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MAdjustUltrafiltrationStateResponse::data + * \details Provides model's Data from the received messages data values + * \return Data + */ AdjustUltrafiltrationStateResponseData MAdjustUltrafiltrationStateResponse::data() const { Data data; data.mAccepted = _data.mAccepted.value; Index: sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationStateResponse.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationStateResponse.h (.../MTreatmentAdjustUltrafiltrationStateResponse.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationStateResponse.h (.../MTreatmentAdjustUltrafiltrationStateResponse.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,17 @@ namespace Model { +/*! + * \brief The MAdjustUltrafiltrationStateResponse class + * \details The ultrafiltration adjustment state response model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1:(U08) | + * |:----:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------: |:--: | + * |0x1000| 0x100 | 9 | Rsp | N | HD | UI | Generic response ACK/NAK | mAccepted | + * + * \sa Data + * + */ class MAdjustUltrafiltrationStateResponse : public MAbstract { // friends @@ -34,7 +45,7 @@ QVariantList parameters() const override; struct { - Types::U08 mAccepted ; // IMPORTANT : This is a response to AcknowGeneric which has a data of 1 byte for the accepted/rejected. + Types::U08 mAccepted ; // IMPORTANT : This is a response of AcknowGeneric which has a data of 1 byte for the accepted/rejected state. } _data; public: @@ -54,7 +65,6 @@ bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MAdjustUltrafiltrationStateResponse::Data AdjustUltrafiltrationStateResponseData; Index: sources/model/hd/alarm/MAlarmCleared.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/alarm/MAlarmCleared.cpp (.../MAlarmCleared.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/alarm/MAlarmCleared.cpp (.../MAlarmCleared.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -32,6 +32,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MAlarmCleared::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MAlarmCleared::Data MAlarmCleared::data() const { Data data; data.mAlarmID = _data.mAlarmID.value; Index: sources/model/hd/alarm/MAlarmCleared.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/alarm/MAlarmCleared.h (.../MAlarmCleared.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/alarm/MAlarmCleared.h (.../MAlarmCleared.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MAlarmCleared class + * \details The alarm cleared model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | + * |0x0400| 0x001 | 1 | Event | Y | HD | All | Alarm Cleared | \ref Data::mAlarmID | + * + * \sa Data + * + */ class MAlarmCleared { // friends @@ -33,7 +44,7 @@ public: QString stringPrefix = "Alarm Cleared"; struct Data { - quint32 mAlarmID = 0; /*!< Alarm ID value of type quint32 extracted out */ + quint32 mAlarmID = 0; ///< Alarm ID }; private: @@ -50,7 +61,6 @@ Data data() const; }; - } typedef Model::MAlarmCleared::Data AlarmClearedData; Index: sources/model/hd/alarm/MAlarmStatusData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/alarm/MAlarmStatusData.cpp (.../MAlarmStatusData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/alarm/MAlarmStatusData.cpp (.../MAlarmStatusData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -54,6 +54,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MAlarmStatus::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MAlarmStatus::Data MAlarmStatus::data() const { Data data; data.mState = _data.mState .value; Index: sources/model/hd/alarm/MAlarmStatusData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/alarm/MAlarmStatusData.h (.../MAlarmStatusData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/alarm/MAlarmStatusData.h (.../MAlarmStatusData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -19,13 +19,24 @@ // Project #include "types.h" -#include "guiglobals.h" +#include "GuiGlobals.h" // forward declarations class tst_models; namespace Model { +/*! + * \brief The MAlarmStatus class + * \details The alarm status model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | #4:(U32) | #5:(U16) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: | + * |0x0200| 0x001 | 1 | 1 Hz | N | HD | All | Alarm Status | \ref Data::mState | \ref Data::mTop | \ref Data::mEscalatesIn | \ref Data::mMuteTimeout | \ref Data::mFlags | + * + * \sa Data + * + */ class MAlarmStatus { // friends @@ -45,13 +56,14 @@ eFlag_alarmsSilenced , eFlag_Bits_Length = 16, }; + QString stringPrefix = "Alarm Status"; struct Data { - quint32 mState = 0; /*!< State - Alarm Priority value of type unsigned int as 4 bytes extracted out */ - quint32 mTop = 0; /*!< Top - Top value of type unsigned int as 4 bytes extracted out */ - quint32 mEscalatesIn = 0; /*!< EscalatesIn - EscalatesIn value of type unsigned int as 4 bytes extracted out */ - quint32 mMuteTimeout = 0; /*!< MuteTimeout - MuteTimeout value of type unsigned int as 4 bytes extracted out */ - QBitArray mFlags ; /*!< Flags - Flags value of type unsigned int as 1 byte extracted out */ + quint32 mState = 0; ///< State - Alarm Priority + quint32 mTop = 0; ///< Top - Top current alarm ID + quint32 mEscalatesIn = 0; ///< EscalatesIn - EscalatesIn + quint32 mMuteTimeout = 0; ///< MuteTimeout - MuteTimeout + QBitArray mFlags ; ///< Flags - Flags }; private: @@ -66,14 +78,13 @@ public: MAlarmStatus(); - QString toString ( ) const ; + QString toString ( ) const ; void toVariantList ( QVariantList &vData ) const ; bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr); static QString toText ( Gui::GuiAlarmID vAlarmID); Data data() const ; }; - } typedef Model::MAlarmStatus::Data AlarmStatusData; Index: sources/model/hd/alarm/MAlarmTriggered.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/alarm/MAlarmTriggered.cpp (.../MAlarmTriggered.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/alarm/MAlarmTriggered.cpp (.../MAlarmTriggered.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -32,6 +32,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MAlarmTriggered::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MAlarmTriggered::Data MAlarmTriggered::data() const { Data data; data.mAlarmID = _data.mAlarmID.value; Index: sources/model/hd/alarm/MAlarmTriggered.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/alarm/MAlarmTriggered.h (.../MAlarmTriggered.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/alarm/MAlarmTriggered.h (.../MAlarmTriggered.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MAlarmTriggered class + * \details The alarm triggered model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | + * |0x0300| 0x001 | 1 | Event | Y | HD | All | Alarm Triggered | \ref Data::mAlarmID | + * + * \sa Data + * + */ class MAlarmTriggered { // friends @@ -33,7 +44,7 @@ public: QString stringPrefix = "Alarm Triggered"; struct Data { - quint32 mAlarmID = 0; /*!< Alarm ID value of type quint32 extracted out */ + quint32 mAlarmID = 0; ///< Alarm ID }; private: @@ -50,7 +61,6 @@ Data data() const; }; - } typedef Model::MAlarmTriggered::Data AlarmTriggeredData; Index: sources/model/hd/data/MHDOperationModeData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MHDOperationModeData.cpp (.../MHDOperationModeData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MHDOperationModeData.cpp (.../MHDOperationModeData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -29,6 +29,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MHDOperationMode::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MHDOperationMode::Data MHDOperationMode::data() const { Data data; data.mOpMode = _data.mOpMode.value; Index: sources/model/hd/data/MHDOperationModeData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MHDOperationModeData.h (.../MHDOperationModeData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MHDOperationModeData.h (.../MHDOperationModeData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,17 @@ namespace Model { +/*! + * \brief The MHDOperationMode class + * \details The HD operation mode data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: | + * |0x2500| 0x040 | 7 | 1 Hz | N | HD | All | HD Operation Mode Data | \ref Data::mOpMode | + * + * \sa Data + * + */ class MHDOperationMode : public MAbstract { // friends @@ -45,15 +56,14 @@ QString infoText () const override { return QString("OpMode"); } struct Data { - quint32 mOpMode = 0; /*!< Reservoir1 Prim value of type float extracted out */ + quint32 mOpMode = 0; ///< HD operation mode }; MHDOperationMode () {} bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MHDOperationMode::Data HDOperationModeData; Index: sources/model/hd/data/MTreatmentFlowsData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentFlowsData.cpp (.../MTreatmentFlowsData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentFlowsData.cpp (.../MTreatmentFlowsData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -49,7 +49,12 @@ else { if(vIndex) *vIndex = index; return false; } } -// ----- BloodFlow ----- +/*! + * \brief MBloodFlow::data + * \details Provides model's Data from the received messages data values of + BloodFlow. + * \return Data + */ MBloodFlow::Data MBloodFlow::data() const { Data data; data.mFlowSetPoint = _data.mFlowSetPoint .value; @@ -62,7 +67,12 @@ return data; } -// ----- DialysateFlow ----- +/*! + * \brief MDialysateFlow::data + * \details Provides model's Data from the received messages data values of + * DialysateFlow. + * \return Data + */ MDialysateFlow::Data MDialysateFlow::data() const { Data data; data.mFlowSetPoint = _data.mFlowSetPoint .value; Index: sources/model/hd/data/MTreatmentFlowsData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentFlowsData.h (.../MTreatmentFlowsData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentFlowsData.h (.../MTreatmentFlowsData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -28,21 +28,22 @@ namespace Model { /*! - * \brief The Flow Data class + * \brief The MFlow class + * \details The parent class of the flow data models */ class MFlow : public MAbstract { QVariantList parameters() const override; protected: struct Data { - Types::S32 mFlowSetPoint ; /*!< vFlowSetPoint - Flow Set Point value of type signed int extracted out */ - Types::F32 mMeasuredFlow ; /*!< vMeasuredFlow - Measured Flow value of type float extracted out */ - Types::F32 mRotorSpeed ; /*!< vRotorSpeed - Rotor Speed value of type float extracted out */ - Types::F32 mMotorSpeed ; /*!< vMotorSpeed - Motor Speed value of type float extracted out */ - Types::F32 mMotorCtlSpeed ; /*!< vMotorCtlSpeed - Motor Controller Speed value of type float extracted out */ - Types::F32 mMotorCtlCurrent ; /*!< vMotorCtlCurrent - Motor Controller Current value of type float extracted out */ - Types::F32 mPWMDutyCycle ; /*!< vPWMDtCycle - PWM Duty Cycle in % value of type float extracted out */ + Types::S32 mFlowSetPoint ; ///< Flow Set Point + Types::F32 mMeasuredFlow ; ///< Measured Flow + Types::F32 mRotorSpeed ; ///< Rotor Speed + Types::F32 mMotorSpeed ; ///< Motor Speed + Types::F32 mMotorCtlSpeed ; ///< Motor Controller Speed + Types::F32 mMotorCtlCurrent ; ///< Motor Controller Current + Types::F32 mPWMDutyCycle ; ///< PWM Duty Cycle in % } _data; public: @@ -56,7 +57,15 @@ }; /*! - * \brief The Blood Flow Data class + * \brief The MBloodFlow class + * \details The blood flow data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(S32) | #2:(F32) | #3:(F32) | #4:(F32) | #5:(F32) | #6:(F32) | #7:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: |:--: | + * |0x0500| 0x040 | 7 | 1 Hz | N | HD | All | Blood Flow Data | \ref Data::mFlowSetPoint | \ref Data::mMeasuredFlow | \ref Data::mRotorSpeed | \ref Data::mMotorSpeed | \ref Data::mMotorCtlSpeed | \ref Data::mMotorCtlCurrent | \ref Data::mPWMDutyCycle | + * + * \sa Data + * */ class MBloodFlow : public MFlow { @@ -67,13 +76,13 @@ QString infoText () const override { return QString("BloodFlow"); } struct Data { - qint32 mFlowSetPoint = 0; /*!< vFlowSetPoint - Flow Set Point value of type signed int extracted out */ - float mMeasuredFlow = 0; /*!< vMeasuredFlow - Measured Flow value of type float extracted out */ - float mRotorSpeed = 0; /*!< vRotorSpeed - Rotor Speed value of type float extracted out */ - float mMotorSpeed = 0; /*!< vMotorSpeed - Motor Speed value of type float extracted out */ - float mMotorCtlSpeed = 0; /*!< vMotorCtlSpeed - Motor Controller Speed value of type float extracted out */ - float mMotorCtlCurrent = 0; /*!< vMotorCtlCurrent - Motor Controller Current value of type float extracted out */ - float mPWMDutyCycle = 0; /*!< vPWMDtCycle - PWM Duty Cycle in % value of type float extracted out */ + qint32 mFlowSetPoint = 0; ///< Flow Set Point + float mMeasuredFlow = 0; ///< Measured Flow + float mRotorSpeed = 0; ///< Rotor Speed + float mMotorSpeed = 0; ///< Motor Speed + float mMotorCtlSpeed = 0; ///< Motor Controller Speed + float mMotorCtlCurrent = 0; ///< Motor Controller Current + float mPWMDutyCycle = 0; ///< PWM Duty Cycle in % }; MBloodFlow() { } @@ -82,7 +91,15 @@ }; /*! - * \brief The Dialysate Flow Data class + * \brief The MDialysateFlow class + * \details The dialysate flow data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(S32) | #2:(F32) | #3:(F32) | #4:(F32) | #5:(F32) | #6:(F32) | #7:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: |:--: | + * |0x0800| 0x040 | 7 | 1 Hz | N | HD | All | Dialysate Flow Data | mFlowSetPoint | mMeasuredFlow | mRotorSpeed | mMotorSpeed | mMotorCtlSpeed | mMotorCtlCurrent | mPWMDutyCycle | + * + * \sa Data + * */ class MDialysateFlow : public MFlow { @@ -93,20 +110,19 @@ QString infoText () const override { return QString("DialysateFlow"); } struct Data { - qint32 mFlowSetPoint = 0; /*!< vFlowSetPoint - Flow Set Point value of type signed int extracted out */ - float mMeasuredFlow = 0; /*!< vMeasuredFlow - Measured Flow value of type float extracted out */ - float mRotorSpeed = 0; /*!< vRotorSpeed - Rotor Speed value of type float extracted out */ - float mMotorSpeed = 0; /*!< vMotorSpeed - Motor Speed value of type float extracted out */ - float mMotorCtlSpeed = 0; /*!< vMotorCtlSpeed - Motor Controller Speed value of type float extracted out */ - float mMotorCtlCurrent = 0; /*!< vMotorCtlCurrent - Motor Controller Current value of type float extracted out */ - float mPWMDutyCycle = 0; /*!< vPWMDtCycle - PWM Duty Cycle in % value of type float extracted out */ + qint32 mFlowSetPoint = 0; ///< Flow Set Point + float mMeasuredFlow = 0; ///< Measured Flow + float mRotorSpeed = 0; ///< Rotor Speed + float mMotorSpeed = 0; ///< Motor Speed + float mMotorCtlSpeed = 0; ///< Motor Controller Speed + float mMotorCtlCurrent = 0; ///< Motor Controller Current + float mPWMDutyCycle = 0; ///< PWM Duty Cycle in % }; MDialysateFlow() { } Data data() const; }; - } typedef Model:: MBloodFlow::Data BloodFlowData; Index: sources/model/hd/data/MTreatmentOutletFlowData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentOutletFlowData.cpp (.../MTreatmentOutletFlowData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentOutletFlowData.cpp (.../MTreatmentOutletFlowData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -47,6 +47,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MOutletFlow::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MOutletFlow::Data MOutletFlow::data() const { Data data; data.mRefUFVol = _data.mRefUFVol .value; Index: sources/model/hd/data/MTreatmentOutletFlowData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentOutletFlowData.h (.../MTreatmentOutletFlowData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentOutletFlowData.h (.../MTreatmentOutletFlowData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,17 @@ namespace Model { +/*! + * \brief The MOutletFlow class + * \details The outlet flow data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | #2:(F32) | #3:(F32) | #4:(F32) | #5:(F32) | #6:(F32) | #7:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: |:--: | + * |0x0B00| 0x040 | 7 | 1 Hz | N | HD | All | Outlet Flow Data | \ref Data::mRefUFVol | \ref Data::mMeasUFVol | \ref Data::mRotorSpeed | \ref Data::mMotorSpeed | \ref Data::mMotorCtlSpeed | \ref Data::mMotorCtlCurrent | \ref Data::mPWMDtCycle | + * + * \sa Data + * + */ class MOutletFlow : public MAbstract { // friends @@ -50,21 +61,20 @@ QString infoText () const override { return QString("OutletFlow"); } struct Data { - float mRefUFVol = 0; /*!< Reference UF Volume value of type float extracted out */ - float mMeasUFVol = 0; /*!< Measured UF Volume value of type float extracted out */ - float mRotorSpeed = 0; /*!< Rotor Speed value of type float extracted out */ - float mMotorSpeed = 0; /*!< Motor Speed value of type float extracted out */ - float mMotorCtlSpeed = 0; /*!< Motor Controller Speed value of type float extracted out */ - float mMotorCtlCurrent = 0; /*!< Motor Controller Current value of type float extracted out */ - float mPWMDtCycle = 0; /*!< PWM Duty Cycle in % value of type float extracted out */ + float mRefUFVol = 0; ///< Reference UF Volume + float mMeasUFVol = 0; ///< Measured UF Volume + float mRotorSpeed = 0; ///< Rotor Speed + float mMotorSpeed = 0; ///< Motor Speed + float mMotorCtlSpeed = 0; ///< Motor Controller Speed + float mMotorCtlCurrent = 0; ///< Motor Controller Current + float mPWMDtCycle = 0; ///< PWM Duty Cycle in % }; MOutletFlow () { } bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MOutletFlow::Data OutletFlowData; Index: sources/model/hd/data/MTreatmentPressureOcclusionData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentPressureOcclusionData.cpp (.../MTreatmentPressureOcclusionData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentPressureOcclusionData.cpp (.../MTreatmentPressureOcclusionData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -41,6 +41,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MPressureOcclusion::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MPressureOcclusion::Data MPressureOcclusion::data() const { Data data; data.mArterialPressure = _data.mArterialPressure .value; Index: sources/model/hd/data/MTreatmentPressureOcclusionData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentPressureOcclusionData.h (.../MTreatmentPressureOcclusionData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentPressureOcclusionData.h (.../MTreatmentPressureOcclusionData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,17 @@ namespace Model { +/*! + * \brief The MPressureOcclusionData class + * \details The pressureocclusion data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(F32) | #2:(F32) | #3:(F32) | #4:(F32) | #5:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: | + * |0x0900| 0x040 | 7 | 1 Hz | N | HD | All | PressureOcclusion Data | \ref Data::mArterialPressure | \ref Data::mVenousPressure | \ref Data::mBloodPumpOcclusion | \ref Data::mDialysateInletPumpOcclusion | \ref Data::mDialysateOutletPumpOcclusion | + * + * \sa Data + * + */ class MPressureOcclusion : public MAbstract { // friends @@ -48,19 +59,18 @@ QString infoText () const override { return QString("Pressure/Occlusion"); } struct Data { - float mArterialPressure = 0; /*!< ArterialPressure value of type float extracted out */ - float mVenousPressure = 0; /*!< VenousPressure value of type float extracted out */ - float mBloodPumpOcclusion = 0; /*!< BloodPumpOcclusion value of type float extracted out */ - float mDialysateInletPumpOcclusion = 0; /*!< DialysateInletPumpOcclusion value of type float extracted out */ - float mDialysateOutletPumpOcclusion = 0; /*!< DialysateOutletPumpOcclusion value of type float extracted out */ + float mArterialPressure = 0; ///< ArterialPressure + float mVenousPressure = 0; ///< VenousPressure + float mBloodPumpOcclusion = 0; ///< BloodPumpOcclusion + float mDialysateInletPumpOcclusion = 0; ///< DialysateInletPumpOcclusion + float mDialysateOutletPumpOcclusion = 0; ///< DialysateOutletPumpOcclusion }; MPressureOcclusion () { } bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MPressureOcclusion::Data PressureOcclusionData; Index: sources/model/hd/data/MTreatmentRangesData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentRangesData.cpp (.../MTreatmentRangesData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentRangesData.cpp (.../MTreatmentRangesData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -44,6 +44,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MTreatmentRanges::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MTreatmentRanges::Data MTreatmentRanges::data() const { Data data; data.mDuration_Min = _data.mDuration_Min .value; Index: sources/model/hd/data/MTreatmentRangesData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentRangesData.h (.../MTreatmentRangesData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentRangesData.h (.../MTreatmentRangesData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -27,6 +27,17 @@ namespace Model { +/*! + * \brief The MTreatmentRanges class + * \details The treatment adjustment parameter ranges data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(F32) | #4:(F32) | #5:(U32) | #6:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: | + * |0x1A00| 0x020 | 6 | 1/60 Hz| Y | HD | UI | Treatment adjustment param ranges Data | \ref Data::mDuration_Min | \ref Data::mDuration_Max | \ref Data::mUltrafiltration_Volume_Min | \ref Data::mUltrafiltration_Volume_Max | \ref Data::mDialysate_Flow_Min | \ref Data::mDialysate_Flow_Max | + * + * \sa Data + * + */ class MTreatmentRanges : public MAbstract { // friends @@ -50,20 +61,19 @@ QString infoText () const override { return QString("TreatmentRanges"); } struct Data { - quint32 mDuration_Min = 0; /*!< mDuration_Min value of type U32 extracted out */ - quint32 mDuration_Max = 0; /*!< mDuration_Max value of type U32 extracted out */ - float mUltrafiltration_Volume_Min = 0; /*!< mUltrafiltration_Volume_Min value of type float extracted out */ - float mUltrafiltration_Volume_Max = 0; /*!< mUltrafiltration_Volume_Max value of type float extracted out */ - quint32 mDialysate_Flow_Min = 0; /*!< mDialysate_Flow_Min value of type U32 extracted out */ - quint32 mDialysate_Flow_Max = 0; /*!< mDialysate_Flow_Max value of type U32 extracted out */ + quint32 mDuration_Min = 0; ///< mDuration_Min + quint32 mDuration_Max = 0; ///< mDuration_Max + float mUltrafiltration_Volume_Min = 0; ///< mUltrafiltration_Volume_Min + float mUltrafiltration_Volume_Max = 0; ///< mUltrafiltration_Volume_Max + quint32 mDialysate_Flow_Min = 0; ///< mDialysate_Flow_Min + quint32 mDialysate_Flow_Max = 0; ///< mDialysate_Flow_Max }; MTreatmentRanges () { } bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MTreatmentRanges::Data TreatmentRangesData; Index: sources/model/hd/data/MTreatmentSalineData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentSalineData.cpp (.../MTreatmentSalineData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentSalineData.cpp (.../MTreatmentSalineData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -35,6 +35,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MTreatmentSaline::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MTreatmentSaline::Data MTreatmentSaline::data() const { Data data; data.mTarget = _data.mTarget .value; Index: sources/model/hd/data/MTreatmentSalineData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentSalineData.h (.../MTreatmentSalineData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentSalineData.h (.../MTreatmentSalineData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -27,6 +27,19 @@ namespace Model { +/*! + * \brief The MTreatmentSaline class + * \details The treatment saline bolus data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(F32) | #3:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | + * |0x2F00| 0x040 | 7 | 1 Hz | N | HD | All | Treatment Saline Bolus Data | \ref Data::mTarget | \ref Data::mCumulative | \ref Data::mDelivered | + * + * \sa Data + * \sa MAdjustSalineReq : Saline Bolus Request + * \sa MAdjustSalineResponse : Saline Bolus Response + * + */ class MTreatmentSaline : public MAbstract { // friends @@ -47,9 +60,9 @@ QString infoText() const override { return QString("SalineData") ; } struct Data { - quint32 mTarget = 0; /*!< Target Target volume for the current started saline bolus */ - float mCumulative = 0; /*!< Cumulative Cumulative volume of all saline deliveries during current treatment */ - float mDelivered = 0; /*!< Delivered Current delivered saline volume */ + quint32 mTarget = 0; ///< Target volume for the current started saline bolus + float mCumulative = 0; ///< Cumulative volume of all saline deliveries during current treatment + float mDelivered = 0; ///< Current delivered saline volume }; public: @@ -58,7 +71,6 @@ bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MTreatmentSaline::Data TreatmentSalineData; Index: sources/model/hd/data/MTreatmentStatesData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentStatesData.cpp (.../MTreatmentStatesData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentStatesData.cpp (.../MTreatmentStatesData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -35,6 +35,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MTreatmentStates::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MTreatmentStates::Data MTreatmentStates::data() const { Data data; data.mSubMode = _data.mSubMode .value; Index: sources/model/hd/data/MTreatmentStatesData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentStatesData.h (.../MTreatmentStatesData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentStatesData.h (.../MTreatmentStatesData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,6 +26,19 @@ namespace Model { +/*! + * \brief The MTreatmentStates class + * \details The treatment states data model + * These are states of the current treatment. + * It also includes the ultrafiltration states, saline bolus states. + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | + * |0x0F00| 0x040 | 7 | 1 Hz | N | HD | All | Treatment States Data | \ref Data::mSubMode | \ref Data::mUFState | \ref Data::mSalineState | + * + * \sa Data + * + */ class MTreatmentStates : public MAbstract { // friends @@ -46,17 +59,16 @@ QString infoText () const override { return QString("TreatmentStates"); } struct Data { - quint32 mSubMode = 0; /*!< Sub-Mode value of type quint32 extracted out */ - quint32 mUFState = 0; /*!< UF State value of type quint32 extracted out */ - quint32 mSalineState = 0; /*!< Saline State value of type quint32 extracted out */ + quint32 mSubMode = 0; ///< Sub-Mode + quint32 mUFState = 0; ///< UF State + quint32 mSalineState = 0; ///< Saline State }; MTreatmentStates() { } bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MTreatmentStates::Data TreatmentStatesData; Index: sources/model/hd/data/MTreatmentTimeData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentTimeData.cpp (.../MTreatmentTimeData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentTimeData.cpp (.../MTreatmentTimeData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -35,6 +35,11 @@ else { if(vIndex) *vIndex = index; return false; } } +/*! + * \brief MTreatmentTime::data + * \details Provides model's Data from the received messages data values + * \return Data + */ MTreatmentTime::Data MTreatmentTime::data() const { Data data; data.mTotal = _data.mTotal .value; Index: sources/model/hd/data/MTreatmentTimeData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentTimeData.h (.../MTreatmentTimeData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentTimeData.h (.../MTreatmentTimeData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -27,6 +27,17 @@ namespace Model { +/*! + * \brief The MTreatmentTime class + * \details The treatment time data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | + * |0x0D00| 0x040 | 7 | 1 Hz | N | HD | All | Treatment Time Data | \ref Data::mTotal | \ref Data::mElapsed | \ref Data::mRemaining | + * + * \sa Data + * + */ class MTreatmentTime : public MAbstract { // friends @@ -47,9 +58,9 @@ QString infoText () const override { return QString("TreatmentTime"); } struct Data { - quint32 mTotal = 0; /*!< Total treatment time in sec */ - quint32 mElapsed = 0; /*!< Elapsed treatment time in sec */ - quint32 mRemaining = 0; /*!< Remaining treatment time in sec */ + quint32 mTotal = 0; ///< Total treatment time in sec */ + quint32 mElapsed = 0; ///< Elapsed treatment time in sec */ + quint32 mRemaining = 0; ///< Remaining treatment time in sec */ }; public: @@ -58,7 +69,6 @@ bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MTreatmentTime::Data TreatmentTimeData; Index: sources/storage/DriveWatcher.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/storage/DriveWatcher.cpp (.../DriveWatcher.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/storage/DriveWatcher.cpp (.../DriveWatcher.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file DriveWatcher.cpp - * \date 12/31/2019 - * \author Behrouz NematiPour + * \file DriveWatcher.cpp + * \author (last) Behrouz NematiPour + * \date (last) 25-Aug-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 17-Jul-2020 * */ #include "DriveWatcher.h" Index: sources/storage/DriveWatcher.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/storage/DriveWatcher.h (.../DriveWatcher.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/storage/DriveWatcher.h (.../DriveWatcher.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file DriveWatcher.h - * \date 12/31/2019 - * \author Behrouz NematiPour + * \file DriveWatcher.h + * \author (last) Behrouz NematiPour + * \date (last) 25-Aug-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 17-Jul-2020 * */ #pragma once Index: sources/storage/FileHandler.cpp =================================================================== diff -u -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/storage/FileHandler.cpp (.../FileHandler.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) +++ sources/storage/FileHandler.cpp (.../FileHandler.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file FileHandler.cpp * \author (last) Behrouz NematiPour - * \date (last) 22-Apr-2020 + * \date (last) 25-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 * Index: sources/storage/FileHandler.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/storage/FileHandler.h (.../FileHandler.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/storage/FileHandler.h (.../FileHandler.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file FileHandler.h * \author (last) Behrouz NematiPour - * \date (last) 02-Apr-2020 + * \date (last) 25-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 * Index: sources/storage/Logger.cpp =================================================================== diff -u -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/storage/Logger.cpp (.../Logger.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) +++ sources/storage/Logger.cpp (.../Logger.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file Logger.cpp * \author (last) Behrouz NematiPour - * \date (last) 13-Apr-2020 + * \date (last) 20-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 * Index: sources/storage/Logger.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/storage/Logger.h (.../Logger.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/storage/Logger.h (.../Logger.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file Logger.h * \author (last) Behrouz NematiPour - * \date (last) 04-Feb-2020 + * \date (last) 20-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 * Index: sources/storage/settings.cpp._ =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/storage/settings.cpp._ (.../settings.cpp._) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/storage/settings.cpp._ (.../settings.cpp._) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,16 +1,16 @@ /*! - * + * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * + * * \file settings.cpp * \author (last) Behrouz NematiPour * \date (last) 16-Jan-2020 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 - * + * */ #include "settings.h" Index: sources/storage/settings.h._ =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/storage/settings.h._ (.../settings.h._) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/storage/settings.h._ (.../settings.h._) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,16 +1,16 @@ /*! - * + * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * + * * \file settings.h * \author (last) Behrouz NematiPour * \date (last) 21-Oct-2019 * \author (original) Behrouz NematiPour * \date (original) 24-Sep-2019 - * + * */ #pragma once Index: sources/utility/format.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/utility/format.cpp (.../format.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/utility/format.cpp (.../format.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -21,6 +21,14 @@ Format::Format() { } +/*! + * \brief Format::toHexString + * \details converts the unsigned int 16 bit value vValue to QString. + * \param vValue - value to convert. + * \param vWith0x - adds 0x to the output. + * \param vLen - length of the output string. + * \return QString + */ QString Format::toHexString(quint16 vValue, bool vWith0x, quint8 vLen) { if ( vWith0x ) { return "0x" + QString("%1").arg(vValue,0,16).rightJustified(vLen, '0').toUpper(); @@ -29,11 +37,27 @@ } } +/*! + * \brief Format::toHexByteArray + * \details Returns a hex encoded copy of the byte array. + * The hex encoding uses the numbers 0-9 and the letters a-f. + * Also converts to uppercase. + * \param vData - Data to convert + * \param separator - separator to put in string output in the middle of each byte. + * \return + */ QByteArray Format::toHexByteArray(const QByteArray &vData, char separator) { return vData.toHex(separator).toUpper(); } +/*! + * \brief Format::toHexString + * \details Converts the vData of QByteArray to Hex representation of QString + * \param vData - Data to convert + * \param separator - separator to put in string output in the middle of each byte. + * \return QString + */ QString Format::toHexString(const QByteArray &vData, char separator) { QString string = toHexByteArray(vData, separator); @@ -101,6 +125,14 @@ return mData; } +/*! + * \brief Format::toStringList + * \details Converts the list of of character base items in List of string items. + * \param vList - list of the character base items + * \param vRemoveDuplicate - remove duplicate items if true + * \param vPrefix - add the prefix vPrefix to each item + * \return The QStringList conversion of the character base items vList. + */ QStringList Format::toStringList(const QList vList, bool vRemoveDuplicate, QString vPrefix) { QStringList list; Index: sources/utility/format.h =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/utility/format.h (.../format.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/utility/format.h (.../format.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file format.h * \author (last) Behrouz NematiPour - * \date (last) 07-May-2020 + * \date (last) 30-Jul-2020 * \author (original) Behrouz NematiPour * \date (original) 16-Dec-2019 * Index: sources/utility/types.h =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/utility/types.h (.../types.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/utility/types.h (.../types.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file types.h * \author (last) Behrouz NematiPour - * \date (last) 07-May-2020 + * \date (last) 30-Jul-2020 * \author (original) Behrouz NematiPour * \date (original) 16-Dec-2019 * Index: sources/view/VEventSpy.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/VEventSpy.cpp (.../VEventSpy.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/VEventSpy.cpp (.../VEventSpy.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -19,8 +19,8 @@ #include // Project -#include "guiglobals.h" -#include "logger.h" +#include "GuiGlobals.h" +#include "Logger.h" using namespace View; @@ -41,6 +41,12 @@ } } +/*! + * \brief VEventSpy::onEventSpy + * \details the event handler slot which receives all the events of the UI from Gui::_viewer + * depending on type of the event calls corresponding method. + * \param vEvent - the event + */ void VEventSpy::onEventSpy(QEvent *vEvent) { QEvent::Type mType = vEvent->type(); switch (mType) { @@ -69,8 +75,9 @@ /*! * \brief VEventSpy::mouseEventSpy - * \param vEvent - * \param typeName + * \details Mouse event spy + * \param vEvent - mouse event + * \param typeName - mouse button type name */ // coco begin validated: this code has been manually tested. // the only intention of this code is to be used for EMC testing and has been tested and is working fine. @@ -112,13 +119,17 @@ // coco begin validated: this code has been manually tested. // the only intention of this code is to be used for EMC testing and has been tested and is working fine. +/*! + * \brief VEventSpy::doMouseReset + * \details mouse event count reset + */ void VEventSpy::doMouseReset() { mouseCount(0); } // coco end /*! * \brief VEventSpy::touchEventSpy - * \param vEvent - * \param typeName + * \param vEvent - touch event + * \param typeName - The type of the QEvent which has been shortened e.g. tB: TouchBegin */ // coco begin validated: this code has been manually tested. // the only intention of this code is to be used for EMC testing and has been tested and is working fine. @@ -151,5 +162,9 @@ // coco begin validated: this code has been manually tested. // the only intention of this code is to be used for EMC testing and has been tested and is working fine. +/*! + * \brief VEventSpy::doTouchReset + * \details touch event counter reset + */ void VEventSpy::doTouchReset() { touchCount(0); } // coco end Index: sources/view/VEventSpy.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/VEventSpy.h (.../VEventSpy.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/VEventSpy.h (.../VEventSpy.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -20,14 +20,19 @@ #include // Project -#include "main.h" +#include "main.h" // Doxygen : don't remove // define #define _VEventSpy View::VEventSpy::I() // namespace namespace View { +/*! + * \brief The VEventSpy class + * \details event filter for all the events goes to / comes from UI. + * currently is only used for debugging and HW support. + */ class VEventSpy : public QObject { Q_OBJECT @@ -36,12 +41,13 @@ // coco begin validated: this code has been manually tested. // the only intention of this code is to be used for EMC testing and has been tested and is working fine. - PROPERTY(quint64, touchCount , 0) - PROPERTY(quint64, touchPoints, 0) + PROPERTY( quint64 , touchCount , 0 ) + PROPERTY( quint64 , touchPoints , 0 ) - PROPERTY(quint64, mouseCount, 0) - PROPERTY(QPoint , mousePoint, QPoint()) + PROPERTY( quint64 , mouseCount , 0 ) + PROPERTY( QPoint , mousePoint , QPoint() ) // coco end + private: void initConnections(); void mouseEventSpy(QEvent *vEvent, const QString &vTypeName); Index: sources/view/dg/data/VDGDrainPumpData.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGDrainPumpData.cpp (.../VDGDrainPumpData.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/dg/data/VDGDrainPumpData.cpp (.../VDGDrainPumpData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -15,7 +15,7 @@ #include "VDGDrainPumpData.h" // Project -#include "guicontroller.h" +#include "GuiController.h" VIEW_DEF(VDGDrainPump, DGDrainPumpData) Index: sources/view/dg/data/VDGDrainPumpData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGDrainPumpData.h (.../VDGDrainPumpData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/dg/data/VDGDrainPumpData.h (.../VDGDrainPumpData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -18,12 +18,20 @@ #include // Project +#include "main.h" // Doxygen : don't remove #include "MModel.h" -#include "vview.h" +#include "VView.h" // namespace namespace View { +/*! + * \brief The VDGDrainPump class + * \details View for Model's Data representation. + * + * \sa Model::MDGDrainPump + * + */ class VDGDrainPump : public QObject { Q_OBJECT @@ -32,6 +40,5 @@ PROPERTY( quint32 , dac , 0) VIEW_DEC(VDGDrainPump, DGDrainPumpData) - }; } Index: sources/view/dg/data/VDGHeatersData.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGHeatersData.cpp (.../VDGHeatersData.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/view/dg/data/VDGHeatersData.cpp (.../VDGHeatersData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file VDGHeatersData.cpp - * \date 7/2/2020 - * \author Behrouz NematiPour + * \file VDGHeatersData.cpp + * \author (last) Behrouz NemaiPour + * \date (last) 02-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #include "VDGHeatersData.h" Index: sources/view/dg/data/VDGHeatersData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGHeatersData.h (.../VDGHeatersData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/dg/data/VDGHeatersData.h (.../VDGHeatersData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -18,12 +18,20 @@ #include // Project +#include "main.h" // Doxygen : don't remove #include "MModel.h" -#include "vview.h" +#include "VView.h" // namespace namespace View { +/*! + * \brief The VDGHeaters class + * \details View for Model's Data representation. + * + * \sa Model::MDGHeaters + * + */ class VDGHeaters : public QObject { Q_OBJECT @@ -33,6 +41,5 @@ PROPERTY( quint32, trimmerDC , 0) VIEW_DEC(VDGHeaters, DGHeatersData) - }; } Index: sources/view/dg/data/VDGLoadCellReadingsData.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGLoadCellReadingsData.cpp (.../VDGLoadCellReadingsData.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/view/dg/data/VDGLoadCellReadingsData.cpp (.../VDGLoadCellReadingsData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file VDGLoadCellReadingsData.cpp - * \date 6/10/2020 - * \author Behrouz NematiPour + * \file VDGLoadCellReadingsData.cpp + * \author (last) Behrouz NemaiPour + * \date (last) 02-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #include "VDGLoadCellReadingsData.h" Index: sources/view/dg/data/VDGLoadCellReadingsData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGLoadCellReadingsData.h (.../VDGLoadCellReadingsData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/dg/data/VDGLoadCellReadingsData.h (.../VDGLoadCellReadingsData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -18,12 +18,20 @@ #include // Project +#include "main.h" // Doxygen : don't remove #include "MModel.h" -#include "vview.h" +#include "VView.h" // namespace namespace View { +/*! + * \brief The VDGLoadCellReadings class + * \details View for Model's Data representation. + * + * \sa Model::MDGLoadCellReadings + * + */ class VDGLoadCellReadings : public QObject { Q_OBJECT @@ -34,6 +42,5 @@ PROPERTY( float , reservoir2Bkup , 0) VIEW_DEC(VDGLoadCellReadings, DGLoadCellReadingsData) - }; } Index: sources/view/dg/data/VDGOperationModeData.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGOperationModeData.cpp (.../VDGOperationModeData.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/view/dg/data/VDGOperationModeData.cpp (.../VDGOperationModeData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file VDGOperationModeData.cpp - * \date 7/2/2020 - * \author Behrouz NematiPour + * \file VDGOperationModeData.cpp + * \author (last) Behrouz NemaiPour + * \date (last) 02-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #include "VDGOperationModeData.h" Index: sources/view/dg/data/VDGOperationModeData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGOperationModeData.h (.../VDGOperationModeData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/dg/data/VDGOperationModeData.h (.../VDGOperationModeData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -18,29 +18,36 @@ #include // Project +#include "main.h" // Doxygen : don't remove #include "MModel.h" -#include "vview.h" -#include "guiglobals.h" +#include "VView.h" +#include "GuiGlobals.h" // namespace using namespace Gui; namespace View { +/*! + * \brief The VDGOperationMode class + * \details View for Model's Data representation. + * + * \sa Model::MDGOperationMode + * + */ class VDGOperationMode : public QObject { Q_OBJECT PROPERTY( quint32 , opMode , 0) - VIEW_DEC(VDGOperationMode, DGOperationModeData) - Q_PROPERTY(QString text READ text NOTIFY opModeChanged) + VIEW_DEC(VDGOperationMode, DGOperationModeData) + private: QString opModeText(GuiDGOpModes vEnum); public slots: QString text(); - }; } Index: sources/view/dg/data/VDGPressuresData.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGPressuresData.cpp (.../VDGPressuresData.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/view/dg/data/VDGPressuresData.cpp (.../VDGPressuresData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file VDGPressuresData.cpp - * \date 7/2/2020 - * \author Behrouz NematiPour + * \file VDGPressuresData.cpp + * \author (last) Behrouz NemaiPour + * \date (last) 02-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #include "VDGPressuresData.h" Index: sources/view/dg/data/VDGPressuresData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGPressuresData.h (.../VDGPressuresData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/dg/data/VDGPressuresData.h (.../VDGPressuresData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -18,12 +18,20 @@ #include // Project +#include "main.h" // Doxygen : don't remove #include "MModel.h" -#include "vview.h" +#include "VView.h" // namespace namespace View { +/*! + * \brief The VDGPressures class + * \details View for Model's Data representation. + * + * \sa Model::MDGPressures + * + */ class VDGPressures : public QObject { Q_OBJECT @@ -34,6 +42,5 @@ PROPERTY( float , drainOutletPSI , 0) VIEW_DEC(VDGPressures, DGPressuresData) - }; } Index: sources/view/dg/data/VDGROPumpData.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGROPumpData.cpp (.../VDGROPumpData.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/view/dg/data/VDGROPumpData.cpp (.../VDGROPumpData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file VDGROPumpData.cpp - * \date 7/2/2020 - * \author Behrouz NematiPour + * \file VDGROPumpData.cpp + * \author (last) Behrouz NemaiPour + * \date (last) 02-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #include "VDGROPumpData.h" Index: sources/view/dg/data/VDGROPumpData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGROPumpData.h (.../VDGROPumpData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/dg/data/VDGROPumpData.h (.../VDGROPumpData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -18,12 +18,20 @@ #include // Project +#include "main.h" // Doxygen : don't remove #include "MModel.h" -#include "vview.h" +#include "VView.h" // namespace namespace View { +/*! + * \brief The VDGROPump class + * \details View for Model's Data representation. + * + * \sa Model::MDGROPump + * + */ class VDGROPump : public QObject { Q_OBJECT @@ -33,6 +41,5 @@ PROPERTY( float , pwm , 0) VIEW_DEC(VDGROPump, DGROPumpData) - }; } Index: sources/view/dg/data/VDGReservoirData.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGReservoirData.cpp (.../VDGReservoirData.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/view/dg/data/VDGReservoirData.cpp (.../VDGReservoirData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file VDGReservoirData.cpp - * \date 7/2/2020 - * \author Behrouz NematiPour + * \file VDGReservoirData.cpp + * \author (last) Behrouz NemaiPour + * \date (last) 02-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #include "VDGReservoirData.h" Index: sources/view/dg/data/VDGReservoirData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGReservoirData.h (.../VDGReservoirData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/dg/data/VDGReservoirData.h (.../VDGReservoirData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -18,12 +18,20 @@ #include // Project +#include "main.h" // Doxygen : don't remove #include "MModel.h" -#include "vview.h" +#include "VView.h" // namespace namespace View { +/*! + * \brief The VDGReservoir class + * \details View for Model's Data representation. + * + * \sa Model::MDGReservoir + * + */ class VDGReservoir : public QObject { Q_OBJECT @@ -33,6 +41,5 @@ PROPERTY( float , drainToVol , 0) VIEW_DEC(VDGReservoir, DGReservoirData) - }; } Index: sources/view/dg/data/VDGTemperaturesData.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGTemperaturesData.cpp (.../VDGTemperaturesData.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/view/dg/data/VDGTemperaturesData.cpp (.../VDGTemperaturesData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file VDGTemperaturesData.cpp - * \date 6/12/2020 - * \author Behrouz NematiPour + * \file VDGTemperaturesData.cpp + * \author (last) Behrouz NemaiPour + * \date (last) 02-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #include "VDGTemperaturesData.h" Index: sources/view/dg/data/VDGTemperaturesData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGTemperaturesData.h (.../VDGTemperaturesData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/dg/data/VDGTemperaturesData.h (.../VDGTemperaturesData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -18,12 +18,20 @@ #include // Project +#include "main.h" // Doxygen : don't remove #include "MModel.h" -#include "vview.h" +#include "VView.h" // namespace namespace View { +/*! + * \brief The VDGTemperatures class + * \details View for Model's Data representation. + * + * \sa Model::MDGTemperatures + * + */ class VDGTemperatures : public QObject { Q_OBJECT @@ -42,6 +50,5 @@ PROPERTY( float , trimmerHeaterInternal , 0) VIEW_DEC(VDGTemperatures, DGTemperaturesData) - }; } Index: sources/view/dg/data/VDGValvesStatesData.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGValvesStatesData.cpp (.../VDGValvesStatesData.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/view/dg/data/VDGValvesStatesData.cpp (.../VDGValvesStatesData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file VDGValvesStatesData.cpp - * \date 7/2/2020 - * \author Behrouz NematiPour + * \file VDGValvesStatesData.cpp + * \author (last) Behrouz NemaiPour + * \date (last) 06-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #include "VDGValvesStatesData.h" Index: sources/view/dg/data/VDGValvesStatesData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/dg/data/VDGValvesStatesData.h (.../VDGValvesStatesData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/dg/data/VDGValvesStatesData.h (.../VDGValvesStatesData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -18,12 +18,20 @@ #include // Project +#include "main.h" // Doxygen : don't remove #include "MModel.h" -#include "vview.h" +#include "VView.h" // namespace namespace View { +/*! + * \brief The VDGValvesStates class + * \details View for Model's Data representation. + * + * \sa Model::MDGValvesStates + * + */ class VDGValvesStates : public QObject { Q_OBJECT @@ -45,13 +53,11 @@ PROPERTY( bool , valveStates_11 , false) PROPERTY( bool , valveStates_12 , false) - VIEW_DEC(VDGValvesStates, DGValvesStatesData) - Q_PROPERTY(QString text READ text NOTIFY refreshTriggered) + VIEW_DEC(VDGValvesStates, DGValvesStatesData) + public slots: QString text(); - }; - } Index: sources/view/hd/adjustment/VTreatmentAdjustmentSaline.cpp =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/hd/adjustment/VTreatmentAdjustmentSaline.cpp (.../VTreatmentAdjustmentSaline.cpp) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/hd/adjustment/VTreatmentAdjustmentSaline.cpp (.../VTreatmentAdjustmentSaline.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -15,7 +15,7 @@ #include "VTreatmentAdjustmentSaline.h" // Project -#include "guicontroller.h" +#include "GuiController.h" VIEW_DEF_CLASS_ADJUSTMENT(VTreatmentAdjustmentSaline, AdjustSalineResponseData) @@ -55,6 +55,10 @@ isDisabled( vData.mSalineState == GuiSalineStates::SALINE_DISABLE_STATE ); } +/*! + * \brief View::VTreatmentAdjustmentSaline::doAdjustment + * \details the invocable slot to adjust(start/stop) the treatment saline bolus state + */ void View::VTreatmentAdjustmentSaline::doAdjustment() { if (isStarted()) { Index: sources/view/hd/adjustment/VTreatmentAdjustmentSaline.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/hd/adjustment/VTreatmentAdjustmentSaline.h (.../VTreatmentAdjustmentSaline.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/hd/adjustment/VTreatmentAdjustmentSaline.h (.../VTreatmentAdjustmentSaline.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -17,10 +17,18 @@ #include // Project -#include "vtreatmentadjustmentresponsebase.h" +#include "main.h" // Doxygen : don't remove +#include "VTreatmentAdjustmentResponseBase.h" namespace View { +/*! + * \brief The VTreatmentAdjustmentSaline class + * \details View for Model's Data representation. + * + * \sa Model::MAdjustSalineResponse + * + */ class VTreatmentAdjustmentSaline : public VTreatmentAdjustmentResponseBase { Q_OBJECT @@ -49,6 +57,11 @@ void doAdjustment(); signals: + /*! + * \brief didAdjustment + * \details the notification signal to adjust the saline bolus state + * \param vData - data model for the duration adjustment request + */ void didAdjustment(const AdjustSalineRequestData &vData); }; } Index: sources/view/hd/data/VHDOperationModeData.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/hd/data/VHDOperationModeData.cpp (.../VHDOperationModeData.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/data/VHDOperationModeData.cpp (.../VHDOperationModeData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file VHDOperationModeData.cpp - * \date 7/12/2020 - * \author Behrouz NematiPour + * \file VHDOperationModeData.cpp + * \author (last) Behrouz NematiPour + * \date (last) 13-Aug-2020 + * \author (original) Behrouz NematiPour + * \date (original) 13-Aug-2020 * */ #include "VHDOperationModeData.h" Index: sources/view/hd/data/VHDOperationModeData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/hd/data/VHDOperationModeData.h (.../VHDOperationModeData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/hd/data/VHDOperationModeData.h (.../VHDOperationModeData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -18,29 +18,36 @@ #include // Project +#include "main.h" // Doxygen : don't remove #include "MModel.h" -#include "vview.h" -#include "guiglobals.h" +#include "VView.h" +#include "GuiGlobals.h" // namespace using namespace Gui; namespace View { +/*! + * \brief The VHDOperationMode class + * \details View for Model's data representation. + * + * \sa Model::MHDOperationMode + * + */ class VHDOperationMode : public QObject { Q_OBJECT PROPERTY( quint32 , opMode , 0) - VIEW_DEC(VHDOperationMode, HDOperationModeData) - Q_PROPERTY(QString text READ text NOTIFY opModeChanged) + VIEW_DEC(VHDOperationMode, HDOperationModeData) + private: QString opModeText(GuiHDOpModes vEnum); public slots: QString text(); - }; } Index: sources/view/hd/data/VHDTreatmentStatesData.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/hd/data/VHDTreatmentStatesData.cpp (.../VHDTreatmentStatesData.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/data/VHDTreatmentStatesData.cpp (.../VHDTreatmentStatesData.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -2,9 +2,8 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * * \file VHDTreatmentStatesData.cpp * \date 8/11/2020 Index: sources/view/hd/data/VHDTreatmentStatesData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/view/hd/data/VHDTreatmentStatesData.h (.../VHDTreatmentStatesData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/view/hd/data/VHDTreatmentStatesData.h (.../VHDTreatmentStatesData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -5,11 +5,9 @@ * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file VHDTreatmentStatesData.h - * \author (last) Behrouz NematiPour - * \date (last) 13-Aug-2020 - * \author (original) Behrouz NematiPour - * \date (original) 13-Aug-2020 + * \file VHDTreatmentStatesData.h + * \date 8/11/2020 + * \author Behrouz NematiPour * */ #pragma once @@ -18,14 +16,22 @@ #include // Project +#include "main.h" // Doxygen : don't remove #include "MModel.h" -#include "vview.h" -#include "guiglobals.h" +#include "VView.h" +#include "GuiGlobals.h" // namespace using namespace Gui; namespace View { +/*! + * \brief The VHDTreatmentStates class + * \details View for Model's data representation. + * + * \sa Model::MTreatmentStates + * + */ class VHDTreatmentStates : public QObject { Q_OBJECT Index: unittests/tst_acknow.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- unittests/tst_acknow.cpp (.../tst_acknow.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ unittests/tst_acknow.cpp (.../tst_acknow.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file tst_acknow.cpp * \author (last) Behrouz NematiPour - * \date (last) 07-May-2020 + * \date (last) 20-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 21-Jan-2020 * Index: unittests/tst_acknow.h =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- unittests/tst_acknow.h (.../tst_acknow.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ unittests/tst_acknow.h (.../tst_acknow.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -7,7 +7,7 @@ * * \file tst_acknow.h * \author (last) Behrouz NematiPour - * \date (last) 07-May-2020 + * \date (last) 20-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 21-Jan-2020 * Index: unittests/tst_canbus.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- unittests/tst_canbus.cpp (.../tst_canbus.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ unittests/tst_canbus.cpp (.../tst_canbus.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -6,8 +6,8 @@ * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * * \file tst_canbus.cpp - * \author (last) Behrouz NemaiPour - * \date (last) 23-Jun-2020 + * \author (last) Behrouz NematiPour + * \date (last) 30-Jul-2020 * \author (original) Behrouz NematiPour * \date (original) 19-Dec-2019 * Index: unittests/tst_canbus.h =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- unittests/tst_canbus.h (.../tst_canbus.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ unittests/tst_canbus.h (.../tst_canbus.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -6,8 +6,8 @@ * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * * \file tst_canbus.h - * \author (last) Behrouz NemaiPour - * \date (last) 22-Jun-2020 + * \author (last) Behrouz NematiPour + * \date (last) 20-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 19-Dec-2019 * Index: unittests/tst_initializations.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- unittests/tst_initializations.cpp (.../tst_initializations.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ unittests/tst_initializations.cpp (.../tst_initializations.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,16 +1,16 @@ /*! - * + * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * + * * \file tst_initializations.cpp * \author (last) Behrouz NematiPour - * \date (last) 07-May-2020 + * \date (last) 30-Jul-2020 * \author (original) Behrouz NematiPour * \date (original) 21-Apr-2020 - * + * */ #include "tst_initializations.h" Index: unittests/tst_logging.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- unittests/tst_logging.cpp (.../tst_logging.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ unittests/tst_logging.cpp (.../tst_logging.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,16 +1,16 @@ /*! - * + * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * + * * \file tst_logging.cpp * \author (last) Behrouz NematiPour - * \date (last) 07-May-2020 + * \date (last) 30-Jul-2020 * \author (original) Behrouz NematiPour * \date (original) 08-Jan-2020 - * + * */ #include "tst_logging.h" Index: unittests/tst_messaging.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- unittests/tst_messaging.cpp (.../tst_messaging.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ unittests/tst_messaging.cpp (.../tst_messaging.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -6,8 +6,8 @@ * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * * \file tst_messaging.cpp - * \author (last) Peter Lucia - * \date (last) 06-Jul-2020 + * \author (last) Behrouz NematiPour + * \date (last) 23-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 21-Apr-2020 * Index: unittests/tst_models.cpp =================================================================== diff -u -rda39155b9644400a654a22bc010d5d7fa3526716 -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- unittests/tst_models.cpp (.../tst_models.cpp) (revision da39155b9644400a654a22bc010d5d7fa3526716) +++ unittests/tst_models.cpp (.../tst_models.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -6,8 +6,8 @@ * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * * \file tst_models.cpp - * \author (last) Peter Lucia - * \date (last) 07-Jul-2020 + * \author (last) Behrouz NematiPour + * \date (last) 13-Aug-2020 * \author (original) Behrouz NematiPour * \date (original) 21-Apr-2020 * Index: unittests/tst_threads.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- unittests/tst_threads.cpp (.../tst_threads.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ unittests/tst_threads.cpp (.../tst_threads.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,16 +1,16 @@ /*! - * + * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * + * * \file tst_threads.cpp * \author (last) Behrouz NematiPour - * \date (last) 07-May-2020 + * \date (last) 30-Jul-2020 * \author (original) Behrouz NematiPour * \date (original) 21-Apr-2020 - * + * */ #include "tst_threads.h" Index: unittests/tst_views.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- unittests/tst_views.cpp (.../tst_views.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ unittests/tst_views.cpp (.../tst_views.cpp) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -1,16 +1,16 @@ /*! - * + * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * + * * \file tst_views.cpp * \author (last) Behrouz NemaiPour * \date (last) 23-Jun-2020 * \author (original) Behrouz NematiPour * \date (original) 21-Apr-2020 - * + * */ #include "tst_views.h"