USGS

Isis 3.0 Developer's Reference (API)

Home

Progress.h

Go to the documentation of this file.
00001 #ifndef Progress_h
00002 #define Progress_h
00003 
00025 #include <string>
00026 
00027 namespace Isis {
00053   class Progress {
00054     private:
00055       std::string p_text;     
00057       int p_maximumSteps;     
00060       int p_currentStep;      
00063       int p_currentPercent;   
00067       int p_percentIncrement; 
00069       bool p_printPercent;
00070 
00071     public:
00072       // constructor
00073       Progress();
00074 
00075       // destructor
00076       ~Progress();
00077 
00078       // Change the text std::string
00079       void SetText(const std::string &text);
00080 
00081       // Get the text string
00082       std::string Text() const;
00083 
00084       // Change the maximum steps
00085       void SetMaximumSteps(const int steps);
00086 
00087       // Add steps before completion (for guessed initial step size)
00088       void AddSteps(const int steps);
00089 
00090       // Check and report status
00091       void CheckStatus();
00092   };
00093 };
00094 
00095 #endif