progress.h

/*
** Copyright 2007-2025, RTE (https://www.rte-france.com)
** See AUTHORS.txt
** SPDX-License-Identifier: MPL-2.0
** This file is part of Antares-Simulator,
** Adequacy and Performance assessment for interconnected energy networks.
**
** Antares_Simulator is free software: you can redistribute it and/or modify
** it under the terms of the Mozilla Public Licence 2.0 as published by
** the Mozilla Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** Antares_Simulator is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** Mozilla Public Licence 2.0 for more details.
**
** You should have received a copy of the Mozilla Public Licence 2.0
** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
*/
#ifndef __STUDY_JOB_AGGREGATOR_PROGRESS_H__
#define __STUDY_JOB_AGGREGATOR_PROGRESS_H__
 
#include <atomic>
 
#include <yuni/thread/timer.h>
 
#include <antares/logs/logs.h>
 
class Progress final: public Yuni::Thread::Timer
{
public:
    using ThreadingPolicy = Yuni::Thread::Timer::ThreadingPolicy;
 
    enum State
    {
        stJobs,
        stWrite,
        stReading,
        stSilent,
    };
 
public:
    static std::atomic<int> Current;
    static uint Total;
 
public:
    Progress();
    virtual ~Progress();
 
    bool completed() const;
 
    template<class StringT>
    void message(const StringT& msg);
 
public:
    State state;
 
protected:
    virtual bool onInterval(uint) override;
 
private:
    bool pCompleted;
    Yuni::String pMessage;
    uint pLastPercent;
 
}; // class Progress
 
extern Progress progressBar;
 
#include "progress.hxx"
 
#endif // __STUDY_JOB_AGGREGATOR_PROGRESS_H__