Index: sources/model/hd/alarm/MAlarmStatusData.h =================================================================== diff -u -rbf645acccabb7b5a84801620c4f7fa0b0e6878e0 -r4d969a04e6d80a6d2f6b756a4b87aecd6356e6a9 --- sources/model/hd/alarm/MAlarmStatusData.h (.../MAlarmStatusData.h) (revision bf645acccabb7b5a84801620c4f7fa0b0e6878e0) +++ sources/model/hd/alarm/MAlarmStatusData.h (.../MAlarmStatusData.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 MAlarmStatusData.h - * \date 3/9/2020 - * \author Behrouz NematiPour + * \file MAlarmStatusData.h + * \author (last) Behrouz NemaiPour + * \date (last) 06-Aug-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #pragma once @@ -18,13 +19,39 @@ // Project #include "types.h" -#include "guiglobals.h" +#include "GuiGlobals.h" // forward declarations class tst_models; namespace Model { +/*! + * \brief The MAlarmStatus class + * \details The alarm status model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: | + * |0x0200| 0x001 | 1 | 1 Hz | N | HD | All | Alarm Status | + * + * | Payload || + * | || + * | #1:(U32) | \ref Data::mState | + * | #2:(U32) | \ref Data::mTop | + * | #3:(U32) | \ref Data::mEscalatesIn | + * | #4:(U32) | \ref Data::mMuteTimeout | + * | #5:(U16) | \ref Data::mFlags | + * + * \sa Data + * + *