Index: sources/model/hd/data/MTreatmentStatesData.h =================================================================== diff -u -r3aab84456cfbdc4c4f495975ba9b8968eb844309 -r4d969a04e6d80a6d2f6b756a4b87aecd6356e6a9 --- sources/model/hd/data/MTreatmentStatesData.h (.../MTreatmentStatesData.h) (revision 3aab84456cfbdc4c4f495975ba9b8968eb844309) +++ sources/model/hd/data/MTreatmentStatesData.h (.../MTreatmentStatesData.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 MTreatmentStatesData.h - * \date 6/28/2020 - * \author Behrouz NematiPour + * \file MTreatmentStatesData.h + * \author (last) Behrouz NemaiPour + * \date (last) 17-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #pragma once @@ -25,6 +26,32 @@ namespace Model { +/*! + * \brief The MTreatmentStates class + * \details The treatment states data model + * These are states of the current treatment. + * It also includes the ultrafiltration states, saline bolus states. + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: | + * |0x0F00| 0x040 | 7 | 1 Hz | N | HD | All | Treatment States Data | + * + * | Payload || + * | || + * | #1:(U32) | \ref Data::mSubMode | + * | #2:(U32) | \ref Data::mUFState | + * | #3:(U32) | \ref Data::mSalineState | + * + * \sa Data + * + *

Logging info

+ * | || + * | || + * | typeText | Datum | + * | unitText | HD | + * | infoText | TreatmentStates | + * + */ class MTreatmentStates : public MAbstract { // friends @@ -45,17 +72,16 @@ QString infoText () const override { return QString("TreatmentStates"); } struct Data { - quint32 mSubMode = 0; /*!< Sub-Mode value of type quint32 extracted out */ - quint32 mUFState = 0; /*!< UF State value of type quint32 extracted out */ - quint32 mSalineState = 0; /*!< Saline State value of type quint32 extracted out */ + quint32 mSubMode = 0; ///< Sub-Mode + quint32 mUFState = 0; ///< UF State + quint32 mSalineState = 0; ///< Saline State }; MTreatmentStates() { } bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MTreatmentStates::Data TreatmentStatesData;