/*!
 *
 * Copyright (c) 2022-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    MDDConductivityData.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      30-Mar-2023
 * \author  (original)  Michael Garthwaite
 * \date    (original)  23-Feb-2022
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {
/*!
 * \brief   The MDDConductivityData class
 * \details The DD conductivity sensors data model
 *
 * | MSG  | CAN ID | Type   | Ack | Src | Dst | Description           |
 * |:----:|:------:|:------:|:---:|:---:|:---:|:-----------:          |
 * |0x1F00| 0x101  | 1 Hz   | N   | DD  | All | DD Conductivity Data  |
 *
 * | Payload  ||
 * |          ||
 * | #01:(F32) | \ref Data::mCD1               |
 * | #02:(F32) | \ref Data::mCD2               |
 * | #03:(F32) | \ref Data::mCD3               |
 * | #04:(F32) | \ref Data::mCD4               |
 * | #05:(F32) | \ref Data::mTD1               |
 * | #06:(F32) | \ref Data::mTD2               |
 * | #07:(F32) | \ref Data::mTD3               |
 * | #08:(F32) | \ref Data::mTD4               |
 *
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Datum        |
 * | unitText     | DD           |
 * | infoText     | Conductivity |
 *
 */
class MDDConductivityData : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::F32 mCD1              ;
        Types::F32 mCD2              ;
        Types::F32 mCD3              ;
        Types::F32 mCD4              ;
        Types::F32 mTD1              ;
        Types::F32 mTD2              ;
        Types::F32 mTD3              ;
        Types::F32 mTD4              ;

    } _data;

public:
    Type_Enum    typeText  () const override { return Type_Enum::eDatum      ; }
    Unit_Enum    unitText  () const override { return Unit_Enum::eDD         ; }
    QString      infoText  () const override { return QString("Conductivity"); }

    struct Data{
        float   mCD1                = 0; ///<
        float   mCD2                = 0; ///<
        float   mCD3                = 0; ///<
        float   mCD4                = 0; ///<
        float   mTD1                = 0; ///<
        float   mTD2                = 0; ///<
        float   mTD3                = 0; ///<
        float   mTD4                = 0; ///<
    };

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

};
}

typedef Model::MDDConductivityData::Data DDConductivityData;