Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_Time.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 // Kris
43 // 07.08.03 -- Move into Teuchos package/namespace
44 
45 #ifndef _TEUCHOS_TIME_HPP_
46 #define _TEUCHOS_TIME_HPP_
47 
52 #include "Teuchos_ConfigDefs.hpp"
53 
54 #include <ctime>
55 #ifdef HAVE_MPI
56 #include <mpi.h>
57 #else
58 #if ICL || defined(_WIN32)
59 #include <time.h>
60 #else
61 #include <sys/time.h>
62 #ifndef MINGW
63 #include <sys/resource.h>
64 #endif
65 #endif
66 #endif
67 
68 
69 namespace Teuchos {
70 
71 
85 class TEUCHOSCORE_LIB_DLL_EXPORT Time {
86 public:
92  Time (const std::string& name, bool start = false);
93 
99  static double wallTime ();
100 
107  void start (bool reset = false);
108 
110  double stop ();
111 
113  void disable ();
114 
116  void enable ();
117 
119  bool isEnabled () const {
120  return enabled_;
121  }
122 
134  double totalElapsedTime (bool readCurrentTime = false) const;
135 
137  void reset ();
138 
144  bool isRunning() const {
145  return isRunning_;
146  }
147 
149  const std::string& name() const {
150  return name_;
151  }
152 
155  void incrementNumCalls();
156 
158  int numCalls() const {return numCalls_;}
159 
160 private:
161  double startTime_;
162  double totalTime_;
163  bool isRunning_;
164  bool enabled_;
165  std::string name_;
166  int numCalls_;
167 #ifdef HAVE_TEUCHOS_TIME_MASSIF_SNAPSHOTS
168  // We don't want to rely on incrementNumCalls being called,
169  // because this does not seem to always happen in the same order.
170  // Sometimes after start() is called, sometimes after stop().
171  int numCallsMassifSnapshots_;
172 #endif
173 };
174 
175 
176 } // namespace Teuchos
177 
178 
179 #endif // TEUCHOS_TIME_HPP_
Teuchos header file which uses auto-configuration information to include necessary C++ headers...
bool isEnabled() const
Whether the timer is enabled (see disable()).
Wall-clock timer.
bool isRunning() const
Whether the timer is currently running.
int numCalls() const
The number of times this timer has been called while enabled.
const std::string & name() const
The name of this timer.