/*!
 *
 * 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) 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 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           |
 * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------:          |
 * |0x0F00| 0x040  | 7   | 1 Hz   | N   | HD  | All | Treatment States Data |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mSubMode     |
 * | #2:(U32) | \ref Data::mUFState     |
 * | #3:(U32) | \ref Data::mSalineState |
 *
 * \sa Data
 * \sa Saline_Bolus_States
 * \sa UF_States
 * \sa Treatment_States
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Datum           |
 * | unitText     | HD              |
 * | infoText     | TreatmentStates |
 *
 */
class MTreatmentStates : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32 mSubMode        ;
        Types::U32 mUFState        ;
        Types::U32 mSalineState    ;
    } _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("TreatmentStates"); }

    struct Data {
        quint32    mSubMode     = 0;  ///< Sub-Mode     - Treatment_States
        quint32    mUFState     = 0;  ///< UF State     - UF_States
        quint32    mSalineState = 0;  ///< Saline State - Saline_Bolus_States
    };

    MTreatmentStates() { }

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

typedef Model::MTreatmentStates::Data TreatmentStatesData;