Isis 3 Programmer Reference
Progress.h
Go to the documentation of this file.
1 #ifndef Progress_h
2 #define Progress_h
3 
25 #include <QString>
26 
27 namespace Isis {
58  class Progress {
59  public:
60  // constructor
61  Progress();
62 
63  // destructor
64  ~Progress();
65 
66  // Change the text QString
67  void SetText(const QString &text);
68 
69  // Get the text string
70  QString Text() const;
71 
72  // Change the maximum steps
73  void SetMaximumSteps(const int steps);
74 
75  // Add steps before completion (for guessed initial step size)
76  void AddSteps(const int steps);
77 
78  // Check and report status
79  void CheckStatus();
80 
82 
83  int MaximumSteps() const;
84 
85  int CurrentStep() const;
86 
87  private:
88  QString p_text;
102  bool p_printPercent;
103 
104  bool p_autoDisplay;
105  };
106 };
107 
108 #endif
int p_maximumSteps
Number of steps in your processing sequence.
Definition: Progress.h:90
void SetMaximumSteps(const int steps)
This sets the maximum number of steps in the process.
Definition: Progress.cpp:101
void DisableAutomaticDisplay()
Turns off updating the Isis Gui when CheckStatus() is called.
Definition: Progress.cpp:177
void CheckStatus()
Checks and updates the status.
Definition: Progress.cpp:121
int p_percentIncrement
How much to increment the currentPercent by.
Definition: Progress.h:100
Program progress reporter.
Definition: Progress.h:58
void AddSteps(const int steps)
If the initial step size was a guess, it can be modified using this method.
Definition: Progress.cpp:215
int p_currentPercent
The current percent we are checking against.
Definition: Progress.h:96
void SetText(const QString &text)
Changes the value of the text string reported just before 0% processed.
Definition: Progress.cpp:77
Progress()
Constructs a Progress object.
Definition: Progress.cpp:38
QString p_text
Text string to output at the initial call to CheckStatus (0% processed)
Definition: Progress.h:88
int MaximumSteps() const
Returns the maximum number of steps of the progress.
Definition: Progress.cpp:188
int CurrentStep() const
Returns the current step of the progress.
Definition: Progress.cpp:201
Namespace for ISIS/Bullet specific routines.
Definition: Apollo.h:31
~Progress()
Destroys the Progress object.
Definition: Progress.cpp:66
int p_currentStep
The current step in the processing sequence.
Definition: Progress.h:93
QString Text() const
Returns the text to output.
Definition: Progress.cpp:88