/*!
 *
 * Copyright (c) 2021-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    MTreatmentLogAlarmData.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      22-Mar-2023
 * \author  (original)  Behrouz NematiPour
 * \date    (original)  15-May-2021
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MTreatmentLogAlarmData class
 * \details The post treatment states data model
 *          These are states of the post treatment.
 *
 * | MSG  | CAN ID | Type   | Ack | Src | Dst | Description |
 * |:----:|:------:|:------:|:---:|:---:|:---:|:-----------:|
 * |0x6A00| 0x040  | Event  |  Y  | HD  | UI  | Treatment Log Alarm Data |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mAlarmID     |
 * | #2:(F32) | \ref Data::mParam1      |
 * | #3:(F32) | \ref Data::mParam2      |
 *
 * \sa Data
 * \sa HD_Post_Treatment_Mode_States
 *
 * <h2 class="groupheader">Logging info</h2>
 * |          ||
 * |          ||
 * | typeText | Datum |
 * | unitText | HD    |
 * | infoText | TreatmentLogAlarm |
 *
 */
class MTreatmentLogAlarmData : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32  mAlarmID    ;  ///< Alarm ID
        Types::F32  mParam1     ;  ///< Alarm Parameter 1 // may need more than 1 parameter but defined one so it would be easier to add more later.
        Types::F32  mParam2     ;  ///< Alarm Parameter 2 // may need more than 1 parameter but defined one so it would be easier to add more later.
    } _data;

public:

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

    struct Data {
        quint64     mTimeStamp  ;  ///< Timestamp of the received message in secs since epoch
        quint32     mAlarmID    ;  ///< Alarm ID
        float       mParam1     ;  ///< Alarm Parameter 1
        float       mParam2     ;  ///< Alarm Parameter 2
    };

    MTreatmentLogAlarmData() { }

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

typedef Model::MTreatmentLogAlarmData::Data TreatmentLogAlarmData;