IpTimedTask.hpp

Go to the documentation of this file.

// Copyright (C) 2006, 2009 International Business Machines and others.
// All Rights Reserved.
// This code is published under the Eclipse Public License.
//
// Authors:  Andreas Waechter               IBM    2005-09-19
 
#ifndef __IPTIMEDTASK_HPP__
#define __IPTIMEDTASK_HPP__
 
#include "IpUtils.hpp"
 
namespace Ipopt
{
class IPOPTLIB_EXPORT TimedTask
{
public:
 
   TimedTask()
      :
      total_cputime_(0.),
      total_systime_(0.),
      total_walltime_(0.),
      enabled_(true),
      start_called_(false),
      end_called_(true)
   {}
 
   ~TimedTask()
   {}
 
   void Enable()
   {
      enabled_ = true;
   }
 
   void Disable()
   {
      enabled_ = false;
   }
 
   void Reset()
   {
      total_cputime_ = 0.;
      total_systime_ = 0.;
      total_walltime_ = 0.;
      start_called_ = false;
      end_called_ = true;
   }
 
   void Start()
   {
      if( !enabled_ )
      {
         return;
      }
 
      DBG_ASSERT(end_called_);
      DBG_ASSERT(!start_called_);
      end_called_ = false;
      start_called_ = true;
      start_cputime_ = CpuTime();
      start_systime_ = SysTime();
      start_walltime_ = WallclockTime();
   }
 
   void End()
   {
      if( !enabled_ )
      {
         return;
      }
 
      DBG_ASSERT(!end_called_);
      DBG_ASSERT(start_called_);
      end_called_ = true;
      start_called_ = false;
      total_cputime_ += CpuTime() - start_cputime_;
      total_systime_ += SysTime() - start_systime_;
      total_walltime_ += WallclockTime() - start_walltime_;
   }
 
   void EndIfStarted()
   {
      if( !enabled_ )
      {
         return;
      }
      if( start_called_ )
      {
         end_called_ = true;
         start_called_ = false;
         total_cputime_ += CpuTime() - start_cputime_;
         total_systime_ += SysTime() - start_systime_;
         total_walltime_ += WallclockTime() - start_walltime_;
      }
      DBG_ASSERT(end_called_);
   }
 
   Number TotalCpuTime() const
   {
      DBG_ASSERT(end_called_);
      return total_cputime_;
   }
 
   Number TotalSysTime() const
   {
      DBG_ASSERT(end_called_);
      return total_systime_;
   }
 
   Number TotalWallclockTime() const
   {
      DBG_ASSERT(end_called_);
      return total_walltime_;
   }
 
   Number StartCpuTime() const
   {
      DBG_ASSERT(start_called_);
      DBG_ASSERT(!end_called_);
      return start_cputime_;
   }
 
   Number StartSysTime() const
   {
      DBG_ASSERT(start_called_);
      DBG_ASSERT(!end_called_);
      return start_systime_;
   }
 
   Number StartWallclockTime() const
   {
      DBG_ASSERT(start_called_);
      DBG_ASSERT(!end_called_);
      return start_walltime_;
   }
 
   bool IsEnabled() const
   {
      return enabled_;
   }
 
   bool IsStarted() const
   {
      return start_called_;
   }
 
private:
 
   TimedTask(const TimedTask&);
 
   void operator=(const TimedTask&);
 
   Number start_cputime_;
   Number total_cputime_;
   Number start_systime_;
   Number total_systime_;
   Number start_walltime_;
   Number total_walltime_;
 
   bool enabled_;
   bool start_called_;
   bool end_called_;
 
};
} // namespace Ipopt
 
#endif