/*!
 *
 * Copyright (c) 2022-2025 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    MHDBloodLeakData.h
 * \author  (last)      Dara Navaei
 * \date    (last)      06-Nov-2024
 * \author  (original)  Michael Garthwaite
 * \date    (original)  17-Feb-2022
 *
 */
#pragma once


// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MHDBloodLeakData class
 * \details The HD blood leak data model
 *
 *
 * |   MSG  | CAN ID | Type | Ack | Src | Dest | Description            |
 * |:------:|:------:|:----:|:---:|:---:|:----:|:---------------------: |
 * | 0x6C00 | 0x040  | 1 Hz | N   | HD  | UI   | HD Blood Leak Data     |
 *
 * | Payload  ||
 * |          ||
 * | #01:(U32) | \ref Data::mBloodLeakStatus                   |
 * | #02:(U32) | \ref Data::mBloodLeakState                    |
 * | #03:(U32) | \ref Data::mBloodLeakPersistentCounter        |
 * | #04:(U32) | \ref Data::mBloodLeakSerialCommState          |
 * | #05:(U32) | \ref Data::mBloodLeakIntensity                |
 * | #06:(U32) | \ref Data::mBloodLeakDetect                   |
 * | #07:(F32) | \ref Data::mBloodLeakIntensityMvgAvg          |
 * | #08:(F32) | \ref Data::mBloodLeakTimeSinceZeroMS          |
 * | #09:(F32) | \ref Data::mBloodLeakDrfitInRangeStatus       |
 * | #10:(F32) | \ref Data::mBloodLeakDriftUpperRangeStatus    |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Datum       |
 * | unitText     | HD          |
 * | infoText     | BloodLeak   |
 *
 */
class MHDBloodLeakData : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32 mBloodLeakStatus                 ;
        Types::U32 mBloodLeakState                  ;
        Types::U32 mBloodLeakPersistentCounter      ;
        Types::U32 mBloodLeakSerialCommState        ;
        Types::U32 mBloodLeakIntensity              ;
        Types::U32 mBloodLeakDetect                 ;
        Types::F32 mBloodLeakIntensityMvgAvg        ;
        Types::U32 mBloodLeakTimeSinceZeroMS        ;
        Types::U32 mBloodLeakDrfitInRangeStatus     ;
        Types::U32 mBloodLeakDriftUpperRangeStatus  ;
    } _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("BloodLeak") ; }

    struct Data {
        quint32 mBloodLeakStatus                = 0;
        quint32 mBloodLeakState                 = 0;
        quint32 mBloodLeakPersistentCounter     = 0;
        quint32 mBloodLeakSerialCommState       = 0;
        quint32 mBloodLeakIntensity             = 0;
        quint32 mBloodLeakDetect                = 0;
        float   mBloodLeakIntensityMvgAvg       = 0;
        quint32 mBloodLeakTimeSinceLastZeroMS   = 0;
        quint32 mBloodLeakDriftInRangeStatus    = 0;
        quint32 mBloodLeakDriftUpperRangeStatus = 0;
    };

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

};
}

typedef Model::MHDBloodLeakData::Data HDBloodLeakData;