/*!
 *
 * Copyright (c) 2021-2022 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    MTreatmentSalineData.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      11-Apr-2021
 * \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 MTreatmentSaline class
 * \details The treatment saline bolus data model
 *
 * | MSG  | CAN ID | Box | Type   | Ack | Src | Dst | Description                 |
 * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------:                |
 * |0x2F00| 0x040  | 7   | 1 Hz   | N   | HD  | All | Treatment Saline Bolus Data |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mTarget     |
 * | #2:(F32) | \ref Data::mCumulative |
 * | #3:(F32) | \ref Data::mDelivered  |
 *
 * \sa Data
 * \sa MAdjustSalineReq : Saline Bolus Request
 * \sa MAdjustSalineResponse : Saline Bolus Response
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Datum  |
 * | unitText     | HD     |
 * | infoText     | Saline |
 *
 */
class MTreatmentSaline : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32  mTarget     ;
        Types::F32  mCumulative ;
        Types::F32  mDelivered  ;
    } _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("Saline") ; }

    struct Data {
        quint32     mTarget      = 0; ///< Target volume for the current started saline bolus
        float       mCumulative  = 0; ///< Cumulative volume of all saline deliveries during current treatment
        float       mDelivered   = 0; ///< Current delivered saline volume
    };

public:
    MTreatmentSaline () { }

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

typedef Model::MTreatmentSaline::Data TreatmentSalineData;