ProfileHackPack_profile_hack.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) 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 Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef PROFILE_HACK_H
#define PROFILE_HACK_H

#include "StopWatchPack_stopwatch.hpp"

namespace ProfileHackPack {


void set_time( const char func_name[], double time_secs );

void print_timings( std::ostream& out );

class ProfileTiming {
public:
  ProfileTiming( const std::string& func_name, std::ostream* out = NULL )
    : func_name_(func_name), out_(out)
  {
    timer_.reset();
    timer_.start();
  }
  ~ProfileTiming()
  {
    set_time( func_name_.c_str(), timer_.read() );
    if( out_ )
      print_timings( *out_ );
  }

private:
  std::string                 func_name_;
  std::ostream                *out_;
  StopWatchPack::stopwatch    timer_;

  // Not defined and not to be called!
  ProfileTiming();
  ProfileTiming(const ProfileTiming&);
  ProfileTiming& operator=(const ProfileTiming&);

}; // end class ProfileTiming


} // end namespace ProfileHackPack

#endif // PROFILE_HACK_H