TimedRegion.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright (C) 2022 Stellar Science; U.S. Government has Unlimited Rights.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef PROFILINGTIMEDREGION_HPP
#define PROFILINGTIMEDREGION_HPP
 
#include "profiling_export.h"
 
#include <functional>
#include <memory>
 
#include "ProfilingRegion.hpp"
#include "UtLog.hpp"
#include "UtLogStream.hpp"
#include "UtProcessorTime.hpp"
#include "UtWallClock.hpp"
 
namespace profiling
{
class PROFILING_EXPORT TimedRegion final
{
public:
   enum class Mode
   {
      REGION,   
      SUBREGION 
   };

   TimedRegion(const char*                                  aRegionLabel,
               Mode                                         aMode                    = Mode::REGION,
               std::function<void(ut::log::MessageStream&)> aExtraStartingOutputFunc = nullptr,
               ut::log::MessageStream                       aOutputStream            = ut::log::info());
 
   ~TimedRegion();

   void StartSubregion(const std::string& aStartMessage = "");

   void StopSubregion(const std::string& aEndMessage = "");

   double GetWallTime();

   double GetCpuTime();
 
   TimedRegion()                   = delete;
   TimedRegion(const TimedRegion&) = delete;
   TimedRegion& operator=(const TimedRegion&) = delete;
   TimedRegion(TimedRegion&&)                 = delete;
   TimedRegion& operator=(TimedRegion&&) = delete;
 
private:
   void LogStart(const std::string& aStartMessage = "");
   void LogEnd(const std::string& aEndMessage = "");

   std::unique_ptr<ProfilingRegion> mProfilingRegion;
   std::string mRegionLabel;
   Mode mMode;
   std::function<void(ut::log::MessageStream&)> mExtraStartingOutputFunc;
   ut::log::MessageStream mOutputStream;
 
   UtWallClock     mWallClock;
   UtProcessorTime mProcessorTime;

   double mCpuOffset = 0.0;
   double mWallOffset = 0.0;
};
 
} // namespace profiling
 
#endif // PROFILINGTIMEDREGION_HPP