/*!
 *
 * 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    MAdjustTDVersionsResponse.h
 * \author  (last)      Michael Garthwaite
 * \date    (last)      28-Feb-2022
 * \author  (original)  Behrouz NematiPour
 * \date    (original)  16-Apr-2021
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MAdjustVersionsTDResponse class
 * \details The TD versions data model
 *
 * |   MSG  | CAN ID | Type | Ack | Src | Dest | Description           |
 * |:------:|:------:|:----:|:---:|:---:|:----:|:---------------------:|
 * | 0x0E00 | 0x100  | Rsp  | Y   | TD  | All  | TD Versions Data      |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U08) | \ref Data::mTDMajor             |
 * | #2:(U08) | \ref Data::mTDMinor             |
 * | #3:(U08) | \ref Data::mTDMicro             |
 * | #4:(U16) | \ref Data::mTDBuild             |
 * | #5:(U08) | \ref Data::mTDFPGAId            |
 * | #6:(U08) | \ref Data::mTDFPGAMajor         |
 * | #7:(U08) | \ref Data::mTDFPGAMinor         |
 * | #8:(U08) | \ref Data::mTDFPGALab           |
 * | #9:(U32) | \ref Data::mCompatibilityRev    |
 *
 * \sa Data
 * \sa MAdjustVersionsTDResponse : TD Versions Response Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |          ||
 * |          ||
 * | typeText | Event |
 * | unitText | TD    |
 * | infoText | VersionRsp |
 *
 */
class MAdjustVersionsTDResponse : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U08 mMajor               ;
        Types::U08 mMinor               ;
        Types::U08 mMicro               ;
        Types::U16 mBuild               ;
        Types::U08 mFPGAId              ;
        Types::U08 mFPGAMajor           ;
        Types::U08 mFPGAMinor           ;
        Types::U08 mFPGALab             ;
        Types::U32 mCompatibilityRev    ;
    } _data;

public:

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

    struct Data {
        quint8  mMajor              = 0;  /*!< TD Versions Major      value of type quint8 extracted out */
        quint8  mMinor              = 0;  /*!< TD Versions Minor      value of type quint8 extracted out */
        quint8  mMicro              = 0;  /*!< TD Versions Micro      value of type quint8 extracted out */
        quint16 mBuild              = 0;  /*!< TD Versions Build      value of type quint16 extracted out */
        quint8  mFPGAId             = 0;  /*!< TD Versions FPGA ID    value of type quint8 extracted out */
        quint8  mFPGAMajor          = 0;  /*!< TD Versions FPGA Major value of type quint8 extracted out */
        quint8  mFPGAMinor          = 0;  /*!< TD Versions FPGA Minor value of type quint8 extracted out */
        quint8  mFPGALab            = 0;  /*!< TD Versions FPGA Lab   value of type quint8 extracted out */
        quint32 mCompatibilityRev   = 0;  /*!< TD Versions Compatibility Revision */
    };

    MAdjustVersionsTDResponse () { }

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

typedef Model::MAdjustVersionsTDResponse::Data AdjustVersionsTDResponseData;