/*!
 *
 * Copyright (c) 2020-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    MAbstract.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      04-Aug-2021
 * \author  (original)  Behrouz NemaiPour
 * \date    (original)  02-Jul-2020
 *
 */

#pragma once

// Qt
#include <QString>
#include <QVariantList>

// Project

namespace Model {

/*!
 * \page    GeneralModelsDescription General Models Description
 *          The Models are the entities which keep the data and methods to manipulate the data.
 *          The UI Application is using different types of models in different situations.
 *          One use case, as the Denali Device is using the Denali Message Protocol over the CANBus for all the messaging transactions
 *          and almost all the Messages carrying data payloads of a model object for each message,
 *          is keeping the data for that specific message.
 *          So for each message there is a model to keep the structured data.
 *          Each model has been described in its class.
 *
 *          The Models using for Denali Messaging depending on the Unit on the CANBus and the type of the messages categorized into :
 *
 * **Units on the CANBus :**
 * |       |       |     |
 * |:-----:|:-----:|:---:|
 * | UI    | HD    | DG  |
 *
 * **Type of messages known at the moment :**
 * |        |      |             |        |
 * |:------:|:----:|:-----------:|:------:|
 * | Events | Data | Adjustments | Alarms |
 *
 */

/*!
 * \brief   The MAbstract class
 * \details All the Message Models has to be inherited from MAbstract.
 *          As this class is abstract it dictates children to implement required methods.
 *          And also implements some share methods to ease implementing Models.
 */
class MAbstract {

private:
    const char _delimiter = ',';
    quint8     _precision =   3;

public:
    enum class Type_Enum {
        eDatum,
        eEvent,
    };

    enum class Unit_Enum {
        eUI,
        eHD,
        eDG,
        eDV,
    };

private:
    typedef QMap<Type_Enum,QString> TypeMap;
    static const TypeMap _typeText;
    static const TypeMap _typeText_make() {
        static const TypeMap map {
            {MAbstract::Type_Enum::eDatum, "D"},
            {MAbstract::Type_Enum::eEvent, "E"}
        };
        return map;
    }

    typedef QMap<Unit_Enum,QString> UnitMap;
    static const UnitMap _unitText;
    static const UnitMap _unitText_make() {
        static const UnitMap map {
            {MAbstract::Unit_Enum::eUI, "UI"},
            {MAbstract::Unit_Enum::eHD, "HD"},
            {MAbstract::Unit_Enum::eDG, "DG"},
            {MAbstract::Unit_Enum::eDV, "DV"}
        };
        return map;
    }

public:
    static const QString unitText(const Unit_Enum &vEnum) {
        return _unitText[vEnum];
    }
    static const QString typeText(const Type_Enum &vEnum) {
        return _typeText[vEnum];
    }


    // the model needs to implement these since each model have different meaning of the bytes from different source(unit).

    /*!
     * \brief   fromByteArray
     * \details converts the values from Byte Arrays to the Model data.
     * \param   vByteArray - the byte array input
     * \param   vIndex     - current index of each data section in byte array
     * \return  true on successful conversion
     */
    virtual bool         fromByteArray(const QByteArray   &vByteArray  , int *vIndex = nullptr)       = 0;
    /*!
     * \brief   typeText
     * \details type of the model which can be Data or Event which is mostly used in logging.
     * \return  Enum of Types
     */
    virtual Type_Enum    typeText     () const = 0;
    /*!
     * \brief   unitText
     * \details the unit which UI communicates with by using this model and is used in Logging mostly
     * \return  Enum of Units
     */
    virtual Unit_Enum    unitText     () const = 0;
    /*!
     * \brief   infoText
     * \details the text description of the model which will be used in the logging.
     * \return  QString
     */
    virtual QString      infoText     () const = 0;
    /*!
     * \brief   parameters
     * \return  current data values of the models.
     */
    virtual QVariantList parameters   () const = 0;
    /*!
     * \brief   size
     * \return  This has to be implemented in each child to return the message payload length.
     */
    // TODO : The message length can be get from the model itself but currently we have an enum for that.
    // It needs work and will be done later.
    // virtual quint32      size         () const = 0;

    // Non-virtual methods which working with parameters virtual method.
    void    toVariantList(QVariantList &vData) const;
    QString toString     (                   ) const;
    QString description  (                   ) const;
};
}