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-2012.
//
// 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 $
// --------------------------------------------------------------------------

#ifndef OPENMS_SYSTEM_STOPWATCH_H
#define OPENMS_SYSTEM_STOPWATCH_H

#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

#include <iostream>

namespace OpenMS
{
  class OPENMS_DLLAPI StopWatch
  {
public:


    StopWatch();

    StopWatch(const StopWatch & stop_watch);

    virtual ~StopWatch();



    void clear();

    bool start();

    bool stop();

    void reset();



    DoubleReal getClockTime() const;

    DoubleReal getUserTime() const;

    DoubleReal getSystemTime() const;

    inline DoubleReal getCPUTime() const
    {
      return getUserTime() + getSystemTime();
    }



    StopWatch & operator=(const StopWatch & stop_watch);



    bool isRunning() const
    {
      return is_running_;
    }

    bool operator==(const StopWatch & stop_watch) const;

    inline bool operator!=(const StopWatch & stop_watch) const
    {
      return !(*this == stop_watch);
    }

    inline bool operator<(const StopWatch & stop_watch) const
    {
      return getCPUTime() < stop_watch.getCPUTime();
    }

    inline bool operator<=(const StopWatch & stop_watch) const
    {
      return !(stop_watch < *this);
    }

    inline bool operator>=(const StopWatch & stop_watch) const
    {
      return !(*this < stop_watch);
    }

    inline bool operator>(const StopWatch & stop_watch) const
    {
      return stop_watch < *this;
    }


    static String toString(DoubleReal time);

private:

    static PointerSizeInt cpu_speed_;

#ifdef OPENMS_WINDOWSPLATFORM
    static PointerSizeInt clock_speed_;
    typedef OPENMS_UINT64_TYPE TimeType; // do not use clock_t on Windows, since its not big enough for larger time intervalls
#else
    typedef clock_t TimeType;
#endif

    // state of stop watch, either true(on) or false(off)
    bool is_running_;

    // clock seconds value when the stop watch was last started
    PointerSizeInt start_secs_;

    // clock useconds value when the stop watch was last started
    PointerSizeInt start_usecs_;

    // user time when the stop watch was last started
    TimeType start_user_time_;

    // system time when the stop watch was last started
    TimeType start_system_time_;

    // current accumulated clock seconds
    PointerSizeInt current_secs_;

    // current accumulated clock useconds
    PointerSizeInt current_usecs_;

    // current accumulated user time
    TimeType current_user_time_;

    // current accumulated user time
    TimeType current_system_time_;
  };

}

#endif // OPENMS_SYSTEM_STOPWATCH_H