/*!
 *
 * Copyright (c) 2021-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    MTreatmentAdjustDurationConfirmResponse.h
 * \author  (last)      Stephen Quong
 * \date    (last)      17-Nov-2025
 * \author  (original)  Stephen Quong
 * \date    (original)  17-Nov-2025
 *
 */
#pragma once

// Qt
#include <QString>

// Project
#include "types.h"

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MAdjustDurationConfirmResponse class
 * \details The UF vol. change confirmation response model
 *
 * | MSG  | CAN ID | Type   | Ack | Src | Dst | Description                                 |
 * |:----:|:------:|:------:|:---:|:---:|:---:|:-----------:                                |
 * |0x8600| 0x040  | Rsp    | Y   | HD  | UI  | Treatment Duration Confirmation Response    |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mAccepted        |
 * | #2:(U32) | \ref Data::mReason          |
 * |          |                             |
 * | #4:(U32) | \ref Data::mDuration        |
 * | #3:(F32) | \ref Data::mUFVolumeRemoved |
 * | #5:(F32) | \ref Data::mUFSetVolume     |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Event           |
 * | unitText     | HD              |
 * | infoText     | AdjustUFConfirm |
 *
 */
class MAdjustDurationConfirmResponse {

    // friends
    friend class ::tst_models;

public:
    QString  stringPrefix = "AdjustDurationConfirm";
    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       mUFVolumeRemoved    = 0;  /*!< UF volume removed    value of type float   extracted out */
        float       mUFSetVolume        = 0;  /*!< UF set volume        value of type float   extracted out */
    };

protected:
    struct _Data {
        Types::U32  mAccepted           ;
        Types::U32  mReason             ;

        Types::U32  mDuration           ;
        Types::F32  mUFVolumeRemoved    ;
        Types::F32  mUFSetVolume        ;
    } _data;

public:
    MAdjustDurationConfirmResponse () { }

    QString toString          (                               ) const ;
    void    toVariantList     (      QVariantList &vData      ) const ;
    bool    fromByteArray     (const QByteArray   &vByteArray , int *vIndex = nullptr);

    Data    data() const;
};
}

typedef Model::MAdjustDurationConfirmResponse::Data AdjustDurationConfirmResponseData;