 |
Isis 3 Developer Reference
|
|
Isis 3 Developer Reference
|
Program progress reporter. More...
#include <Progress.h>
Public Member Functions | |
| Progress () | |
| Constructs a Progress object. More... | |
| ~Progress () | |
| Destroys the Progress object. More... | |
| void | SetText (const QString &text) |
| Changes the value of the text string reported just before 0% processed. More... | |
| QString | Text () const |
| Returns the text to output. More... | |
| void | SetMaximumSteps (const int steps) |
| This sets the maximum number of steps in the process. More... | |
| void | AddSteps (const int steps) |
| If the initial step size was a guess, it can be modified using this method. More... | |
| void | CheckStatus () |
| Checks and updates the status. More... | |
| void | DisableAutomaticDisplay () |
| Turns off updating the Isis Gui when CheckStatus() is called. More... | |
| int | MaximumSteps () const |
| Returns the maximum number of steps of the progress. More... | |
| int | CurrentStep () const |
| Returns the current step of the progress. More... | |
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.
| Isis::Progress::Progress | ( | ) |
Constructs a Progress object.
| Isis::iException::User |
References _FILEINFO_, Isis::PvlObject::findGroup(), and Isis::Preference::Preferences().
| Isis::Progress::~Progress | ( | ) |
Destroys the Progress object.
| 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 |
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 |
References _FILEINFO_, and Isis::iApp.
Referenced by Isis::Process::CalculateStatistics(), Isis::GroundGrid::CreateGrid(), Isis::ImageOverlapSet::FindAllOverlaps(), Isis::InterestOperator::FindCnetRef(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::ControlNetStatistics::GeneratePointStats(), Isis::Histogram::Histogram(), Isis::Cube::histogram(), Isis::OverlapStatistics::OverlapStatistics(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessExport::ProcessCubes(), Isis::ProcessImport::ProcessJp2(), Isis::ControlNet::ReadControl(), Isis::Pipeline::Run(), 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.
Referenced by Isis::ImportControlNetWorkOrder::execute().
| void Isis::Progress::DisableAutomaticDisplay | ( | ) |
Turns off updating the Isis Gui when CheckStatus() is called.
You must use RedrawProgress() to visually update the current progress.
Referenced by Isis::ImportControlNetWorkOrder::execute().
| int Isis::Progress::MaximumSteps | ( | ) | const |
Returns the maximum number of steps of the progress.
Referenced by Isis::ImportControlNetWorkOrder::execute().
| 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) |
References _FILEINFO_.
Referenced by Isis::Process::CalculateStatistics(), Isis::GroundGrid::CreateGrid(), Isis::ImageOverlapSet::FindAllOverlaps(), Isis::InterestOperator::FindCnetRef(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::ControlNetStatistics::GeneratePointStats(), Isis::Histogram::Histogram(), Isis::Cube::histogram(), Isis::OverlapStatistics::OverlapStatistics(), Isis::ProcessImport::ProcessBil(), Isis::ProcessImport::ProcessBip(), Isis::ProcessImport::ProcessBsq(), Isis::ProcessImport::ProcessJp2(), Isis::ControlNet::ReadControl(), Isis::Pipeline::Run(), 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. |
Referenced by Isis::Equalization::applyCorrection(), Isis::Equalization::calculateBandStatistics(), Isis::HiEqualization::calculateStatistics(), Isis::Process::CalculateStatistics(), Isis::ImageOverlapSet::FindAllOverlaps(), Isis::InterestOperator::FindCnetRef(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::ControlNetStatistics::GeneratePointStats(), Isis::Histogram::Histogram(), Isis::Cube::histogram(), Isis::HiCalData::load(), 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::SpectralDefinition2D::SpectralDefinition2D(), 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.