/*!
 *
 * Copyright (c) 2019-2020 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    MAlarmClearedCondition.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      11-Dec-2020
 * \author  (original)  Behrouz NemaiPour
 * \date    (original)  11-Dec-2020
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MAlarmConditionCleared class
 * \details The alarm condition cleared model
 *
 * | MSG  | CAN ID     | M.Box | Type | Ack | Src | Dest | Description              |
 * |:----:|:----------:|:-----:|:----:|:---:|:---:|:----:|:------------------------:|
 * |0x3F00| 0x001,2,4  |  N/A  | Cmd  | Y   | UI  | HD   | Alarm Condition Cleared |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref alarmID |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Event           |
 * | unitText     | HD              |
 * | infoText     | Alarm Condition |
 *
 */
class MAlarmClearedCondition : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32  mAlarmID    ;
    } _data;

public:
    // coco begin validated: Manually tested. This model class is a placeholder for the message 63(0x3F00) and there is no use case for this now.
    Type_Enum    typeText() const override { return Type_Enum::eEvent         ; }
    Unit_Enum    unitText() const override { return Unit_Enum::eHD            ; }
    QString      infoText() const override { return QString("AlarmCondition") ; }
    // coco end
    struct Data {
        quint32     mAlarmID = 0;  ///< Alarm ID
    };

public:
    MAlarmClearedCondition () { }

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

typedef Model::MAlarmClearedCondition::Data AlarmClearedConditionData;