|
Isis 3.0 Object Programmers' Reference |
Home |
Program progress reporter. More...
#include <Progress.h>
Public Member Functions | |
| Progress () | |
| Constructs a Progress object. | |
| ~Progress () | |
| Destroys the Progress object. | |
| void | SetText (const QString &text) |
| Changes the value of the text string reported just before 0% processed. | |
| QString | Text () const |
| Returns the text to output. | |
| void | SetMaximumSteps (const int steps) |
| This sets the maximum number of steps in the process. | |
| void | AddSteps (const int steps) |
| If the initial step size was a guess, it can be modified using this method. | |
| void | CheckStatus () |
| Checks and updates the status. | |
| void | DisableAutomaticDisplay () |
| Turns off updating the Isis Gui when CheckStatus() is called. | |
| int | MaximumSteps () const |
| Returns the maximum number of steps of the progress. | |
| int | CurrentStep () const |
| Returns the current step of the progress. | |
Private Attributes | |
| QString | p_text |
Text string to output at the initial call to | |
| int | p_maximumSteps |
| Number of steps in your processing sequence. | |
| int | p_currentStep |
| The current step in the processing sequence. | |
| int | p_currentPercent |
| The current percent we are checking against. | |
| int | p_percentIncrement |
| How much to increment the currentPercent by. | |
| bool | p_printPercent |
| bool | p_autoDisplay |
Program progress reporter.
This class is used to output the percent completion for programs in either the command line mode or the graphical user interface. Generally, this object is created within a Process derived class. Therefore you should only use this object if you are developing such a class.
2003-05-16 Stuart Sides - Modified schema from astrogeology... isis.astrogeology...
2004-02-29 Jeff Anderson - Added ability to send progress status to the parent process
2005-02-11 Elizabeth Ribelin - Modified file to support Doxygen documentation
2005-10-03 Elizabeth Miller - Changed
2012-03-13 Steven Lambright - Added DisableAutomaticGuiRedraws().
2012-09-11 Steven Lambright - Added accessors to the current progress value and range. Renamed DisableAutomaticGuiRedraws() to DisableAutomaticDisplay() in order to include command-line progress printouts.
2012-10-04 Jeannie Backer - Removed documentation reference to the now non-existant CubeInfo class. No mantis ticket related to this change.
Definition at line 58 of file Progress.h.
| Isis::Progress::Progress | ( | ) |
Constructs a Progress object.
| Isis::iException::User |
Definition at line 38 of file Progress.cpp.
References _FILEINFO_, and Isis::PvlObject::findGroup().
| Isis::Progress::~Progress | ( | ) |
Destroys the Progress object.
Definition at line 66 of file Progress.cpp.
| void Isis::Progress::AddSteps | ( | const int | steps | ) |
If the initial step size was a guess, it can be modified using this method.
For example, if you SetMaximumSteps(11) then call AddSteps(1) then the new MaximumSteps is 12. The progress bar will not go backwards (it will not drop from 10% to 5%). "steps" can be negative to remove steps.
| steps | Amount to adjust the MaximumSteps by |
Definition at line 215 of file Progress.cpp.
References _FILEINFO_.
Referenced by Isis::ImageOverlapSet::FindAllOverlaps(), and Isis::OverlapStatistics::OverlapStatistics().
| void Isis::Progress::CheckStatus | ( | ) |
Checks and updates the status.
The first time this is invoked, it outputs the text from SetText and 0% processed. It should then be invoked for each step, for example, a step could be considered processing a line for NL lines in the image. If you do not call this enough times you will not reached 100% processed.
| IException::Programmer | Step exceeds maximumSteps |
Definition at line 121 of file Progress.cpp.
References _FILEINFO_, Isis::Application::ProcessGuiEvents(), and Isis::Application::UpdateProgress().
Referenced by Isis::Process::CalculateStatistics(), Isis::GroundGrid::CreateGrid(), Isis::ImageOverlapSet::FindAllOverlaps(), Isis::InterestOperator::FindCnetRef(), Isis::Histogram::Histogram(), Isis::Cube::histogram(), Isis::CameraStatistics::init(), Isis::ProcessExport::InitProcess(), Isis::OverlapStatistics::OverlapStatistics(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessImport::ProcessJp2(), Isis::ControlNet::ReadControl(), Isis::Pipeline::Run(), Isis::ProcessByBrick::RunProcess(), Isis::SerialNumberList::SerialNumberList(), Isis::ControlNet::SetImages(), Isis::ProcessByQuickFilter::StartProcess(), Isis::ProcessExport::StartProcess(), and Isis::Cube::statistics().
| int Isis::Progress::CurrentStep | ( | ) | const |
Returns the current step of the progress.
This value should always be in the range of: [0, MaximumSteps()]. CheckStatus() increments the current step.
Definition at line 201 of file Progress.cpp.
Referenced by Isis::ImportControlNetWorkOrder::asyncRedo().
| void Isis::Progress::DisableAutomaticDisplay | ( | ) |
Turns off updating the Isis Gui when CheckStatus() is called.
You must use RedrawProgress() to visually update the current progress.
Definition at line 177 of file Progress.cpp.
Referenced by Isis::ImportControlNetWorkOrder::syncRedo().
| int Isis::Progress::MaximumSteps | ( | ) | const |
Returns the maximum number of steps of the progress.
Definition at line 188 of file Progress.cpp.
Referenced by Isis::ImportControlNetWorkOrder::asyncRedo().
| void Isis::Progress::SetMaximumSteps | ( | const int | steps | ) |
This sets the maximum number of steps in the process.
Whenever this is invoked it also resets the counters to their initial states. This allows for programs which have multiple steps.
| steps | Maximum number of steps |
| IException::Programmer | Invalid value for step (must be >0) |
Definition at line 101 of file Progress.cpp.
References _FILEINFO_.
Referenced by Isis::Process::CalculateStatistics(), Isis::GroundGrid::CreateGrid(), Isis::ImageOverlapSet::FindAllOverlaps(), Isis::InterestOperator::FindCnetRef(), Isis::Histogram::Histogram(), Isis::Cube::histogram(), Isis::CameraStatistics::init(), Isis::ProcessExport::InitProcess(), Isis::OverlapStatistics::OverlapStatistics(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessImport::ProcessJp2(), Isis::ControlNet::ReadControl(), Isis::Pipeline::Run(), Isis::ProcessByBrick::RunProcess(), Isis::SerialNumberList::SerialNumberList(), Isis::ControlNet::SetImages(), Isis::ProcessByQuickFilter::StartProcess(), and Isis::Cube::statistics().
| void Isis::Progress::SetText | ( | const QString & | text | ) |
Changes the value of the text string reported just before 0% processed.
This text is only output under the following condition. After SetMaximumSteps is called, the first call to CheckStatus will immediately output the text. By default this is set to "Working".
| text | Text to output. |
Definition at line 77 of file Progress.cpp.
Referenced by Isis::Equalization::calculateStatistics(), Isis::Process::CalculateStatistics(), Isis::ImageOverlapSet::FindAllOverlaps(), Isis::InterestOperator::FindCnetRef(), Isis::Histogram::Histogram(), Isis::Cube::histogram(), Isis::OverlapStatistics::OverlapStatistics(), Isis::ProcessExport::ProcessExport(), Isis::ProcessImport::ProcessImport(), Isis::ControlNet::ReadControl(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::Pipeline::Run(), Isis::SerialNumberList::SerialNumberList(), Isis::ControlNet::SetImages(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::BundleAdjust::Solve(), Isis::ProcessMapMosaic::StartProcess(), and Isis::Cube::statistics().
| QString Isis::Progress::Text | ( | ) | const |
Returns the text to output.
Generally, this in not needed except rare circumstances where an application has multiple steps and the text string needs to be saved and restored.
Definition at line 88 of file Progress.cpp.
|
private |
The current percent we are checking against.
Once this percentage is exceeded we report that percentage is completed and increase this value by the increment.
Definition at line 96 of file Progress.h.
|
private |
The current step in the processing sequence.
This is incremented by one everytime CheckStatus is called.
Definition at line 93 of file Progress.h.
|
private |
Number of steps in your processing sequence.
For example, if there are 20 lines in an cube. This will be 20.
Definition at line 90 of file Progress.h.
|
private |
How much to increment the currentPercent by.
It should only be 1,2, 5, or 10.
Definition at line 100 of file Progress.h.
|
private |
Text string to output at the initial call to
CheckStatus (0% processed)
Definition at line 88 of file Progress.h.