performanceMonitor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2015 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include <vrfutil/vrfutilDefines.h>
#include "vrfutil/averager.h"
#include <vlutil/vlPerformanceStats.h>

#include <map>

class DT_DLL_vrfutil DtPerformanceMonitor
{
public:
   typedef std::map<int, DtAverager> SectionTimes;

public:
   DtPerformanceMonitor();

   static int AddProfileContextString(int context, const char* str)
   {
      if (!theProfileContextStrings)
      {
         theProfileContextStrings = new std::map<int, std::string>();
      }

      (*theProfileContextStrings)[context] = str;
      return context;
   }

   static std::string ProfileContextString(int context)
   {
      std::map<int, std::string>::const_iterator iter = (*theProfileContextStrings).find(context);

      if (iter != (*theProfileContextStrings).end())
      {
         return iter->second;
      }

      return "";
   }

   virtual void pause();
   virtual void resume();

   virtual bool isPaused() const;

   virtual void addSample(double frameTime, int section = -1);
      
   virtual void adjustSample(int section, double frameTime);

   static DtPerformanceMonitor* Instance();

   static DtPerformanceMonitor* SetInstance(DtPerformanceMonitor*);

   virtual double meanFrameRate(int section = -1);

   virtual double medianFrameRate(int section = -1);

   virtual double standardDeviationFrameRate(int section = -1);

   virtual double minimumFrameRate(int section = -1);

   virtual double maximumFrameRate(int section = -1);

   virtual double lastSample(int section = -1);

   virtual void reset();

   virtual void setNumberOfFramesToAverage(unsigned int numFramesToAverage);
   virtual unsigned int numberOfFramesToAverage();

   virtual int numSections() const;

   virtual int section(int index) const;

   virtual std::vector<int> sections() const;

   const SectionTimes& sectionTimes() const
   {
      return mySectionTimes;
   }

   double currentFrameRate() const
   {
      return myCurrentFrameRate;
   }

protected:
   static std::map<int, std::string>* theProfileContextStrings;
   SectionTimes mySectionTimes;
   bool myIsPaused;
   double myCurrentFrameRate;

   static DtPerformanceMonitor* thePerformanceMonitor;
   unsigned int myMaxPopulationSize;
};

#define PROFILE_CONTEXT_STRING(Context, Description) const int the##Context = DtPerformanceMonitor::AddProfileContextString(Context, Description);

const int SIMULATION_FRAME_RATE = -1;
PROFILE_CONTEXT_STRING(SIMULATION_FRAME_RATE, "Simulation Frame Rate")

const int SIMULATION_FRAME = 1;
PROFILE_CONTEXT_STRING(SIMULATION_FRAME, "Simulation")

const int BEGIN_FRAME = 2;
PROFILE_CONTEXT_STRING(BEGIN_FRAME, "Begin")

const int ADVANCE_FRAME = 3;
PROFILE_CONTEXT_STRING(ADVANCE_FRAME, "Advance")

const int OBJECT_TICK = 4;
PROFILE_CONTEXT_STRING(OBJECT_TICK, "Object Tick")

const int APPLICATION_TICK = 5;
PROFILE_CONTEXT_STRING(APPLICATION_TICK, "Application Tick")

const int NETWORK_TICK = 6;
PROFILE_CONTEXT_STRING(NETWORK_TICK, "Network Tick")

class DT_DLL_vrfutil DtPerformanceMonitorMarker
{
public:
   DtPerformanceMonitorMarker(int context)
   : myContext(context)
   {
      start();
   }

   virtual ~DtPerformanceMonitorMarker()
   {
      stop();
   }

   void start()
   {
      myPerformanceMarker.start();
   }

   void stop()
   {
      myPerformanceMarker.stop();
      DtPerformanceMonitor::Instance()->addSample(myPerformanceMarker.duration(), myContext);
   }

protected:
   DtTimedSection myPerformanceMarker;
   int myContext;
};

#define DtVRF_PERFORMANCE_PROFILE(Context) DtPerformanceMonitorMarker frameRate##Context(Context);