VRS - The Virtual Rendering System

version 3.3

progress.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2000-2008 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * This  library  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 2.1 of the License, or (at
 * your option) any later version. 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 FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

#ifndef VRS_PROGRESS_H
#define VRS_PROGRESS_H

#include <vrs/config.h>

namespace VRS {

    class VRS_CORE_API Progress {

    public:
        Progress(
            const std::string& description,
            double totalValue,
            bool forceShow = false,
            bool allowChildProgress = true
        );
        ~Progress();

        std::string description() const;
        double totalValue() const;
        double currentValue() const;
        double percent() const;
        bool isCanceled() const;
        double timeElapsed() const;
        std::string timeElapsedString() const;
        double timeRemaining() const;
        std::string timeRemainingString() const;
        bool update(double complete, const std::string& newDescription = std::string());
        bool finish();
        void cancel();
    private:
        // disable operators new & delete
        static void* operator new(size_t);
        static void operator delete(void*);

        std::string description_;
        double totalValue_;
        double currentValue_; // 0.0 <= currentValue_ <= totalValue_ or currentValue_ = -1.0
        double timeStarted_;
        bool allowChildProgress_;
        bool isActive_;
        bool isFinished_; // flag, if the "finished" method has been called
        bool isCanceled_;
    }; // class Progress

} // namespace VRS

#endif // VRS_PROGRESS_H

---

Generated on Sat May 18 06:00:19 2013 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact