Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Types | Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
ProgressLogger Class Reference

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

#include <OpenMS/CONCEPT/ProgressLogger.h>

Inheritance diagram for ProgressLogger:
AccurateMassSearchEngine AverageLinkage BaseGroupFinder BaseSuperimposer CachedmzML ChromatogramExtractor CompleteLinkage ConfidenceScoring 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 > SILACAnalyzer SILACFiltering SingleLinkage SVMWrapper TOFCalibration ToolDescriptionFile TraMLFile TransitionTSVReader XMassFile SignalToNoiseEstimator< OpenMS::OpenMS::MSSpectrum< PeakT > >

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_
 

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

Constructor.

Destructor.

Member Function Documentation

void endProgress ( ) const
LogType getLogType ( ) const

Returns the type of progress log being used.

void setLogType ( LogType  type) const
void setProgress ( SignedSize  value) const
void startProgress ( SignedSize  begin,
SignedSize  end,
const String label 
) const

Member Data Documentation

SignedSize begin_
mutableprotected
QProgressDialog* dlg_
mutableprotected
SignedSize end_
mutableprotected
time_t last_invoke_
mutableprotected
int recursion_depth_
staticprotected
StopWatch stop_watch_
mutableprotected
LogType type_
mutableprotected
SignedSize value_
mutableprotected

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:28 using doxygen 1.8.5