Index: sources/model/hd/data/MTreatmentTimeData.h =================================================================== diff -u -r618891879f5cdc68e37ee68eea005afb76dd4e5b -r4d969a04e6d80a6d2f6b756a4b87aecd6356e6a9 --- sources/model/hd/data/MTreatmentTimeData.h (.../MTreatmentTimeData.h) (revision 618891879f5cdc68e37ee68eea005afb76dd4e5b) +++ sources/model/hd/data/MTreatmentTimeData.h (.../MTreatmentTimeData.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 MTreatmentTimeData.h - * \date 3/9/2020 - * \author Behrouz NematiPour + * \file MTreatmentTimeData.h + * \author (last) Behrouz NematiPour + * \date (last) 20-Aug-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #pragma once @@ -26,6 +27,30 @@ namespace Model { +/*! + * \brief The MTreatmentTime class + * \details The treatment time data model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: | + * |0x0D00| 0x040 | 7 | 1 Hz | N | HD | All | Treatment Time Data | + * + * | Payload || + * | || + * | #1:(U32) | \ref Data::mTotal | + * | #2:(U32) | \ref Data::mElapsed | + * | #3:(U32) | \ref Data::mRemaining | + * + * \sa Data + * + *

Logging info

+ * | || + * | || + * | typeText | Datum | + * | unitText | HD | + * | infoText | TreatmentTime | + * + */ class MTreatmentTime : public MAbstract { // friends @@ -46,9 +71,9 @@ QString infoText () const override { return QString("TreatmentTime"); } struct Data { - quint32 mTotal = 0; /*!< Total treatment time in sec */ - quint32 mElapsed = 0; /*!< Elapsed treatment time in sec */ - quint32 mRemaining = 0; /*!< Remaining treatment time in sec */ + quint32 mTotal = 0; ///< Total treatment time in sec */ + quint32 mElapsed = 0; ///< Elapsed treatment time in sec */ + quint32 mRemaining = 0; ///< Remaining treatment time in sec */ }; public: @@ -57,7 +82,6 @@ bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr) override; Data data ( ) const ; }; - } typedef Model::MTreatmentTime::Data TreatmentTimeData;