Teuchos_PerformanceMonitorBase.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_PERFORMANCEMONITORBASE_H
#define TEUCHOS_PERFORMANCEMONITORBASE_H

#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_MPIComm.hpp"
#include "Teuchos_RefCountPtr.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_PerformanceMonitorUtils.hpp"
#include "Teuchos_TableFormat.hpp"

namespace Teuchos
{
 
  template <class T> 
  class PerformanceMonitorBase
  {
  public:
    PerformanceMonitorBase(T& counter, bool reset=false)
      : counter_(counter), isRecursiveCall_(counter_.isRunning())
    {
      counter_.incrementNumCalls();
    }

    virtual ~PerformanceMonitorBase() {}
    
    static RefCountPtr<T> getNewCounter(const string& name)
    {
      RefCountPtr<T> rtn = rcp(new T(name), true);
      counters().append(rtn);
      return rtn;
    }

    static TableFormat& format()
    {
      static RefCountPtr<TableFormat> rtn=rcp(new TableFormat()); 
      return *rtn; 
    }

  protected:
    
    const T& counter() const {return counter_;}
    
    T& counter() {return counter_;}

    bool isRecursiveCall() const {return isRecursiveCall_;}
      
    /* Use the "Meyers Trick" to create static data safely */
    static Array<RefCountPtr<T> >& counters() 
    {static Array<RefCountPtr<T> > rtn; return rtn;}
    
  private:
    
    T& counter_;

    
    bool isRecursiveCall_;
      
    
  };

  
  
  
}
#endif

---