Index: sources/model/MEndTreatmentResponse.h
===================================================================
diff -u -r7c895d9b6c198a48ab75ac2090b0a61d99bbd1ab -r1f8abdd821041623392d18cf4f80cad9ae1bf246
--- sources/model/MEndTreatmentResponse.h (.../MEndTreatmentResponse.h) (revision 7c895d9b6c198a48ab75ac2090b0a61d99bbd1ab)
+++ sources/model/MEndTreatmentResponse.h (.../MEndTreatmentResponse.h) (revision 1f8abdd821041623392d18cf4f80cad9ae1bf246)
@@ -15,6 +15,28 @@
namespace Model {
+/*!
+ * \brief The MEndTreatmentResponse class
+ * \details The end treamtent response model
+ *
+ * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description |
+ * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------------------: |
+ * | 60 | 0x020 | 6 | Rsp | Y | HD | UI | End Treatment Response |
+ *
+ * | Payload ||
+ * | ||
+ * | #1:(U32) | \ref Data::endTreatmentResponse |
+ *
+ * \sa Data
+ *
+ *
+ * | ||
+ * | ||
+ * | typeText | Event |
+ * | unitText | HD |
+ * | infoText | EndTreatmentResponse |
+ *
+ */
class MEndTreatmentResponse : public MAbstract {
// friends
Index: sources/model/MStartTreatmentResponse.h
===================================================================
diff -u -r7c895d9b6c198a48ab75ac2090b0a61d99bbd1ab -r1f8abdd821041623392d18cf4f80cad9ae1bf246
--- sources/model/MStartTreatmentResponse.h (.../MStartTreatmentResponse.h) (revision 7c895d9b6c198a48ab75ac2090b0a61d99bbd1ab)
+++ sources/model/MStartTreatmentResponse.h (.../MStartTreatmentResponse.h) (revision 1f8abdd821041623392d18cf4f80cad9ae1bf246)
@@ -15,6 +15,29 @@
namespace Model {
+/*!
+ * \brief The MStartTreatmentResponse class
+ * \details The start treamtent response model
+ *
+ * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description |
+ * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------------------: |
+ * |0x3900| 0x020 | 6 | Rsp | Y | HD | UI | Start Treatment Response |
+ *
+ * | Payload ||
+ * | ||
+ * | #1:(U32) | \ref Data::startTreatmentResponse |
+ * | #2:(U32) | \ref Data::startTreatmentRejectReason |
+ *
+ * \sa Data
+ *
+ *
+ * | ||
+ * | ||
+ * | typeText | Event |
+ * | unitText | HD |
+ * | infoText | StartTreatmentResponse |
+ *
+ */
class MStartTreatmentResponse : public MAbstract {
// friends
Index: sources/model/MTreatmentParametersResp.h
===================================================================
diff -u -rb61d8a3e01fef66eee8095c9cddf835d9bb32b66 -r1f8abdd821041623392d18cf4f80cad9ae1bf246
--- sources/model/MTreatmentParametersResp.h (.../MTreatmentParametersResp.h) (revision b61d8a3e01fef66eee8095c9cddf835d9bb32b66)
+++ sources/model/MTreatmentParametersResp.h (.../MTreatmentParametersResp.h) (revision 1f8abdd821041623392d18cf4f80cad9ae1bf246)
@@ -24,6 +24,46 @@
class tst_models;
namespace Model {
+
+/*!
+ * \brief The MTreatmentParametersResponse class
+ * \details The treatment parameters response model
+ *
+ * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description |
+ * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:------------------------------: |
+ * | 53 | 0x020 | 6 | Rsp | Y | HD | UI | Treatment Parameters Response |
+ *
+ * | Payload ||
+ * | ||
+ * | #1:(U32) | \ref Data::requestValid |
+ * | #2:(U32) | \ref bloodFlowRate |
+ * | #3:(U32) | \ref dialysateFlowRate |
+ * | #4:(U32) | \ref duration |
+ * | #5:(U32) | \ref heparinStopTime |
+ * | #6:(U32) | \ref salineBolus |
+ * | #7:(U32) | \ref acidConcentrate |
+ * | #8:(U32) | \ref bicarbonateConcentrate |
+ * | #9:(U32) | \ref dialyzerType |
+ * | #10:(U32) | \ref bloodPressureMeasureInterval |
+ * | #11:(U32) | \ref rinsebackFlowRate |
+ * | #12:(U32) | \ref arterialPressureLimitLow |
+ * | #13:(U32) | \ref arterialPressureLimitHigh |
+ * | #14:(U32) | \ref venousPressureLimitLow |
+ * | #15:(U32) | \ref venousPressureLimitHigh |
+ * | #16:(U32) | \ref heparinDispensingRate |
+ * | #17:(U32) | \ref heparinBolusVolume |
+ * | #18:(U32) | \ref dialysateTemp |
+ *
+ * \sa Data
+ *
+ *
+ * | ||
+ * | ||
+ * | typeText | Datum |
+ * | unitText | HD |
+ * | infoText | TreatmentParametersResponse |
+ *
+ */
class MTreatmentParametersResponse : public MAbstract
{
friend class::tst_models;
@@ -55,7 +95,7 @@
Type_Enum typeText () const override { return Type_Enum::eDatum; }
Unit_Enum unitText () const override { return Unit_Enum::eHD ; }
- QString infoText () const override { return QString("OpMode"); }
+ QString infoText () const override { return QString("TreatmentParametersResponse"); }
struct Data {
quint32 requestValid = 0;
Index: sources/model/hd/adjustment/MTreatmentAdjustRequests.h
===================================================================
diff -u -rc241fc1d31be3e4958582dff94de8189f5bbba67 -r1f8abdd821041623392d18cf4f80cad9ae1bf246
--- sources/model/hd/adjustment/MTreatmentAdjustRequests.h (.../MTreatmentAdjustRequests.h) (revision c241fc1d31be3e4958582dff94de8189f5bbba67)
+++ sources/model/hd/adjustment/MTreatmentAdjustRequests.h (.../MTreatmentAdjustRequests.h) (revision 1f8abdd821041623392d18cf4f80cad9ae1bf246)
@@ -293,6 +293,19 @@
}
};
+/*!
+ * \brief The MAlarmAcknowledgeReq class
+ * \details The model to tell HD an alarm has been acknowledged
+ *
+ * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description |
+ * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-------------------------:|
+ * | 63 | 0x100 | N/A | Cmd | Y | UI | HD | Alarm Acknolwedge Request |
+ *
+ * | Payload ||
+ * | ||
+ * | #1:(U32) | \ref alarmID |
+ *
+ */
class MAlarmAcknowledgeReq : public MModel {
public:
quint32 alarmID;
@@ -307,6 +320,19 @@
}
};
+/*!
+ * \brief The MStartTreatmentReq class
+ * \details The model to request starting a treatment
+ *
+ * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description |
+ * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-------------------------:|
+ * | 56 | 0x100 | 9 | Req | Y | UI | HD | Start Treatment Request |
+ *
+ * | Payload ||
+ * | ||
+ * | #1:(U32) | \ref request |
+ *
+ */
class MStartTreatmentReq : public MModel {
public:
enum Options {
@@ -326,6 +352,19 @@
}
};
+/*!
+ * \brief The MConfirmTreatmentReq class
+ * \details The model to tell HD treatment parameters have been confirmed
+ *
+ * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description |
+ * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-------------------------:|
+ * | 56 | 0x100 | 9 | Req | Y | UI | HD | Confirm Treatment Request |
+ *
+ * | Payload ||
+ * | ||
+ * | #1:(U32) | \ref request |
+ *
+ */
class MConfirmTreatmentReq : public MModel {
public:
enum Options {
@@ -344,6 +383,19 @@
}
};
+/*!
+ * \brief The MEndTreatmentReq class
+ * \details The model to request an end to treatment
+ *
+ * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description |
+ * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-------------------------:|
+ * | 60 | 0x100 | 9 | Req | Y | UI | HD | End Treatment Request |
+ *
+ * | Payload ||
+ * | ||
+ * | N/A ||
+ *
+ */
class MEndTreatmentReq : public MModel {
public:
@@ -358,26 +410,55 @@
}
};
+/*!
+ * \brief The MAdjustTreatmentParametersReq class
+ * \details The model used to request treatment parameters validation
+ *
+ * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description |
+ * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:-------------------------:|
+ * | 60 | 0x100 | 9 | Req | Y | UI | HD | New Treatment Parameters Request |
+ *
+ * | Payload ||
+ * | ||
+ * | #1:(U32) | \ref bloodFlowRate |
+ * | #2:(U32) | \ref dialysateFlowRate |
+ * | #3:(U32) | \ref duration |
+ * | #4:(U32) | \ref heparinStopTime |
+ * | #5:(U32) | \ref salineBolus |
+ * | #6:(U32) | \ref acidConcentrate |
+ * | #7:(U32) | \ref bicarbonateConcentrate |
+ * | #8:(U32) | \ref dialyzerType |
+ * | #9:(U32) | \ref bloodPressureMeasureInterval |
+ * | #10:(U32) | \ref rinsebackFlowRate |
+ * | #11:(S32) | \ref arterialPressureLimitLow |
+ * | #12:(S32) | \ref arterialPressureLimitHigh |
+ * | #13:(S32) | \ref venousPressureLimitLow |
+ * | #14:(S32) | \ref venousPressureLimitHigh |
+ * | #15:(F32) | \ref heparinDispensingRate |
+ * | #16:(F32) | \ref heparinBolusVolume |
+ * | #17:(F32) | \ref dialysateTemp |
+ *
+ */
class MAdjustTreatmentParametersReq : public MModel {
public:
quint32 bloodFlowRate = 0; // mL/min
quint32 dialysateFlowRate = 0; // mL/min
quint32 duration = 0; // minutes
- float heparinDispensingRate = 0; // mL/hr
- float heparinBolusVolume = 0; // mL
quint32 heparinStopTime = 0; // min
quint32 salineBolus = 0; // mL
quint32 acidConcentrate = 0; //
quint32 bicarbonateConcentrate = 0; //
quint32 dialyzerType = 0; //
- float dialysateTemp = 0; // Celsius
+ quint32 bloodPressureMeasureInterval = 0; // minutes
+ quint32 rinsebackFlowRate = 0; // mL/min
qint32 arterialPressureLimitLow = 0; // mmHg
qint32 arterialPressureLimitHigh = 0; // mmHg
qint32 venousPressureLimitLow = 0; // mmHg
qint32 venousPressureLimitHigh = 0; // mmHg
- quint32 bloodPressureMeasureInterval = 0; // minutes
- quint32 rinsebackFlowRate = 0; // mL/min
+ float heparinDispensingRate = 0; // mL/hr
+ float heparinBolusVolume = 0; // mL
+ float dialysateTemp = 0; // Celsius
// coco begin validated : Has been validated manually.
// This object is used statically for now, kept the logic for later usage.
@@ -386,20 +467,20 @@
bloodFlowRate ,
dialysateFlowRate ,
duration ,
- heparinDispensingRate ,
- heparinBolusVolume ,
heparinStopTime ,
salineBolus ,
acidConcentrate ,
bicarbonateConcentrate ,
dialyzerType ,
- dialysateTemp ,
+ bloodPressureMeasureInterval ,
+ rinsebackFlowRate ,
arterialPressureLimitLow ,
arterialPressureLimitHigh ,
venousPressureLimitLow ,
venousPressureLimitHigh ,
- bloodPressureMeasureInterval ,
- rinsebackFlowRate ,
+ heparinDispensingRate ,
+ heparinBolusVolume ,
+ dialysateTemp ,
});
}
// coco end
Index: sources/view/VPriming.h
===================================================================
diff -u -r0d59385f134f65a19dace1e2b46eb2631924396e -r1f8abdd821041623392d18cf4f80cad9ae1bf246
--- sources/view/VPriming.h (.../VPriming.h) (revision 0d59385f134f65a19dace1e2b46eb2631924396e)
+++ sources/view/VPriming.h (.../VPriming.h) (revision 1f8abdd821041623392d18cf4f80cad9ae1bf246)
@@ -25,6 +25,13 @@
namespace View {
+/*!
+ * \brief The VPriming class
+ * \details View for Model's Data representation.
+ *
+ * \sa Model::MPrimingData
+ *
+ */
class VPriming : public QObject
{
Q_OBJECT
Index: sources/view/VTreatmentBegin.h
===================================================================
diff -u -rd94a2b9334b1b35739b637472e8c3054d7b9b804 -r1f8abdd821041623392d18cf4f80cad9ae1bf246
--- sources/view/VTreatmentBegin.h (.../VTreatmentBegin.h) (revision d94a2b9334b1b35739b637472e8c3054d7b9b804)
+++ sources/view/VTreatmentBegin.h (.../VTreatmentBegin.h) (revision 1f8abdd821041623392d18cf4f80cad9ae1bf246)
@@ -12,6 +12,11 @@
namespace View {
+/*!
+ * \brief The VTreatmentBegin class
+ * \details View for starting a new treatment and changing ultrafiltration volume.
+ *
+ */
class VTreatmentBegin : public QObject
{
Q_OBJECT
Index: sources/view/VTreatmentCreate.h
===================================================================
diff -u -racacd66264bfec7cc8a90047485f53903564cef5 -r1f8abdd821041623392d18cf4f80cad9ae1bf246
--- sources/view/VTreatmentCreate.h (.../VTreatmentCreate.h) (revision acacd66264bfec7cc8a90047485f53903564cef5)
+++ sources/view/VTreatmentCreate.h (.../VTreatmentCreate.h) (revision 1f8abdd821041623392d18cf4f80cad9ae1bf246)
@@ -29,9 +29,9 @@
/*!
* \brief The VCreateTreatment class
*
- * The Create Treatment View manages the treatment parameter selection entry and validation.
+ * The Create Treatment View manages the pre-treatment parameter selection entry and validation.
*
- * The Create Treatment View manages data display and translation between the user interface
+ * \details The Create Treatment View manages data display and translation between the user interface
* and treatment parameter and treatment parameter response models.
*
* Upon HD messaging with confirmation of the current parameter selection,
@@ -48,6 +48,11 @@
* - The data is validated for correctness and compatibility
* - The continue button is enabled upon success so FW can validate the parameter selection
*
+ * \sa Model::MAdjustTreatmentParametersReq
+ * \sa Model::MTreatmentParametersResponse
+ * \sa Model::MStartTreatmentReq
+ * \sa Model::MConfirmTreatmentReq
+ * \sa Model::MStartTreatmentResponse
*/
class VTreatmentCreate : public QObject
{
Index: sources/view/VTreatmentEnd.h
===================================================================
diff -u -r53134008481fd775533e8988b7436f2f75e47336 -r1f8abdd821041623392d18cf4f80cad9ae1bf246
--- sources/view/VTreatmentEnd.h (.../VTreatmentEnd.h) (revision 53134008481fd775533e8988b7436f2f75e47336)
+++ sources/view/VTreatmentEnd.h (.../VTreatmentEnd.h) (revision 1f8abdd821041623392d18cf4f80cad9ae1bf246)
@@ -16,6 +16,14 @@
namespace View {
+/*!
+ * \brief The VTreatmentEnd class
+ * \details View for handling a treatment end request and response
+ *
+ * \sa Model::EndTreatmentRequestData
+ * \sa Model::EndTreatmentResponseData
+ *
+ */
class VTreatmentEnd : public QObject
{
Q_OBJECT