iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
CPUTimer.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 #ifndef INCLUDE_NRT_CORE_DEBUGGING_CPUTIMER_H
37 #define INCLUDE_NRT_CORE_DEBUGGING_CPUTIMER_H
38 
39 #include <sys/resource.h>
40 #include <sys/time.h>
41 
42 namespace nrt
43 {
44 
45  //! Utility class for monitoring user/system cpu usage plus wall-clock time.
46  /*! \ingroup debugging */
47  class CPUTimer
48  {
49  public:
50  //! Constructor; immediately start timing
51  CPUTimer();
52 
53  //! Reset the timer and immediately start timing again
54  /*! Use this function to start timing. */
55  void reset();
56 
57  //! Mark the current time for access via user_secs()/sys_secs()/real_secs()
58  /*! Use this function to stop timing. */
59  void mark();
60 
61  //! Get the number of seconds spent executing user instructions between reset() and mark()
62  double user_secs() const;
63 
64  //! Get the number of seconds spent executing system code on behalf of
65  //! this process between reset() and mark()
66  double sys_secs() const;
67 
68  //! Get the real (wall-clock) CPU seconds between reset() and mark()
69  double real_secs() const;
70 
71  //! Print a report based on the most recent mark()
72  /*! \param where a message pre-pended before the output, typically indicating where the report comes from. */
73  void report(char const * where = "") const;
74 
75  private:
76  timeval t1, t2;
77  rusage r1, r2;
78  };
79 } // namespace nrt
80 
81 #endif // INCLUDE_NRT_CORE_DEBUGGING_CPUTIMER_H