/*!
 *
 * Copyright (c) 2022-2025 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    MDuetConfirmHDi.h
 * \author  (last)      Dara Navaei
 * \date    (last)      18-Mar-2025
 * \author  (original)  Behrouz NematiPour
 * \date    (original)  22-Sep-2022
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MDuetConfirmHDi class
 * \details The HD Confirmation request model
 *
 * | MSG  | CAN ID | Type | Ack | Src | Dest | Description |
 * |:----:|:------:|:----:|:---:|:---:|:----:|:-----------:|
 * |0xBA00| 0x020  | INIT | Y   | HD  | UI   | Confirm     |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mId           |
 * | #2:(U32) | \ref Data::mCommand      |
 * | #3:(U32) | \ref Data::mReason       |
 * | #4:(F32) | \ref Data::mExtraParam1  |
 * | #5:(F32) | \ref Data::mExtraParam2  |
 * | #6:(F32) | \ref Data::mExtraParam3  |
 * | #7:(F32) | \ref Data::mExtraParam4  |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |          ||
 * |          ||
 * | typeText | Event |
 * | unitText | HD    |
 * | infoText | Confirm |
 *
 */
class MDuetConfirmHDi : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32  mId         ; /*!< Request ID               */
        Types::U32  mCommand    ; /*!< Request Command          */
        Types::U32  mReason     ; /*!< Request Rejection Reason */
        Types::F32  mExtraParam1; /*!< Extra Param 1            */
        Types::F32  mExtraParam2; /*!< Extra Param 2            */
        Types::F32  mExtraParam3; /*!< Extra Param 3            */
        Types::F32  mExtraParam4; /*!< Extra Param 4            */
    } _data;

public:
    Type_Enum    typeText   () const override { return Type_Enum::eEvent    ; }
    Unit_Enum    unitText   () const override { return Unit_Enum::eHD       ; }
    QString      infoText   () const override { return QString("Confirm" )  ; }

    struct Data {
        quint32  mId          = 0;    /*!< Request ID               */
        quint32  mCommand     = 0;    /*!< Request Command          */
        quint32  mReason      = 0;    /*!< Request Rejection Reason */
        float    mExtraParam1 = 0.0;  /*!< Extra Param 1            */
        float    mExtraParam2 = 0.0;  /*!< Extra Param 2            */
        float    mExtraParam3 = 0.0;  /*!< Extra Param 3            */
        float    mExtraParam4 = 0.0;  /*!< Extra Param 4            */
    };

    MDuetConfirmHDi () { }

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

typedef Model::MDuetConfirmHDi::Data DuetConfirmHDiData;