Base class for all classes that want to report their progess. More...
#include <OpenMS/CONCEPT/ProgressLogger.h>
Public Types | |
enum | LogType { CMD, GUI, NONE } |
Possible log types. More... | |
Public Member Functions | |
ProgressLogger () | |
Constructor. More... | |
~ProgressLogger () | |
Destructor. More... | |
void | setLogType (LogType type) const |
Sets the progress log that should be used. The default type is NONE! More... | |
LogType | getLogType () const |
Returns the type of progress log being used. More... | |
void | startProgress (SignedSize begin, SignedSize end, const String &label) const |
Initializes the progress display. More... | |
void | setProgress (SignedSize value) const |
Sets the current progress. More... | |
void | endProgress () const |
Ends the progress display. More... | |
Protected Attributes | |
LogType | type_ |
SignedSize | begin_ |
SignedSize | end_ |
SignedSize | value_ |
QProgressDialog * | dlg_ |
StopWatch | stop_watch_ |
time_t | last_invoke_ |
Static Protected Attributes | |
static int | recursion_depth_ |
Base class for all classes that want to report their progess.
Per default the progress log is disabled. Use setLogType to enable it.
Use startProgress, setProgress and endProgress for the actual logging.
enum LogType |
ProgressLogger | ( | ) |
Constructor.
~ProgressLogger | ( | ) |
Destructor.
void endProgress | ( | ) | const |
Ends the progress display.
Referenced by InternalCalibration::calibrateMapGlobally(), InternalCalibration::calibrateMapSpectrumwise(), SignalToNoiseEstimatorMedian< OpenMS::OpenMS::MSSpectrum< PeakT > >::computeSTN_(), SignalToNoiseEstimatorMeanIterative< Container >::computeSTN_(), FeatureFinderAlgorithmSimplest< PeakType, FeatureType >::run(), FeatureFinderAlgorithmSimple< PeakType, FeatureType >::run(), FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run(), and FeatureFinderAlgorithmIsotopeWavelet< OpenMS::Peak2D, FeatureType >::run().
LogType getLogType | ( | ) | const |
Returns the type of progress log being used.
void setLogType | ( | LogType | type | ) | const |
Sets the progress log that should be used. The default type is NONE!
Referenced by FileHandler::loadExperiment(), FeatureFinderAlgorithmIsotopeWavelet< OpenMS::Peak2D, FeatureType >::run(), TOPPViewBase::runTOPPTool_(), and FileHandler::storeExperiment().
void setProgress | ( | SignedSize | value | ) | const |
Sets the current progress.
Referenced by InternalCalibration::calibrateMapGlobally(), InternalCalibration::calibrateMapSpectrumwise(), SignalToNoiseEstimatorMedian< OpenMS::OpenMS::MSSpectrum< PeakT > >::computeSTN_(), SignalToNoiseEstimatorMeanIterative< Container >::computeSTN_(), SimpleSeeder< PeakType, FeatureType >::nextSeed(), FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run(), FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run(), and FeatureFinderAlgorithmIsotopeWavelet< OpenMS::Peak2D, FeatureType >::run().
void startProgress | ( | SignedSize | begin, |
SignedSize | end, | ||
const String & | label | ||
) | const |
Initializes the progress display.
Sets the progress range from begin
to end
. If begin
equals end
, setProgress only indicates that the program is still running, but without showing any absolute progress value.
Sets the label to label
.
Referenced by InternalCalibration::calibrateMapGlobally(), InternalCalibration::calibrateMapSpectrumwise(), SignalToNoiseEstimatorMedian< OpenMS::OpenMS::MSSpectrum< PeakT > >::computeSTN_(), SignalToNoiseEstimatorMeanIterative< Container >::computeSTN_(), SimpleSeeder< PeakType, FeatureType >::initialize_(), FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run(), FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run(), and FeatureFinderAlgorithmIsotopeWavelet< OpenMS::Peak2D, FeatureType >::run().
|
mutableprotected |
|
mutableprotected |
|
mutableprotected |
|
mutableprotected |
|
staticprotected |
|
mutableprotected |
|
mutableprotected |
|
mutableprotected |
OpenMS / TOPP release 1.11.1 | Documentation generated on Thu Nov 14 2013 11:19:28 using doxygen 1.8.5 |