/*!
 *
 * Copyright (c) 2020-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    MFPFlowData.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      10-Feb-2023
 * \author  (original)  Behrouz NemaiPour
 * \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 MFPFlow class
 * \details The FP Flow data model
 *
 * | MSG  | CAN ID | Box | Type   | Ack | Src | Dst | Description       |
 * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------:      |
 * |0x3600| 0x102  | 8   | 1 Hz   | N   | FP  | All | FP Flow Data    |
 *
 * | Payload  ||
 * |          ||
 * | #01:(F32) | \ref Data::mP7Flow          |
 * | #02:(F32) | \ref Data::mP16Flow         |
 * | #03:(F32) | \ref Data::mP7Temp          |
 * | #04:(F32) | \ref Data::mP16Temp         |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Datum     |
 * | unitText     | FP        |
 * | infoText     | Flow      |
 *
 */
class MFPFlow : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::F32   mP7Flow         ;   ///<  P7 flow rate at water inlet.
        Types::F32   mP16Flow        ;   ///<  P16 flow rate at RO filter outlet.
        Types::F32   mP7Temp         ;   ///<  P7 temperature from inlet flow sensor.
        Types::F32   mP16Temp        ;   ///<  P16 temperature from outlet flow sensor.
    } _data;

public:

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

    struct Data {
        float       mWaterInletFlow         = 0;  ///<  P7 flow rate at water inlet.
        float       mROFilterOutletFlow     = 0;  ///<  P16 flow rate at RO filter outlet.
        float       mWaterInletTemp         = 0;  ///<  P7 temperature from inlet flow sensor.
        float       mROFilterOutletTemp     = 0;  ///<  P16 temperature from outlet flow sensor.
    };

    MFPFlow () {}

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

typedef Model::MFPFlow::Data FPFlowData;