/*!
 *
 * 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    MPostTreatmentStatesData.h
 * \author  (last)      Behrouz NematiPour
 * \date    (last)      30-Mar-2023
 * \author  (original)  Behrouz NematiPour
 * \date    (original)  11-Apr-2021
 *
 */
#pragma once

// Qt
#include <QString>

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

// forward declarations
class tst_models;

namespace Model {

/*!
 * \brief   The MPostTreatmentStates class
 * \details The post treatment states data model
 *          These are states of the post treatment.
 *
 * | MSG  | CAN ID | Type   | Ack | Src | Dst | Description                |
 * |:----:|:------:|:------:|:---:|:---:|:---:|:-----------:               |
 * |0x7700| 0x040  | 1 Hz   | N   | HD  | All | Post-Treatment States Data |
 *
 * | Payload  ||
 * |          ||
 * | #1:(U32) | \ref Data::mSubMode     |
 * | #2:(U32) | \ref Data::mDrainState  |
 *
 * \sa Data
 * \sa HD_Post_Treatment_Mode_States
 *
 * <h2 class="groupheader">Logging info</h2>
 * |              ||
 * |              ||
 * | typeText     | Datum               |
 * | unitText     | HD                  |
 * | infoText     | PostTreatmentStates |
 *
 */
class MPostTreatmentStates : public MAbstract {

    // friends
    friend class ::tst_models;

    QVariantList parameters() const override;

    struct {
        Types::U32 mSubMode        ;  ///< State - HD_Post_Treatment_Mode_States
        Types::U32 mDrainState     ;  ///< State - Drain_States - Post-Treatment drain reservoirs state machine [Not currently being used]
    } _data;

public:

    Type_Enum    typeText  () const override { return Type_Enum::eDatum            ; }
    Unit_Enum    unitText  () const override { return Unit_Enum::eHD               ; }
    QString      infoText  () const override { return QString("PostTreatmentStates"); }

    struct Data {
        quint32    mSubMode     = 0;  ///< State - HD_Post_Treatment_Mode_States
        quint32    mDrainState  = 0;  ///< State - ???
    };

    MPostTreatmentStates() { }

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

typedef Model::MPostTreatmentStates::Data PostTreatmentStatesData;