Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Protected Attributes | Static Protected Attributes

ProgressLogger Class Reference

Base class for all classes that want to report their progess. More...

#include <OpenMS/CONCEPT/ProgressLogger.h>

Inheritance diagram for ProgressLogger:
AverageLinkage BaseGroupFinder BaseSuperimposer CachedmzML ChromatogramExtractor CompleteLinkage ConsensusXMLFile DTA2DFile ElutionPeakDetection FeatureFinder FeatureFindingMetabo FeatureXMLFile GaussFilter InternalCalibration IonizationSimulation LinearResampler MapAlignmentAlgorithm MascotGenericFile MascotInfile MassTraceDetection MorphologicalFilter MRMDecoy MRMFeatureFinderScoring MS2File MSSim MzDataFile MzIdentMLFile MzMLFile MzQuantMLFile MzXMLFile PeakPickerCWT PeakPickerHiRes PeakPickerSH QcMLFile RawMSSignalSimulation SavitzkyGolayFilter SignalToNoiseEstimator< Container > SILACFiltering SingleLinkage SVMWrapper TOFCalibration ToolDescriptionFile TraMLFile TransitionTSVReader XMassFile

List of all members.

Public Types

enum  LogType { CMD, GUI, NONE }
 

Possible log types.

More...

Public Member Functions

 ProgressLogger ()
 Constructor.
 ~ProgressLogger ()
 Destructor.
void setLogType (LogType type) const
 Sets the progress log that should be used. The default type is NONE!
LogType getLogType () const
 Returns the type of progress log being used.
void startProgress (SignedSize begin, SignedSize end, const String &label) const
 Initializes the progress display.
void setProgress (SignedSize value) const
 Sets the current progress.
void endProgress () const
 Ends the progress display.

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_

Detailed Description

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.

Note:
All methods are const, so it can be used through a const reference or in const methods as well!

Member Enumeration Documentation

enum LogType

Possible log types.

Enumerator:
CMD 

Command line progress.

GUI 

Progress dialog.

NONE 

No progress logging.

Constructor & Destructor Documentation

ProgressLogger (  ) 

Constructor.

~ProgressLogger (  ) 

Destructor.

Member Function Documentation

void endProgress (  )  const

Ends the progress display.

Referenced by InternalCalibration::calibrateMapGlobally(), InternalCalibration::calibrateMapSpectrumwise(), SignalToNoiseEstimatorMedian< OpenMS::MSSpectrum< PeakT > >::computeSTN_(), SignalToNoiseEstimatorMeanIterative< Container >::computeSTN_(), MzXMLHandler< MapType >::endElement(), MzMLHandler< MapType >::endElement(), MzDataHandler< MapType >::endElement(), FeatureFinderAlgorithmSimplest< PeakType, FeatureType >::run(), FeatureFinderAlgorithmSimple< PeakType, FeatureType >::run(), FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run(), FeatureFinderAlgorithmIsotopeWavelet< PeakType, FeatureType >::run(), MzXMLHandler< MapType >::writeTo(), MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

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< PeakType, FeatureType >::run(), TOPPViewBase::runTOPPTool_(), and FileHandler::storeExperiment().

void setProgress ( SignedSize  value  )  const

Sets the current progress.

Referenced by InternalCalibration::calibrateMapGlobally(), InternalCalibration::calibrateMapSpectrumwise(), SignalToNoiseEstimatorMedian< OpenMS::MSSpectrum< PeakT > >::computeSTN_(), SignalToNoiseEstimatorMeanIterative< Container >::computeSTN_(), MzMLHandler< MapType >::endElement(), MzDataHandler< MapType >::endElement(), SimpleSeeder< PeakType, FeatureType >::nextSeed(), FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run(), FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run(), FeatureFinderAlgorithmIsotopeWavelet< PeakType, FeatureType >::run(), MzXMLHandler< MapType >::startElement(), MzXMLHandler< MapType >::writeTo(), MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

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.

Note:
Make sure to call setLogType first!

Referenced by InternalCalibration::calibrateMapGlobally(), InternalCalibration::calibrateMapSpectrumwise(), SignalToNoiseEstimatorMedian< OpenMS::MSSpectrum< PeakT > >::computeSTN_(), SignalToNoiseEstimatorMeanIterative< Container >::computeSTN_(), SimpleSeeder< PeakType, FeatureType >::initialize_(), FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run(), FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run(), FeatureFinderAlgorithmIsotopeWavelet< PeakType, FeatureType >::run(), MzXMLHandler< MapType >::startElement(), MzMLHandler< MapType >::startElement(), MzDataHandler< MapType >::startElement(), MzXMLHandler< MapType >::writeTo(), MzMLHandler< MapType >::writeTo(), and MzDataHandler< MapType >::writeTo().

Member Data Documentation

SignedSize begin_ [mutable, protected]
QProgressDialog* dlg_ [mutable, protected]
SignedSize end_ [mutable, protected]
time_t last_invoke_ [mutable, protected]
int recursion_depth_ [static, protected]
StopWatch stop_watch_ [mutable, protected]
LogType type_ [mutable, protected]
SignedSize value_ [mutable, protected]
OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:42:51 using doxygen 1.7.1