frameTimer.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2013 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <broker/dllExport.h>
#include <vlutil/vlTime.h>
#include <map>

class DtString;

namespace MAKVrExchange
{

   class DtPortalConnection;

   class DT_DLL_BROKER DtFrameTimer
   {
   public:

      typedef DtFrameTimer* (*DtFrameTimerCreator)( DtPortalConnection* );

      enum FrameSectionType
      {
         FRAME,
         INTERNAL,
         EXTERNAL,
         MESSAGE_PROC,
         TRANSLATION,
         OUT_OF_FRAME,
         EXTERNAL_OTHER,
         FRAME_OTHER,
         USER_START
      };

      struct SectionInfo
      {
         SectionInfo()
            : startTime( -1 )
            , duration( -1 )
            , avgDuration( 0 )
            , avgPercent( 0 )
         {
         }

         DtTime startTime;    // Time the last section started.
         DtTime duration;     // Duration of the last section.
         DtTime avgDuration;  // Avg duration of section (or sum so far if still processing).
         double avgPercent;   // Avg percent of frame spent in section (or sum so far if still processing).
      };

      typedef std::map<FrameSectionType,SectionInfo> SectionInfoMap;

   public:

      static DtFrameTimerCreator theFrameTimerCreator;

      static DtFrameTimer* create( DtPortalConnection* portalConn );

      virtual ~DtFrameTimer();

      virtual void markFrameStart();

      virtual void markFrameEnd();

      virtual void markStart( FrameSectionType section );

      virtual void markEnd( FrameSectionType section );

      virtual void generateReport();

      virtual void printFrameStatistics();

      virtual const SectionInfoMap& sectionInfo() const;

      virtual double fps() const;

   protected:

      DtFrameTimer( DtPortalConnection* portalConn );

      virtual DtString roundPercent( double percent );

   protected:

      SectionInfoMap mySectionInfo;

      unsigned int myFrameCounter;
      unsigned int myLastFrameCount;
      DtTime myLastReportTime;
      double myFps;

      DtPortalConnection* myPortalConn;

   };

}