ms_progress_info.hpp

/*
##############################################################################
# file: ms_progress_info.hpp
# 'msparser' toolkit
# Current progress through a file load or dave
##############################################################################
# COPYRIGHT NOTICE
# Copyright 1998-2014 Matrix Science Limited  All Rights Reserved.
#
##############################################################################
 * @(#)$Source: parser/inc/ms_progress_info.hpp $
 * @(#)$Revision: 13eeeb76d98cb3364b3262ac81b740f5a2a28aba | MSPARSER_REL_2_8_1-0-gea32989045 $
 * @(#)$Date: 2018-10-18 17:21:45 +0100 $
##############################################################################
 */

#ifndef MS_PROGRESS_INFO_HPP
#define MS_PROGRESS_INFO_HPP


// Includes from the standard template library
#include <list>
#include <string>

namespace matrix_science
{
    //=========================================================================
    class ms_progress_info;


    class MS_MASCOTRESFILE_API ms_progress_info
    {
        public:
            enum STATUS
            {
                S_NOT_STARTED, 
                S_RUNNING, 
                S_RUNNING_INDETERMINATE, 
                S_STOPPED_FAIL, 
                S_STOPPED_BREAK, 
                S_STOPPED_COMPLETE 
            };

            ms_progress_info();

            ms_progress_info(const std::string & description, size_t total);

            ~ms_progress_info();

            void clear(const std::string & description = "", size_t total = 0);
            STATUS getStatus() const;
            const std::string & getDescription() const;
            size_t getTotal() const;
            size_t getProgress() const;
            int getNumberOfSubtasks() const;
            const ms_progress_info * getSubtaskProgress(int index) const;
            void setBreak() const;

            ms_progress_info * addSubtask(const std::string & description, size_t total);
            void addSubtask(const ms_progress_info * task);
            void updateProgress(size_t progress, size_t total);
            void updateFail();
            void updateBreak();
            void updateComplete();
            void updateIndeterminate();
            bool isBreaking() const;
            void removeSubtask(int index);

        private:
            // noncopyable
            ms_progress_info(const ms_progress_info &);
            void operator= (const ms_progress_info &);

            std::string description_;
            STATUS status_;
            size_t total_;
            size_t progress_;
            mutable bool break_;

            // The bool item in the list is used to specify whether the parent 
            // destructor should delete the child object. 
            // If the object is created by calling 
            // addSubtask(description, total) then it has been created by the
            // parent and will be deleted by the parent. 
            std::list<std::pair<bool, ms_progress_info*> > subtasks_;
    };
 // end of quantitation_group
    //=========================================================================

} // namespace matrix_science

#endif // MS_PROGRESS_INFO_HPP

/*------------------------------- End of File -------------------------------*/