Index: sources/model/hd/data/MTreatmentSalineData.h =================================================================== diff -u -r7ed86349cdad43d311f776a69ed54c2023265e53 -r4d969a04e6d80a6d2f6b756a4b87aecd6356e6a9 --- sources/model/hd/data/MTreatmentSalineData.h (.../MTreatmentSalineData.h) (revision 7ed86349cdad43d311f776a69ed54c2023265e53) +++ sources/model/hd/data/MTreatmentSalineData.h (.../MTreatmentSalineData.h) (revision 4d969a04e6d80a6d2f6b756a4b87aecd6356e6a9) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file MTreatmentSalineData.h - * \date 8/10/2020 - * \author Behrouz NematiPour + * \file MTreatmentSalineData.h + * \author (last) Behrouz NematiPour + * \date (last) 10-Aug-2020 + * \author (original) Behrouz NematiPour + * \date (original) 10-Aug-2020 * */ #pragma once @@ -26,6 +27,32 @@ namespace Model { +/*! + * \brief The MTreatmentSaline class + * \details The treatment saline bolus data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: | + * |0x2F00| 0x040 | 7 | 1 Hz | N | HD | All | Treatment Saline Bolus Data | + * + * | Payload || + * | || + * | #1:(U32) | \ref Data::mTarget | + * | #2:(F32) | \ref Data::mCumulative | + * | #3:(F32) | \ref Data::mDelivered | + * + * \sa Data + * \sa MAdjustSalineReq : Saline Bolus Request + * \sa MAdjustSalineResponse : Saline Bolus Response + * + *

Logging info

+ * | || + * | || + * | typeText | Datum | + * | unitText | HD | + * | infoText | SalineData | + * + */ class MTreatmentSaline : public MAbstract { // friends @@ -46,9 +73,9 @@ QString infoText() const override { return QString("SalineData") ; } struct Data { - quint32 mTarget = 0; /*!< Target Target volume for the current started saline bolus */ - float mCumulative = 0; /*!< Cumulative Cumulative volume of all saline deliveries during current treatment */ - float mDelivered = 0; /*!< Delivered Current delivered saline volume */ + quint32 mTarget = 0; ///< Target volume for the current started saline bolus + float mCumulative = 0; ///< Cumulative volume of all saline deliveries during current treatment + float mDelivered = 0; ///< Current delivered saline volume }; public: @@ -57,7 +84,6 @@ bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MTreatmentSaline::Data TreatmentSalineData;