/*!
 *
 * Copyright (c) 2019-2020 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 MTreatmentAdjustUltrafiltrationStateResponse.h
 * \author (last) Behrouz NematiPour
 * \date (last) 16-Oct-2020
 * \author (original) Behrouz NemaiPour
 * \date (original) 02-Jul-2020
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MAdjustUltrafiltrationStateResponse class
 * \details The ultrafiltration adjustment state response model
 *
 * | MSG | CAN ID | M.Box | Type | Ack | Src | Dest | Description              |
 * |:---:|:------:|:-----:|:----:|:---:|:---:|:----:|:------------------------:|
 * | 65  | 0x020  | 6     | Rsp  | Y   | HD  | UI   | UF Pause/Resume Response |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mAccepted |
 * | #2:(U32) | \ref Data::mReason   |
 * | #3:(U32) | \ref Data::mState    |
 *
 * \sa Data
 * \sa MAdjustUltrafiltrationStateReq : Ultrafiltration state change Request
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Event         |
 * | unitText     | HD            |
 * | infoText     | AdjustUFState |
 *
 */
class MAdjustUltrafiltrationStateResponse : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

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

    struct Data {
        bool       mAccepted = 0;  /*!< Accepted        value of type quint32 extracted out */
        quint32    mReason   = 0;  /*!< Reason          value of type quint32 extracted out */
        quint32    mState    = 0;  /*!< UF State        value of type quint32 extracted out */
    };

    MAdjustUltrafiltrationStateResponse() { }

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

typedef Model::MAdjustUltrafiltrationStateResponse::Data AdjustUltrafiltrationStateResponseData;