/*!
 *
 * Copyright (c) 2023 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    UiUpdateStatus.h
 * \author  (last)      Phil Braica
 * \date    (last)      23-Jan-2023
 * \author  (original)  Phil Braica
 * \date    (original)  23-Jan-2023
 *
 */
 
#ifndef UI_UPDATE_STATUS_H_
#define UI_UPDATE_STATUS_H_

#include "HalStdTypes.h"
#include <string>

namespace SwUpdate {
        
struct UiUpdateStatus {

    /*!
     * \brief   Constructor.
     */
    UiUpdateStatus() :
        goal("Idle"),
        targetName(""),
        stepIndex(0),
        totalSteps(0),
        stepName(""),
        percentTotal(0),
        inProgress(false) {

        ; // NOP.
    }

    ::std::string   goal;           ///< Either "Idle", "Complete" or "Shutdown". 
    ::std::string   targetName;     ///< Linux, UI, DG, DGFPGA, HG, HGFPGA
    uint32          stepIndex;      ///< Which step.
    uint32          totalSteps;     ///< Out of how many steps.
    ::std::string   stepName;       ///< Step name.
    float           percentTotal;   ///< Percent of all steps (estimated).
    bool            inProgress;     ///< In progress or was this the abort/fail/complete point.
};

} // namespace SwUpdate

#endif // UI_UPDATE_STATUS_H_