progress.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2000-2022 Inria
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation
 *  and/or other materials provided with the distribution.
 *  * Neither the name of the ALICE Project-Team nor the names of its
 *  contributors may be used to endorse or promote products derived from this
 *  software without specific prior written permission.
 * 
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 *  Contact: Bruno Levy
 *
 *     https://www.inria.fr/fr/bruno-levy
 *
 *     Inria,
 *     Domaine de Voluceau,
 *     78150 Le Chesnay - Rocquencourt
 *     FRANCE
 *
 */
 
#ifndef GEOGRAM_BASIC_PROGRESS
#define GEOGRAM_BASIC_PROGRESS
 
#include <geogram/basic/common.h>
#include <geogram/basic/logger.h>
#include <geogram/basic/counted.h>
#include <geogram/basic/smart_pointer.h>
 
namespace GEO {
 
    class GEOGRAM_API ProgressClient : public Counted {
    public:
        virtual void begin() = 0;
 
        virtual void progress(index_t step, index_t percent) = 0;
 
        virtual void end(bool canceled) = 0;
 
    protected:
         ~ProgressClient() override;
    };
 
    typedef SmartPointer<ProgressClient> ProgressClient_var;
 
    /************************************************************************/
 
    struct GEOGRAM_API TaskCanceled : std::exception {
        const char* what() const GEO_NOEXCEPT override;
    };
 
    /************************************************************************/
 
    class ProgressTask;
 
    namespace Progress {
        void GEOGRAM_API initialize();
 
        void GEOGRAM_API terminate();
 
        void GEOGRAM_API set_client(ProgressClient* client);
 
        GEOGRAM_API const ProgressTask* current_progress_task();
 
        void GEOGRAM_API cancel();
 
        bool GEOGRAM_API is_canceled();
 
        void GEOGRAM_API clear_canceled();
    }
 
    /************************************************************************/
 
    class GEOGRAM_API ProgressTask {
    public:
        ProgressTask(
            const std::string& task_name, index_t max_steps,
            bool quiet 
        );
 
        ProgressTask(
            const std::string& task_name = "", index_t max_steps = 100
        );
 
        virtual ~ProgressTask();
 
        virtual void progress(index_t step);
 
        virtual void next();
 
        bool is_canceled() const;
 
        void reset();
 
        void reset(index_t max_steps);
 
        const std::string& task_name() const {
            return task_name_;
        }
 
        double start_time() const {
            return start_time_;
        }
 
        index_t max_steps() const {
            return max_steps_;
        }
 
        index_t step() const {
            return step_;
        }
 
        index_t percent() const {
            return percent_;
        }
 
    protected:
        virtual void update();
 
    private:
        std::string task_name_;
        double start_time_;
        bool quiet_;
        index_t max_steps_;
        index_t step_;
        index_t percent_;
    };
}
 
#endif