/*!
 *
 * 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 MAlarmTriggered.h
 * \author (last) Behrouz NemaiPour
 * \date (last) 02-Jul-2020
 * \author (original) Behrouz NemaiPour
 * \date (original) 02-Jul-2020
 *
 */
#pragma once

// Qt
#include <QString>

// Project
#include "types.h"

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MAlarmTriggered class
 * \details The alarm triggered model
 *
 * | MSG  | CAN ID | Box | Type   | Ack | Src | Dst | Description     |
 * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------:    |
 * |0x0300| 0x001  | 1   | Event  | Y   | HD  | All | Alarm Triggered |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mAlarmID |
 *
 * \sa Data
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Event           |
 * | unitText     | HD              |
 * | infoText     | Alarm Triggered |
 *
 */
class MAlarmTriggered {

    // friends
    friend class ::tst_models;

public:
    QString  stringPrefix = "Alarm Triggered";
    struct Data {
        quint32     mAlarmID = 0;  ///< Alarm ID
    };

private:
    struct {
        Types::U32  mAlarmID    ;
    } _data;

public:
    MAlarmTriggered () { }

    QString toString        (                               ) const ;
    void    toVariantList   (      QVariantList &vData      ) const ;
    bool    fromByteArray   (const QByteArray   &vByteArray  , int *vIndex = nullptr);

    Data    data() const;
};
}

typedef Model::MAlarmTriggered::Data AlarmTriggeredData;