/*!
 *
 * Copyright (c) 2021-2024 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    MTreatmentUltrafiltrationData.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      09-Mar-2022
 * \author  (original)  Behrouz NematiPour
 * \date    (original)  11-Apr-2021
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MTreatmentUltrafiltration class
 * \details The treatment Ultrafiltration data model
 *
 * | MSG  | CAN ID | Box | Type   | Ack | Src | Dst | Description                   |
 * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------:                  |
 * |0x3E00| 0x100  | 7   | 1 Hz   | N   | TD  | All | Treatment Ultrafiltration Data|
 *
 * | Payload  ||
 * |          ||
 * | #1:(F32) | \ref Data::mSetVolume       |
 * | #2:(F32) | \ref Data::mTargetRate      |
 * | #3:(F32) | \ref Data::mVolumeRemoved   |
 * | #4:(U32) | \ref Data::mState           |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Datum           |
 * | unitText     | TD              |
 * | infoText     | Ultrafiltration |
 *
 */
class MTreatmentUltrafiltration : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::F32  mSetVolume       ;
        Types::F32  mTargetRate      ;
        Types::F32  mVolumeRemoved   ;
        Types::U32  mState           ;
    } _data;

public:

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

    struct Data {
        float       mSetVolume       = 0; ///< Ultrafiltration set volume
        float       mTargetRate      = 0; ///< Current Ultrafiltration target rate
        float       mVolumeRemoved   = 0; ///< Current volume removed during ultrafiltration
        quint32     mState           = 0; ///< Ultrafiltration rate
    };

public:
    MTreatmentUltrafiltration () { }

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

typedef Model::MTreatmentUltrafiltration::Data TreatmentUltrafiltrationData;