/*!
 *
 * 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    MDGReservoirData.h
 * \date    7/2/2020
 * \author  Behrouz NematiPour
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MDGReservoir class
 * \details The DG reservoir data model
 *
 * | MSG  | CAN ID | Box | Type   | Ack | Src | Dst | Description       | #1:(U32)         | #2:(U32)     | #3:(U32)      |
 * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------:      |:--:              |:--:          |:--:           |
 * |0x2800| 0x080  | 8   | 1 Hz   | N   | DG  | All | DG Reservoir Data | mActiveReservoir | mFillToVol   | mDrainToVol   |
 *
 * \sa Data
 *
 */
class MDGReservoir : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32  mActiveReservoir    ;
        Types::U32  mFillToVol          ;
        Types::U32  mDrainToVol         ;
    } _data;

public:

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

    struct Data {
        quint32     mActiveReservoir = 0; ///< Active reservoir
        quint32     mFillToVol       = 0; ///< Fill  to vol (mL)
        quint32     mDrainToVol      = 0; ///< Drain to vol (mL)
    };

    MDGReservoir () {}

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

typedef Model::MDGReservoir::Data DGReservoirData;