/*!
 *
 * 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    MTreatmentAdjustDurationEditResponse.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      11-Apr-2021
 * \author  (original)  Behrouz NematiPour
 * \date    (original)  11-Apr-2021
 *
 */
#pragma once

// Qt
#include <QMetaType>
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MAdjustDurationEditResponse class
 * \details The treatment duration change response model
 *
 * | MSG  | CAN ID | Type   | Ack | Src | Dst | Description                        |
 * |:----:|:------:|:------:|:---:|:---:|:---:|:-----------:                       |
 * |0x8400| 0x020  | Rsp    | Y   | HD  | UI  | Treatment Duration Edit Response   |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mAccepted        |
 * | #2:(U32) | \ref Data::mReason          |
 * | #3:(U32) | \ref Data::mDuration        |
 * | #4:(F32) | \ref Data::mUFVolumeGoal    |
 * | #4:(F32) | \ref Data::mUFRate          |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Event          |
 * | unitText     | HD             |
 * | infoText     | AdjustDuration |
 *
 */
class MAdjustDurationEditResponse : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {

        Types::U32  mAccepted       ;
        Types::U32  mReason         ;
        Types::U32  mDuration       ;
        Types::F32  mUFVolumeGoal   ;
        Types::F32  mUFRate         ;
    } _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("AdjustDurationEdit") ; }

    struct Data {
        bool        mAccepted       = 0;  /*!< Accepted         value of type quint32 extracted out */
        quint32     mReason         = 0;  /*!< Reason           value of type quint32 extracted out */
        quint32     mDuration       = 0;  /*!< Duration         value of type quint32 extracted out */
        float       mUFVolumeGoal   = 0;  /*!< UF Volume Goal   value of type float extracted out */
        float       mUFRate         = 0;  /*!< UF Rate          value of type float extracted out */
    };

    MAdjustDurationEditResponse () { }

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

typedef Model::MAdjustDurationEditResponse::Data AdjustDurationEditResponseData;