Index: sources/model/hd/alarm/MAlarmStatusData.h =================================================================== diff -u -r56e378f7504701b9e9a9dccaf205aef2fd52c58e -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 --- sources/model/hd/alarm/MAlarmStatusData.h (.../MAlarmStatusData.h) (revision 56e378f7504701b9e9a9dccaf205aef2fd52c58e) +++ sources/model/hd/alarm/MAlarmStatusData.h (.../MAlarmStatusData.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) @@ -19,13 +19,24 @@ // 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 | #1:(U32) | #2:(U32) | #3:(U32) | #4:(U32) | #5:(U16) | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: |:--: |:--: |:--: |:--: |:--: | + * |0x0200| 0x001 | 1 | 1 Hz | N | HD | All | Alarm Status | \ref Data::mState | \ref Data::mTop | \ref Data::mEscalatesIn | \ref Data::mMuteTimeout | \ref Data::mFlags | + * + * \sa Data + * + */ class MAlarmStatus { // friends @@ -45,13 +56,14 @@ eFlag_alarmsSilenced , eFlag_Bits_Length = 16, }; + QString stringPrefix = "Alarm Status"; struct Data { - quint32 mState = 0; /*!< State - Alarm Priority value of type unsigned int as 4 bytes extracted out */ - quint32 mTop = 0; /*!< Top - Top value of type unsigned int as 4 bytes extracted out */ - quint32 mEscalatesIn = 0; /*!< EscalatesIn - EscalatesIn value of type unsigned int as 4 bytes extracted out */ - quint32 mMuteTimeout = 0; /*!< MuteTimeout - MuteTimeout value of type unsigned int as 4 bytes extracted out */ - QBitArray mFlags ; /*!< Flags - Flags value of type unsigned int as 1 byte extracted out */ + quint32 mState = 0; ///< State - Alarm Priority + quint32 mTop = 0; ///< Top - Top current alarm ID + quint32 mEscalatesIn = 0; ///< EscalatesIn - EscalatesIn + quint32 mMuteTimeout = 0; ///< MuteTimeout - MuteTimeout + QBitArray mFlags ; ///< Flags - Flags }; private: @@ -66,14 +78,13 @@ public: MAlarmStatus(); - QString toString ( ) const ; + QString toString ( ) const ; void toVariantList ( QVariantList &vData ) const ; bool fromByteArray (const QByteArray &vByteArray , int *vIndex = nullptr); static QString toText ( Gui::GuiAlarmID vAlarmID); Data data() const ; }; - } typedef Model::MAlarmStatus::Data AlarmStatusData;