StopWatch.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2021.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $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;
 
  };
 
}