Teuchos - Trilinos Tools Package Version of the Day
Teuchos_Time.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 // Kris
00043 // 07.08.03 -- Move into Teuchos package/namespace
00044 
00045 #ifndef _TEUCHOS_TIME_HPP_
00046 #define _TEUCHOS_TIME_HPP_
00047 
00052 #include "Teuchos_ConfigDefs.hpp"
00053 
00054 #include <ctime>
00055 #ifdef HAVE_MPI
00056 #include "mpi.h"
00057 #else
00058 #if ICL || defined(_WIN32)
00059 #include <time.h>
00060 #else
00061 #include <sys/time.h>
00062 #ifndef MINGW
00063 #include <sys/resource.h>
00064 #endif
00065 #endif
00066 #endif
00067 
00068 
00069 namespace Teuchos {
00070 
00071 
00081 /* ADDITIONAL COMMENTS:
00082  * Initial version by Mike Heroux and Kris Kampshoff. 
00083  * Modified as follows by Kevin Long, 9/29/03:
00084  * <ul>
00085  * <li> There is no need to define explicit copy ctor and dtor for this class.
00086  * <li> The wallTime() method returns the same value for every instance of this class, so
00087  * it would be best to make it a static method.
00088  * <li> Removed the communicator data member. Cross-processor comparisons of timings
00089  * can be done by the TimeMonitor.
00090  * </ul>
00091  */ 
00092 
00093 class TEUCHOSCORE_LIB_DLL_EXPORT Time
00094 {
00095 
00096 public:
00098   Time(const std::string& name, bool start = false);
00099   
00101   static double wallTime();
00102   
00104   void start(bool reset = false);
00105 
00107   double stop();
00108 
00112   double totalElapsedTime(bool readCurrentTime = false) const;
00113 
00116   void reset() {totalTime_ = 0; numCalls_ = 0;}
00117 
00123   bool isRunning() const {return isRunning_;}
00124 
00126   const std::string& name() const {return name_;}
00127 
00129   void incrementNumCalls() {numCalls_++;}
00130 
00132   int numCalls() const {return numCalls_;}
00133 
00134 private:
00135 
00136   double startTime_;
00137   double totalTime_;
00138   bool isRunning_;
00139   std::string name_;
00140   int numCalls_;
00141 
00142 };
00143 
00144 
00145 } // namespace Teuchos
00146 
00147 
00148 #endif // TEUCHOS_TIME_HPP_
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines