/*!
 *
 * Copyright (c) 2020-2024 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.
 *
 * \file    MAlarmStatusData.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      29-Jul-2023
 * \author  (original)  Behrouz NemaiPour
 * \date    (original)  02-Jul-2020
 *
 */
#pragma once

// Qt
#include <QString>

// Project
#include "MAbstract.h"
#include "types.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
 *
 * <h2 class="groupheader">Logging info</h2>
 * |          ||
 * |          ||
 * | typeText | Datum        |
 * | unitText | HD           |
 * | infoText | Alarm Status |
 *
 */
class MAlarmStatus : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32   mState                 ;
        Types::U32   mTop                   ;
        Types::U32   mEscalatesIn           ;
        Types::U32   mMuteTimeout           ;
        Types::Flags mFlags                 ;
    } _data;

public:

    Type_Enum    typeText  () const override { return Type_Enum::eDatum      ; }
    Unit_Enum    unitText  () const override { return Unit_Enum::eHD         ; }
    QString      infoText  () const override { return QString("AlarmStatus") ; }

    struct Data {
        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
    };

public:
    MAlarmStatus() { }

    bool    fromByteArray   (const QByteArray   &vByteArray  , int *vIndex = nullptr)       override;
    Data    data            (                                                       ) const         ;
    void    data            (const Data         &vData                              )               ;

    static QString toText   (Gui::GuiAlarmID vAlarmID);

};
}

typedef Model::MAlarmStatus::Data AlarmStatusData;