CRNProgress.h

Go to the documentation of this file.

/* Copyright 2007-2016 Yann LEYDIER, CoReNum, INSA-Lyon, Université Paris Descartes, ENS-Lyon
 * 
 * This file is part of libcrn.
 * 
 * libcrn is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * libcrn 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 libcrn.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * file: CRNProgress.h
 * \author Yann LEYDIER
 */

#ifndef CRNPROGRESS_HEADER
#define CRNPROGRESS_HEADER

#include <CRNString.h>

namespace crn
{
    /****************************************************************************/
    class Progress
    {
        public:
            enum class Type { PERCENT = 0, ABSOLUTE = 1 };
            Progress(const String &nam, size_t maxcount = 100):name(nam),end(maxcount),current(0),type(Type::PERCENT) { }
            Progress(const Progress &) = delete;
            Progress(Progress&&) = default;
            Progress& operator=(const Progress &) = delete;
            Progress& operator=(Progress&&) = default;

            virtual ~Progress();

            void Advance();
            void SetMaxCount(size_t maxcount, bool reset = true) { end = maxcount; if (reset) Reset(); }
            void Reset();

            void SetType(Type typ) noexcept { type = typ; }

            void SetName(const crn::String &nam) { name = nam; }

        protected:
            virtual void display(const String &msg) = 0;

            String name;
            size_t current; 
            size_t end; 
            String disp; 
            Type type; 
    };

    CRN_ALIAS_SMART_PTR(Progress)

    /****************************************************************************/
    class ConsoleProgress: public Progress
    {
        public:
            ConsoleProgress(const String &name, size_t maxcount = 100):Progress(name, maxcount) {}
            virtual ~ConsoleProgress() override {}

        protected:
            virtual void display(const String &msg) override;
    };

    CRN_ALIAS_SMART_PTR(ConsoleProgress)
}

#endif