/*!
 *
 * 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    MTreatmentAdjustDialysateFlowRateResponse.h
 * \author  (last)      Stephen Quong
 * \date    (last)      18-Nov-2025
 * \author  (original)  Stephen Quong
 * \date    (original)  18-Nov-2025
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MAdjustDialysateFlowRateResponse class
 * \details The Dialysate Flow Rate adjustment response model
 *
 * | MSG  | CAN ID | Type | Ack | Src | Dest | Description                          |
 * |:----:|:------:|:----:|:---:|:---:|:----:|:------------------------------------:|
 * |0x9800| 0x020  | Rsp  | Y   | TD  | UI   | Adjust Dialysate Flow Rate Response  |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mAccepted            |
 * | #2:(U32) | \ref Data::mReason              |
 * | #3:(U32) | \ref Data::mDialysateFlowRate   |
 *
 * \sa Data
 * \sa MAdjustDialysateFlowRateReq : Adjust Dialysate Flow Rate Request
 * \sa MTreatmentDialysateFlowRate : Adjust Dialysate Flow Rate Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Event                   |
 * | unitText     | HD                      |
 * | infoText     | AdjustDialysateFlowRate |
 *
 */
class MAdjustDialysateFlowRateResponse : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32 mAccepted            ;
        Types::U32 mReason              ;
        Types::U32 mDialysateFlowRate   ;
    } _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("AdjustDialysateFlowRate")    ; }

    struct Data {
        bool       mAccepted            = 0;  /*!< Accepted             value of type quint32 extracted out */
        quint32    mReason              = 0;  /*!< Reason               value of type quint32 extracted out */
        quint32    mDialysateFlowRate   = 0;  /*!< Dialysate Flow Rate  value of type quint32 extracted out */
    };

    MAdjustDialysateFlowRateResponse () { }

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

typedef Model::MAdjustDialysateFlowRateResponse::Data AdjustDialysateFlowRateResponseData;