Teuchos_Time.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

// Kris
// 07.08.03 -- Move into Teuchos package/namespace

#ifndef _TEUCHOS_TIME_HPP_
#define _TEUCHOS_TIME_HPP_

#include "Teuchos_ConfigDefs.hpp"

#include <ctime>
#ifdef HAVE_MPI
#include <mpi.h>
#else
#if ICL || defined(_WIN32)
#include <time.h>
#else
#include <sys/time.h>
#ifndef MINGW
#include <sys/resource.h>
#endif
#endif
#endif


namespace Teuchos {


class TEUCHOSCORE_LIB_DLL_EXPORT Time {
public:
  Time (const std::string& name, bool start = false);

  static double wallTime ();

  void start (bool reset = false);

  double stop ();

  void disable ();

  void enable ();

  bool isEnabled () const {
    return enabled_;
  }

  double totalElapsedTime (bool readCurrentTime = false) const;

  void reset ();

  bool isRunning() const {
    return isRunning_;
  }

  const std::string& name() const {
    return name_;
  }

  void incrementNumCalls();

  int numCalls() const {return numCalls_;}

private:
  double startTime_;
  double totalTime_;
  bool isRunning_;
  bool enabled_;
  std::string name_;
  int numCalls_;
#ifdef HAVE_TEUCHOS_TIME_MASSIF_SNAPSHOTS
  // We don't want to rely on incrementNumCalls being called,
  // because this does not seem to always happen in the same order.
  // Sometimes after start() is called, sometimes after stop().
  int numCallsMassifSnapshots_;
#endif
};


} // namespace Teuchos


#endif // TEUCHOS_TIME_HPP_