/*!
 *
 * 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    MTreatmentIsolatedUFData.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 MTreatmentIsolatedUF class
 * \details The treatment IsolatedUF data model
 *
 * | MSG  | CAN ID | Box | Type   | Ack | Src | Dst | Description               |
 * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------:              |
 * |0x9A00| 0x100  | 7   | 1 Hz   | N   | TD  | All | Treatment IsolatedUF Data  |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mDuration        |
 * | #2:(U32) | \ref Data::mSetVolume       |
 * | #3:(U32) | \ref Data::mVolumeDelivered |
 * | #4:(U32) | \ref Data::mRate            |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Datum           |
 * | unitText     | TD              |
 * | infoText     | IsolatedUF      |
 *
 */
class MTreatmentIsolatedUF : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32  mDuration           ;
        Types::U32  mSetVolume          ;
        Types::U32  mVolumeDelivered    ;
        Types::U32  mRate               ;
    } _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("IsolatedUF") ; }

    struct Data {
        quint32 mDuration           = 0; ///< Current duration
        quint32 mSetVolume          = 0; ///< Current volume goal
        quint32 mVolumeDelivered    = 0; ///< Current volume removed during Isolateds UF
        quint32 mRate               = 0; ///< IsolatedUF rate
    };

public:
    MTreatmentIsolatedUF () { }

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

typedef Model::MTreatmentIsolatedUF::Data TreatmentIsolatedUFData;