Progress.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2024, EPFL/Blue Brain Project
 *
 * Responsible Author: Daniel.Nachbaur@epfl.ch
 *
 * This file is part of Blue Brain BioExplorer <https://github.com/BlueBrain/BioExplorer>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library 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 GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <platform/core/common/BaseObject.h>
 
#include <functional>
#include <mutex>
#include <string>
 
namespace core
{
class Progress : public BaseObject
{
public:
    Progress() = default;
    explicit Progress(const std::string& operation)
        : _operation(operation)
    {
    }
 
    void update(const std::string& operation, const float amount)
    {
        std::lock_guard<std::mutex> lock_(_mutex);
        _updateValue(_operation, operation);
        _updateValue(_amount, amount);
    }
 
    void increment(const std::string& operation, const float increment)
    {
        std::lock_guard<std::mutex> lock_(_mutex);
        _updateValue(_operation, operation);
        _updateValue(_amount, _amount + increment);
    }
 
    void consume(std::function<void(std::string, float)> callback)
    {
        std::lock_guard<std::mutex> lock_(_mutex);
        if (isModified())
        {
            callback(_operation, _amount);
            resetModified();
        }
    }
 
private:
    std::string _operation;
    float _amount{0.f};
    std::mutex _mutex;
};
} // namespace core