Index: sources/model/hd/data/MTreatmentFlowsData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/data/MTreatmentFlowsData.h (.../MTreatmentFlowsData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/data/MTreatmentFlowsData.h (.../MTreatmentFlowsData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -28,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: @@ -56,7 +57,15 @@ }; /*! - * \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 | #1:(S32) | #2:(F32) | #3:(F32) | #4:(F32) | #5:(F32) | #6:(F32) | #7:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: |:--: | + * |0x0500| 0x040 | 7 | 1 Hz | N | HD | All | Blood Flow Data | \ref Data::mFlowSetPoint | \ref Data::mMeasuredFlow | \ref Data::mRotorSpeed | \ref Data::mMotorSpeed | \ref Data::mMotorCtlSpeed | \ref Data::mMotorCtlCurrent | \ref Data::mPWMDutyCycle | + * + * \sa Data + * */ class MBloodFlow : public MFlow { @@ -67,13 +76,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() { } @@ -82,7 +91,15 @@ }; /*! - * \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 | #1:(S32) | #2:(F32) | #3:(F32) | #4:(F32) | #5:(F32) | #6:(F32) | #7:(F32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: |:--: |:--: | + * |0x0800| 0x040 | 7 | 1 Hz | N | HD | All | Dialysate Flow Data | mFlowSetPoint | mMeasuredFlow | mRotorSpeed | mMotorSpeed | mMotorCtlSpeed | mMotorCtlCurrent | mPWMDutyCycle | + * + * \sa Data + * */ class MDialysateFlow : public MFlow { @@ -93,20 +110,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;