Index: sources/model/hd/data/MTreatmentOutletFlowData.h =================================================================== diff -u -raa0772fe1b0ff6b07e9f64e8c38acad66ad5468d -r4d969a04e6d80a6d2f6b756a4b87aecd6356e6a9 --- sources/model/hd/data/MTreatmentOutletFlowData.h (.../MTreatmentOutletFlowData.h) (revision aa0772fe1b0ff6b07e9f64e8c38acad66ad5468d) +++ sources/model/hd/data/MTreatmentOutletFlowData.h (.../MTreatmentOutletFlowData.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 MTreatmentOutletFlowData.h - * \date 3/9/2020 - * \author Behrouz NematiPour + * \file MTreatmentOutletFlowData.h + * \author (last) Behrouz NemaiPour + * \date (last) 28-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #pragma once @@ -25,6 +26,34 @@ namespace Model { +/*! + * \brief The MOutletFlow class + * \details The outlet flow data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: | + * |0x0B00| 0x040 | 7 | 1 Hz | N | HD | All | Outlet Flow Data | + * + * | Payload || + * | || + * | #1:(F32) | \ref Data::mRefUFVol | + * | #2:(F32) | \ref Data::mMeasUFVol | + * | #3:(F32) | \ref Data::mRotorSpeed | + * | #4:(F32) | \ref Data::mMotorSpeed | + * | #5:(F32) | \ref Data::mMotorCtlSpeed | + * | #6:(F32) | \ref Data::mMotorCtlCurrent | + * | #7:(F32) | \ref Data::mPWMDtCycle | + * + * \sa Data + * + *

Logging info

+ * | || + * | || + * | typeText | Datum | + * | unitText | HD | + * | infoText | OutletFlow | + * + */ class MOutletFlow : public MAbstract { // friends @@ -49,21 +78,20 @@ QString infoText () const override { return QString("OutletFlow"); } struct Data { - float mRefUFVol = 0; /*!< Reference UF Volume value of type float extracted out */ - float mMeasUFVol = 0; /*!< Measured UF Volume value of type float extracted out */ - float mRotorSpeed = 0; /*!< Rotor Speed value of type float extracted out */ - float mMotorSpeed = 0; /*!< Motor Speed value of type float extracted out */ - float mMotorCtlSpeed = 0; /*!< Motor Controller Speed value of type float extracted out */ - float mMotorCtlCurrent = 0; /*!< Motor Controller Current value of type float extracted out */ - float mPWMDtCycle = 0; /*!< PWM Duty Cycle in % value of type float extracted out */ + float mRefUFVol = 0; ///< Reference UF Volume + float mMeasUFVol = 0; ///< Measured UF Volume + float mRotorSpeed = 0; ///< Rotor Speed + float mMotorSpeed = 0; ///< Motor Speed + float mMotorCtlSpeed = 0; ///< Motor Controller Speed + float mMotorCtlCurrent = 0; ///< Motor Controller Current + float mPWMDtCycle = 0; ///< PWM Duty Cycle in % }; MOutletFlow () { } bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MOutletFlow::Data OutletFlowData;