/*!
 *
 * Copyright (c) 2021-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    MAlarmActiveList.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      18-Apr-2022
 * \author  (original)  Behrouz NematiPour
 * \date    (original)  15-May-2021
 *
 */
#pragma once

// Qt
#include <QString>

// Project
#include "MAdjustRequestsBase.h"
#include "MAbstract.h"
#include "types.h"

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MAlarmActiveListReq class
 * \details The model to tell HD an alarm action has been made by user
 *
 * | MSG  | CAN ID | Type | Ack | Src | Dest | Description |
 * |:----:|:------:|:----:|:---:|:---:|:----:|:-----------:|
 * |0x0900| 0x041  | Req  | Y   | UI  | TD   | Alarm Active List Request |
 *
 * | Payload  ||
 * |          ||
 * | NONE     ||
 * \sa MAlarmActiveListRsp : Alarm Active List Response
 *
 */
class MAlarmActiveListReq : public MModel {
public:
    static QString toString(const QVariantList &vParameters) {
        return MModel::toString("AlarmActiveList", vParameters);
    }
};

/*!
 * \brief   The MAlarmActiveListResponse class
 * \details The TreatmentLog adjustment response model
 *
 * | MSG  | CAN ID | Type | Ack | Src | Dest | Description |
 * |:----:|:------:|:----:|:---:|:---:|:----:|:---------:  |
 * |0x0A00| 0x040  | Rsp  | Y   | TD  | UI   | Alarm Active List Response |
 *
 * | Payload  ||
 * |          ||
 * | # 1:(U32) | \ref Data::mAccepted |
 * | # 2:(U32) | \ref Data::mReason   |
 * | # 3:(U32) | \ref Data::mAlarmID0 |
 * | # 4:(U32) | \ref Data::mAlarmID1 |
 * | # 5:(U32) | \ref Data::mAlarmID2 |
 * | # 6:(U32) | \ref Data::mAlarmID3 |
 * | # 7:(U32) | \ref Data::mAlarmID4 |
 * | # 8:(U32) | \ref Data::mAlarmID5 |
 * | # 9:(U32) | \ref Data::mAlarmID6 |
 * | #10:(U32) | \ref Data::mAlarmID7 |
 * | #11:(U32) | \ref Data::mAlarmID8 |
 * | #12:(U32) | \ref Data::mAlarmID9 |
 * \sa Data
 * \sa MAlarmActiveListReq : Alarm Active List Request
 *
 * <h2 class="groupheader">Logging info</h2>
 * |          ||
 * |          ||
 * | typeText | Event              |
 * | unitText | TD                 |
 * | infoText | AdjustTreatmentLog |
 *
 */
class MAlarmActiveListResponse : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32  mAccepted;
        Types::U32  mReason  ;
        Types::U32  mAlarmID0;
        Types::U32  mAlarmID1;
        Types::U32  mAlarmID2;
        Types::U32  mAlarmID3;
        Types::U32  mAlarmID4;
        Types::U32  mAlarmID5;
        Types::U32  mAlarmID6;
        Types::U32  mAlarmID7;
        Types::U32  mAlarmID8;
        Types::U32  mAlarmID9;
    } _data;

public:

    Type_Enum    typeText  () const override { return Type_Enum::eEvent         ; }
    Unit_Enum    unitText  () const override { return Unit_Enum::eTD            ; }
    QString      infoText  () const override { return QString("AlarmActiveList"); }

    struct Data {
        bool        mAccepted   = 0; /*!< Accepted value of type quint32 extracted out */
        quint32     mReason     = 0; /*!< Reason   value of type quint32 extracted out */
        quint32     mAlarmID0   = 0; /*!< Active Alarm ID 0 */
        quint32     mAlarmID1   = 0; /*!< Active Alarm ID 1 */
        quint32     mAlarmID2   = 0; /*!< Active Alarm ID 2 */
        quint32     mAlarmID3   = 0; /*!< Active Alarm ID 3 */
        quint32     mAlarmID4   = 0; /*!< Active Alarm ID 4 */
        quint32     mAlarmID5   = 0; /*!< Active Alarm ID 5 */
        quint32     mAlarmID6   = 0; /*!< Active Alarm ID 6 */
        quint32     mAlarmID7   = 0; /*!< Active Alarm ID 7 */
        quint32     mAlarmID8   = 0; /*!< Active Alarm ID 8 */
        quint32     mAlarmID9   = 0; /*!< Active Alarm ID 9 */
    };

    MAlarmActiveListResponse () { }

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

typedef Model::MAlarmActiveListReq             AlarmActiveListRequestData;
typedef Model::MAlarmActiveListResponse::Data AlarmActiveListResponseData;