MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
StopWatchPack_stopwatch.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) 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 Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef STPWATCH_H
43 #define STPWATCH_H
44 
45 #include "Moocho_ConfigDefs.hpp"
46 
47 namespace StopWatchPack {
48 
54 
55 double seconds(void);
56 
59 class stopwatch {
60 public:
61 
63  stopwatch() : running_(false), last_time_(0.0), total_(0.0)
64  {}
65 
67  bool is_running() const {
68  return running_;
69  }
70 
72  void start() {
73  if (!running_) {
74  last_time_ = seconds();
75  running_ = true;
76  }
77  }
78 
80  double stop() {
81  if (running_) {
82  total_ += seconds() - last_time_;
83  running_ = false;
84  }
85  //std::cout << "total = " << total_ << std::endl;
86  return total_;
87  }
88 
90  void reset() {
91  running_ = false;
92  last_time_ = 0.0;
93  total_ = 0.0;
94  }
95 
97  double read() {
98  if (running_) {
99  double curr_time = seconds();
100  total_ += curr_time - last_time_;
101  last_time_ = curr_time;
102  }
103  return total_;
104  }
105 
106 private:
107  bool running_;
108  double last_time_;
109  double total_;
110 };
111 
112 // end namespace StopWatchPack
114 
115 } // end namespace StopWatchPack
116 
117 #endif // STPWATCH_H
void reset()
Stops and resets the clock if it is running.
Simple stopwatch object.
void start()
Starts timing if it has already not been started.
stopwatch()
Initializes of not running.
bool is_running() const
Returns true if this is currently timming.
double stop()
Stops timing and returns the time (sec.) since start() was called.
double read()
Reads the elapsed time (sec.) and leaves the clock running.