Index: denali.pro.user =================================================================== diff -u -r6aea3fd1baa6992d6eba9938599374f615649fab -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- denali.pro.user (.../denali.pro.user) (revision 6aea3fd1baa6992d6eba9938599374f615649fab) +++ denali.pro.user (.../denali.pro.user) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -1,6 +1,6 @@ - + EnvironmentId Index: main.cpp =================================================================== diff -u -r6aea3fd1baa6992d6eba9938599374f615649fab -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- main.cpp (.../main.cpp) (revision 6aea3fd1baa6992d6eba9938599374f615649fab) +++ main.cpp (.../main.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -20,10 +20,11 @@ * This document describes the detail description of the UI Application Software design.\n * UI Application starts by Application Initialization which happens in \ref main() "Application Initialization".\n * For information please see : - * - \ref main() "Application Initialization" - * - \subpage CommandLineSwitches "Command line switches" - * - \subpage MessageFlow "Messaging workflow" - * - \subpage MessageView "Messaging View and exposure in UI" + * - \ref main() + * - \subpage CommandLineSwitches + * - \subpage DenaliMessageStructure + * - \subpage MessageFlow + * - \subpage MessageView */ // Qt Index: sources/ApplicationController.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/ApplicationController.cpp (.../ApplicationController.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/ApplicationController.cpp (.../ApplicationController.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -81,7 +81,7 @@ // coco end /*! - * \brief ApplicationController::initConnections + * \brief ApplicationController::initConnections * \details Initializes the required signal/slot connection between this class and other objects * to be able to communicate. */ @@ -161,32 +161,32 @@ // coco end /*! - * \brief ApplicationController::onFailedTransmit - * Called when we failed to get a response back from the HD - * \param seq - The sequence that failed to send to the HD. + * \brief ApplicationController::onFailedTransmit + * \details Called when failed to get a response back from the HD + * \param seq - The sequence that failed to send to the HD. */ void ApplicationController::onFailedTransmit(Sequence seq) { emit didFailedTransmit(seq); } /*! - * \brief Process the requested action + * \brief Process the requested action * \details Processes the requested action - * \param vAction - User requested Action - * \param vData - Action data to be transmitted. + * \param vAction - User requested Action + * \param vData - Action data to be transmitted. */ void ApplicationController::onActionTransmit(GuiActionType vAction, const QVariantList &vData) { emit didActionTransmit(vAction, vData); } /*! - * \brief An action has been confirmed + * \brief An action has been confirmed * \details GUI requested an action. - * In response HD confirmed the action. - * \param vAction - * \param vData + * In response HD confirmed the action. + * \param vAction - Received action + * \param vData - data of the action */ void ApplicationController::onActionReceive (GuiActionType vAction, const QVariantList &vData) { Index: sources/ApplicationPost.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/ApplicationPost.cpp (.../ApplicationPost.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/ApplicationPost.cpp (.../ApplicationPost.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,11 +25,21 @@ } +/*! + * \brief ApplicationPost::init + * \details Initialization + * \return true + */ bool ApplicationPost::init() { return true; } +/*! + * \brief ApplicationPost::start + * \details Starting the post application initialization + * \return + */ bool ApplicationPost::start() { // coco begin validated: Is a placeholder and has not been implemented yet Index: sources/canbus/MessageBuilder.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/canbus/MessageBuilder.h (.../MessageBuilder.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/canbus/MessageBuilder.h (.../MessageBuilder.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -29,27 +29,31 @@ /*! * - * \brief The Message Builder class - * \details This class is handling the can message by building and striping it. - * \verbatim - * \table - * // -- CAN PAYLOAD STRUCTURE -- - * | #0| #1| #2| #3| #4| #5| #6| #7| #8| ........ | - * |---|-------|-------|---|-------|---|-----------| - * | A5| Seq# | MsgId |Len| Data |CRC|..padding..| - * +---+-------+-------+---+-------+---+-----------+ + * \page DenaliMessageStructure Denali Message Structure * - * Header Frame: - * 1 - CRC is last after payload - * Ex1 - If Len=0 then CRC is #4 - * Ex2 - If Len=1 then CRC is #5 and payload is #4 - * 2 - If CRC is not the last by in the frame - * then there is padding 0x00 to make the frame 8 byte fix + * CAN PAYLOAD STRUCTURE * - * Tail Frame: - * 3 - Partial frames only have Payload and CRC ( and padded) - * \endverbatim + * | #0 | #1 , #2 | #3 , #4 | #5 | #6 , #7 | #8 | .......... | + * |:---:|:-------:|:-------:|:---:|:-------:|:---:|:----------:| + * | A5 | #seq | MSG ID | Len | Data | CRC | ..padding..| + * + \verbatim + Header Frame: + 1 - CRC is last after payload + Ex1 - If Len=0 then CRC is #4 + Ex2 - If Len=1 then CRC is #5 and payload is #4 + 2 - If CRC is not the last by in the frame + then there is padding 0x00 to make the frame 8 byte fix + + Tail Frame: + 3 - Partial frames only have Payload and CRC ( and padded ) + \endverbatim */ + +/*! + * \brief The MessageBuilder class + * \details This class is handling the can message by building and striping it. + */ class MessageBuilder : public QObject { Q_OBJECT Index: sources/gui/GuiGlobals.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/gui/GuiGlobals.cpp (.../GuiGlobals.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/gui/GuiGlobals.cpp (.../GuiGlobals.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -73,8 +73,7 @@ qRegisterMetaType ("GuiRequestReasons"); - - // Note that this Models are not used in the qml + // Note that this Models are not used in the QML // but Qt needs them to be registered to be able to use them in between threads queue // by their metadata information. REGISTER_MODEL_METATYPES Index: sources/gui/GuiGlobals.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/gui/GuiGlobals.h (.../GuiGlobals.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/gui/GuiGlobals.h (.../GuiGlobals.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -20,6 +20,14 @@ // Project namespace Gui { + /*! + * \brief The MainView class + * \details A QQuickView inherited child. + * Main entry of the QML. + * It's not usual to inherit from QQuickView and most of the time the class QQuickView, itself, is used. + * It's been inherited to grab all the events which is send/received to/from QML. + * \sa VEventSpy + */ class MainView : public QQuickView { Q_OBJECT Index: sources/gui/GuiView.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/gui/GuiView.h (.../GuiView.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/gui/GuiView.h (.../GuiView.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -27,7 +27,11 @@ // namespace namespace Gui { - +/*! + * \brief The GuiView class + * \details Global view which is used mostly for non-messaging purposes. + * Different purposes could be like device notifications and such. + */ class GuiView : public QObject { Q_OBJECT Index: sources/main.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/main.h (.../main.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/main.h (.../main.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -99,16 +99,18 @@ NOTIFY vVARIABLE##vSIGNAL) \ Q_SIGNALS: \ /*! \brief Property notify signal - \details The Property notify signal (...Changed) - which will be emitted by Property setter. + \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 + \details The property getter which reads the private variable \return current value */\ vTYPE vVARIABLE () const { \ Index: sources/model/MAbstract.h =================================================================== diff -u -r6aea3fd1baa6992d6eba9938599374f615649fab -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/MAbstract.h (.../MAbstract.h) (revision 6aea3fd1baa6992d6eba9938599374f615649fab) +++ sources/model/MAbstract.h (.../MAbstract.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -22,6 +22,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: Index: sources/model/MDGDebugText.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/MDGDebugText.cpp (.../MDGDebugText.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/model/MDGDebugText.cpp (.../MDGDebugText.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -28,6 +28,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 -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/MDGDebugText.h (.../MDGDebugText.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/model/MDGDebugText.h (.../MDGDebugText.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,16 @@ 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 | + * + * \sa Data + */ class MDGDebugText : public MAbstract { // friends @@ -46,7 +56,7 @@ }; bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; - Data data ( ) const; + Data data ( ) const ; }; } Index: sources/model/MHDDebugText.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/MHDDebugText.cpp (.../MHDDebugText.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/model/MHDDebugText.cpp (.../MHDDebugText.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -28,6 +28,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 -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/MHDDebugText.h (.../MHDDebugText.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/model/MHDDebugText.h (.../MHDDebugText.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,16 @@ 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 | + * + * \sa Data + */ class MHDDebugText : public MAbstract { // friends @@ -45,7 +55,7 @@ }; bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; - Data data ( ) const; + Data data ( ) const ; }; } Index: sources/model/MModel.h =================================================================== diff -u -r6aea3fd1baa6992d6eba9938599374f615649fab -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/MModel.h (.../MModel.h) (revision 6aea3fd1baa6992d6eba9938599374f615649fab) +++ sources/model/MModel.h (.../MModel.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -87,83 +87,90 @@ * * * \enddot - * \note This instruction needs to be reviewed. + * + * \note + * 00 - sort .pro file after all new files added. + * * \details * This comment explains how to add a Denali Message in Denali UI Application * - * 1 - Look at the message structure in the "message list.xlsx" + * Model : * - * 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 => + * 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 * - * \code{.cpp} + * 02 - MessageGlobals.h : add len + * \code{.cpp} + * {Gui::GuiActionType::ID_HDOperationModeData , 1 * 4 }, // 1 parameter each 4bytes + * \endcode * - * PressureOcclusion = 0x0900, //(little endian) + * 03 - Implement the model by copy/paste of the closest model, fit to your need. + * \sa MHDOperationMode + * \sa MHDOperationModeData.h + * \sa MHDOperationModeData.cpp * - * \endcode + * 04 - Added #include in MModel.h for the implemented model + * \code{.cpp} + * #include "MHDOperationModeData.h" + * \endcode * - * 3 - MSG Payload Len : - * Add a line in the "messageglobals.h" in payloadLen hash table - * to define the required payload length of the message + * 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 * - * 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. + * 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 * - * 5 - Register Model : - * Add the required lines like the other models in the mmodel.h file. + * View : + * 07 - Implement the view by copy/paste of the closest view, fit to your need. + * \sa VHDOperationMode + * \sa VHDOperationModeData.h + * \sa VHDOperationModeData.cpp * - * 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} - * \n - * bool pressureOcclusionData (const Message &vMessage, QVariantList &vData) __attribute_warn_unused_result__; - * \n - * \endcode + * 08 - Register the view in VView.h in macro list + * \sa REGISTER_VIEW_TYPES + * \sa VView.h * - * in the implementation should be like: + * 09 - Include the view header in the GuiGlobals.cpp + * \code{.cpp} + * #include "VHDOperationModeData.h" + * \endcode + * \sa GuiGlobals.cpp * - * \code{.cpp} - * \n - * 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; + * QML : + * 10 - Import the registered view + * \code{.js} + * import VHDOperationMode 0.1; + * \endcode + * \sa main.qml * - * Model::MPressureOcclusion mData; - * ok = mData.fromByteArray(vMessage.data); - * LOG_DATUM("HD," + mData.toString()); + * 11 - Create an object + * \code{.js} + * VHDOperationMode { id: vHDOperationMode } + * \endcode + * \sa main.qml * - * mData.toVariantList(vData); - * emit didActionReceive(mData.data()); - * - * return ok; - * } - * \n - * \endcode - * - * Add a case in MessageInterpreter::interpretMessage_HD for that message id Enum - * with lines like : - * - * \code{.cpp} - * \n - * case Gui::GuiActionType::PressureOcclusion: - * ok = pressureOcclusionData (vMessage, vData); - * break; - * \n - * \endcode - * + * 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 \ \ Index: sources/model/MPowerOff.cpp =================================================================== diff -u -r15de0cd12dad1ea5107c52e5ed89280bc9e29b1d -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/MPowerOff.cpp (.../MPowerOff.cpp) (revision 15de0cd12dad1ea5107c52e5ed89280bc9e29b1d) +++ sources/model/MPowerOff.cpp (.../MPowerOff.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -28,6 +28,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/dg/data/MDGDrainPumpData.cpp =================================================================== diff -u -r90bcc276f2a879169fef20e9168711cf906c0e54 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGDrainPumpData.cpp (.../MDGDrainPumpData.cpp) (revision 90bcc276f2a879169fef20e9168711cf906c0e54) +++ sources/model/dg/data/MDGDrainPumpData.cpp (.../MDGDrainPumpData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -31,6 +31,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGDrainPumpData.h (.../MDGDrainPumpData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/dg/data/MDGDrainPumpData.h (.../MDGDrainPumpData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MDGDrainPump class + * \details The DG drain pump data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MDGDrainPump : public MAbstract { // friends Index: sources/model/dg/data/MDGHeatersData.cpp =================================================================== diff -u -r90bcc276f2a879169fef20e9168711cf906c0e54 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGHeatersData.cpp (.../MDGHeatersData.cpp) (revision 90bcc276f2a879169fef20e9168711cf906c0e54) +++ sources/model/dg/data/MDGHeatersData.cpp (.../MDGHeatersData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -34,6 +34,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGHeatersData.h (.../MDGHeatersData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/dg/data/MDGHeatersData.h (.../MDGHeatersData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MDGHeaters class + * \details The DG heaters data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MDGHeaters : public MAbstract { // friends Index: sources/model/dg/data/MDGLoadCellReadingsData.cpp =================================================================== diff -u -r90bcc276f2a879169fef20e9168711cf906c0e54 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGLoadCellReadingsData.cpp (.../MDGLoadCellReadingsData.cpp) (revision 90bcc276f2a879169fef20e9168711cf906c0e54) +++ sources/model/dg/data/MDGLoadCellReadingsData.cpp (.../MDGLoadCellReadingsData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -37,6 +37,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGLoadCellReadingsData.h (.../MDGLoadCellReadingsData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/dg/data/MDGLoadCellReadingsData.h (.../MDGLoadCellReadingsData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MDGLoadCellReadings class + * \details The DG load cells reading data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MDGLoadCellReadings : public MAbstract { // friends Index: sources/model/dg/data/MDGOperationModeData.cpp =================================================================== diff -u -r90bcc276f2a879169fef20e9168711cf906c0e54 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGOperationModeData.cpp (.../MDGOperationModeData.cpp) (revision 90bcc276f2a879169fef20e9168711cf906c0e54) +++ sources/model/dg/data/MDGOperationModeData.cpp (.../MDGOperationModeData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -28,6 +28,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGOperationModeData.h (.../MDGOperationModeData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/dg/data/MDGOperationModeData.h (.../MDGOperationModeData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MDGOperationMode class + * \details The DG operation mode data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MDGOperationMode : public MAbstract { // friends Index: sources/model/dg/data/MDGPressuresData.cpp =================================================================== diff -u -r90bcc276f2a879169fef20e9168711cf906c0e54 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGPressuresData.cpp (.../MDGPressuresData.cpp) (revision 90bcc276f2a879169fef20e9168711cf906c0e54) +++ sources/model/dg/data/MDGPressuresData.cpp (.../MDGPressuresData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -37,6 +37,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGPressuresData.h (.../MDGPressuresData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/dg/data/MDGPressuresData.h (.../MDGPressuresData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MDGPressures class + * \details The DG pressure data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MDGPressures : public MAbstract { // friends Index: sources/model/dg/data/MDGROPumpData.cpp =================================================================== diff -u -r90bcc276f2a879169fef20e9168711cf906c0e54 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGROPumpData.cpp (.../MDGROPumpData.cpp) (revision 90bcc276f2a879169fef20e9168711cf906c0e54) +++ sources/model/dg/data/MDGROPumpData.cpp (.../MDGROPumpData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -34,6 +34,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 -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGROPumpData.h (.../MDGROPumpData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/model/dg/data/MDGROPumpData.h (.../MDGROPumpData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MDGROPump class + * \details The DG reverse osmosis pump data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MDGROPump : public MAbstract { // friends Index: sources/model/dg/data/MDGReservoirData.cpp =================================================================== diff -u -r90bcc276f2a879169fef20e9168711cf906c0e54 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGReservoirData.cpp (.../MDGReservoirData.cpp) (revision 90bcc276f2a879169fef20e9168711cf906c0e54) +++ sources/model/dg/data/MDGReservoirData.cpp (.../MDGReservoirData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -34,6 +34,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGReservoirData.h (.../MDGReservoirData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/dg/data/MDGReservoirData.h (.../MDGReservoirData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MDGReservoir class + * \details The DG reservoir data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MDGReservoir : public MAbstract { // friends Index: sources/model/dg/data/MDGTemperaturesData.cpp =================================================================== diff -u -r90bcc276f2a879169fef20e9168711cf906c0e54 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGTemperaturesData.cpp (.../MDGTemperaturesData.cpp) (revision 90bcc276f2a879169fef20e9168711cf906c0e54) +++ sources/model/dg/data/MDGTemperaturesData.cpp (.../MDGTemperaturesData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -62,6 +62,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGTemperaturesData.h (.../MDGTemperaturesData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/dg/data/MDGTemperaturesData.h (.../MDGTemperaturesData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MDGTemperatures class + * \details The DG temperatures data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MDGTemperatures : public MAbstract { // friends Index: sources/model/dg/data/MDGValvesStatesData.cpp =================================================================== diff -u -r90bcc276f2a879169fef20e9168711cf906c0e54 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGValvesStatesData.cpp (.../MDGValvesStatesData.cpp) (revision 90bcc276f2a879169fef20e9168711cf906c0e54) +++ sources/model/dg/data/MDGValvesStatesData.cpp (.../MDGValvesStatesData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -30,6 +30,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/dg/data/MDGValvesStatesData.h (.../MDGValvesStatesData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/dg/data/MDGValvesStatesData.h (.../MDGValvesStatesData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MDGValvesStates class + * \details The DG valves states data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MDGValvesStates : public MAbstract { // friends Index: sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.cpp =================================================================== diff -u -rda39155b9644400a654a22bc010d5d7fa3526716 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.cpp (.../MTreatmentAdjustBloodDialysateResponse.cpp) (revision da39155b9644400a654a22bc010d5d7fa3526716) +++ sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.cpp (.../MTreatmentAdjustBloodDialysateResponse.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -37,6 +37,11 @@ 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; Index: sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.h =================================================================== diff -u -rda39155b9644400a654a22bc010d5d7fa3526716 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.h (.../MTreatmentAdjustBloodDialysateResponse.h) (revision da39155b9644400a654a22bc010d5d7fa3526716) +++ sources/model/hd/adjustment/MTreatmentAdjustBloodDialysateResponse.h (.../MTreatmentAdjustBloodDialysateResponse.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MAdjustBloodDialysateResponse class + * \details The blood and dialysate adjustment response model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MAdjustBloodDialysateResponse : public MAbstract { // friends Index: sources/model/hd/adjustment/MTreatmentAdjustDurationResponse.cpp =================================================================== diff -u -r30f83b2813e68ae3c2806399bf808b642c215b67 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustDurationResponse.cpp (.../MTreatmentAdjustDurationResponse.cpp) (revision 30f83b2813e68ae3c2806399bf808b642c215b67) +++ sources/model/hd/adjustment/MTreatmentAdjustDurationResponse.cpp (.../MTreatmentAdjustDurationResponse.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -38,6 +38,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustDurationResponse.h (.../MTreatmentAdjustDurationResponse.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/adjustment/MTreatmentAdjustDurationResponse.h (.../MTreatmentAdjustDurationResponse.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MAdjustDurationResponse class + * \details The duration adjustment response model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MAdjustDurationResponse : public MAbstract { // friends Index: sources/model/hd/adjustment/MTreatmentAdjustRequests.h =================================================================== diff -u -r6aea3fd1baa6992d6eba9938599374f615649fab -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustRequests.h (.../MTreatmentAdjustRequests.h) (revision 6aea3fd1baa6992d6eba9938599374f615649fab) +++ sources/model/hd/adjustment/MTreatmentAdjustRequests.h (.../MTreatmentAdjustRequests.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -32,6 +32,15 @@ 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(',')); Index: sources/model/hd/adjustment/MTreatmentAdjustSalineResponse.cpp =================================================================== diff -u -r7ed86349cdad43d311f776a69ed54c2023265e53 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustSalineResponse.cpp (.../MTreatmentAdjustSalineResponse.cpp) (revision 7ed86349cdad43d311f776a69ed54c2023265e53) +++ sources/model/hd/adjustment/MTreatmentAdjustSalineResponse.cpp (.../MTreatmentAdjustSalineResponse.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -35,6 +35,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 -r6aea3fd1baa6992d6eba9938599374f615649fab -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustSalineResponse.h (.../MTreatmentAdjustSalineResponse.h) (revision 6aea3fd1baa6992d6eba9938599374f615649fab) +++ sources/model/hd/adjustment/MTreatmentAdjustSalineResponse.h (.../MTreatmentAdjustSalineResponse.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -26,13 +26,14 @@ namespace Model { /*! - * \brief The MAdjustSalineResponse class + * \brief The MAdjustSalineResponse class * \details The Saline Bolus adjustment response model * - * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1:mAccepted | #2:mReason | #3:mTarget | * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:--------------------:|:-----------------:|:----------------------:|:-------------------:| * | 20 | 0x020 | 6 | Rsp | Y | HD | UI | Saline Bolus Response| 0=No, 1=Yes (U32) | rejection reason (U32) | Bolus Vol.-mL (U32) | * + * \sa Data * \sa MAdjustSalineReq : Saline Bolus Request * \sa MTreatmentSaline : Saline Bolus Data * Index: sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationConfirmResponse.cpp =================================================================== diff -u -r6ae83fa9a1a3204864fc5b50fe906ac09e9c1ea5 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationConfirmResponse.cpp (.../MTreatmentAdjustUltrafiltrationConfirmResponse.cpp) (revision 6ae83fa9a1a3204864fc5b50fe906ac09e9c1ea5) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationConfirmResponse.cpp (.../MTreatmentAdjustUltrafiltrationConfirmResponse.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -48,6 +48,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationConfirmResponse.h (.../MTreatmentAdjustUltrafiltrationConfirmResponse.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationConfirmResponse.h (.../MTreatmentAdjustUltrafiltrationConfirmResponse.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,17 @@ namespace Model { +/*! + * \brief The MAdjustUltrafiltrationConfirmResponse class + * \details The ultrafiltration adjustment confirm response model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MAdjustUltrafiltrationConfirmResponse { // friends Index: sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationEditResponse.cpp =================================================================== diff -u -r6ae83fa9a1a3204864fc5b50fe906ac09e9c1ea5 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationEditResponse.cpp (.../MTreatmentAdjustUltrafiltrationEditResponse.cpp) (revision 6ae83fa9a1a3204864fc5b50fe906ac09e9c1ea5) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationEditResponse.cpp (.../MTreatmentAdjustUltrafiltrationEditResponse.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -60,6 +60,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationEditResponse.h (.../MTreatmentAdjustUltrafiltrationEditResponse.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationEditResponse.h (.../MTreatmentAdjustUltrafiltrationEditResponse.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MAdjustUltrafiltrationEditResponse class + * \details The ultrafiltration adjustment edit response model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MAdjustUltrafiltrationEditResponse : public MAdjustUltrafiltrationConfirmResponse { Index: sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationStateResponse.cpp =================================================================== diff -u -r30f83b2813e68ae3c2806399bf808b642c215b67 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationStateResponse.cpp (.../MTreatmentAdjustUltrafiltrationStateResponse.cpp) (revision 30f83b2813e68ae3c2806399bf808b642c215b67) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationStateResponse.cpp (.../MTreatmentAdjustUltrafiltrationStateResponse.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -29,6 +29,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationStateResponse.h (.../MTreatmentAdjustUltrafiltrationStateResponse.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/adjustment/MTreatmentAdjustUltrafiltrationStateResponse.h (.../MTreatmentAdjustUltrafiltrationStateResponse.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,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 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MAdjustUltrafiltrationStateResponse : public MAbstract { // friends Index: sources/model/hd/alarm/MAlarmCleared.cpp =================================================================== diff -u -r6ae83fa9a1a3204864fc5b50fe906ac09e9c1ea5 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/alarm/MAlarmCleared.cpp (.../MAlarmCleared.cpp) (revision 6ae83fa9a1a3204864fc5b50fe906ac09e9c1ea5) +++ sources/model/hd/alarm/MAlarmCleared.cpp (.../MAlarmCleared.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -31,6 +31,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/alarm/MAlarmCleared.h (.../MAlarmCleared.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/alarm/MAlarmCleared.h (.../MAlarmCleared.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,17 @@ namespace Model { +/*! + * \brief The MAlarmCleared class + * \details The alarm cleared data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MAlarmCleared { // friends Index: sources/model/hd/alarm/MAlarmStatusData.cpp =================================================================== diff -u -rbf645acccabb7b5a84801620c4f7fa0b0e6878e0 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/alarm/MAlarmStatusData.cpp (.../MAlarmStatusData.cpp) (revision bf645acccabb7b5a84801620c4f7fa0b0e6878e0) +++ sources/model/hd/alarm/MAlarmStatusData.cpp (.../MAlarmStatusData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -53,6 +53,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/alarm/MAlarmStatusData.h (.../MAlarmStatusData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/alarm/MAlarmStatusData.h (.../MAlarmStatusData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MAlarmStatus class + * \details The alarm status data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MAlarmStatus { // friends Index: sources/model/hd/alarm/MAlarmTriggered.cpp =================================================================== diff -u -r6ae83fa9a1a3204864fc5b50fe906ac09e9c1ea5 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/alarm/MAlarmTriggered.cpp (.../MAlarmTriggered.cpp) (revision 6ae83fa9a1a3204864fc5b50fe906ac09e9c1ea5) +++ sources/model/hd/alarm/MAlarmTriggered.cpp (.../MAlarmTriggered.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -31,6 +31,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/alarm/MAlarmTriggered.h (.../MAlarmTriggered.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/alarm/MAlarmTriggered.h (.../MAlarmTriggered.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,17 @@ namespace Model { +/*! + * \brief The MAlarmTriggered class + * \details The alarm triggered data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MAlarmTriggered { // friends Index: sources/model/hd/data/MHDOperationModeData.cpp =================================================================== diff -u -r15de0cd12dad1ea5107c52e5ed89280bc9e29b1d -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MHDOperationModeData.cpp (.../MHDOperationModeData.cpp) (revision 15de0cd12dad1ea5107c52e5ed89280bc9e29b1d) +++ sources/model/hd/data/MHDOperationModeData.cpp (.../MHDOperationModeData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -28,6 +28,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MHDOperationModeData.h (.../MHDOperationModeData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/data/MHDOperationModeData.h (.../MHDOperationModeData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MHDOperationMode class + * \details The HD operation mode data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MHDOperationMode : public MAbstract { // friends Index: sources/model/hd/data/MTreatmentFlowsData.cpp =================================================================== diff -u -r30f83b2813e68ae3c2806399bf808b642c215b67 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentFlowsData.cpp (.../MTreatmentFlowsData.cpp) (revision 30f83b2813e68ae3c2806399bf808b642c215b67) +++ sources/model/hd/data/MTreatmentFlowsData.cpp (.../MTreatmentFlowsData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -48,7 +48,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; @@ -61,7 +66,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentFlowsData.h (.../MTreatmentFlowsData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/data/MTreatmentFlowsData.h (.../MTreatmentFlowsData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -27,7 +27,8 @@ namespace Model { /*! - * \brief The Flow Data class + * \brief The MFlow class + * \details The parent class of the flow data models */ class MFlow : public MAbstract { @@ -55,7 +56,15 @@ }; /*! - * \brief The Blood Flow Data class + * \brief The MBloodFlow class + * \details The blood flow data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * */ class MBloodFlow : public MFlow { @@ -81,7 +90,15 @@ }; /*! - * \brief The Dialysate Flow Data class + * \brief The MDialysateFlow class + * \details The dialysate flow data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * */ class MDialysateFlow : public MFlow { Index: sources/model/hd/data/MTreatmentOutletFlowData.cpp =================================================================== diff -u -r30f83b2813e68ae3c2806399bf808b642c215b67 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentOutletFlowData.cpp (.../MTreatmentOutletFlowData.cpp) (revision 30f83b2813e68ae3c2806399bf808b642c215b67) +++ sources/model/hd/data/MTreatmentOutletFlowData.cpp (.../MTreatmentOutletFlowData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -46,6 +46,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentOutletFlowData.h (.../MTreatmentOutletFlowData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/data/MTreatmentOutletFlowData.h (.../MTreatmentOutletFlowData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MOutletFlow class + * \details The outlet flow data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MOutletFlow : public MAbstract { // friends Index: sources/model/hd/data/MTreatmentPressureOcclusionData.cpp =================================================================== diff -u -r30f83b2813e68ae3c2806399bf808b642c215b67 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentPressureOcclusionData.cpp (.../MTreatmentPressureOcclusionData.cpp) (revision 30f83b2813e68ae3c2806399bf808b642c215b67) +++ sources/model/hd/data/MTreatmentPressureOcclusionData.cpp (.../MTreatmentPressureOcclusionData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -40,6 +40,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentPressureOcclusionData.h (.../MTreatmentPressureOcclusionData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/data/MTreatmentPressureOcclusionData.h (.../MTreatmentPressureOcclusionData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,17 @@ namespace Model { +/*! + * \brief The MPressureOcclusion class + * \details The pressure/occlusion data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MPressureOcclusion : public MAbstract { // friends Index: sources/model/hd/data/MTreatmentRangesData.cpp =================================================================== diff -u -r30f83b2813e68ae3c2806399bf808b642c215b67 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentRangesData.cpp (.../MTreatmentRangesData.cpp) (revision 30f83b2813e68ae3c2806399bf808b642c215b67) +++ sources/model/hd/data/MTreatmentRangesData.cpp (.../MTreatmentRangesData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -43,6 +43,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentRangesData.h (.../MTreatmentRangesData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/data/MTreatmentRangesData.h (.../MTreatmentRangesData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -26,6 +26,18 @@ namespace Model { +/*! + * \brief The MTreatmentRanges class + * \details The treatment ranges data model + * The ranges are used for adjustments and these values are ranges of adjustment. + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MTreatmentRanges : public MAbstract { // friends Index: sources/model/hd/data/MTreatmentSalineData.cpp =================================================================== diff -u -r7ed86349cdad43d311f776a69ed54c2023265e53 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentSalineData.cpp (.../MTreatmentSalineData.cpp) (revision 7ed86349cdad43d311f776a69ed54c2023265e53) +++ sources/model/hd/data/MTreatmentSalineData.cpp (.../MTreatmentSalineData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -34,6 +34,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 -r6aea3fd1baa6992d6eba9938599374f615649fab -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentSalineData.h (.../MTreatmentSalineData.h) (revision 6aea3fd1baa6992d6eba9938599374f615649fab) +++ sources/model/hd/data/MTreatmentSalineData.h (.../MTreatmentSalineData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -26,13 +26,14 @@ namespace Model { /*! - * \brief The MTreatmentSaline class - * the model which populates the data of message : + * \brief The MTreatmentSaline class + * \details The saline bolus data model * * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1:mTarget | #2:mCumulative | #3:mDelivered | * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:------------------------------------:|:-------------:|:--------------:|:-----------------:| * | 47 | 0x040 | 7 | 1 Hz | N | HD | All | Treatment Saline Bolus Data (all mL) | Max vol (U32) | Cum. vol (F32) | In-prog vol (F32) | * + * \sa Data * \sa MAdjustSalineReq : Saline Bolus Request * \sa MAdjustSalineResponse : Saline Bolus Response * Index: sources/model/hd/data/MTreatmentStatesData.cpp =================================================================== diff -u -r30f83b2813e68ae3c2806399bf808b642c215b67 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentStatesData.cpp (.../MTreatmentStatesData.cpp) (revision 30f83b2813e68ae3c2806399bf808b642c215b67) +++ sources/model/hd/data/MTreatmentStatesData.cpp (.../MTreatmentStatesData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -34,6 +34,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentStatesData.h (.../MTreatmentStatesData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/data/MTreatmentStatesData.h (.../MTreatmentStatesData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,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 | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MTreatmentStates : public MAbstract { // friends Index: sources/model/hd/data/MTreatmentTimeData.cpp =================================================================== diff -u -r30f83b2813e68ae3c2806399bf808b642c215b67 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentTimeData.cpp (.../MTreatmentTimeData.cpp) (revision 30f83b2813e68ae3c2806399bf808b642c215b67) +++ sources/model/hd/data/MTreatmentTimeData.cpp (.../MTreatmentTimeData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -34,6 +34,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 -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/model/hd/data/MTreatmentTimeData.h (.../MTreatmentTimeData.h) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/model/hd/data/MTreatmentTimeData.h (.../MTreatmentTimeData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -26,6 +26,17 @@ namespace Model { +/*! + * \brief The MTreatmentTime class + * \details The treatment time data model + * + * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description | #1 | #2 | #3 | #4 | #5 | #6 | #7 | #8 | + * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-----------:|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + * | | | | | | | | | | | | | | | | | + * + * \sa Data + * + */ class MTreatmentTime : public MAbstract { // friends Index: sources/storage/FileHandler.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/storage/FileHandler.cpp (.../FileHandler.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/storage/FileHandler.cpp (.../FileHandler.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -56,6 +56,15 @@ ++count; } +/*! + * \brief FileHandler::write + * \details writes content vContent into the file vFileName. + * appends to the file if vAppend is true otherwise overwrites the file content with vContent + * \param vFileName - Source file name + * \param vContent - content to be written into file. + * \param vAppend - append (true) or overwrite (false) + * \return false if file can't be opened for write. + */ bool FileHandler::write(const QString &vFileName, const QString &vContent, bool vAppend) { QFile file(vFileName); Index: sources/storage/Logger.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/storage/Logger.cpp (.../Logger.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/storage/Logger.cpp (.../Logger.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -279,7 +279,12 @@ } } - +/*! + * \brief Logger::exportLogs + * \details Exports the log files from log folder (Storage::Log_Base_Path_Name_Location) + * into USB drive folder (Storage::USB_Mount_Point) + * \return true if at least one file has been exported + */ bool Logger::exportLogs() { // coco begin validated: This needs user interaction to check the old files deleted @@ -302,8 +307,7 @@ /*! * \brief Logger::concurrentExportLogs - * \details Exports the log files from log folder (Storage::Log_Base_Path_Name_Location) - * into USB drive folder (Storage::USB_Mount_Point) + * \details Export logs scheduler. * \return always returns true for now. * \note This method uses QtConcurrent run to execute the FileHandler copyFolder method. */ @@ -318,6 +322,10 @@ } // coco end +/*! + * \brief Logger::onExportLogs + * \details Export log notification slot which logs result of export. + */ void Logger::onExportLogs() { // coco begin validated: This needs user interaction to export to USB device @@ -363,8 +371,7 @@ /*! * \brief Logger::concurrentRemoveLogs - * \details - * + * \details remove logs scheduler. * \return always returns true for now. * \note This method uses QtConcurrent run to execute the FileHandler copyFolder method. */ @@ -379,16 +386,34 @@ } // coco end +/*! + * \brief Logger::onRemoveLogs + * \details Remove old logs notification slot which logs result of remove. + */ void Logger::onRemoveLogs() { // coco begin validated: This needs user interaction to export to USB device // has been tested manually LOG_DEBUG(QString("Remove Logs Ended: %1").arg(_removeLogsWatcher.result())); emit didRemoveLogs(); } +// coco end +/*! + * \brief Logger::onSDCardSpaceChange + * \details SD Card storage space parameter change slot. + * This slot when called is calling the function concurrentRemoveLogs, + * if percent of available space vPercent is less than _availableSpacePercent, + * if the SD Card is ready (vReady is true) + * \param vReady - The SD Card is Ready + * \param vTotal - Total storage space on the SD Card + * \param vAvailable - Available storage space on the SD Card + * \param vPercent - Percent of available storage space on the SD Card + */ void Logger::onSDCardSpaceChange(bool vReady, qint64 vTotal, qint64 vAvailable, quint8 vPercent) { + // coco begin validated: This needs user interaction to change the SD card files system. + // has been tested manually Q_UNUSED(vTotal ) Q_UNUSED(vAvailable ) if ( ! vReady ) return; Index: sources/storage/StorageGlobals.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/storage/StorageGlobals.cpp (.../StorageGlobals.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/storage/StorageGlobals.cpp (.../StorageGlobals.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -15,6 +15,12 @@ #include "StorageGlobals.h" +/*! + * \brief Storage + * \details The container of the constant global variable withing Storage namespace members. + * For example it currently includes USB mount root folder and SD Card mount root folder and such, + * which is used by Logger, DriveWatcher, ... . + */ namespace Storage { // USB Index: sources/utility/crc.cpp =================================================================== diff -u -r44a85c96ab55e424866ec4cca0270aa218355f82 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/utility/crc.cpp (.../crc.cpp) (revision 44a85c96ab55e424866ec4cca0270aa218355f82) +++ sources/utility/crc.cpp (.../crc.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -1,24 +1,25 @@ /*! - * + * * 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 crc.cpp * \author (last) Behrouz NematiPour * \date (last) 16-Dec-2019 * \author (original) Behrouz NematiPour * \date (original) 16-Dec-2019 - * + * */ #include "crc.h" -/*! The CRC table - * This code has been borrowed from Firmware repository - * This should be exactly the same replica of that copy. - * PLEASE DO UPDATE ON ANY MODIFICATION IN FIRMWARE OF SOFTWARE +/*! + * \brief The CRC table + * \details This code has been borrowed from Firmware repository + * This should be exactly the same replica of that copy. + * PLEASE DO UPDATE ON ANY MODIFICATION IN FIRMWARE */ const unsigned char crc8_table[] = { 0, 49, 98, 83, 196, 245, 166, 151, 185, 136, 219, 234, 125, 76, 31, 46, @@ -40,11 +41,11 @@ }; /*! - * \brief crc8 - * \param vData the data which to be used for crc8 generation - * \return a byte contains the generated crc8. - * \note this algorithm borrowed from Firmware repository - * some changed has been made to be able to work with Qt libraries. + * \brief crc8 + * \param vData the data which to be used for crc8 generation + * \return a byte contains the generated crc8. + * \note this algorithm borrowed from Firmware repository + * some modification has been made to be able to work with Qt libraries. */ quint8 crc8(const QByteArray &vData) { Index: sources/utility/format.cpp =================================================================== diff -u -r618891879f5cdc68e37ee68eea005afb76dd4e5b -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/utility/format.cpp (.../format.cpp) (revision 618891879f5cdc68e37ee68eea005afb76dd4e5b) +++ sources/utility/format.cpp (.../format.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -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/types.cpp =================================================================== diff -u -r44a85c96ab55e424866ec4cca0270aa218355f82 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/utility/types.cpp (.../types.cpp) (revision 44a85c96ab55e424866ec4cca0270aa218355f82) +++ sources/utility/types.cpp (.../types.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -1,30 +1,46 @@ /*! - * + * * 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 types.cpp * \author (last) Behrouz NematiPour * \date (last) 07-May-2020 * \author (original) Behrouz NematiPour * \date (original) 26-Dec-2019 - * + * */ #include "types.h" // Qt // Project +/*! + * \brief Types::floatCompare + * \details compares two floats with a tolerance. + * \param f1 - float value 1 + * \param f2 - float value 2 + * \return true if (almost) equal + */ bool Types::floatCompare(float f1, float f2) { static constexpr auto epsilon = 1.0e-05f; if (qAbs(f1 - f2) <= epsilon) return true; return qAbs(f1 - f2) <= epsilon * qMax(qAbs(f1), qAbs(f2)); } +/*! + * \brief Types::getBits + * \details converts the array of byte to array of bits + * \param vData - the array of bytes + * \param vStartIndex - start index of the array to be used for conversion + * \param vFlags - the array of bits + * \param vLen - the amounts of bytes to be converted + * \return false if there is not enough data available from start index vStartIndex to the length of vLen. + */ bool Types::getBits(const QByteArray &vData, int &vStartIndex, QBitArray &vFlags, int vLen) { vFlags.clear(); QByteArray data = vData.mid(vStartIndex, vLen); Index: sources/view/VEventSpy.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/VEventSpy.cpp (.../VEventSpy.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/VEventSpy.cpp (.../VEventSpy.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -40,6 +40,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) { @@ -68,8 +74,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. @@ -111,12 +118,16 @@ // 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 - General event type which will be cast to QTouchEvent + * \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. @@ -150,5 +161,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 -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/VEventSpy.h (.../VEventSpy.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/VEventSpy.h (.../VEventSpy.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -27,6 +27,11 @@ // 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 Index: sources/view/VView.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/VView.h (.../VView.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/VView.h (.../VView.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -15,31 +15,31 @@ #pragma once /*! - * \page MessageView Denali Message UI usage instruction + * \page MessageView Denali Message View usage instruction in QML * \details This comment explains how to use a Denali Message populated data in Denali UI Application - * \verbatim - * 1 - Look at the message structure in the "message list.xlsx" - * - * 2 - View Implementation : - * Implement a view like VDGPressures by copy/paste the closest model .h/.cpp file - * and adding it to project and modify to fit the new model. - * - * 3 - Register View : - * - Add the required lines like the other models in the VView.h file. - * - Also add the #include in the GuiGlobals.cpp - * - * 4 - Usage in UI : - * Import : import VDGPressures 0.1; - * Instantiate : VDGPressures { id: vDGPressures } - * Access : value: vDGPressures.drainInletPSI - * \endverbatim + \verbatim + 1 - Look at the message structure in the "message list.xlsx" + + 2 - View Implementation : + Implement a view like VDGPressures by copy/paste the closest model .h/.cpp file + and adding it to project and modify to fit the new model. + + 3 - Register View : + - Add the required lines like the other models in the VView.h file. + - Also add the #include in the GuiGlobals.cpp + + 4 - Usage in UI : + Import : import VDGPressures 0.1; + Instantiate : VDGPressures { id: vDGPressures } + Access : value: vDGPressures.drainInletPSI + \endverbatim */ //--------------------------------------------------------------------------------// //--------------------------------------------------------------------------------// // The child declaration in header #define VIEW_DEC_CLASS(vCLASS) \ private: \ - /*! \brief Connection Initializer + /*! \brief Connection Initializer \details All the class signal/slot connections are defined here. */\ void initConnections(); \ Index: sources/view/dg/data/VDGDrainPumpData.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/dg/data/VDGDrainPumpData.cpp (.../VDGDrainPumpData.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/dg/data/VDGDrainPumpData.cpp (.../VDGDrainPumpData.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -18,12 +18,6 @@ VIEW_DEF(VDGDrainPump, DGDrainPumpData) -/*! - * \brief VDGDrainPump::onActionReceive - * \details Model data received message handler. - * When signal received this method is called to update the view properties. - * \param vData - Model data - */ void VDGDrainPump::onActionReceive(const DGDrainPumpData &vData) { rpm ( vData.mRPM ); Index: sources/view/dg/data/VDGDrainPumpData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/dg/data/VDGDrainPumpData.h (.../VDGDrainPumpData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/dg/data/VDGDrainPumpData.h (.../VDGDrainPumpData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,8 +25,8 @@ namespace View { /*! - * \brief The VDGDrainPump class - * View for Model data DGDrainPumpData representation. + * \brief The VDGDrainPump class + * \details View for Model's Data representation. */ class VDGDrainPump : public QObject { Index: sources/view/dg/data/VDGHeatersData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/dg/data/VDGHeatersData.h (.../VDGHeatersData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/dg/data/VDGHeatersData.h (.../VDGHeatersData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,10 @@ // namespace namespace View { +/*! + * \brief The VDGHeaters class + * \details View for Model's Data representation. + */ class VDGHeaters : public QObject { Q_OBJECT Index: sources/view/dg/data/VDGLoadCellReadingsData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/dg/data/VDGLoadCellReadingsData.h (.../VDGLoadCellReadingsData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/dg/data/VDGLoadCellReadingsData.h (.../VDGLoadCellReadingsData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,10 @@ // namespace namespace View { +/*! + * \brief The VDGLoadCellReadings class + * \details View for Model's Data representation. + */ class VDGLoadCellReadings : public QObject { Q_OBJECT Index: sources/view/dg/data/VDGOperationModeData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/dg/data/VDGOperationModeData.h (.../VDGOperationModeData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/dg/data/VDGOperationModeData.h (.../VDGOperationModeData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -26,6 +26,10 @@ using namespace Gui; namespace View { +/*! + * \brief The VDGOperationMode class + * \details View for Model's Data representation. + */ class VDGOperationMode : public QObject { Q_OBJECT Index: sources/view/dg/data/VDGPressuresData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/dg/data/VDGPressuresData.h (.../VDGPressuresData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/dg/data/VDGPressuresData.h (.../VDGPressuresData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,10 @@ // namespace namespace View { +/*! + * \brief The VDGPressures class + * \details View for Model's Data representation. + */ class VDGPressures : public QObject { Q_OBJECT Index: sources/view/dg/data/VDGROPumpData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/dg/data/VDGROPumpData.h (.../VDGROPumpData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/dg/data/VDGROPumpData.h (.../VDGROPumpData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,10 @@ // namespace namespace View { +/*! + * \brief The VDGROPump class + * \details View for Model's Data representation. + */ class VDGROPump : public QObject { Q_OBJECT Index: sources/view/dg/data/VDGReservoirData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/dg/data/VDGReservoirData.h (.../VDGReservoirData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/dg/data/VDGReservoirData.h (.../VDGReservoirData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,10 @@ // namespace namespace View { +/*! + * \brief The VDGReservoir class + * \details View for Model's Data representation. + */ class VDGReservoir : public QObject { Q_OBJECT Index: sources/view/dg/data/VDGTemperaturesData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/dg/data/VDGTemperaturesData.h (.../VDGTemperaturesData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/dg/data/VDGTemperaturesData.h (.../VDGTemperaturesData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,10 @@ // namespace namespace View { +/*! + * \brief The VDGTemperatures class + * \details View for Model's Data representation. + */ class VDGTemperatures : public QObject { Q_OBJECT Index: sources/view/dg/data/VDGValvesStatesData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/dg/data/VDGValvesStatesData.h (.../VDGValvesStatesData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/dg/data/VDGValvesStatesData.h (.../VDGValvesStatesData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,10 @@ // namespace namespace View { +/*! + * \brief The VDGValvesStates class + * \details View for Model's Data representation. + */ class VDGValvesStates : public QObject { Q_OBJECT Index: sources/view/hd/adjustment/VTreatmentAdjustmentDuration.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentDuration.h (.../VTreatmentAdjustmentDuration.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/adjustment/VTreatmentAdjustmentDuration.h (.../VTreatmentAdjustmentDuration.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,10 @@ namespace View { +/*! + * \brief The VTreatmentAdjustmentDuration class + * \details View for Model's Data representation. + */ class VTreatmentAdjustmentDuration : public VTreatmentAdjustmentResponseBase { Q_OBJECT @@ -50,12 +54,22 @@ // ----- Adjust Duration public slots: + /*! + * \brief doAdjustment + * \details the invocable slot to adjust the treatment duration + * \param vDuration - treatment duration + */ void doAdjustment(quint32 vDuration) { _data.duration = vDuration; emit didAdjustment(_data); } signals: + /*! + * \brief didAdjustment + * \details the notification signal to adjust the treatment duration + * \param vData - data model for the duration adjustment request + */ void didAdjustment(const AdjustDurationRequestData &vData); }; } Index: sources/view/hd/adjustment/VTreatmentAdjustmentFlows.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentFlows.cpp (.../VTreatmentAdjustmentFlows.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/adjustment/VTreatmentAdjustmentFlows.cpp (.../VTreatmentAdjustmentFlows.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -40,4 +40,3 @@ // *** otherwise will use the previous values before being set. *** adjustment ( true ); } - Index: sources/view/hd/adjustment/VTreatmentAdjustmentFlows.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentFlows.h (.../VTreatmentAdjustmentFlows.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/adjustment/VTreatmentAdjustmentFlows.h (.../VTreatmentAdjustmentFlows.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -24,6 +24,10 @@ namespace View { +/*! + * \brief The VTreatmentAdjustmentFlows class + * \details View for Model's Data representation. + */ class VTreatmentAdjustmentFlows : public VTreatmentAdjustmentResponseBase { Q_OBJECT @@ -32,7 +36,6 @@ AdjustBloodDialysateRequestData _data; - // coco begin validated: // The property adjustment_Triggered has to be always true // and to always trigger the change event to work as a notifier for GUI @@ -48,14 +51,24 @@ // ----- Adjust Blood/Dialysate Flows public slots: + /*! + * \brief doAdjustment + * \details the invocable slot to adjust the treatment blood and dialysate flow rates + * \param vBloodFlow + * \param vDialysateFlow + */ void doAdjustment(quint32 vBloodFlow, quint32 vDialysateFlow) { _data. bloodFlow = vBloodFlow; _data.dialysateFlow = vDialysateFlow; emit didAdjustment(_data); } signals: + /*! + * \brief didAdjustment + * \details the notification signal to adjust the blood and dialysate flow rates + * \param vData - data model for the blood and dialysate adjustment request + */ void didAdjustment(const AdjustBloodDialysateRequestData &vData); }; - } Index: sources/view/hd/adjustment/VTreatmentAdjustmentResponseBase.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentResponseBase.h (.../VTreatmentAdjustmentResponseBase.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/adjustment/VTreatmentAdjustmentResponseBase.h (.../VTreatmentAdjustmentResponseBase.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -30,6 +30,12 @@ using namespace Gui; namespace View { +/*! + * \brief The VTreatmentAdjustmentResponseBase class + * \details The base class of all the view classes for adjustment response. + * All the adjustment responses contain accepted field as a flag for acceptance or rejection of the requested adjustment. + * In case of adjustment request rejection the reason field is the reason for rejection. + */ class VTreatmentAdjustmentResponseBase : public QObject { Index: sources/view/hd/adjustment/VTreatmentAdjustmentSaline.cpp =================================================================== diff -u -r00d9bb06ec2bad14f6dc2db678b750c244f694ef -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentSaline.cpp (.../VTreatmentAdjustmentSaline.cpp) (revision 00d9bb06ec2bad14f6dc2db678b750c244f694ef) +++ sources/view/hd/adjustment/VTreatmentAdjustmentSaline.cpp (.../VTreatmentAdjustmentSaline.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -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 -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentSaline.h (.../VTreatmentAdjustmentSaline.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/adjustment/VTreatmentAdjustmentSaline.h (.../VTreatmentAdjustmentSaline.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -22,6 +22,10 @@ namespace View { +/*! + * \brief The VTreatmentAdjustmentSaline class + * \details View for Model's Data representation. + */ class VTreatmentAdjustmentSaline : public VTreatmentAdjustmentResponseBase { Q_OBJECT @@ -50,6 +54,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/adjustment/VTreatmentAdjustmentUltrafiltrationConfirm.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationConfirm.cpp (.../VTreatmentAdjustmentUltrafiltrationConfirm.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationConfirm.cpp (.../VTreatmentAdjustmentUltrafiltrationConfirm.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -19,11 +19,19 @@ VIEW_DEF_CLASS_ADJUSTMENT(VTreatmentAdjustmentUltrafiltrationConfirm, AdjustUltrafiltrationConfirmResponseData) +/*! \brief Connection Initializer + \details All the class signal/slot connections are defined here. +*/ void VTreatmentAdjustmentUltrafiltrationConfirm::initConnections() { ACTION_VIEW_CONNECTION(AdjustUltrafiltrationConfirmResponseData); ADJUST_VIEW_CONNECTION( AdjustUltrafiltrationConfirmRequestData); } +/*! + * \brief VTreatmentAdjustmentUltrafiltrationEdit::onActionReceive + * \details received response model data handler + * \param vData - model data + */ void VTreatmentAdjustmentUltrafiltrationConfirm::onActionReceive(const AdjustUltrafiltrationConfirmResponseData &vData) { adjustment_Accepted ( vData.mAccepted ); @@ -38,13 +46,23 @@ adjustment ( true ); } +/*! + * \brief View::VTreatmentAdjustmentUltrafiltrationConfirm::doOptionRate + * \details the invocable slot to adjust the ultrafiltration by rate modification + * \param vVolume - the ultrafiltration volume + */ void View::VTreatmentAdjustmentUltrafiltrationConfirm::doOptionRate(float vVolume) { _data.volume = int(vVolume * 1000); // cast to int to truncate the float after convert to mL _data.option = AdjustUltrafiltrationConfirmRequestData::eRate; emit didAdjustment(_data); } +/*! + * \brief View::VTreatmentAdjustmentUltrafiltrationConfirm::doOptionDuration + * \details the invocable slot to adjust the ultrafiltration by duration modification + * \param vVolume - the ultrafiltration volume + */ void View::VTreatmentAdjustmentUltrafiltrationConfirm::doOptionDuration(float vVolume) { _data.volume = int(vVolume * 1000); // cast to int to truncate the float after convert to mL Index: sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationConfirm.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationConfirm.h (.../VTreatmentAdjustmentUltrafiltrationConfirm.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationConfirm.h (.../VTreatmentAdjustmentUltrafiltrationConfirm.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -23,6 +23,10 @@ namespace View { +/*! + * \brief The VTreatmentAdjustmentUltrafiltrationConfirm class + * \details View for Model's Data representation. + */ class VTreatmentAdjustmentUltrafiltrationConfirm : public VTreatmentAdjustmentResponseBase { Q_OBJECT @@ -56,6 +60,11 @@ void doOptionDuration(float vVolume); signals: + /*! + * \brief didAdjustment + * \details the notification signal to confirm the the treatment ultrafiltration adjustment + * \param vData - data model for confirm the the treatment ultrafiltration adjustment request + */ void didAdjustment(const AdjustUltrafiltrationConfirmRequestData &vData); }; Index: sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationEdit.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationEdit.cpp (.../VTreatmentAdjustmentUltrafiltrationEdit.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationEdit.cpp (.../VTreatmentAdjustmentUltrafiltrationEdit.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -19,11 +19,19 @@ VIEW_DEF_CLASS_ADJUSTMENT(VTreatmentAdjustmentUltrafiltrationEdit, AdjustUltrafiltrationEditResponseData) +/*! \brief Connection Initializer + \details All the class signal/slot connections are defined here. +*/ void VTreatmentAdjustmentUltrafiltrationEdit::initConnections() { ACTION_VIEW_CONNECTION(AdjustUltrafiltrationEditResponseData); ADJUST_VIEW_CONNECTION( AdjustUltrafiltrationEditRequestData); } +/*! + * \brief VTreatmentAdjustmentUltrafiltrationEdit::onActionReceive + * \details received response model data handler + * \param vData - model data + */ void VTreatmentAdjustmentUltrafiltrationEdit::onActionReceive(const AdjustUltrafiltrationEditResponseData &vData) { adjustment_Accepted ( vData.mAccepted ); @@ -41,6 +49,11 @@ adjustment ( true ); } +/*! + * \brief View::VTreatmentAdjustmentUltrafiltrationEdit::doAdjustment + * \details the invocable slot to adjust the treatment ultrafiltration volume + * \param vVolume - requested ultrafiltration volume + */ void View::VTreatmentAdjustmentUltrafiltrationEdit::doAdjustment(float vVolume) { _data.volume = vVolume * 1000; // L => mL emit didAdjustment(_data); Index: sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationEdit.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationEdit.h (.../VTreatmentAdjustmentUltrafiltrationEdit.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationEdit.h (.../VTreatmentAdjustmentUltrafiltrationEdit.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -23,6 +23,10 @@ namespace View { +/*! + * \brief The VTreatmentAdjustmentUltrafiltrationEdit class + * \details View for Model's Data representation. + */ class VTreatmentAdjustmentUltrafiltrationEdit : public VTreatmentAdjustmentResponseBase { Q_OBJECT @@ -54,6 +58,11 @@ void doAdjustment(float vVolume); signals: + /*! + * \brief didAdjustment + * \details the notification signal to adjust the treatment ultrafiltration volume + * \param vData - data model for edit the treatment ultrafiltration volume adjustment request + */ void didAdjustment(const AdjustUltrafiltrationEditRequestData &vData); }; Index: sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationState.cpp =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationState.cpp (.../VTreatmentAdjustmentUltrafiltrationState.cpp) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationState.cpp (.../VTreatmentAdjustmentUltrafiltrationState.cpp) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -37,12 +37,20 @@ adjustment ( true ); } +/*! + * \brief View::VTreatmentAdjustmentUltrafiltrationState::doPause + * \details request to pause the ultrafiltration + */ void View::VTreatmentAdjustmentUltrafiltrationState::doPause() { _data.requestedState = AdjustUltrafiltrationStateRequestData::ePaused; emit didAdjustment(_data); } +/*! + * \brief View::VTreatmentAdjustmentUltrafiltrationState::doResume + * \details request to resume the ultrafiltration + */ void View::VTreatmentAdjustmentUltrafiltrationState::doResume() { _data.requestedState = AdjustUltrafiltrationStateRequestData::eRunning; @@ -51,7 +59,7 @@ /*! * \brief View::VTreatmentAdjustmentUltrafiltrationState::text - * \details The slot to ge the Reason Description + * \details The slot to get the Reason Description * \return Reason description as string * \note The ultrafiltration state (Resume/Pause) change has no returned reason code and it's only bool. */ Index: sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationState.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationState.h (.../VTreatmentAdjustmentUltrafiltrationState.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/adjustment/VTreatmentAdjustmentUltrafiltrationState.h (.../VTreatmentAdjustmentUltrafiltrationState.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -23,6 +23,10 @@ namespace View { +/*! + * \brief The VTreatmentAdjustmentUltrafiltrationState class + * \details View for Model's Data representation. + */ class VTreatmentAdjustmentUltrafiltrationState : public VTreatmentAdjustmentResponseBase { Q_OBJECT Index: sources/view/hd/alarm/VAlarmStatus.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/alarm/VAlarmStatus.h (.../VAlarmStatus.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/alarm/VAlarmStatus.h (.../VAlarmStatus.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -31,6 +31,10 @@ using namespace Gui; namespace View { +/*! + * \brief The VAlarmStatus class + * \details View for Model's Data representation. + */ class VAlarmStatus : public QObject { Q_OBJECT Index: sources/view/hd/data/VHDOperationModeData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/data/VHDOperationModeData.h (.../VHDOperationModeData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/data/VHDOperationModeData.h (.../VHDOperationModeData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -26,6 +26,10 @@ using namespace Gui; namespace View { +/*! + * \brief The VHDOperationMode class + * \details View for Model's data representation. + */ class VHDOperationMode : public QObject { Q_OBJECT Index: sources/view/hd/data/VHDTreatmentStatesData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/data/VHDTreatmentStatesData.h (.../VHDTreatmentStatesData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/data/VHDTreatmentStatesData.h (.../VHDTreatmentStatesData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -26,6 +26,10 @@ using namespace Gui; namespace View { +/*! + * \brief The VHDTreatmentStates class + * \details View for Model's data representation. + */ class VHDTreatmentStates : public QObject { Q_OBJECT Index: sources/view/hd/data/VTreatmentBloodFlow.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/data/VTreatmentBloodFlow.h (.../VTreatmentBloodFlow.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/data/VTreatmentBloodFlow.h (.../VTreatmentBloodFlow.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,10 @@ // namespace namespace View { +/*! + * \brief The VTreatmentBloodFlow class + * \details View for Model's data representation. + */ class VTreatmentBloodFlow : public QObject { Q_OBJECT Index: sources/view/hd/data/VTreatmentDialysateFlow.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/data/VTreatmentDialysateFlow.h (.../VTreatmentDialysateFlow.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/data/VTreatmentDialysateFlow.h (.../VTreatmentDialysateFlow.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,10 @@ // namespace namespace View { +/*! + * \brief The VTreatmentDialysateFlow class + * \details View for Model's data representation. + */ class VTreatmentDialysateFlow : public QObject { Q_OBJECT Index: sources/view/hd/data/VTreatmentPressureOcclusion.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/data/VTreatmentPressureOcclusion.h (.../VTreatmentPressureOcclusion.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/data/VTreatmentPressureOcclusion.h (.../VTreatmentPressureOcclusion.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,10 @@ // namespace namespace View { +/*! + * \brief The VTreatmentPressureOcclusion class + * \details View for Model's data representation. + */ class VTreatmentPressureOcclusion : public QObject { Q_OBJECT Index: sources/view/hd/data/VTreatmentRanges.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/data/VTreatmentRanges.h (.../VTreatmentRanges.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/data/VTreatmentRanges.h (.../VTreatmentRanges.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,10 @@ // namespace namespace View { +/*! + * \brief The VTreatmentRanges class + * \details View for Model's data representation. + */ class VTreatmentRanges : public QObject { Q_OBJECT Index: sources/view/hd/data/VTreatmentSalineData.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/data/VTreatmentSalineData.h (.../VTreatmentSalineData.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/data/VTreatmentSalineData.h (.../VTreatmentSalineData.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,10 @@ // namespace namespace View { +/*! + * \brief The VTreatmentSaline class + * \details View for Model's data representation. + */ class VTreatmentSaline : public QObject { Q_OBJECT Index: sources/view/hd/data/VTreatmentTime.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/data/VTreatmentTime.h (.../VTreatmentTime.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/data/VTreatmentTime.h (.../VTreatmentTime.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,10 @@ // namespace namespace View { +/*! + * \brief The VTreatmentTime class + * \details View for Model's data representation. + */ class VTreatmentTime : public QObject { Q_OBJECT Index: sources/view/hd/data/VTreatmentUltrafiltration.h =================================================================== diff -u -rc503f43840024e18650c1ac558448dd0f3b70427 -rbb74da05f81b82dad3ec844c1feb1135b949f1c2 --- sources/view/hd/data/VTreatmentUltrafiltration.h (.../VTreatmentUltrafiltration.h) (revision c503f43840024e18650c1ac558448dd0f3b70427) +++ sources/view/hd/data/VTreatmentUltrafiltration.h (.../VTreatmentUltrafiltration.h) (revision bb74da05f81b82dad3ec844c1feb1135b949f1c2) @@ -25,6 +25,10 @@ // namespace namespace View { +/*! + * \brief The VTreatmentUltrafiltration class + * \details View for Model's data representation. + */ class VTreatmentUltrafiltration : public QObject { Q_OBJECT