/*!
 *
 * Copyright (c) 2024-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    MTDAdvancedInstitutionalRecordResponse.h
 * \author  (last)      Nico Ramirez
 * \date    (last)      20-Nov-2025
 * \author  (original)  Nico Ramirez
 * \date    (original)  20-Nov-2025
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MTDAdvancedInstitutionalRecordResponse class
 * \details The TD Institutional response model
 *
 * | MSG  | CAN ID | Type | Ack | Src | Dest | Description |
 * |:----:|:------:|:----:|:---:|:---:|:----:|:-----------:|
 * |0x8700| 0x020  | Rsp  | Y   | HD  | UI   | Service Mode |
 *
 * | Payload   ||
 * |           ||
 * | #1: (U32) | \ref Data::mAccepted                           |
 * | #2: (U32) | \ref Data::mReason                             |
 * | #3: (U32) | \ref Data::mMinRORejectionRatioAlarmMin        |
 * | #4: (U32) | \ref Data::mMinRORejectionRatioAlarmMax        |
 * | #5: (U32) | \ref Data::mMinRORejectionRatioAlarmDef        |
 * | #6: (U32) | \ref Data::mDisinfectionFrequencyMin           |
 * | #7: (U32) | \ref Data::mDisinfectionFrequencyMax           |
 * | #8: (U32) | \ref Data::mDisinfectionFrequencyDef           |
 * | #9: (U32) | \ref Data::mDisinfectionParametersCycleTimeMin |
 * | #10:(U32) | \ref Data::mDisinfectionParametersCycleTimeMax |
 * | #11:(U32) | \ref Data::mDisinfectionParametersCycleTimeDef |
 * | #12:(U32) | \ref Data::mMaxBloodPumpStopTimeMin            |
 * | #13:(U32) | \ref Data::mMaxBloodPumpStopTimeMax            |
 * | #14:(U32) | \ref Data::mMaxBloodPumpStopTimeDef            |
 * | #15:(U32) | \ref Data::mInletWaterCondLowThresholdMin      |
 * | #16:(U32) | \ref Data::mInletWaterCondLowThresholdMax      |
 * | #17:(U32) | \ref Data::mInletWaterCondLowThresholdDef      |
 * | #18:(U32) | \ref Data::mInletWaterCondHighThresholdMin     |
 * | #19:(U32) | \ref Data::mInletWaterCondHighThresholdMax     |
 * | #20:(U32) | \ref Data::mInletWaterCondHighThresholdDef     |
 * | #21:(U32) | \ref Data::mChlorineWaterSampleCheckMin        |
 * | #22:(U32) | \ref Data::mChlorineWaterSampleCheckMax        |
 * | #23:(U32) | \ref Data::mChlorineWaterSampleCheckDef        |
 * | #24:(U32) | \ref Data::mWaterSampleTestResultRequiredDef   |

 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |          ||
 * |          ||
 * | typeText | Event |
 * | unitText | HD    |
 * | infoText | ServiceMode |
 *
 */
class MAdvancedInstitutionalRecordResponse : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32 mAccepted                            ;
        Types::U32 mReason                              ;
        Types::U32 mMinRORejectionRatioAlarmMin         ;
        Types::U32 mMinRORejectionRatioAlarmMax         ;
        Types::U32 mMinRORejectionRatioAlarmDef         ;
        Types::U32 mDisinfectionFrequencyMin            ;
        Types::U32 mDisinfectionFrequencyMax            ;
        Types::U32 mDisinfectionFrequencyDef            ;
        Types::U32 mDisinfectionParametersCycleTimeMin  ;
        Types::U32 mDisinfectionParametersCycleTimeMax  ;
        Types::U32 mDisinfectionParametersCycleTimeDef  ;
        Types::U32 mMaxBloodPumpStopTimeMin             ;
        Types::U32 mMaxBloodPumpStopTimeMax             ;
        Types::U32 mMaxBloodPumpStopTimeDef             ;
        Types::U32 mInletWaterCondLowThresholdMin       ;
        Types::U32 mInletWaterCondLowThresholdMax       ;
        Types::U32 mInletWaterCondLowThresholdDef       ;
        Types::U32 mInletWaterCondHighThresholdMin      ;
        Types::U32 mInletWaterCondHighThresholdMax      ;
        Types::U32 mInletWaterCondHighThresholdDef      ;
        Types::U32 mChlorineWaterSampleCheckMin         ;
        Types::U32 mChlorineWaterSampleCheckMax         ;
        Types::U32 mChlorineWaterSampleCheckDef         ;
        Types::U32 mWaterSampleTestResultRequiredDef    ;
    } _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("AdvancedInstitutionalRecord") ; }

    struct Data {
        bool        mAccepted = true                    ;  /*!< Accepted        value of type quint32 extracted out */
        quint32     mReason   = 0                       ;  /*!< Reason          value of type quint32 extracted out */
        quint32     mMinRORejectionRatioAlarmMin        ;
        quint32     mMinRORejectionRatioAlarmMax        ;
        quint32     mMinRORejectionRatioAlarmDef        ;
        quint32     mDisinfectionFrequencyMin           ;
        quint32     mDisinfectionFrequencyMax           ;
        quint32     mDisinfectionFrequencyDef           ;
        quint32     mDisinfectionParametersCycleTimeMin ;
        quint32     mDisinfectionParametersCycleTimeMax ;
        quint32     mDisinfectionParametersCycleTimeDef ;
        quint32     mMaxBloodPumpStopTimeMin            ;
        quint32     mMaxBloodPumpStopTimeMax            ;
        quint32     mMaxBloodPumpStopTimeDef            ;
        quint32     mInletWaterCondLowThresholdMin      ;
        quint32     mInletWaterCondLowThresholdMax      ;
        quint32     mInletWaterCondLowThresholdDef      ;
        quint32     mInletWaterCondHighThresholdMin     ;
        quint32     mInletWaterCondHighThresholdMax     ;
        quint32     mInletWaterCondHighThresholdDef     ;
        quint32     mChlorineWaterSampleCheckMin        ;
        quint32     mChlorineWaterSampleCheckMax        ;
        quint32     mChlorineWaterSampleCheckDef        ;
        quint32     mWaterSampleTestResultRequiredDef   ;

    };

    MAdvancedInstitutionalRecordResponse () { }

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

typedef Model::MAdvancedInstitutionalRecordResponse::Data AdvancedInstitutionalRecordResponseData;