Index: sources/model/dg/data/MDGReservoirData.h =================================================================== diff -u -r3aab84456cfbdc4c4f495975ba9b8968eb844309 -r4d969a04e6d80a6d2f6b756a4b87aecd6356e6a9 --- sources/model/dg/data/MDGReservoirData.h (.../MDGReservoirData.h) (revision 3aab84456cfbdc4c4f495975ba9b8968eb844309) +++ sources/model/dg/data/MDGReservoirData.h (.../MDGReservoirData.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 MDGReservoirData.h - * \date 7/2/2020 - * \author Behrouz NematiPour + * \file MDGReservoirData.h + * \author (last) Behrouz NemaiPour + * \date (last) 17-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #pragma once @@ -25,12 +26,35 @@ namespace Model { +/*! + * \brief The MDGReservoir class + * \details The DG reservoir data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: | + * |0x2800| 0x080 | 8 | 1 Hz | N | DG | All | DG Reservoir Data | + * + * | Payload || + * | || + * | #1:(U32) | \ref Data::mActiveReservoir | + * | #2:(U32) | \ref Data::mFillToVol | + * | #3:(U32) | \ref Data::mDrainToVol | + * + * \sa Data + * + *

Logging info

+ * | || + * | || + * | typeText | Datum | + * | unitText | DG | + * | infoText | Reservoir | + * + */ class MDGReservoir : public MAbstract { // friends friend class ::tst_models; - // DG Reservoir Data (U32) active reservoir (U32) Fill to vol (mL) (U32) Drain to vol (mL) QVariantList parameters() const override; struct { @@ -46,17 +70,16 @@ QString infoText () const override { return QString("Reservoir"); } struct Data { - quint32 mActiveReservoir = 0; - quint32 mFillToVol = 0; - quint32 mDrainToVol = 0; + quint32 mActiveReservoir = 0; ///< Active reservoir + quint32 mFillToVol = 0; ///< Fill to vol (mL) + quint32 mDrainToVol = 0; ///< Drain to vol (mL) }; MDGReservoir () {} bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MDGReservoir::Data DGReservoirData;