/*!
 *
 * 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    MAdjustHDRequests.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      16-Apr-2021
 * \author  (original)  Behrouz NematiPour
 * \date    (original)  16-Apr-2021
 *
 */

#pragma once

// Qt

//project
#include "MAdjustRequestsBase.h"

using namespace Gui;

namespace Model {

/*!
 * Simple request models
 * These are models to send the request for the doAdjustment
 * The the only reason thy have been defined to help overloading the adjustment methods
 * Otherwise the parameters are so tiny models.
 */

/*!
 * \brief   The MAdjustHDDateTime class
 * \details The model to request starting a treatment
 *
 * |  MSG | CAN ID | Type | Ack | Src | Dest | Description |
 * |:----:|:------:|:----:|:---:|:---:|:----:|:-----------:|
 * | 109  | 0x100  | Req  | Y   | UI  | HD   | Set RTC Date and Time   |
 *
 * | Payload ||
 * |         ||
 * | #1:(U32) mEpoch | \ref mEpoch |
 *
 */
class MAdjustHDDateTimeReq : public MModel {
public:
    quint32 mEpoch;
    // coco begin validated : Has been validated manually.
    QString toString() {
        return toString({mEpoch});
    }
    // coco end
    static QString toString(const QVariantList &vParameters) {
        return MModel::toString("AdjustHDDateTime", vParameters);
    }
};

/*!
 * \brief   The MAdjustAlarmVolumeReq class
 * \details The HD alarm volume request model
 *
 * |   MSG  | CAN ID | Type | Ack | Src | Dest | Description |
 * |:------:|:------:|:----:|:---:|:---:|:----:|:-----------:|
 * | 0x4E00 | 0x100  | Req  | Y   | UI  | HD   | HD Set Alarm Volume Request |
 *
 * | Payload ||
 * |         ||
 * | #1:(U32) volume | \ref MAdjustHDAlarmVolumeResponse |
 *
 */
class MAdjustHDAlarmVolumeReq : public MModel {
public:

    quint32 volume;

    // coco begin validated : Has been validated manually.
    // This object is used statically for now, kept the logic for later usage.
    QString toString() {
        return toString( { volume } );
    }
    // coco end
    static QString toString(const QVariantList &vParameters) {
        return MModel::toString("AdjustHDAlarmVolume", vParameters);
    }
};

/*!
 * \brief   The MAdjustUIPostFinalResultRequest class
 * \details The UI power on self test result model
 *
 * |   MSG  | CAN ID | Type | Ack | Src | Dest | Description |
 * |:------:|:------:|:----:|:---:|:---:|:----:|:-----------:|
 * | 0x9200 | 0x100  | Req  | Y   | UI  | HD   | Report UI POST result |
 *
 * | Payload ||
 * |         ||
 * | #1:(U32) mResult | \ref mResult |
 *
 */
class MAdjustUIPostFinalResultReq : public MModel {
public:

    quint32 mResult;

    // coco begin validated : Has been validated manually.
    // This object is used statically for now, kept the logic for later usage.
    QString toString() {
        return toString( { mResult } );
    }
    // coco end
    static QString toString(const QVariantList &vParameters) {
        return MModel::toString("AdjustUIPostFinalResult", vParameters);
    }
};


/*!
 * \brief   The MAdjustUIReportVersionRequest class
 * \details The UI power on self test version reporting model
 *
 * |   MSG  | CAN ID | Type | Ack | Src | Dest | Description |
 * |:------:|:------:|:----:|:---:|:---:|:----:|:-----------:|
 * | 0x9F00 | 0x100  | Req  | Y   | UI  | HD   | Report UI version on POST |
 *
 * | Payload ||
 * |         ||
 * | #1:(U32) mResult | \ref mResult |
 * | #2:(U32) mMinor  | \ref mMinor  |
 * | #3:(U32) mMicro  | \ref mMicro  |
 * | #4:(U32) mBuild  | \ref mBuild  |
 * | #5:(U32) mCompat | \ref mCompat |
 *
 */
class MAdjustUIReportVersionRequest : public MModel {
public:

    quint8 mMajor;
    quint8 mMinor;
    quint8 mMicro;
    quint16 mBuild;
    quint32 mCompat;

    // coco begin validated : Has been validated manually.
    // This object is used statically for now, kept the logic for later usage.
    QString toString() {
        return toString( { mMajor,
                             mMinor,
                             mMicro,
                             mBuild,
                             mCompat
                         } );
    }
    // coco end
    static QString toString(const QVariantList &vParameters) {
        return MModel::toString("AdjustUIReportVersion", vParameters);
    }
};
}

typedef Model::MAdjustHDDateTimeReq                    AdjustHDDateTimeRequestData;
typedef Model::MAdjustHDAlarmVolumeReq              AdjustHDAlarmVolumeRequestData;
typedef Model::MAdjustUIPostFinalResultReq      AdjustUIPostFinalResultRequestData;
typedef Model::MAdjustUIReportVersionRequest  AdjustUIPostReportVersionRequestData;