/*!
 *
 * 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    MAlarmTriggered.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      18-Apr-2022
 * \author  (original)  Behrouz NemaiPour
 * \date    (original)  02-Jul-2020
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MAlarmTriggered class
 * \details The alarm triggered model
 *
 * | MSG  | CAN ID | Box | Type   | Ack | Src | Dst | Description     |
 * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------:    |
 * |0x0300| 0x001  | 1   | Event  | Y   | HD  | All | Alarm Triggered |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mAlarmID          |
 * | #2:(U32) | \ref Data::mFieldDescriptor1 |
 * | #3:(Any) | \ref Data::mDataField1       |
 * | #4:(U32) | \ref Data::mFieldDescriptor2 |
 * | #5:(Any) | \ref Data::mDataField2       |
 * | #6:(U32) | \ref Data::mPriority         |
 * | #7:(U32) | \ref Data::mRank             |
 * | #8:(U32) | \ref Data::mClearTop         |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Event          |
 * | unitText     | HD             |
 * | infoText     | AlarmTriggered |
 *
 */
class MAlarmTriggered : public MAbstractDynamic {

    // friends
    friend class ::tst_models;

protected:
    QVariantList parameters() const;

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("AlarmTriggered") ; }

    struct Data {
        quint32     mAlarmID         = 0;

        quint32     mFieldDescriptor1   ;
        quint32     mDataFieldU1        ;
        qint32      mDataFieldS1        ;
        float       mDataFieldF1        ;
        bool        mDataFieldB1        ;

        quint32     mFieldDescriptor2   ;
        quint32     mDataFieldU2        ;
        qint32      mDataFieldS2        ;
        float       mDataFieldF2        ;
        bool        mDataFieldB2        ;

        quint32     mPriority           ;
        quint32     mRank               ;
        bool        mClearTop           ;
    };

    struct {
        Types::U32  mPriority           ;
        Types::U32  mRank               ;
        Types::U32  mClearTop           ;
    } _xata;

public:
    MAlarmTriggered () { }

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

    Data data       () const;
};


/*!
 * \brief   The MAlarmTriggeredReq class
 * \details The model to transmit AlarmTrigger (mainly being used for post for now)
 *
 * | MSG  | CAN ID | Type | Ack | Src | Dest | Description |
 * |:----:|:------:|:----:|:---:|:---:|:----:|:-----------:|
 * |0x0300| 0x200  | Req  | Y   | UI  | All  | Alarm Triggered |
 *
 * | Payload  ||
 * |          ||
 * |          ||
 *
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Event          |
 * | unitText     | UI             |
 * | infoText     | AlarmTriggered |
 *
 */
class MAlarmTriggeredReq : public MModel {
public:
    QString toString();
    static QString toString(const QVariantList &vParameters);
    static Can::Can_Id canid ();
};

}

typedef Model::MAlarmTriggered::Data AlarmTriggeredData;
typedef Model::MAlarmTriggeredReq    AlarmTriggeredRequestData;