vlPerformanceStats.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
******************************************************************************/
#pragma once

#include "vlUtil.h"
#include <vector>

#ifdef _WIN32
#else
#include <sys/time.h>
#endif

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

class DT_DLL_VLUTIL DtTimedSection
{
public:
   DtTimedSection();
   
   virtual void start();

   virtual void stop();
   
   virtual double duration() const;
   
protected:

   //Platform specific storage times, and additional members.
#ifdef _WIN32
   typedef LARGE_INTEGER TimeValue;
   double myInverseFrequency;
#else
    typedef timeval TimeValue;
    struct timezone tz;
 #endif

    TimeValue myStartVal;
    TimeValue myEndVal;
};

class DT_DLL_VLUTIL DtTimedLappingSection : public DtTimedSection
{
public:

   DtTimedLappingSection();

   virtual void lap();

   virtual double durationSegment( const unsigned int & lapReference ) const;

   virtual unsigned int getCurrentLap() const;
protected:

   // this stores a vector of all the time lapses
   std::vector< TimeValue > myLapValues;

   // the current lap
   unsigned int myCurrentLap;
};

class DT_DLL_VLUTIL DtTimeStatistic
{
public:

   DtTimeStatistic();

   void addTime(double time);

   inline double last() const
   {
      return myLastTime;
   }

   inline double minimum() const 
   { 
      return myMinimum; 
   }
   
   inline double avg() const
   {
      // Calculate the average by taking the running Avg scaled by the max
      // count plus the current average scaled by the count/ over the total count;
      return (myLastSum + mySum) / (double)(myLastCount + myCount);
   }
   
   inline double maximum() const 
   { 
      return myMaximum; 
   }

   void reset();

protected:
   double myLastTime;
   double myMinimum;
   double mySum;
   double myLastSum;
   double myMaximum;   
   unsigned int myCount;
   unsigned int myLastCount;
   static const int theMaxCount = 1000;
};

class DT_DLL_VLUTIL DtPerformanceStats
{  
public:
   //A vector of stats.
   typedef std::vector<DtTimeStatistic> TimeStats;

   //Create a time stat list.
   DtPerformanceStats();
   
   //Destroy a time stat list.
   ~DtPerformanceStats();
   
   void resetAllStats();

   inline void addTime(unsigned int id, double time)
   {
      stat(id).addTime(time);
   }

   inline double last(unsigned int id) const
   {
      return stat(id).last();
   }

   inline double minimum(unsigned int id) const 
   { 
      return stat(id).minimum();
   }

   inline double avg(unsigned int id) const
   {
      return stat(id).avg();
   }

   inline double maximum(unsigned int id) const 
   { 
      return stat(id).maximum(); 
   }

   DtTimeStatistic& stat(unsigned int statEnumIndex);
   const DtTimeStatistic& stat(unsigned int statEnumIndex) const;
   

   TimeStats& stats();
   const TimeStats& stats() const;
   
protected:
   TimeStats myStats;
};

#ifdef DtUSE_UTILITIES_NAMESPACE
}
#endif