progressmonitor.h

Go to the documentation of this file.

/*
    Sheep - A Rigid Body Dynamics Engine
    Copyright (C) 2001-2004 Francois Beaune
    Contact: http://toxicengine.sourceforge.net/

    This file is part of Sheep.

    Sheep is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    Sheep 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Sheep; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef SHEEP_MISC_PROGRESSMONITOR_H
#define SHEEP_MISC_PROGRESSMONITOR_H

#include "common/math/real.h"

#include <cassert>
#include <string>

namespace sheep {

    class ProgressMonitor {
    public:
        //! Initializes the object by calling the Reset() method.
        ProgressMonitor();

        //! Resets this ProgressMonitor object.
        void Reset();

        //! Starts a new job. Cumulated duration of all jobs must be equal to 1.0.
        //! Triggers the update callback.
        void StartJob(Real range_min, Real range_max, Real duration = 1.0);

        //! Ends the current job. Triggers the update callback.
        void EndJob();

        //! Any resolution below or equal 0.0 will make the UpdateCallback() method
        //! be called at each progress update. Maximum resolution is 1.0. Default
        //! resolution is 1.0 / 100.
        void SetUpdateResolution(Real resolution);

        //! Changes the current message. Triggers the update callback.
        void SetMessage(const std::string &message);

        //! Returns the current message.
        const std::string &GetMessage() const;

        //! Sets the current job's progress. 'progress' must lies in [range_min, range_max].
        //! Triggers the update callback.
        void SetJobProgress(Real progress);

        //! Returns the total progress. This is the value that should be displayed.
        Real GetProgress() const;

        //! This method should be called when all jobs are done. It calls EndJob()
        //! if necessary. Triggers the update callback.
        void Done();

        //! Returns true if all jobs are done, false otherwise.
        bool IsDone() const;

        //! Typically implemented using GetProgress(), IsDone() and GetMessage() methods.
        virtual void UpdateCallback() = 0;

    private:
        Real m_job_start;           //!< Start time of the current job.
        Real m_job_duration;        //!< Duration of the current job.
        Real m_job_range_min;       //!< Lower bound of the current job's range.
        Real m_job_range_max;       //!< Upper bound of the current job's range.
        Real m_job_progress_scale;  //!< m_job_duration / (m_job_range_max - m_job_range_min).
        bool m_job_done;            //!< Is the current job done?

        Real m_update_resolution;   //!< Minimum progress change required to trigger the update callback.
        std::string m_message;      //!< Current message.

        Real m_progress;            //!< Total progress.
        bool m_done;                //!< Are all jobs done?

        Real m_last_update;         //!< Time of the last update.

        void post_update();
    };

#include "progressmonitor.inl"

}

#endif  // !SHEEP_MISC_PROGRESSMONITOR_H

---