Index: sources/model/hd/data/MTreatmentFlowsData.h =================================================================== diff -u -raa0772fe1b0ff6b07e9f64e8c38acad66ad5468d -r4d969a04e6d80a6d2f6b756a4b87aecd6356e6a9 --- sources/model/hd/data/MTreatmentFlowsData.h (.../MTreatmentFlowsData.h) (revision aa0772fe1b0ff6b07e9f64e8c38acad66ad5468d) +++ sources/model/hd/data/MTreatmentFlowsData.h (.../MTreatmentFlowsData.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 MTreatmentFlowsData.h - * \date 3/9/2020 - * \author Behrouz NematiPour + * \file MTreatmentFlowsData.h + * \author (last) Behrouz NemaiPour + * \date (last) 28-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #pragma once @@ -27,21 +28,22 @@ namespace Model { /*! - * \brief The Flow Data class + * \brief The MFlow class + * \details The parent class of the flow data models */ class MFlow : public MAbstract { QVariantList parameters() const override; protected: struct Data { - Types::S32 mFlowSetPoint ; /*!< vFlowSetPoint - Flow Set Point value of type signed int extracted out */ - Types::F32 mMeasuredFlow ; /*!< vMeasuredFlow - Measured Flow value of type float extracted out */ - Types::F32 mRotorSpeed ; /*!< vRotorSpeed - Rotor Speed value of type float extracted out */ - Types::F32 mMotorSpeed ; /*!< vMotorSpeed - Motor Speed value of type float extracted out */ - Types::F32 mMotorCtlSpeed ; /*!< vMotorCtlSpeed - Motor Controller Speed value of type float extracted out */ - Types::F32 mMotorCtlCurrent ; /*!< vMotorCtlCurrent - Motor Controller Current value of type float extracted out */ - Types::F32 mPWMDutyCycle ; /*!< vPWMDtCycle - PWM Duty Cycle in % value of type float extracted out */ + Types::S32 mFlowSetPoint ; ///< Flow Set Point + Types::F32 mMeasuredFlow ; ///< Measured Flow + Types::F32 mRotorSpeed ; ///< Rotor Speed + Types::F32 mMotorSpeed ; ///< Motor Speed + Types::F32 mMotorCtlSpeed ; ///< Motor Controller Speed + Types::F32 mMotorCtlCurrent ; ///< Motor Controller Current + Types::F32 mPWMDutyCycle ; ///< PWM Duty Cycle in % } _data; public: @@ -55,7 +57,32 @@ }; /*! - * \brief The Blood Flow Data class + * \brief The MBloodFlow class + * \details The blood flow data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: | + * |0x0500| 0x040 | 7 | 1 Hz | N | HD | All | Blood Flow Data | + * + * | Payload || + * | || + * | #1:(S32) | \ref Data::mFlowSetPoint | + * | #2:(F32) | \ref Data::mMeasuredFlow | + * | #3:(F32) | \ref Data::mRotorSpeed | + * | #4:(F32) | \ref Data::mMotorSpeed | + * | #5:(F32) | \ref Data::mMotorCtlSpeed | + * | #6:(F32) | \ref Data::mMotorCtlCurrent | + * | #7:(F32) | \ref Data::mPWMDutyCycle | + * + * \sa Data + * + *

Logging info

+ * | || + * | || + * | typeText | Datum | + * | unitText | HD | + * | infoText | BloodFlow | + * */ class MBloodFlow : public MFlow { @@ -66,13 +93,13 @@ QString infoText () const override { return QString("BloodFlow"); } struct Data { - qint32 mFlowSetPoint = 0; /*!< vFlowSetPoint - Flow Set Point value of type signed int extracted out */ - float mMeasuredFlow = 0; /*!< vMeasuredFlow - Measured Flow value of type float extracted out */ - float mRotorSpeed = 0; /*!< vRotorSpeed - Rotor Speed value of type float extracted out */ - float mMotorSpeed = 0; /*!< vMotorSpeed - Motor Speed value of type float extracted out */ - float mMotorCtlSpeed = 0; /*!< vMotorCtlSpeed - Motor Controller Speed value of type float extracted out */ - float mMotorCtlCurrent = 0; /*!< vMotorCtlCurrent - Motor Controller Current value of type float extracted out */ - float mPWMDutyCycle = 0; /*!< vPWMDtCycle - PWM Duty Cycle in % value of type float extracted out */ + qint32 mFlowSetPoint = 0; ///< Flow Set Point + float mMeasuredFlow = 0; ///< Measured Flow + float mRotorSpeed = 0; ///< Rotor Speed + float mMotorSpeed = 0; ///< Motor Speed + float mMotorCtlSpeed = 0; ///< Motor Controller Speed + float mMotorCtlCurrent = 0; ///< Motor Controller Current + float mPWMDutyCycle = 0; ///< PWM Duty Cycle in % }; MBloodFlow() { } @@ -81,7 +108,32 @@ }; /*! - * \brief The Dialysate Flow Data class + * \brief The MDialysateFlow class + * \details The dialysate flow data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: | + * |0x0800| 0x040 | 7 | 1 Hz | N | HD | All | Dialysate Flow Data | + * + * | Payload || + * | || + * | #1:(S32) | \ref Data::mFlowSetPoint | + * | #2:(F32) | \ref Data::mMeasuredFlow | + * | #3:(F32) | \ref Data::mRotorSpeed | + * | #4:(F32) | \ref Data::mMotorSpeed | + * | #5:(F32) | \ref Data::mMotorCtlSpeed | + * | #6:(F32) | \ref Data::mMotorCtlCurrent | + * | #7:(F32) | \ref Data::mPWMDutyCycle | + * + * \sa Data + * + *

Logging info

+ * | || + * | || + * | typeText | Datum | + * | unitText | HD | + * | infoText | DialysateFlow | + * */ class MDialysateFlow : public MFlow { @@ -92,20 +144,19 @@ QString infoText () const override { return QString("DialysateFlow"); } struct Data { - qint32 mFlowSetPoint = 0; /*!< vFlowSetPoint - Flow Set Point value of type signed int extracted out */ - float mMeasuredFlow = 0; /*!< vMeasuredFlow - Measured Flow value of type float extracted out */ - float mRotorSpeed = 0; /*!< vRotorSpeed - Rotor Speed value of type float extracted out */ - float mMotorSpeed = 0; /*!< vMotorSpeed - Motor Speed value of type float extracted out */ - float mMotorCtlSpeed = 0; /*!< vMotorCtlSpeed - Motor Controller Speed value of type float extracted out */ - float mMotorCtlCurrent = 0; /*!< vMotorCtlCurrent - Motor Controller Current value of type float extracted out */ - float mPWMDutyCycle = 0; /*!< vPWMDtCycle - PWM Duty Cycle in % value of type float extracted out */ + qint32 mFlowSetPoint = 0; ///< Flow Set Point + float mMeasuredFlow = 0; ///< Measured Flow + float mRotorSpeed = 0; ///< Rotor Speed + float mMotorSpeed = 0; ///< Motor Speed + float mMotorCtlSpeed = 0; ///< Motor Controller Speed + float mMotorCtlCurrent = 0; ///< Motor Controller Current + float mPWMDutyCycle = 0; ///< PWM Duty Cycle in % }; MDialysateFlow() { } Data data() const; }; - } typedef Model:: MBloodFlow::Data BloodFlowData;