StopWatch.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Marc Sturm, Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/config.h>
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/String.h>
 
#ifdef OPENMS_HAS_SYS_TIME_H
#include <sys/time.h>
#endif
 
#ifdef OPENMS_HAS_TIME_H
#include <ctime>
#endif
 
namespace OpenMS
{
  class OPENMS_DLLAPI StopWatch
  {
public:
 
    void start();
 
    void stop();
 
    void resume();
 
    void reset();
 
    void clear();
 
 
 
    double getClockTime() const;
 
    double getUserTime() const;
 
    double getSystemTime() const;
 
    double getCPUTime() const;
 
 
    bool isRunning() const;
 
    bool operator==(const StopWatch & stop_watch) const;
 
    bool operator!=(const StopWatch & stop_watch) const;
 
    bool operator<(const StopWatch & stop_watch) const;
 
    bool operator<=(const StopWatch & stop_watch) const;
 
    bool operator>=(const StopWatch & stop_watch) const;
 
    bool operator>(const StopWatch & stop_watch) const;
 
 
    String toString() const;
 
    static String toString(const double time_in_seconds);
 
private:
  #ifdef OPENMS_WINDOWSPLATFORM
    typedef OPENMS_UINT64_TYPE TimeType; 
    static const long long SecondsTo100Nano_;  
  #else
    typedef clock_t TimeType;
    static const PointerSizeInt cpu_speed_; 
  #endif
 
    struct TimeDiff_
    {
      TimeType user_ticks{ 0 }; 
      TimeType kernel_ticks{ 0 }; 
      PointerSizeInt start_time{ 0 }; 
      PointerSizeInt start_time_usec{ 0 }; 
 
      double userTime() const;
      double kernelTime() const;
      double getCPUTime() const;
      double clockTime() const;
 
      TimeDiff_ operator-(const TimeDiff_& earlier) const;
      TimeDiff_& operator+=(const TimeDiff_& other);
      bool operator==(const TimeDiff_& rhs) const;
 
      private:
        double ticksToSeconds_(TimeType in) const;
    };
 
 
    TimeDiff_ snapShot_() const;
 
    TimeDiff_ accumulated_times_;
 
    TimeDiff_ last_start_;
 
    bool is_running_ = false;
 
  };
 
}