Index: sources/model/dg/data/MDGReservoirData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/dg/data/MDGReservoirData.h (.../MDGReservoirData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/dg/data/MDGReservoirData.h (.../MDGReservoirData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -26,12 +26,22 @@ namespace Model { +/*! + * \brief The MDGReservoir class + * \details The DG reservoir data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | #1:(U32) | #2:(U32) | #3:(U32) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: | + * |0x2800| 0x080 | 8 | 1 Hz | N | DG | All | DG Reservoir Data | \ref Data::mActiveReservoir | \ref Data::mFillToVol | \ref Data::mDrainToVol | + * + * \sa Data + * + */ 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 { @@ -47,17 +57,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;