Teuchos_PerformanceMonitorBase.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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef TEUCHOS_PERFORMANCEMONITORBASE_H
00030 #define TEUCHOS_PERFORMANCEMONITORBASE_H
00031 
00037 #include "Teuchos_ConfigDefs.hpp"
00038 #include "Teuchos_MPIComm.hpp"
00039 #include "Teuchos_RCP.hpp"
00040 #include "Teuchos_Array.hpp"
00041 #include "Teuchos_PerformanceMonitorUtils.hpp"
00042 #include "Teuchos_TableFormat.hpp"
00043 
00044 namespace Teuchos
00045 {
00046  
00075 template <class T> 
00076 class PerformanceMonitorBase
00077 {
00078 public:
00079 
00081   PerformanceMonitorBase(T& counter_in, bool reset=false)
00082     : counter_(counter_in), isRecursiveCall_(counter_.isRunning())
00083     {
00084       (void)reset;  // get rid of "unused parameter" warning
00085       counter_.incrementNumCalls();
00086     }
00087 
00089   virtual ~PerformanceMonitorBase() {}
00090     
00097   static RCP<T> getNewCounter(const std::string& name)
00098     {
00099       RCP<T> rtn = rcp(new T(name), true);
00100       counters().append(rtn);
00101       return rtn;
00102     }
00103 
00107   static TableFormat& format()
00108     {
00109       static RCP<TableFormat> rtn=rcp(new TableFormat()); 
00110       return *rtn; 
00111     }
00112 
00113 protected:
00114     
00116   const T& counter() const { return counter_; }
00117     
00119   T& counter() { return counter_; }
00120 
00126   bool isRecursiveCall() const { return isRecursiveCall_; }
00127       
00129   static Array<RCP<T> >& counters() 
00130     {
00131       static Array<RCP<T> > rtn;
00132       return rtn;
00133     }
00134     
00135 private:
00136     
00137   T& counter_;
00138     
00139   bool isRecursiveCall_;
00140     
00141 };
00142 
00143   
00144 } // namespace Teuchos
00145 
00146 
00147 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 09:57:30 2011 for Teuchos Package Browser (Single Doxygen Collection) by  doxygen 1.6.3