/*!
 *
 * Copyright (c) 2020-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    MTDOpModeData.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      18-May-2021
 * \author  (original)  Behrouz NemaiPour
 * \date    (original)  02-Jul-2020
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MTDOpMode class
 * \details The HD operation mode data model
 *
 * | MSG  | CAN ID | Type   | Ack | Src | Dst | Description            |
 * |:----:|:------:|:------:|:---:|:---:|:---:|:-----------:           |
 * |0x2500| 0x040  | 1 Hz   | N   | HD  | All | HD Operation Mode Data |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mOpMode  |
 * | #2:(U32) | \ref Data::mSubMode |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |          ||
 * |          ||
 * | typeText | Datum  |
 * | unitText | HD     |
 * | infoText | OpMode |
 *
 */
class MTDOpMode : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32  mOpMode     ;
        Types::U32  mSubMode    ;
    } _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("OpMode"); }

    struct Data {
        quint32     mOpMode     = 0;  ///< HD operation mode
        quint32     mSubMode    = 0;  ///< HD operation sub mode. In each OpMode sub mode has different meaning regarding the OpMode.
    };

    MTDOpMode () {}

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

typedef Model::MTDOpMode::Data TDOpModeData;