/*!
 *
 * 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    MDGROPumpData.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      12-Feb-2021
 * \author  (original)  Behrouz NematiPour
 * \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 MDGROPump class
 * \details The DG RO pump data model
 *
 * | MSG  | CAN ID | Box | Type   | Ack | Src | Dst | Description     |
 * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------:    |
 * |0x1F00| 0x080  | 8   | 1 Hz   | N   | DG  | All | DG RO Pump Data |
 *
 * | Payload  ||
 * |          ||
 * | #1:(F32) | \ref Data::mPressure        |
 * | #2:(F32) | \ref Data::mFlowRate        |
 * | #3:(F32) | \ref Data::mPWM             |
 * | #4:(U32) | \ref Data::mState           |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Datum  |
 * | unitText     | DG     |
 * | infoText     | ROPump |
 *
 */
class MDGROPump : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::F32  mPressure      ;
        Types::F32  mFlowRate      ;
        Types::F32  mPWM           ;
        Types::U32  mState         ;
    } _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("ROPump"); }

    struct Data {
        float       mPressure   = 0;  ///< Set pt. pressure
        float       mFlowRate   = 0;  ///< flow rate
        float       mPWM        = 0;  ///< PWM
        quint32     mState      = 0;  ///< State
    };

    MDGROPump () { }

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

typedef Model::MDGROPump::Data DGROPumpData;