/*!
 *
 * Copyright (c) 2021-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    MHDGeneralEvent.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      07-Oct-2021
 * \author  (original)  Behrouz NematiPour
 * \date    (original)  07-Oct-2021
 *
 */
#pragma once

// Qt

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MHDGeneralEvent class
 * \details The HD General Event model
 *
 * | MSG  | CAN ID | Type   | Ack | Src | Dst | Description |
 * |:----:|:------:|:------:|:---:|:---:|:---:|:-----------:|
 * |0xA400| 0x020  | Event  |  N  | HD  | UI  | HD General Event |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mEventID          |
 * | #2:(U32) | \ref Data::mFieldDescriptor1 |
 * | #3:(Any) | \ref Data::mDataField1       |
 * | #4:(U32) | \ref Data::mFieldDescriptor2 |
 * | #5:(Any) | \ref Data::mDataField2       |
 *
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Event   |
 * | unitText     | HD      |
 * | infoText     | General |
 *
 */
class MHDGeneralEvent : public MAbstractDynamic {

    // friends
    friend class ::tst_models;

public:
    Type_Enum    typeText() const override { return Type_Enum::eEvent    ; }
    Unit_Enum    unitText() const override { return Unit_Enum::eHD       ; }
    QString      infoText() const override { return QString("General"  ) ; }

    struct Data {
        quint32     mEventID         = 0;
        quint32     mFieldDescriptor1   ;
        quint32     mDataFieldU1        ;
        qint32      mDataFieldS1        ;
        float       mDataFieldF1        ;
        bool        mDataFieldB1        ;
        quint32     mFieldDescriptor2   ;
        quint32     mDataFieldU2        ;
        qint32      mDataFieldS2        ;
        float       mDataFieldF2        ;
        bool        mDataFieldB2        ;
    };

public:
    MHDGeneralEvent () { }

    Data data       () const;
};
}

typedef Model::MHDGeneralEvent::Data HDGeneralEventData;