/*!
 *
 * 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    MTreatmentStatesData.h
 * \author  (last) Behrouz NematiPour
 * \date    (last) 07-Nov-2021
 * \author  (original) Behrouz NematiPour
 * \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 MTreatmentStates class
 * \details The treatment states data model
 *          These are states of the current treatment.
 *          It also includes the ultrafiltration states, saline bolus states.
 *
 * | MSG  | CAN ID | Box | Type   | Ack | Src | Dst | Description               |
 * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------:              |
 * |0x5C00| 0x040  | 7   | 1 Hz   | N   | HD  | All | Pre-Treatment States Data |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mSubMode                     |
 * | #2:(U32) | \ref Data::mWaterSampleState            |
 * | #3:(U32) | \ref Data::mSelfTestConsumablesState    |
 * | #4:(U32) | \ref Data::mSelfTestNoCartridgeState    |
 * | #5:(U32) | \ref Data::mInstallationState           |
 * | #6:(U32) | \ref Data::mSelfTestDryState            |
 * | #7:(U32) | \ref Data::mPrimeState                  |
 * | #8:(U32) | \ref Data::mRecirculateState            |
 * | #9:(U32) | \ref Data::mPatientConnectionState      |
 *
 * \sa Data
 * \sa HD_Pre_Treatment_Mode_States
 * \sa HD_Pre_Treatment_Sample_Water_States
 * \sa HD_Pre_Treatment_Consumable_Self_Test_States
 * \sa HD_Pre_Treatment_No_Cart_Self_Tests_States
 * \sa HD_Pre_Treatment_Dry_Self_Tests_States
 * \sa HD_Pre_Treatment_Prime_States
 * \sa HD_Pre_Treatment_Recirc_States
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Datum              |
 * | unitText     | HD                 |
 * | infoText     | PreTreatmentStates |
 *
 */
class MPreTreatmentStates : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32 mSubMode                     ;
        Types::U32 mWaterSampleState            ;
        Types::U32 mSelfTestConsumablesState    ;
        Types::U32 mSelfTestNoCartridgeState    ;
        Types::U32 mInstallationState           ;
        Types::U32 mSelfTestDryState            ;
        Types::U32 mPrimeState                  ;
        Types::U32 mRecirculateState            ;
        Types::U32 mPatientConnectionState      ;
    } _data;

public:

    Type_Enum    typeText  () const override { return Type_Enum::eDatum            ; }
    Unit_Enum    unitText  () const override { return Unit_Enum::eHD               ; }
    QString      infoText  () const override { return QString("PreTreatmentStates"); }

    struct Data {
        quint32    mSubMode                     = 0;  ///< SubMode             State - HD_Pre_Treatment_Mode_States
        quint32    mWaterSampleState            = 0;  ///< WaterSample         State - HD_Pre_Treatment_Sample_Water_States
        quint32    mSelfTestConsumablesState    = 0;  ///< selfTestConsumables State - HD_Pre_Treatment_Consumable_Self_Test_States
        quint32    mSelfTestNoCartridgeState    = 0;  ///< SelfTestNoCartridge State - HD_Pre_Treatment_No_Cart_Self_Tests_States
        quint32    mInstallationState           = 0;  ///< Installation        State - 0 = One state only
        quint32    mSelfTestDryState            = 0;  ///< SelfTestDry         State - HD_Pre_Treatment_Dry_Self_Tests_States
        quint32    mPrimeState                  = 0;  ///< Prime               State - HD_Pre_Treatment_Prime_States
        quint32    mRecirculateState            = 0;  ///< Recirculate         State - HD_Pre_Treatment_Recirc_States
        quint32    mPatientConnectionState      = 0;  ///< PatientConnection   State - 0 = One state only
    };

    MPreTreatmentStates() { }

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

typedef Model::MPreTreatmentStates::Data PreTreatmentStatesData;