ProgressLogger.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm, Stephan Aiche $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
 
namespace OpenMS
{
  class String;
 
  class OPENMS_DLLAPI ProgressLogger
  {
public:
    ProgressLogger();
 
    virtual ~ProgressLogger();
 
    ProgressLogger(const ProgressLogger& other);
 
    ProgressLogger& operator=(const ProgressLogger& other);
 
    enum LogType
    {
      CMD, 
      GUI, 
      NONE 
    };
 
    class OPENMS_DLLAPI ProgressLoggerImpl
    {
public:
      virtual void startProgress(const SignedSize begin, const SignedSize end, const String& label, const int current_recursion_depth) const = 0;
      virtual void setProgress(const SignedSize value, const int current_recursion_depth) const = 0;
      virtual SignedSize nextProgress() const = 0; //< does not print/show anything; returns current progress
      virtual void endProgress(const int current_recursion_depth, UInt64 bytes_processed = 0) const = 0;
 
      virtual ~ProgressLoggerImpl() {}
 
  
 
    };
 
    void setLogType(LogType type) const;
 
    LogType getLogType() const;
 
    void setLogger(ProgressLoggerImpl* logger);
 
    void startProgress(SignedSize begin, SignedSize end, const String& label) const;
 
    void setProgress(SignedSize value) const;
 
    void endProgress(UInt64 bytes_processed = 0) const;
 
    void nextProgress() const;
 
protected:
    mutable LogType type_;
    mutable time_t last_invoke_;
    static int recursion_depth_;
 
    mutable ProgressLoggerImpl* current_logger_;
 
  };
 
  // Function pointer for injecting the GUI progress logger implementation
  typedef ProgressLogger::ProgressLoggerImpl* (*MakeGUIProgressLoggerFunc)();
  extern OPENMS_DLLAPI MakeGUIProgressLoggerFunc make_gui_progress_logger;
 
} // namespace OpenMS