ProgressCallback.h

/*
 * Copyright 2020 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
#pragma once
 
#include <lagrange/api.h>
 
#include <tbb/spin_mutex.h>
#include <atomic>
#include <functional>
#include <string>
 
namespace lagrange {

class LA_CORE_API ProgressCallback
{
public:
    ProgressCallback(
        std::function<void(const std::string&, float)> func = nullptr,
        std::string name = "",
        size_t num_iterations = 1);

    void set_callback(std::function<void(const std::string&, float)> func);

    void set_section(std::string name, size_t num_iterations = 1);

    const std::string& get_section() const { return m_section_name; }

    void set_num_iterations(size_t num_iterations);

    void advance(size_t increment);

    void update();

    void update(float progress);

    void set_verbose(bool verbose) { m_verbose = verbose; }
 
private:
    std::function<void(const std::string&, float)> m_callback;

    std::string m_section_name;

    size_t m_num_iterations = 1;

    std::atomic_size_t m_current_iteration = {0};

    float m_last_progress = 0.f;

    tbb::spin_mutex m_mutex;

    bool m_verbose = false;
};
 
} // namespace lagrange